CollidableShape (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DNBodyCollidableNode, X3DNode

All Known Implementing Classes:

CollidableShapeObject
```
public interface CollidableShape
extends X3DNBodyCollidableNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.2 or later) [X3DNBodyCollidableNode] CollidableShape connects the collision detection system, the rigid body model, and the renderable scene graph. Contains a single Shape node (containerField='shape') for animating collidable geometry.
- Warning: avoid changing Shape geometry at run time to prevent performance problems.
- Warning: apply containerField='shape' to single Shape child node, not containerField='children' default.
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: CollidableShape, X3D Tooltips: CollidableShape, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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`	`getEnabled()` Provide boolean value from inputOutput SFBool field named enabled.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float[]`	`getRotation()` Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
`Shape`	`getShape()` Provide Shape instance (using a properly typed node) from initializeOnly SFNode field shape.
`float[]`	`getTranslation()` Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.
`CollidableShape`	`setBboxCenter(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`CollidableShape`	`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.
`CollidableShape`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`CollidableShape`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`CollidableShape`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`CollidableShape`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`CollidableShape`	`setRotation(float[] newValue)` Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
`CollidableShape`	`setShape(Shape newValue)` Assign Shape instance (using a properly typed node) to initializeOnly SFNode field shape.
`CollidableShape`	`setTranslation(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named translation.
`CollidableShape`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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 X3DNBodyCollidableNode
    
    Returns:
    
    value of bboxCenter field
  - setBboxCenter
```
CollidableShape 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 X3DNBodyCollidableNode
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    CollidableShape - 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 X3DNBodyCollidableNode
    
    Returns:
    
    value of bboxSize field
  - setBboxSize
```
CollidableShape 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 X3DNBodyCollidableNode
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    CollidableShape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getEnabled
```
boolean getEnabled()
```
    Provide boolean value from inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation. *
    
    Specified by:
    
    getEnabled in interface X3DNBodyCollidableNode
    
    Returns:
    
    value of enabled field
  - setEnabled
```
CollidableShape setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Specified by:
    
    setEnabled in interface X3DNBodyCollidableNode
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    CollidableShape - 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 X3DNBodyCollidableNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
CollidableShape 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 X3DNBodyCollidableNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    CollidableShape - 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
  - getRotation
```
float[] getRotation()
```
    Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
    
    Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system.
    - Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    Specified by:
    
    getRotation in interface X3DNBodyCollidableNode
    
    Returns:
    
    value of rotation field
  - setRotation
```
CollidableShape setRotation(float[] newValue)
```
    Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
    
    Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system. Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    
    Specified by:
    
    setRotation in interface X3DNBodyCollidableNode
    
    Parameters:
    
    newValue - is new value for the rotation field.
    
    Returns:
    
    CollidableShape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getShape
```
Shape getShape()
```
    Provide Shape instance (using a properly typed node) from initializeOnly SFNode field shape.
    
    Returns:
    
    value of shape field
  - setShape
```
CollidableShape setShape(Shape newValue)
```
    Assign Shape instance (using a properly typed node) to initializeOnly SFNode field shape.
    
    Parameters:
    
    newValue - is new value for the shape field.
    
    Returns:
    
    CollidableShape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTranslation
```
float[] getTranslation()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.
    
    Tooltip: Position (x, y, z in meters) of children relative to local coordinate system.
    - Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    Specified by:
    
    getTranslation in interface X3DNBodyCollidableNode
    
    Returns:
    
    value of translation field
  - setTranslation
```
CollidableShape setTranslation(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named translation.
    
    Tooltip: Position (x, y, z in meters) of children relative to local coordinate system. Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
    
    Specified by:
    
    setTranslation in interface X3DNBodyCollidableNode
    
    Parameters:
    
    newValue - is new value for the translation field.
    
    Returns:
    
    CollidableShape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
CollidableShape 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 X3DNBodyCollidableNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CollidableShape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
CollidableShape 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 X3DNBodyCollidableNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CollidableShape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
CollidableShape 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 X3DNBodyCollidableNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CollidableShape - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface CollidableShape

Method Summary

Method Detail

getBboxCenter

setBboxCenter

getBboxSize

setBboxSize

getEnabled

setEnabled

getMetadata

setMetadata

getRotation

setRotation

getShape

setShape

getTranslation

setTranslation

setDEF

setUSE

setCssClass