Package org.web3d.x3d.sai.Shape

Interface X3DShapeNode

All Superinterfaces:
X3DBoundedObject, X3DChildNode, X3DNode
All Known Subinterfaces:
ParticleSystem, Shape
All Known Implementing Classes:
ParticleSystemObject, ShapeObject
public interface X3DShapeNode
extends X3DChildNode, X3DBoundedObject
Base type for all Shape nodes.


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

  • Method Summary

    Modifier and Type Method Description
    X3DAppearanceNode getAppearance()
    Provide X3DAppearanceNode instance (using a properly typed node) from inputOutput SFNode field appearance.
    float[] getBboxCenter()
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
    float[] getBboxSize()
    Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
    boolean getDisplayBBox()
    Provide boolean value from inputOutput SFBool field named displayBBox.
    X3DGeometryNode getGeometry()
    Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    boolean getVisible()
    Provide boolean value from inputOutput SFBool field named visible.
    X3DShapeNode setAppearance​(X3DAppearanceNode newValue)
    Accessor method to assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.
    X3DShapeNode setBboxCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    X3DShapeNode setBboxSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    X3DShapeNode setDisplayBBox​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named displayBBox.
    X3DShapeNode setGeometry​(X3DGeometryNode newValue)
    Accessor method to assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
    X3DShapeNode setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    X3DShapeNode setVisible​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named visible.

  • Method Details

    • getAppearance

      X3DAppearanceNode getAppearance()
      Provide X3DAppearanceNode instance (using a properly typed node) from inputOutput SFNode field appearance.
      Returns:
      value of appearance field

    • setAppearance

      X3DShapeNode setAppearance​(X3DAppearanceNode newValue)
      Accessor method to assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.
      Parameters:
      newValue - is new value for the appearance field.
      Returns:
      X3DShapeNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getBboxCenter

      float[] getBboxCenter()
      Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Returns:
      value of bboxCenter field

    • setBboxCenter

      X3DShapeNode setBboxCenter​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      X3DShapeNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getBboxSize

      float[] getBboxSize()
      Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Returns:
      value of bboxSize field

    • setBboxSize

      X3DShapeNode setBboxSize​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      X3DShapeNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDisplayBBox

      boolean getDisplayBBox()
      Provide boolean value from inputOutput SFBool field named displayBBox.
      Specified by:
      getDisplayBBox in interface X3DBoundedObject
      Returns:
      value of displayBBox field

    • setDisplayBBox

      X3DShapeNode setDisplayBBox​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named displayBBox.
      Specified by:
      setDisplayBBox in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the displayBBox field.
      Returns:
      X3DShapeNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getGeometry

      X3DGeometryNode getGeometry()
      Provide X3DGeometryNode instance (using a properly typed node) from inputOutput SFNode field geometry.
      Returns:
      value of geometry field

    • setGeometry

      X3DShapeNode setGeometry​(X3DGeometryNode newValue)
      Accessor method to assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
      Parameters:
      newValue - is new value for the geometry field.
      Returns:
      X3DShapeNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      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

      X3DShapeNode setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      X3DShapeNode - 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

    • getVisible

      boolean getVisible()
      Provide boolean value from inputOutput SFBool field named visible.
      Specified by:
      getVisible in interface X3DBoundedObject
      Returns:
      value of visible field

    • setVisible

      X3DShapeNode setVisible​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named visible.
      Specified by:
      setVisible in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the visible field.
      Returns:
      X3DShapeNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).