Class TextureBackgroundObject

  • All Implemented Interfaces:
    X3DBindableNode, X3DChildNode, X3DNode, TextureBackground, X3DBackgroundNode

    public class TextureBackgroundObject
    extends X3DConcreteNode
    implements TextureBackground
    X3D node tooltip: [X3DBackgroundNode] TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.
    • Hint: Background, Fog, GeoViewpoint, NavigationInfo, OrthoViewpoint, TextureBackground and Viewpoint are bindable nodes, meaning that no more than one of each node type can be active at a given time.
    • Warning: results are undefined if a bindable node (Background, Fog, NavigationInfo, OrthoViewpoint, TextureBackground, Viewpoint) is a contained descendant node of either LOD or Switch.
    • Warning: each of the child ImageTexture or PixelTexture nodes must have unique containerField values for backTexture, bottomTexture, frontTexture, leftTexture, rightTexture, or topTexture.
    • Hint: authors can have LoadSensor nodes receive notifications and send reporting events when background texture node(s) are loaded.

    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: TextureBackground, X3D Tooltips: TextureBackground, X3D Scene Authoring Hints: Images
    • Field Detail

      • NAME

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

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the TextureBackground 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: 3
        See Also:
        Constant Field Values
      • BACKTEXTURE_DEFAULT_VALUE

        public static final X3DNode BACKTEXTURE_DEFAULT_VALUE
        SFNode field named backTexture has default value null (Java syntax) or NULL (XML syntax).
      • BOTTOMTEXTURE_DEFAULT_VALUE

        public static final X3DNode BOTTOMTEXTURE_DEFAULT_VALUE
        SFNode field named bottomTexture has default value null (Java syntax) or NULL (XML syntax).
      • FRONTTEXTURE_DEFAULT_VALUE

        public static final X3DNode FRONTTEXTURE_DEFAULT_VALUE
        SFNode field named frontTexture has default value null (Java syntax) or NULL (XML syntax).
      • GROUNDANGLE_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Float> GROUNDANGLE_DEFAULT_VALUE
        MFFloat field named groundAngle has default value equal to an empty list.
      • GROUNDCOLOR_DEFAULT_VALUE

        public static final float[] GROUNDCOLOR_DEFAULT_VALUE
        MFColor field named groundColor has default value equal to an empty list.
      • IS_DEFAULT_VALUE

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

        public static final X3DNode LEFTTEXTURE_DEFAULT_VALUE
        SFNode field named leftTexture 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).
      • RIGHTTEXTURE_DEFAULT_VALUE

        public static final X3DNode RIGHTTEXTURE_DEFAULT_VALUE
        SFNode field named rightTexture has default value null (Java syntax) or NULL (XML syntax).
      • SKYANGLE_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Float> SKYANGLE_DEFAULT_VALUE
        MFFloat field named skyAngle has default value equal to an empty list.
      • SKYCOLOR_DEFAULT_VALUE

        public static final float[] SKYCOLOR_DEFAULT_VALUE
        MFColor field named skyColor has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
      • TOPTEXTURE_DEFAULT_VALUE

        public static final X3DNode TOPTEXTURE_DEFAULT_VALUE
        SFNode field named topTexture has default value null (Java syntax) or NULL (XML syntax).
      • TRANSPARENCY_DEFAULT_VALUE

        public static final float TRANSPARENCY_DEFAULT_VALUE
        SFFloat field named transparency has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • fromField_BACKTEXTURE

        public static final java.lang.String fromField_BACKTEXTURE
        fromField ROUTE name for SFNode field named backTexture.
        See Also:
        Constant Field Values
      • toField_BACKTEXTURE

        public static final java.lang.String toField_BACKTEXTURE
        toField ROUTE name for SFNode field named backTexture.
        See Also:
        Constant Field Values
      • fromField_BINDTIME

        public static final java.lang.String fromField_BINDTIME
        fromField ROUTE name for SFTime field named bindTime.
        See Also:
        Constant Field Values
      • fromField_BOTTOMTEXTURE

        public static final java.lang.String fromField_BOTTOMTEXTURE
        fromField ROUTE name for SFNode field named bottomTexture.
        See Also:
        Constant Field Values
      • toField_BOTTOMTEXTURE

        public static final java.lang.String toField_BOTTOMTEXTURE
        toField ROUTE name for SFNode field named bottomTexture.
        See Also:
        Constant Field Values
      • fromField_FRONTTEXTURE

        public static final java.lang.String fromField_FRONTTEXTURE
        fromField ROUTE name for SFNode field named frontTexture.
        See Also:
        Constant Field Values
      • toField_FRONTTEXTURE

        public static final java.lang.String toField_FRONTTEXTURE
        toField ROUTE name for SFNode field named frontTexture.
        See Also:
        Constant Field Values
      • fromField_GROUNDANGLE

        public static final java.lang.String fromField_GROUNDANGLE
        fromField ROUTE name for MFFloat field named groundAngle.
        See Also:
        Constant Field Values
      • toField_GROUNDANGLE

        public static final java.lang.String toField_GROUNDANGLE
        toField ROUTE name for MFFloat field named groundAngle.
        See Also:
        Constant Field Values
      • fromField_GROUNDCOLOR

        public static final java.lang.String fromField_GROUNDCOLOR
        fromField ROUTE name for MFColor field named groundColor.
        See Also:
        Constant Field Values
      • toField_GROUNDCOLOR

        public static final java.lang.String toField_GROUNDCOLOR
        toField ROUTE name for MFColor field named groundColor.
        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_ISBOUND

        public static final java.lang.String fromField_ISBOUND
        fromField ROUTE name for SFBool field named isBound.
        See Also:
        Constant Field Values
      • fromField_LEFTTEXTURE

        public static final java.lang.String fromField_LEFTTEXTURE
        fromField ROUTE name for SFNode field named leftTexture.
        See Also:
        Constant Field Values
      • toField_LEFTTEXTURE

        public static final java.lang.String toField_LEFTTEXTURE
        toField ROUTE name for SFNode field named leftTexture.
        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_RIGHTTEXTURE

        public static final java.lang.String fromField_RIGHTTEXTURE
        fromField ROUTE name for SFNode field named rightTexture.
        See Also:
        Constant Field Values
      • toField_RIGHTTEXTURE

        public static final java.lang.String toField_RIGHTTEXTURE
        toField ROUTE name for SFNode field named rightTexture.
        See Also:
        Constant Field Values
      • toField_SET_BIND

        public static final java.lang.String toField_SET_BIND
        toField ROUTE name for SFBool field named set_bind.
        See Also:
        Constant Field Values
      • fromField_SKYANGLE

        public static final java.lang.String fromField_SKYANGLE
        fromField ROUTE name for MFFloat field named skyAngle.
        See Also:
        Constant Field Values
      • toField_SKYANGLE

        public static final java.lang.String toField_SKYANGLE
        toField ROUTE name for MFFloat field named skyAngle.
        See Also:
        Constant Field Values
      • fromField_SKYCOLOR

        public static final java.lang.String fromField_SKYCOLOR
        fromField ROUTE name for MFColor field named skyColor.
        See Also:
        Constant Field Values
      • toField_SKYCOLOR

        public static final java.lang.String toField_SKYCOLOR
        toField ROUTE name for MFColor field named skyColor.
        See Also:
        Constant Field Values
      • fromField_TOPTEXTURE

        public static final java.lang.String fromField_TOPTEXTURE
        fromField ROUTE name for SFNode field named topTexture.
        See Also:
        Constant Field Values
      • toField_TOPTEXTURE

        public static final java.lang.String toField_TOPTEXTURE
        toField ROUTE name for SFNode field named topTexture.
        See Also:
        Constant Field Values
      • fromField_TRANSPARENCY

        public static final java.lang.String fromField_TRANSPARENCY
        fromField ROUTE name for SFFloat field named transparency.
        See Also:
        Constant Field Values
      • toField_TRANSPARENCY

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

      • TextureBackgroundObject

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

        public TextureBackgroundObject​(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: TextureBackground
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the TextureBackground 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: 3
        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
      • getBackTexture

        public X3DNode getBackTexture()
        Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field backTexture.
        Specified by:
        getBackTexture in interface TextureBackground
        Returns:
        value of backTexture field
        See Also:
        Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
      • clearBackTexture

        public TextureBackgroundObject clearBackTexture()
        Utility method to clear SFNode value of backTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setBackTexture

        public TextureBackgroundObject setBackTexture​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field backTexture.
        Parameters:
        newValue - is new value for the backTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setBackTexture(X3DNode)
      • hasBackTexture

        public boolean hasBackTexture()
        Indicate whether an object is available for inputOutput SFNode field backTexture.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getBackTexture(), getBackTextureProtoInstance()
      • getBindTime

        public double getBindTime()
        Provide double value in seconds from outputOnly SFTime field named bindTime.

        Tooltip: event sent when node becomes active/inactive.
        • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
        Specified by:
        getBindTime in interface TextureBackground
        Specified by:
        getBindTime in interface X3DBackgroundNode
        Specified by:
        getBindTime in interface X3DBindableNode
        Returns:
        value of bindTime field
      • getBottomTexture

        public X3DNode getBottomTexture()
        Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field bottomTexture.
        Specified by:
        getBottomTexture in interface TextureBackground
        Returns:
        value of bottomTexture field
        See Also:
        Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
      • clearBottomTexture

        public TextureBackgroundObject clearBottomTexture()
        Utility method to clear SFNode value of bottomTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setBottomTexture

        public TextureBackgroundObject setBottomTexture​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field bottomTexture.
        Parameters:
        newValue - is new value for the bottomTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setBottomTexture(X3DNode)
      • hasBottomTexture

        public boolean hasBottomTexture()
        Indicate whether an object is available for inputOutput SFNode field bottomTexture.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getBottomTexture(), getBottomTextureProtoInstance()
      • getFrontTexture

        public X3DNode getFrontTexture()
        Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field frontTexture.
        Specified by:
        getFrontTexture in interface TextureBackground
        Returns:
        value of frontTexture field
        See Also:
        Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
      • clearFrontTexture

        public TextureBackgroundObject clearFrontTexture()
        Utility method to clear SFNode value of frontTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setFrontTexture

        public TextureBackgroundObject setFrontTexture​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field frontTexture.
        Parameters:
        newValue - is new value for the frontTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setFrontTexture(X3DNode)
      • hasFrontTexture

        public boolean hasFrontTexture()
        Indicate whether an object is available for inputOutput SFNode field frontTexture.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getFrontTexture(), getFrontTextureProtoInstance()
      • getGroundAngle

        public float[] getGroundAngle()
        Provide array of Float results unit axis, angle (in radians) within allowed range of [0,1.5708] from inputOutput MFFloat field named groundAngle.

        Tooltip: [0,pi/2] The angle array values increase from 0.0 nadir (straight down) to pi/2=1.570796 (horizon).
        • Warning: you must have one more groundColor value than groundAngle values.
        • Warning: colors at groundAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
        • Hint: https://en.wikipedia.org/wiki/Radian
        Specified by:
        getGroundAngle in interface TextureBackground
        Specified by:
        getGroundAngle in interface X3DBackgroundNode
        Returns:
        value of groundAngle field
      • getGroundAngleList

        public java.util.ArrayList<java.lang.Float> getGroundAngleList()
        Utility method to get ArrayList value of MFFloat groundAngle field, similar to getGroundAngle().
        Returns:
        value of groundAngle field
      • setGroundAngle

        public TextureBackgroundObject setGroundAngle​(float[] newValue)
        Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.

        Tooltip: [0,pi/2] The angle array values increase from 0.0 nadir (straight down) to pi/2=1.570796 (horizon).
        • Warning: you must have one more groundColor value than groundAngle values.
        • Warning: colors at groundAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
        • Hint: https://en.wikipedia.org/wiki/Radian
        Specified by:
        setGroundAngle in interface TextureBackground
        Specified by:
        setGroundAngle in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the groundAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGroundAngle

        public TextureBackgroundObject setGroundAngle​(java.util.ArrayList<java.lang.Float> newValue)
        Assign ArrayList value of MFFloat groundAngle field, similar to setGroundAngle(float[]).
        Parameters:
        newValue - is new value for the groundAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearGroundAngle

        public TextureBackgroundObject clearGroundAngle()
        Utility method to clear MFFloat value of groundAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setGroundAngle

        public TextureBackgroundObject setGroundAngle​(int[] newValue)
        Assign floating-point array value of MFFloat groundAngle field, similar to setGroundAngle(float[]).
        Parameters:
        newValue - is new value for the groundAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addGroundAngle

        public TextureBackgroundObject addGroundAngle​(float newValue)
        Add singleton float value to MFFloat groundAngle field.
        Parameters:
        newValue - is new value to add to the groundAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addGroundAngle

        public TextureBackgroundObject addGroundAngle​(SFFloatObject newValue)
        Add singleton SFFloatObject value to MFFloat groundAngle field.
        Parameters:
        newValue - is new value to add to the groundAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGroundAngle

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

        public float[] getGroundColor()
        Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named groundColor.

        Tooltip: Color of the ground at the various angles on the ground partial sphere. First value is color of ground at 0.0 radians representing the nadir (straight down).
        Specified by:
        getGroundColor in interface TextureBackground
        Specified by:
        getGroundColor in interface X3DBackgroundNode
        Returns:
        value of groundColor field
      • setGroundColor

        public TextureBackgroundObject setGroundColor​(float[] newValue)
        Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.

        Tooltip: Color of the ground at the various angles on the ground partial sphere. First value is color of ground at 0.0 radians representing the nadir (straight down).
        Specified by:
        setGroundColor in interface TextureBackground
        Specified by:
        setGroundColor in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the groundColor field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addGroundColor

        public TextureBackgroundObject addGroundColor​(SFColorObject newValue)
        Add singleton SFColorObject value to MFColor groundColor field.
        Parameters:
        newValue - is new value to add to the groundColor field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGroundColor

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

        public TextureBackgroundObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        TextureBackgroundObject - 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()
      • getIsBound

        public boolean getIsBound()
        Provide boolean value from outputOnly SFBool field named isBound.

        Tooltip: event true sent when node becomes active, event false sent when unbound by another node.
        • Hint: paired node operations can be established by connecting set_bind and isBound fields of corresponding bindable nodes.
        • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
        Specified by:
        getIsBound in interface TextureBackground
        Specified by:
        getIsBound in interface X3DBackgroundNode
        Specified by:
        getIsBound in interface X3DBindableNode
        Returns:
        value of isBound field
      • getLeftTexture

        public X3DNode getLeftTexture()
        Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field leftTexture.
        Specified by:
        getLeftTexture in interface TextureBackground
        Returns:
        value of leftTexture field
        See Also:
        Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
      • clearLeftTexture

        public TextureBackgroundObject clearLeftTexture()
        Utility method to clear SFNode value of leftTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setLeftTexture

        public TextureBackgroundObject setLeftTexture​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field leftTexture.
        Parameters:
        newValue - is new value for the leftTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setLeftTexture(X3DNode)
      • hasLeftTexture

        public boolean hasLeftTexture()
        Indicate whether an object is available for inputOutput SFNode field leftTexture.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getLeftTexture(), getLeftTextureProtoInstance()
      • clearMetadata

        public TextureBackgroundObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        TextureBackgroundObject - 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
      • getRightTexture

        public X3DNode getRightTexture()
        Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field rightTexture.
        Specified by:
        getRightTexture in interface TextureBackground
        Returns:
        value of rightTexture field
        See Also:
        Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
      • clearRightTexture

        public TextureBackgroundObject clearRightTexture()
        Utility method to clear SFNode value of rightTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setRightTexture

        public TextureBackgroundObject setRightTexture​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field rightTexture.
        Parameters:
        newValue - is new value for the rightTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setRightTexture(X3DNode)
      • hasRightTexture

        public boolean hasRightTexture()
        Indicate whether an object is available for inputOutput SFNode field rightTexture.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getRightTexture(), getRightTextureProtoInstance()
      • getSkyAngle

        public float[] getSkyAngle()
        Provide array of Float results unit axis, angle (in radians) within allowed range of [0,3.1416] from inputOutput MFFloat field named skyAngle.

        Tooltip: [0,pi] The angle array values increase from 0.0 zenith (straight up) to pi/2=1.570796 (horizon) to pi=3.14159 (nadir).
        • Warning: you must have one more skyColor value than skyAngle values.
        • Warning: colors at skyAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
        • Hint: https://en.wikipedia.org/wiki/Radian
        Specified by:
        getSkyAngle in interface TextureBackground
        Specified by:
        getSkyAngle in interface X3DBackgroundNode
        Returns:
        value of skyAngle field
      • getSkyAngleList

        public java.util.ArrayList<java.lang.Float> getSkyAngleList()
        Utility method to get ArrayList value of MFFloat skyAngle field, similar to getSkyAngle().
        Returns:
        value of skyAngle field
      • setSkyAngle

        public TextureBackgroundObject setSkyAngle​(float[] newValue)
        Accessor method to assign Float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.

        Tooltip: [0,pi] The angle array values increase from 0.0 zenith (straight up) to pi/2=1.570796 (horizon) to pi=3.14159 (nadir).
        • Warning: you must have one more skyColor value than skyAngle values.
        • Warning: colors at skyAngle=0 are ignored. Interchange profile hint: this field may be ignored, applying the default value regardless.
        • Hint: https://en.wikipedia.org/wiki/Radian
        Specified by:
        setSkyAngle in interface TextureBackground
        Specified by:
        setSkyAngle in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the skyAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSkyAngle

        public TextureBackgroundObject setSkyAngle​(java.util.ArrayList<java.lang.Float> newValue)
        Assign ArrayList value of MFFloat skyAngle field, similar to setSkyAngle(float[]).
        Parameters:
        newValue - is new value for the skyAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearSkyAngle

        public TextureBackgroundObject clearSkyAngle()
        Utility method to clear MFFloat value of skyAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setSkyAngle

        public TextureBackgroundObject setSkyAngle​(int[] newValue)
        Assign floating-point array value of MFFloat skyAngle field, similar to setSkyAngle(float[]).
        Parameters:
        newValue - is new value for the skyAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addSkyAngle

        public TextureBackgroundObject addSkyAngle​(float newValue)
        Add singleton float value to MFFloat skyAngle field.
        Parameters:
        newValue - is new value to add to the skyAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addSkyAngle

        public TextureBackgroundObject addSkyAngle​(SFFloatObject newValue)
        Add singleton SFFloatObject value to MFFloat skyAngle field.
        Parameters:
        newValue - is new value to add to the skyAngle field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSkyAngle

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

        public float[] getSkyColor()
        Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput MFColor field named skyColor.

        Tooltip: Color of the sky at various angles on the sky sphere. First value is color of sky at 0.0 radians representing the zenith (straight up).
        Specified by:
        getSkyColor in interface TextureBackground
        Specified by:
        getSkyColor in interface X3DBackgroundNode
        Returns:
        value of skyColor field
      • setSkyColor

        public TextureBackgroundObject setSkyColor​(float[] newValue)
        Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.

        Tooltip: Color of the sky at various angles on the sky sphere. First value is color of sky at 0.0 radians representing the zenith (straight up).
        Specified by:
        setSkyColor in interface TextureBackground
        Specified by:
        setSkyColor in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the skyColor field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addSkyColor

        public TextureBackgroundObject addSkyColor​(SFColorObject newValue)
        Add singleton SFColorObject value to MFColor skyColor field.
        Parameters:
        newValue - is new value to add to the skyColor field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSkyColor

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

        public X3DNode getTopTexture()
        Provide X3DNode instance (using a properly typed node) with acceptable node types limited to X3DTexture2DNode|MultiTexture, from inputOutput SFNode field topTexture.
        Specified by:
        getTopTexture in interface TextureBackground
        Returns:
        value of topTexture field
        See Also:
        Tooltip: [X3DTexture2DNode | MultiTexture] Parent TextureBackground element can contain up to six image nodes (ImageTexture PixelTexture MovieTexture MultiTexture). Warning: each child image node must have a different containerField value.
      • clearTopTexture

        public TextureBackgroundObject clearTopTexture()
        Utility method to clear SFNode value of topTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setTopTexture

        public TextureBackgroundObject setTopTexture​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field topTexture.
        Parameters:
        newValue - is new value for the topTexture field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setTopTexture(X3DNode)
      • hasTopTexture

        public boolean hasTopTexture()
        Indicate whether an object is available for inputOutput SFNode field topTexture.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getTopTexture(), getTopTextureProtoInstance()
      • getTransparency

        public float getTransparency()
        Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.

        Tooltip: transparency applied to texture images, enabling an X3D scene to overlay an HTML page or desktop. *
        Specified by:
        getTransparency in interface TextureBackground
        Specified by:
        getTransparency in interface X3DBackgroundNode
        Returns:
        value of transparency field
      • setTransparency

        public TextureBackgroundObject setTransparency​(float newValue)
        Accessor method to assign float value to inputOutput SFFloat field named transparency.

        Tooltip: transparency applied to texture images, enabling an X3D scene to overlay an HTML page or desktop. *
        Specified by:
        setTransparency in interface TextureBackground
        Specified by:
        setTransparency in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the transparency field.
        Returns:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setTransparency

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

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

        public final TextureBackgroundObject 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:
        TextureBackgroundObject - 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 TextureBackgroundObject 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:
        TextureBackgroundObject - 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 TextureBackgroundObject 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:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        W3C Cascading Style Sheets
      • setUSE

        public TextureBackgroundObject setUSE​(TextureBackgroundObject 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:
        TextureBackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addComments

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

        public TextureBackgroundObject 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:
        TextureBackgroundObject - 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)