LocalFog (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DFogObject, X3DNode

All Known Implementing Classes:

LocalFogObject
```
public interface LocalFog
extends X3DChildNode, X3DFogObject
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DChildNode,X3DFogObject] LocalFog simulates atmospheric effects by blending distant objects with fog color. LocalFog effects occur around the local transformation center, rather than bound to the viewer. The nearest LocalFog node within range takes precedence over other LocalFog and Fog nodes.
- Hint: LocalFog effects are based on its position in the world, as given by current transformation hierarchy.
- Hint: LocalFog effects remain independent of current view location.
- Warning: LocalFog only affects geometry within the same scene subgraph.
- Warning: LocalFog is not a bindable node.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: LocalFog, X3D Tooltips: LocalFog, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`float[]`	`getColor()` Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.
`boolean`	`getEnabled()` Provide boolean value from inputOutput SFBool field named enabled.
`java.lang.String`	`getFogType()` Provide String enumeration value ['LINEAR'\|'EXPONENTIAL'] from inputOutput SFString field named fogType.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float`	`getVisibilityRange()` Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named visibilityRange.
`LocalFog`	`setColor(float[] newValue)` Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.
`LocalFog`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`LocalFog`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`LocalFog`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`LocalFog`	`setFogType(java.lang.String newValue)` Assign String enumeration value ("LINEAR"\|"EXPONENTIAL") ['LINEAR'\|'EXPONENTIAL'] to inputOutput SFString field named fogType.
`LocalFog`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`LocalFog`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`LocalFog`	`setVisibilityRange(float newValue)` Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named visibilityRange.

- Method Detail
  - getColor
```
float[] getColor()
```
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.
    
    Tooltip: [0,1] Fog color.
    - Hint: match Background color to make objects fade away.
    - Hint: X3D Scene Authoring Hints, Color
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
    Specified by:
    
    getColor in interface X3DFogObject
    
    Returns:
    
    value of color field
  - setColor
```
LocalFog setColor(float[] newValue)
```
    Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.
    
    Tooltip: [0,1] Fog color. Hint: match Background color to make objects fade away. Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
    
    Specified by:
    
    setColor in interface X3DFogObject
    
    Parameters:
    
    newValue - is new value for the color field.
    
    Returns:
    
    LocalFog - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getEnabled
```
boolean getEnabled()
```
    Provide boolean value from inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation. *
    
    Returns:
    
    value of enabled field
  - setEnabled
```
LocalFog setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    LocalFog - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getFogType
```
java.lang.String getFogType()
```
    Provide String enumeration value ['LINEAR'|'EXPONENTIAL'] from inputOutput SFString field named fogType.
    
    Tooltip: Specifies algorithm for rate of increasing Fog, either LINEAR or EXPONENTIAL.
    - Hint: EXPONENTIAL is more natural but also more computationally expensive.
    - Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
    Specified by:
    
    getFogType in interface X3DFogObject
    
    Returns:
    
    value of fogType field
  - setFogType
```
LocalFog setFogType(java.lang.String newValue)
```
    Assign String enumeration value ("LINEAR"|"EXPONENTIAL") ['LINEAR'|'EXPONENTIAL'] to inputOutput SFString field named fogType.
    
    Tooltip: Specifies algorithm for rate of increasing Fog, either LINEAR or EXPONENTIAL. Hint: EXPONENTIAL is more natural but also more computationally expensive. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
    
    Specified by:
    
    setFogType in interface X3DFogObject
    
    Parameters:
    
    newValue - is new value for the fogType field.
    
    Returns:
    
    LocalFog - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
LocalFog setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    LocalFog - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getVisibilityRange
```
float getVisibilityRange()
```
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named visibilityRange.
    
    Tooltip: Distance in meters where objects are totally obscured by the fog, using local coordinate system.
    - Hint: visibilityRange 0 disables Fog.
    Specified by:
    
    getVisibilityRange in interface X3DFogObject
    
    Returns:
    
    value of visibilityRange field
  - setVisibilityRange
```
LocalFog setVisibilityRange(float newValue)
```
    Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named visibilityRange.
    
    Tooltip: Distance in meters where objects are totally obscured by the fog, using local coordinate system. Hint: visibilityRange 0 disables Fog.
    
    Specified by:
    
    setVisibilityRange in interface X3DFogObject
    
    Parameters:
    
    newValue - is new value for the visibilityRange field.
    
    Returns:
    
    LocalFog - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
LocalFog setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    LocalFog - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
LocalFog setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    LocalFog - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
LocalFog setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    LocalFog - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface LocalFog

Method Summary

Method Detail

getColor

setColor

getEnabled

setEnabled

getFogType

setFogType

getMetadata

setMetadata

getVisibilityRange

setVisibilityRange

setDEF

setUSE

setCssClass