Shape (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DNode, X3DShapeNode

All Known Implementing Classes:

ShapeObject
```
public interface Shape
extends X3DShapeNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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).
- Hint: Shape
  https://en.wikipedia.org/wiki/Shape
- Hint: the Shape design pattern to collect appearance and geometry together is fundamentally the same for many types of 3D graphics software and hardware.
- Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance node (with correct containerField value) for contained node content.
- Hint: X3D Architecture 12.2.1 Shape nodes
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#Shapenodes
- Hint: X3D Architecture 17.2.2 Lighting model
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/lighting.html#Lightingmodel
- Hint: apply containerField='shape' if parent node is CADFace.
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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)` Assign X3DAppearanceNode instance (using a properly typed node) to inputOutput SFNode field appearance.
`Shape`	`setBboxCenter(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`Shape`	`setBboxSize(float[] newValue)` Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
`Shape`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`Shape`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`Shape`	`setGeometry(X3DGeometryNode newValue)` Assign X3DGeometryNode instance (using a properly typed node) to inputOutput SFNode field geometry.
`Shape`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`Shape`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    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.
    - Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
    - Hint: X3D Architecture, 10.2.2 Bounding boxes
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    Specified by:
    
    getBboxCenter in interface X3DBoundedObject
    
    Specified by:
    
    getBboxCenter in interface X3DShapeNode
    
    Returns:
    
    value of bboxCenter field
  - setBboxCenter
```
Shape setBboxCenter(float[] newValue)
```
    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. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    
    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.
    - Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
    - Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
    - Hint: X3D Architecture, 10.2.2 Bounding boxes
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    Specified by:
    
    getBboxSize in interface X3DBoundedObject
    
    Specified by:
    
    getBboxSize in interface X3DShapeNode
    
    Returns:
    
    value of bboxSize field
  - setBboxSize
```
Shape setBboxSize(float[] newValue)
```
    Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], 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. Hint: can be useful for collision computations or inverse-kinematics (IK) engines. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    
    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)
```
    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)
```
    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
  - setDEF
```
Shape setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DShapeNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
Shape setUSE(java.lang.String newValue)
```
    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 interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DShapeNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
Shape setCssClass(java.lang.String newValue)
```
    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 interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DShapeNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    Shape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface Shape

Method Summary

Method Detail

getAppearance

setAppearance

getBboxCenter

setBboxCenter

getBboxSize

setBboxSize

getGeometry

setGeometry

getMetadata

setMetadata

setDEF

setUSE

setCssClass