Class BackgroundObject

    • Field Detail

      • NAME

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

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

        public static final java.util.ArrayList<java.lang.String> BACKURL_DEFAULT_VALUE
        MFString field named backUrl has default value equal to an empty list.
      • BOTTOMURL_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> BOTTOMURL_DEFAULT_VALUE
        MFString field named bottomUrl has default value equal to an empty list.
      • FRONTURL_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> FRONTURL_DEFAULT_VALUE
        MFString field named frontUrl has default value equal to an empty list.
      • 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).
      • LEFTURL_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> LEFTURL_DEFAULT_VALUE
        MFString field named leftUrl has default value equal to an empty list.
      • METADATA_DEFAULT_VALUE

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

        public static final java.util.ArrayList<java.lang.String> RIGHTURL_DEFAULT_VALUE
        MFString field named rightUrl has default value equal to an empty list.
      • 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).
      • TOPURL_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> TOPURL_DEFAULT_VALUE
        MFString field named topUrl has default value equal to an empty list.
      • 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_BACKURL

        public static final java.lang.String fromField_BACKURL
        fromField ROUTE name for MFString field named backUrl.
        See Also:
        Constant Field Values
      • toField_BACKURL

        public static final java.lang.String toField_BACKURL
        toField ROUTE name for MFString field named backUrl.
        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_BOTTOMURL

        public static final java.lang.String fromField_BOTTOMURL
        fromField ROUTE name for MFString field named bottomUrl.
        See Also:
        Constant Field Values
      • toField_BOTTOMURL

        public static final java.lang.String toField_BOTTOMURL
        toField ROUTE name for MFString field named bottomUrl.
        See Also:
        Constant Field Values
      • fromField_FRONTURL

        public static final java.lang.String fromField_FRONTURL
        fromField ROUTE name for MFString field named frontUrl.
        See Also:
        Constant Field Values
      • toField_FRONTURL

        public static final java.lang.String toField_FRONTURL
        toField ROUTE name for MFString field named frontUrl.
        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_LEFTURL

        public static final java.lang.String fromField_LEFTURL
        fromField ROUTE name for MFString field named leftUrl.
        See Also:
        Constant Field Values
      • toField_LEFTURL

        public static final java.lang.String toField_LEFTURL
        toField ROUTE name for MFString field named leftUrl.
        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_RIGHTURL

        public static final java.lang.String fromField_RIGHTURL
        fromField ROUTE name for MFString field named rightUrl.
        See Also:
        Constant Field Values
      • toField_RIGHTURL

        public static final java.lang.String toField_RIGHTURL
        toField ROUTE name for MFString field named rightUrl.
        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_TOPURL

        public static final java.lang.String fromField_TOPURL
        fromField ROUTE name for MFString field named topUrl.
        See Also:
        Constant Field Values
      • toField_TOPURL

        public static final java.lang.String toField_TOPURL
        toField ROUTE name for MFString field named topUrl.
        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

      • BackgroundObject

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

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

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

        public java.lang.String[] getBackUrl()
        Provide array of String results from inputOutput MFString field named backUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        getBackUrl in interface Background
        Returns:
        value of backUrl field
      • getBackUrlList

        public java.util.ArrayList<java.lang.String> getBackUrlList()
        Utility method to get ArrayList value of MFString backUrl field, similar to getBackUrl().
        Returns:
        value of backUrl field
      • setBackUrl

        public BackgroundObject setBackUrl​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named backUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        setBackUrl in interface Background
        Parameters:
        newValue - is new value for the backUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBackUrl

        public BackgroundObject setBackUrl​(MFStringObject newValue)
        Assign typed object value to MFString backUrl field, similar to setBackUrl(String[]).
        Parameters:
        newValue - is new value for the backUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBackUrl

        public BackgroundObject setBackUrl​(SFStringObject newValue)
        Assign single SFString object value to MFString backUrl field, similar to setBackUrl(String[]).
        Parameters:
        newValue - is new value for the backUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBackUrl

        public BackgroundObject setBackUrl​(java.lang.String newValue)
        Assign singleton String value to MFString backUrl field, similar to setBackUrl(String[]).
        Parameters:
        newValue - is new value for the backUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBackUrl

        public BackgroundObject setBackUrl​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString backUrl field, similar to setBackUrl(String[]).
        Parameters:
        newValue - is new value for the backUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearBackUrl

        public BackgroundObject clearBackUrl()
        Utility method to clear MFString value of backUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addBackUrl

        public BackgroundObject addBackUrl​(java.lang.String newValue)
        Add singleton String value to MFString backUrl field.
        Parameters:
        newValue - is new value to add to the backUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        MFStringObject.cleanupEnumerationValues(String)
      • 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 Background
        Specified by:
        getBindTime in interface X3DBackgroundNode
        Specified by:
        getBindTime in interface X3DBindableNode
        Returns:
        value of bindTime field
      • getBottomUrl

        public java.lang.String[] getBottomUrl()
        Provide array of String results from inputOutput MFString field named bottomUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        getBottomUrl in interface Background
        Returns:
        value of bottomUrl field
      • getBottomUrlList

        public java.util.ArrayList<java.lang.String> getBottomUrlList()
        Utility method to get ArrayList value of MFString bottomUrl field, similar to getBottomUrl().
        Returns:
        value of bottomUrl field
      • setBottomUrl

        public BackgroundObject setBottomUrl​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named bottomUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        setBottomUrl in interface Background
        Parameters:
        newValue - is new value for the bottomUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBottomUrl

        public BackgroundObject setBottomUrl​(MFStringObject newValue)
        Assign typed object value to MFString bottomUrl field, similar to setBottomUrl(String[]).
        Parameters:
        newValue - is new value for the bottomUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBottomUrl

        public BackgroundObject setBottomUrl​(SFStringObject newValue)
        Assign single SFString object value to MFString bottomUrl field, similar to setBottomUrl(String[]).
        Parameters:
        newValue - is new value for the bottomUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBottomUrl

        public BackgroundObject setBottomUrl​(java.lang.String newValue)
        Assign singleton String value to MFString bottomUrl field, similar to setBottomUrl(String[]).
        Parameters:
        newValue - is new value for the bottomUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBottomUrl

        public BackgroundObject setBottomUrl​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString bottomUrl field, similar to setBottomUrl(String[]).
        Parameters:
        newValue - is new value for the bottomUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearBottomUrl

        public BackgroundObject clearBottomUrl()
        Utility method to clear MFString value of bottomUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addBottomUrl

        public BackgroundObject addBottomUrl​(java.lang.String newValue)
        Add singleton String value to MFString bottomUrl field.
        Parameters:
        newValue - is new value to add to the bottomUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        MFStringObject.cleanupEnumerationValues(String)
      • getFrontUrl

        public java.lang.String[] getFrontUrl()
        Provide array of String results from inputOutput MFString field named frontUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        getFrontUrl in interface Background
        Returns:
        value of frontUrl field
      • getFrontUrlList

        public java.util.ArrayList<java.lang.String> getFrontUrlList()
        Utility method to get ArrayList value of MFString frontUrl field, similar to getFrontUrl().
        Returns:
        value of frontUrl field
      • setFrontUrl

        public BackgroundObject setFrontUrl​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named frontUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        setFrontUrl in interface Background
        Parameters:
        newValue - is new value for the frontUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFrontUrl

        public BackgroundObject setFrontUrl​(MFStringObject newValue)
        Assign typed object value to MFString frontUrl field, similar to setFrontUrl(String[]).
        Parameters:
        newValue - is new value for the frontUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFrontUrl

        public BackgroundObject setFrontUrl​(SFStringObject newValue)
        Assign single SFString object value to MFString frontUrl field, similar to setFrontUrl(String[]).
        Parameters:
        newValue - is new value for the frontUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFrontUrl

        public BackgroundObject setFrontUrl​(java.lang.String newValue)
        Assign singleton String value to MFString frontUrl field, similar to setFrontUrl(String[]).
        Parameters:
        newValue - is new value for the frontUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFrontUrl

        public BackgroundObject setFrontUrl​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString frontUrl field, similar to setFrontUrl(String[]).
        Parameters:
        newValue - is new value for the frontUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearFrontUrl

        public BackgroundObject clearFrontUrl()
        Utility method to clear MFString value of frontUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addFrontUrl

        public BackgroundObject addFrontUrl​(java.lang.String newValue)
        Add singleton String value to MFString frontUrl field.
        Parameters:
        newValue - is new value to add to the frontUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        MFStringObject.cleanupEnumerationValues(String)
      • 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 Background
        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 BackgroundObject 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 Background
        Specified by:
        setGroundAngle in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the groundAngle field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGroundAngle

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

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

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

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

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

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

        public BackgroundObject 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:
        BackgroundObject - 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 Background
        Specified by:
        getGroundColor in interface X3DBackgroundNode
        Returns:
        value of groundColor field
      • setGroundColor

        public BackgroundObject 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 Background
        Specified by:
        setGroundColor in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the groundColor field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGroundColor

        public BackgroundObject setGroundColor​(MFColorObject newValue)
        Assign typed object value to MFColor groundColor field, similar to setGroundColor(float[]).
        Parameters:
        newValue - is new value for the groundColor field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addGroundColor

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

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

        public BackgroundObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        BackgroundObject - 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 Background
        Specified by:
        getIsBound in interface X3DBackgroundNode
        Specified by:
        getIsBound in interface X3DBindableNode
        Returns:
        value of isBound field
      • getLeftUrl

        public java.lang.String[] getLeftUrl()
        Provide array of String results from inputOutput MFString field named leftUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        getLeftUrl in interface Background
        Returns:
        value of leftUrl field
      • getLeftUrlList

        public java.util.ArrayList<java.lang.String> getLeftUrlList()
        Utility method to get ArrayList value of MFString leftUrl field, similar to getLeftUrl().
        Returns:
        value of leftUrl field
      • setLeftUrl

        public BackgroundObject setLeftUrl​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named leftUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        setLeftUrl in interface Background
        Parameters:
        newValue - is new value for the leftUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLeftUrl

        public BackgroundObject setLeftUrl​(MFStringObject newValue)
        Assign typed object value to MFString leftUrl field, similar to setLeftUrl(String[]).
        Parameters:
        newValue - is new value for the leftUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLeftUrl

        public BackgroundObject setLeftUrl​(SFStringObject newValue)
        Assign single SFString object value to MFString leftUrl field, similar to setLeftUrl(String[]).
        Parameters:
        newValue - is new value for the leftUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLeftUrl

        public BackgroundObject setLeftUrl​(java.lang.String newValue)
        Assign singleton String value to MFString leftUrl field, similar to setLeftUrl(String[]).
        Parameters:
        newValue - is new value for the leftUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLeftUrl

        public BackgroundObject setLeftUrl​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString leftUrl field, similar to setLeftUrl(String[]).
        Parameters:
        newValue - is new value for the leftUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearLeftUrl

        public BackgroundObject clearLeftUrl()
        Utility method to clear MFString value of leftUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addLeftUrl

        public BackgroundObject addLeftUrl​(java.lang.String newValue)
        Add singleton String value to MFString leftUrl field.
        Parameters:
        newValue - is new value to add to the leftUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        MFStringObject.cleanupEnumerationValues(String)
      • clearMetadata

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

        public java.lang.String[] getRightUrl()
        Provide array of String results from inputOutput MFString field named rightUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        getRightUrl in interface Background
        Returns:
        value of rightUrl field
      • getRightUrlList

        public java.util.ArrayList<java.lang.String> getRightUrlList()
        Utility method to get ArrayList value of MFString rightUrl field, similar to getRightUrl().
        Returns:
        value of rightUrl field
      • setRightUrl

        public BackgroundObject setRightUrl​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named rightUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        setRightUrl in interface Background
        Parameters:
        newValue - is new value for the rightUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setRightUrl

        public BackgroundObject setRightUrl​(MFStringObject newValue)
        Assign typed object value to MFString rightUrl field, similar to setRightUrl(String[]).
        Parameters:
        newValue - is new value for the rightUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setRightUrl

        public BackgroundObject setRightUrl​(SFStringObject newValue)
        Assign single SFString object value to MFString rightUrl field, similar to setRightUrl(String[]).
        Parameters:
        newValue - is new value for the rightUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setRightUrl

        public BackgroundObject setRightUrl​(java.lang.String newValue)
        Assign singleton String value to MFString rightUrl field, similar to setRightUrl(String[]).
        Parameters:
        newValue - is new value for the rightUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setRightUrl

        public BackgroundObject setRightUrl​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString rightUrl field, similar to setRightUrl(String[]).
        Parameters:
        newValue - is new value for the rightUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearRightUrl

        public BackgroundObject clearRightUrl()
        Utility method to clear MFString value of rightUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addRightUrl

        public BackgroundObject addRightUrl​(java.lang.String newValue)
        Add singleton String value to MFString rightUrl field.
        Parameters:
        newValue - is new value to add to the rightUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        MFStringObject.cleanupEnumerationValues(String)
      • 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 Background
        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 BackgroundObject 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 Background
        Specified by:
        setSkyAngle in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the skyAngle field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSkyAngle

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

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

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

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

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

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

        public BackgroundObject 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:
        BackgroundObject - 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 Background
        Specified by:
        getSkyColor in interface X3DBackgroundNode
        Returns:
        value of skyColor field
      • setSkyColor

        public BackgroundObject 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 Background
        Specified by:
        setSkyColor in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the skyColor field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setSkyColor

        public BackgroundObject setSkyColor​(MFColorObject newValue)
        Assign typed object value to MFColor skyColor field, similar to setSkyColor(float[]).
        Parameters:
        newValue - is new value for the skyColor field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addSkyColor

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

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

        public java.lang.String[] getTopUrl()
        Provide array of String results from inputOutput MFString field named topUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        getTopUrl in interface Background
        Returns:
        value of topUrl field
      • getTopUrlList

        public java.util.ArrayList<java.lang.String> getTopUrlList()
        Utility method to get ArrayList value of MFString topUrl field, similar to getTopUrl().
        Returns:
        value of topUrl field
      • setTopUrl

        public BackgroundObject setTopUrl​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named topUrl.

        Tooltip: Image background panorama between ground/sky backdrop and scene's geometry.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character. Interchange profile hint: this field may be ignored, applying the default value regardless.
        Specified by:
        setTopUrl in interface Background
        Parameters:
        newValue - is new value for the topUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setTopUrl

        public BackgroundObject setTopUrl​(MFStringObject newValue)
        Assign typed object value to MFString topUrl field, similar to setTopUrl(String[]).
        Parameters:
        newValue - is new value for the topUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setTopUrl

        public BackgroundObject setTopUrl​(SFStringObject newValue)
        Assign single SFString object value to MFString topUrl field, similar to setTopUrl(String[]).
        Parameters:
        newValue - is new value for the topUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setTopUrl

        public BackgroundObject setTopUrl​(java.lang.String newValue)
        Assign singleton String value to MFString topUrl field, similar to setTopUrl(String[]).
        Parameters:
        newValue - is new value for the topUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setTopUrl

        public BackgroundObject setTopUrl​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString topUrl field, similar to setTopUrl(String[]).
        Parameters:
        newValue - is new value for the topUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearTopUrl

        public BackgroundObject clearTopUrl()
        Utility method to clear MFString value of topUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addTopUrl

        public BackgroundObject addTopUrl​(java.lang.String newValue)
        Add singleton String value to MFString topUrl field.
        Parameters:
        newValue - is new value to add to the topUrl field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        MFStringObject.cleanupEnumerationValues(String)
      • getTransparency

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

        Tooltip: [0,1] how "clear" the background is, allows underlying page to show through: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency &lt; .5 opaque, transparency &gt; .5 transparent. *
        Specified by:
        getTransparency in interface Background
        Specified by:
        getTransparency in interface X3DBackgroundNode
        Returns:
        value of transparency field
      • setTransparency

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

        Tooltip: [0,1] how "clear" the background is, allows underlying page to show through: 1.0 is completely transparent, 0.0 is completely opaque. Interchange profile hint: transparency &lt; .5 opaque, transparency &gt; .5 transparent. *
        Specified by:
        setTransparency in interface Background
        Specified by:
        setTransparency in interface X3DBackgroundNode
        Parameters:
        newValue - is new value for the transparency field.
        Returns:
        BackgroundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setTransparency

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

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

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

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

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

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

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

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

        public BackgroundObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        BackgroundObject - 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)