Package org.web3d.x3d.sai.EnvironmentalEffects

Interface X3DBackgroundNode

All Superinterfaces:
X3DBindableNode, X3DChildNode, X3DNode
All Known Subinterfaces:
Background, TextureBackground
All Known Implementing Classes:
Background, TextureBackground
public interface X3DBackgroundNode
extends X3DBindableNode
Abstract type from which all backgrounds inherit, also defining a background binding stack.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification, X3D Tooltips, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    double getBindTime()
    Provide double value in seconds from outputOnly SFTime field named bindTime.
    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.
    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.
    boolean getIsBound()
    Provide boolean value from outputOnly SFBool field named isBound.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    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.
    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.
    float getTransparency()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named transparency.
    X3DBackgroundNode setGroundAngle​(float[] newValue)
    Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.
    X3DBackgroundNode setGroundColor​(float[] newValue)
    Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.
    X3DBackgroundNode setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    X3DBackgroundNode setSkyAngle​(float[] newValue)
    Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.
    X3DBackgroundNode setSkyColor​(float[] newValue)
    Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.
    X3DBackgroundNode setTransparency​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named transparency.

  • Method Details

    • getBindTime

      double getBindTime()
      Provide double value in seconds from outputOnly SFTime field named bindTime.
      Specified by:
      getBindTime in interface X3DBindableNode
      Returns:
      value of bindTime field

    • getGroundAngle

      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.
      Returns:
      value of groundAngle field

    • setGroundAngle

      X3DBackgroundNode setGroundAngle​(float[] newValue)
      Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named groundAngle.
      Parameters:
      newValue - is new value for the groundAngle field.
      Returns:
      X3DBackgroundNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getGroundColor

      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.
      Returns:
      value of groundColor field

    • setGroundColor

      X3DBackgroundNode setGroundColor​(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named groundColor.
      Parameters:
      newValue - is new value for the groundColor field.
      Returns:
      X3DBackgroundNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIsBound

      boolean getIsBound()
      Provide boolean value from outputOnly SFBool field named isBound.
      Specified by:
      getIsBound in interface X3DBindableNode
      Returns:
      value of isBound field

    • getMetadata

      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 X3DBindableNode
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      X3DBackgroundNode 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 X3DBindableNode
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      X3DBackgroundNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • getSkyAngle

      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.
      Returns:
      value of skyAngle field

    • setSkyAngle

      X3DBackgroundNode setSkyAngle​(float[] newValue)
      Accessor method to assign float array unit axis, angle (in radians) to inputOutput MFFloat field named skyAngle.
      Parameters:
      newValue - is new value for the skyAngle field.
      Returns:
      X3DBackgroundNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getSkyColor

      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.
      Returns:
      value of skyColor field

    • setSkyColor

      X3DBackgroundNode setSkyColor​(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput MFColor field named skyColor.
      Parameters:
      newValue - is new value for the skyColor field.
      Returns:
      X3DBackgroundNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTransparency

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

    • setTransparency

      X3DBackgroundNode setTransparency​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named transparency.
      Parameters:
      newValue - is new value for the transparency field.
      Returns:
      X3DBackgroundNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).