Interface Shape

All Superinterfaces:
X3DBoundedObject, X3DChildNode, X3DNode, X3DShapeNode
All Known Implementing Classes:
ShapeObject

public interface Shape
extends X3DShapeNode
Shape can appear under any grouping node.

X3D node tooltip: [X3DShapeNode] Shape can appear under any grouping node. Shape can contain an Appearance node and a geometry node (for example one of the primitives Box Cone Cylinder Sphere Text, one of ElevationGrid Extrusion IndexedFaceSet IndexedLineSet LineSet PointSet, or one of the other geometry 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: Shape, X3D Tooltips: Shape, 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.
    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.
    Shape setAppearance​(X3DAppearanceNode newValue)
    Accessor method to assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.
    Shape setBboxCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    Shape setBboxSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    Shape setGeometry​(X3DGeometryNode newValue)
    Accessor method to assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
    Shape setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  • Method Details

    • getAppearance

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

      Tooltip: [X3DAppearanceNode] Single contained Appearance node that specifies visual attributes (such as material, texture, fillProperties and lineProperties) applied to corresponding geometry. *
      Specified by:
      getAppearance in interface X3DShapeNode
      Returns:
      value of appearance field
    • setAppearance

      Shape setAppearance​(X3DAppearanceNode newValue)
      Accessor method to assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.

      Tooltip: [X3DAppearanceNode] Single contained Appearance node that specifies visual attributes (such as material, texture, fillProperties and lineProperties) applied to corresponding geometry. *
      Specified by:
      setAppearance in interface X3DShapeNode
      Parameters:
      newValue - is new value for the appearance field.
      Returns:
      Shape - 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.

      Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Specified by:
      getBboxCenter in interface X3DShapeNode
      Returns:
      value of bboxCenter field
    • setBboxCenter

      Shape setBboxCenter​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

      Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Specified by:
      setBboxCenter in interface X3DShapeNode
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      Shape - 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.

      Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Specified by:
      getBboxSize in interface X3DShapeNode
      Returns:
      value of bboxSize field
    • setBboxSize

      Shape setBboxSize​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

      Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Specified by:
      setBboxSize in interface X3DShapeNode
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      Shape - 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.

      Tooltip: [X3DGeometryNode] Single contained geometry node that is rendered according to corresponding appearance. *
      Specified by:
      getGeometry in interface X3DShapeNode
      Returns:
      value of geometry field
    • setGeometry

      Shape setGeometry​(X3DGeometryNode newValue)
      Accessor method to assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.

      Tooltip: [X3DGeometryNode] Single contained geometry node that is rendered according to corresponding appearance. *
      Specified by:
      setGeometry in interface X3DShapeNode
      Parameters:
      newValue - is new value for the geometry field.
      Returns:
      Shape - 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
      Specified by:
      getMetadata in interface X3DShapeNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      Shape 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
      Specified by:
      setMetadata in interface X3DShapeNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      Shape - 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