All Implemented Interfaces:
X3DChildNode, X3DNode, LocalFog, X3DFogObject

public class LocalFog extends X3DConcreteNode implements LocalFog
LocalFog simulates atmospheric effects by blending distant objects with fog color.

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.

Note that SFColor provides a variety of color constants.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
  • Field Details

    • FOGTYPE_LINEAR

      public static final String FOGTYPE_LINEAR
      Tooltip: linear blending as a function of distance. SFString field named fogType with X3DUOM simpleType fogTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "LINEAR" (Java syntax) or LINEAR (XML syntax).
      See Also:
    • FOGTYPE_EXPONENTIAL

      public static final String FOGTYPE_EXPONENTIAL
      Tooltip: exponential blending as a function of distance. SFString field named fogType with X3DUOM simpleType fogTypeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "EXPONENTIAL" (Java syntax) or EXPONENTIAL (XML syntax).
      See Also:
    • NAME

      public static final String NAME
      String constant NAME provides name of this element: LocalFog.
      See Also:
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the LocalFog element: EnvironmentalEffects
      See Also:
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D EnvironmentalEffects component level for this element: 4
      See Also:
    • COLOR_DEFAULT_VALUE

      public static final float[] COLOR_DEFAULT_VALUE
      SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
    • ENABLED_DEFAULT_VALUE

      public static final boolean ENABLED_DEFAULT_VALUE
      SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
      See Also:
    • FOGTYPE_DEFAULT_VALUE

      public static final String FOGTYPE_DEFAULT_VALUE
      SFString field named fogType has default value "LINEAR" (Java syntax) or LINEAR (XML syntax).
      See Also:
    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • VISIBILITYRANGE_DEFAULT_VALUE

      public static final float VISIBILITYRANGE_DEFAULT_VALUE
      SFFloat field named visibilityRange has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
    • fromField_COLOR

      public static final String fromField_COLOR
      fromField ROUTE name for SFColor field named color.
      See Also:
    • toField_COLOR

      public static final String toField_COLOR
      toField ROUTE name for SFColor field named color.
      See Also:
    • fromField_ENABLED

      public static final String fromField_ENABLED
      fromField ROUTE name for SFBool field named enabled.
      See Also:
    • toField_ENABLED

      public static final String toField_ENABLED
      toField ROUTE name for SFBool field named enabled.
      See Also:
    • fromField_FOGTYPE

      public static final String fromField_FOGTYPE
      fromField ROUTE name for SFString field named fogType.
      See Also:
    • toField_FOGTYPE

      public static final String toField_FOGTYPE
      toField ROUTE name for SFString field named fogType.
      See Also:
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
    • fromField_VISIBILITYRANGE

      public static final String fromField_VISIBILITYRANGE
      fromField ROUTE name for SFFloat field named visibilityRange.
      See Also:
    • toField_VISIBILITYRANGE

      public static final String toField_VISIBILITYRANGE
      toField ROUTE name for SFFloat field named visibilityRange.
      See Also:
  • Constructor Details

    • LocalFog

      public LocalFog()
      Constructor for LocalFog to initialize member variables with default values.
    • LocalFog

      public LocalFog(String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details