Class LocalFogObject

  • All Implemented Interfaces:
    X3DChildNode, X3DNode, LocalFog, X3DFogObject

    public class LocalFogObject
    extends X3DConcreteNode
    implements LocalFog
    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 SFColorObject 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:
    X3D Abstract Specification: LocalFog, X3D Tooltips: LocalFog, X3D Scene Authoring Hints
    • Field Detail

      • FOGTYPE_LINEAR

        public static final java.lang.String FOGTYPE_LINEAR
        SFString field named fogType with X3DUOM baseType fogTypeChoices can equal this value "LINEAR" (Java syntax) or LINEAR (XML syntax).
        See Also:
        fogTypeChoices, Constant Field Values
      • FOGTYPE_EXPONENTIAL

        public static final java.lang.String FOGTYPE_EXPONENTIAL
        SFString field named fogType with X3DUOM baseType fogTypeChoices can equal this value "EXPONENTIAL" (Java syntax) or EXPONENTIAL (XML syntax).
        See Also:
        fogTypeChoices, Constant Field Values
      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: LocalFog.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the LocalFog element: EnvironmentalEffects
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D EnvironmentalEffects component level for this element: 4
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • FOGTYPE_DEFAULT_VALUE

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

        public static final ISObject 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:
        Constant Field Values
      • fromField_COLOR

        public static final java.lang.String fromField_COLOR
        fromField ROUTE name for SFColor field named color.
        See Also:
        Constant Field Values
      • toField_COLOR

        public static final java.lang.String toField_COLOR
        toField ROUTE name for SFColor field named color.
        See Also:
        Constant Field Values
      • fromField_ENABLED

        public static final java.lang.String fromField_ENABLED
        fromField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • toField_ENABLED

        public static final java.lang.String toField_ENABLED
        toField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • fromField_FOGTYPE

        public static final java.lang.String fromField_FOGTYPE
        fromField ROUTE name for SFString field named fogType.
        See Also:
        Constant Field Values
      • toField_FOGTYPE

        public static final java.lang.String toField_FOGTYPE
        toField ROUTE name for SFString field named fogType.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_VISIBILITYRANGE

        public static final java.lang.String fromField_VISIBILITYRANGE
        fromField ROUTE name for SFFloat field named visibilityRange.
        See Also:
        Constant Field Values
      • toField_VISIBILITYRANGE

        public static final java.lang.String toField_VISIBILITYRANGE
        toField ROUTE name for SFFloat field named visibilityRange.
        See Also:
        Constant Field Values
    • Constructor Detail

      • LocalFogObject

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

        public LocalFogObject​(java.lang.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 Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: LocalFog
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the LocalFog element: EnvironmentalEffects
        Specified by:
        getComponent in class X3DConcreteElement
        Returns:
        X3D component for this element
      • getComponentLevel

        public final int getComponentLevel()
        Provides default X3D component level for this element: 4
        Specified by:
        getComponentLevel in class X3DConcreteElement
        Returns:
        default X3D component level for this element
      • getFieldType

        public java.lang.String getFieldType​(java.lang.String fieldName)
        Indicate type corresponding to given fieldName.
        Specified by:
        getFieldType in class X3DConcreteElement
        Parameters:
        fieldName - name of field in this X3D node
        Returns:
        X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
        See Also:
        ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
      • getAccessType

        public java.lang.String getAccessType​(java.lang.String fieldName)
        Indicate accessType corresponding to given fieldName.
        Specified by:
        getAccessType in class X3DConcreteElement
        Parameters:
        fieldName - name of field in this X3D node
        Returns:
        X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
        See Also:
        ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
      • initialize

        public final void initialize()
        Initialize all member variables to default values.
        Overrides:
        initialize in class X3DConcreteNode
      • setColor

        public LocalFogObject setColor​(SFColorObject newValue)
        Assign typed object value to SFColor color field, similar to setColor(float[]).
        Parameters:
        newValue - is new value for the color field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setColor

        public LocalFogObject setColor​(float red,
                                       float green,
                                       float blue)
        Assign values to SFColor color field, similar to setColor(float[]).
        Parameters:
        red - first component
        green - second component
        blue - third component
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setColor

        public LocalFogObject setColor​(double red,
                                       double green,
                                       double blue)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
        Parameters:
        red - first component [0..1]
        green - second component [0..1]
        blue - third component [0..1]
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setColor

        public LocalFogObject setColor​(double[] newArray)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getEnabled

        public boolean getEnabled()
        Provide boolean value from inputOutput SFBool field named enabled.

        Tooltip: Enables/disables node operation. *
        Specified by:
        getEnabled in interface LocalFog
        Returns:
        value of enabled field
      • setEnabled

        public LocalFogObject setEnabled​(boolean newValue)
        Accessor method to assign boolean value to inputOutput SFBool field named enabled.

        Tooltip: Enables/disables node operation. *
        Specified by:
        setEnabled in interface LocalFog
        Parameters:
        newValue - is new value for the enabled field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setEnabled

        public LocalFogObject setEnabled​(SFBoolObject newValue)
        Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
        Parameters:
        newValue - is new value for the enabled field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getFogType

        public java.lang.String getFogType()
        Provide String enumeration value ( baseType fogTypeChoices) ["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.


        Available enumeration values for string comparison: LINEAR, EXPONENTIAL.
        Specified by:
        getFogType in interface LocalFog
        Specified by:
        getFogType in interface X3DFogObject
        Returns:
        value of fogType field
      • setFogType

        public LocalFogObject setFogType​(java.lang.String newValue)
        Accessor method to assign String enumeration value ("LINEAR" | "EXPONENTIAL") to inputOutput SFString field named fogType.

        Warning: authors can only choose from a strict list of enumeration values (LINEAR, EXPONENTIAL).

        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 LocalFog
        Specified by:
        setFogType in interface X3DFogObject
        Parameters:
        newValue - is new value for the fogType field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFogType

        public LocalFogObject setFogType​(SFStringObject newValue)
        Assign typed object value to SFString fogType field, similar to setFogType(String).
        Parameters:
        newValue - is new value for the fogType field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearIS

        public LocalFogObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasIS

        public boolean hasIS()
        Indicate whether an object is available for inputOutput SFNode field IS.
        Returns:
        whether a concrete statement or CommentsBlock is available.
        See Also:
        getIS()
      • clearMetadata

        public LocalFogObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasMetadata

        public boolean hasMetadata()
        Indicate whether an object is available for inputOutput SFNode field metadata.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
      • getVisibilityRange

        public 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 LocalFog
        Specified by:
        getVisibilityRange in interface X3DFogObject
        Returns:
        value of visibilityRange field
      • setVisibilityRange

        public LocalFogObject setVisibilityRange​(float newValue)
        Accessor method to assign float value 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 LocalFog
        Specified by:
        setVisibilityRange in interface X3DFogObject
        Parameters:
        newValue - is new value for the visibilityRange field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setVisibilityRange

        public LocalFogObject setVisibilityRange​(SFFloatObject newValue)
        Assign typed object value to SFFloat visibilityRange field, similar to setVisibilityRange(float).
        Parameters:
        newValue - is new value for the visibilityRange field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setVisibilityRange

        public LocalFogObject setVisibilityRange​(double newValue)
        Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setVisibilityRange(float).
        Parameters:
        newValue - is new value for field
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

        public final LocalFogObject setDEF​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named DEF.

        Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

        Note that setting the DEF value clears the USE value.
        Specified by:
        setDEF in class X3DConcreteNode
        Parameters:
        newValue - is new value for the DEF field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

        public LocalFogObject setDEF​(SFStringObject newValue)
        Assign typed object value to SFString DEF field, similar to setDEF(String).
        Parameters:
        newValue - is new value for the DEF field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getUSE

        public java.lang.String getUSE()
        Provide String value from 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.
        Overrides:
        getUSE in class X3DConcreteNode
        Returns:
        value of USE field
        See Also:
        X3D Scene Authoring Hints: Naming Conventions
      • setUSE

        public final LocalFogObject setUSE​(java.lang.String newValue)
        Accessor method to 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 class X3DConcreteNode
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public LocalFogObject setUSE​(SFStringObject newValue)
        Assign typed object value to SFString USE field, similar to setUSE(String).
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getCssClass

        public java.lang.String getCssClass()
        Provide String value from 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
        Overrides:
        getCssClass in class X3DConcreteNode
        Returns:
        value of class field
        See Also:
        W3C Cascading Style Sheets
      • setCssClass

        public final LocalFogObject setCssClass​(java.lang.String newValue)
        Accessor method to 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 class X3DConcreteNode
        Parameters:
        newValue - is new value for the class field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setCssClass

        public LocalFogObject setCssClass​(SFStringObject newValue)
        Assign typed object value to SFString cssClass field, similar to setCssClass(String).
        Parameters:
        newValue - is new value for the class field.
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public LocalFogObject setUSE​(LocalFogObject DEFnode)
        Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

        Warning: note that 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.
        Parameters:
        DEFnode - must have a DEF value defined
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addComments

        public LocalFogObject addComments​(java.lang.String newComment)
        Add comment as String to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComment - initial value
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public LocalFogObject addComments​(java.lang.String[] newComments)
        Add comments as String[] array to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComments - array of comments
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public LocalFogObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        LocalFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in class X3DConcreteElement
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        Returns:
        object reference to found element, null otherwise
        See Also:
        findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue,
                                                         java.lang.String elementName)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in class X3DConcreteElement
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
        Returns:
        object reference to found element, null otherwise
        See Also:
        findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • hasElementByNameValue

        public boolean hasElementByNameValue​(java.lang.String nameValue,
                                             java.lang.String elementName)
        Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
        Returns:
        whether node is found
        See Also:
        findElementByNameValue(String, String)
      • hasNodeByDEF

        public boolean hasNodeByDEF​(java.lang.String DEFvalue)
        Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
        Parameters:
        DEFvalue - is value of the name field being searched for in this element and child elements(if any)
        Returns:
        whether node is found
        See Also:
        findNodeByDEF(String)
      • validate

        public java.lang.String validate()
        Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
        Specified by:
        validate in class X3DConcreteElement
        Returns:
        validation results (if any)