Class TextureBackground

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.EnvironmentalEffects.TextureBackground
All Implemented Interfaces:
X3DBindableNode, X3DChildNode, X3DNode, TextureBackground, X3DBackgroundNode

public class TextureBackground
extends X3DConcreteNode
implements TextureBackground
TextureBackground simulates ground and sky, using vertical arrays of wraparound color values, TextureBackground can also provide backdrop texture images on all six sides.

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 SFColor provides a variety of color constants.

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

    • 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 IS 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
    • containerField_DEFAULT_VALUE

      public static final java.lang.String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), 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 Details

    • TextureBackground

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

      public TextureBackground​(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 Details

    • 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
    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

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

      public X3DNode getBackTexture()
      Provide org.web3d.x3d.sai.Core.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.
    • setBackTexture

      public TextureBackground setBackTexture​(X3DNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field backTexture.
      Specified by:
      setBackTexture in interface TextureBackground
      Parameters:
      newValue - is new value for the backTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 TextureBackground clearBackTexture()
      Utility method to clear SFNode value of backTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setBackTexture

      public TextureBackground setBackTexture​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field backTexture.
      Parameters:
      newValue - is new value for the backTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setBackTexture(org.web3d.x3d.sai.Core.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 org.web3d.x3d.sai.Core.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.
    • setBottomTexture

      public TextureBackground setBottomTexture​(X3DNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field bottomTexture.
      Specified by:
      setBottomTexture in interface TextureBackground
      Parameters:
      newValue - is new value for the bottomTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 TextureBackground clearBottomTexture()
      Utility method to clear SFNode value of bottomTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setBottomTexture

      public TextureBackground setBottomTexture​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field bottomTexture.
      Parameters:
      newValue - is new value for the bottomTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setBottomTexture(org.web3d.x3d.sai.Core.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 org.web3d.x3d.sai.Core.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.
    • setFrontTexture

      public TextureBackground setFrontTexture​(X3DNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field frontTexture.
      Specified by:
      setFrontTexture in interface TextureBackground
      Parameters:
      newValue - is new value for the frontTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 TextureBackground clearFrontTexture()
      Utility method to clear SFNode value of frontTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setFrontTexture

      public TextureBackground setFrontTexture​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field frontTexture.
      Parameters:
      newValue - is new value for the frontTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setFrontTexture(org.web3d.x3d.sai.Core.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: radian units for angular measure 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
    • getGroundAngleString

      public java.lang.String getGroundAngleString()
      Utility method to get String value of MFFloat groundAngle field, similar to getGroundAngle().
      Returns:
      value of groundAngle field
    • setGroundAngle

      public TextureBackground 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: radian units for angular measure 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:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGroundAngle

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

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

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

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

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

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

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

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

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

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

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public TextureBackground setIS​(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public TextureBackground clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      TextureBackground - 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 org.web3d.x3d.sai.Core.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.
    • setLeftTexture

      public TextureBackground setLeftTexture​(X3DNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field leftTexture.
      Specified by:
      setLeftTexture in interface TextureBackground
      Parameters:
      newValue - is new value for the leftTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 TextureBackground clearLeftTexture()
      Utility method to clear SFNode value of leftTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setLeftTexture

      public TextureBackground setLeftTexture​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field leftTexture.
      Parameters:
      newValue - is new value for the leftTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setLeftTexture(org.web3d.x3d.sai.Core.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()
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface TextureBackground
      Specified by:
      getMetadata in interface X3DBackgroundNode
      Specified by:
      getMetadata in interface X3DBindableNode
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public TextureBackground setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface TextureBackground
      Specified by:
      setMetadata in interface X3DBackgroundNode
      Specified by:
      setMetadata in interface X3DBindableNode
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public TextureBackground setMetadata​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)
    • 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 org.web3d.x3d.sai.Core.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.
    • setRightTexture

      public TextureBackground setRightTexture​(X3DNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field rightTexture.
      Specified by:
      setRightTexture in interface TextureBackground
      Parameters:
      newValue - is new value for the rightTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 TextureBackground clearRightTexture()
      Utility method to clear SFNode value of rightTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setRightTexture

      public TextureBackground setRightTexture​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field rightTexture.
      Parameters:
      newValue - is new value for the rightTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setRightTexture(org.web3d.x3d.sai.Core.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: radian units for angular measure 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
    • getSkyAngleString

      public java.lang.String getSkyAngleString()
      Utility method to get String value of MFFloat skyAngle field, similar to getSkyAngle().
      Returns:
      value of skyAngle field
    • setSkyAngle

      public TextureBackground 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: radian units for angular measure 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:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSkyAngle

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

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

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

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

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

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

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

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

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

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

      public X3DNode getTopTexture()
      Provide org.web3d.x3d.sai.Core.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.
    • setTopTexture

      public TextureBackground setTopTexture​(X3DNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field topTexture.
      Specified by:
      setTopTexture in interface TextureBackground
      Parameters:
      newValue - is new value for the topTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      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 TextureBackground clearTopTexture()
      Utility method to clear SFNode value of topTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setTopTexture

      public TextureBackground setTopTexture​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field topTexture.
      Parameters:
      newValue - is new value for the topTexture field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setTopTexture(org.web3d.x3d.sai.Core.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 TextureBackground 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:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTransparency

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

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

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

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

      public TextureBackground setDEF​(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      TextureBackground - 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 TextureBackground 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:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public TextureBackground setUSE​(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      TextureBackground - 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 Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final TextureBackground 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 Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      TextureBackground - 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 TextureBackground setCssClass​(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      TextureBackground - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

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

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

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

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

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

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • 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)