CollisionSpace (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DBoundedObject, X3DNBodyCollisionSpaceNode, X3DNode

All Known Implementing Classes:

CollisionSpaceObject
```
public interface CollisionSpace
extends X3DNBodyCollisionSpaceNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.2 or later) [X3DNBodyCollisionSpaceNode] CollisionSpace holds collection of objects considered together for resolution of inter-object collisions. Contains multiple CollidableShape, CollidableOffset, or CollisionSpace nodes (containerField='collidables'). *

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: CollisionSpace, X3D Tooltips: CollisionSpace, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCollidables(X3DNode[] newValue)` Add array of child collidables nodes to array of existing nodes (if any).
`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.
`X3DNode[]`	`getCollidables()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DNBodyCollisionSpaceNode\|X3DNBodyCollidableNode, from inputOutput MFNode field collidables.
`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.
`boolean`	`getUseGeometry()` Provide boolean value from inputOutput SFBool field named useGeometry.
`CollisionSpace`	`setBboxCenter(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`CollisionSpace`	`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.
`void`	`setCollidables(X3DNode newValue)` Set single child collidables node, replacing prior array of existing nodes (if any).
`CollisionSpace`	`setCollidables(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DNBodyCollisionSpaceNode\|X3DNBodyCollidableNode, to inputOutput MFNode field collidables. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollisionSpaceNode) \|\| (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode); if (!
`CollisionSpace`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`CollisionSpace`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`CollisionSpace`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`CollisionSpace`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`CollisionSpace`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`CollisionSpace`	`setUseGeometry(boolean newValue)` Assign boolean value to inputOutput SFBool field named useGeometry.

- 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 X3DNBodyCollisionSpaceNode
    
    Returns:
    
    value of bboxCenter field
  - setBboxCenter
```
CollisionSpace 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 X3DNBodyCollisionSpaceNode
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    CollisionSpace - 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 X3DNBodyCollisionSpaceNode
    
    Returns:
    
    value of bboxSize field
  - setBboxSize
```
CollisionSpace 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 X3DNBodyCollisionSpaceNode
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    CollisionSpace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getCollidables
```
X3DNode[] getCollidables()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode, from inputOutput MFNode field collidables.
    
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.
    
    Returns:
    
    value of collidables field
    
    See Also:
    
    X3DNBodyCollisionSpaceNode, X3DNBodyCollidableNode
  - setCollidables
```
CollisionSpace setCollidables(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode, to inputOutput MFNode field collidables. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollisionSpaceNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode; newValue=" + newValue); }
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.
    
    Parameters:
    
    newValue - is new value for the collidables field.
    
    Returns:
    
    CollisionSpace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addCollidables
```
void addCollidables(X3DNode[] newValue)
```
    Add array of child collidables nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.
    
    Parameters:
    
    newValue - is new value array to be appended the collidables field.
  - setCollidables
```
void setCollidables(X3DNode newValue)
```
    Set single child collidables node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the collidables field
  - getEnabled
```
boolean getEnabled()
```
    Provide boolean value from inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation. *
    
    Specified by:
    
    getEnabled in interface X3DNBodyCollisionSpaceNode
    
    Returns:
    
    value of enabled field
  - setEnabled
```
CollisionSpace setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Specified by:
    
    setEnabled in interface X3DNBodyCollisionSpaceNode
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    CollisionSpace - 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 X3DNBodyCollisionSpaceNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
CollisionSpace setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNBodyCollisionSpaceNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    CollisionSpace - 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
  - getUseGeometry
```
boolean getUseGeometry()
```
    Provide boolean value from inputOutput SFBool field named useGeometry.
    
    Tooltip: useGeometry indicates whether collision-detection code checks down to level of geometry, or only make approximations using geometry bounds.
    - Hint: testing against object bounds is usually sufficient.
    - Warning: using geometry is more accurate but slower.
    Returns:
    
    value of useGeometry field
  - setUseGeometry
```
CollisionSpace setUseGeometry(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named useGeometry.
    
    Tooltip: useGeometry indicates whether collision-detection code checks down to level of geometry, or only make approximations using geometry bounds. Hint: testing against object bounds is usually sufficient. Warning: using geometry is more accurate but slower.
    
    Parameters:
    
    newValue - is new value for the useGeometry field.
    
    Returns:
    
    CollisionSpace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
CollisionSpace 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 X3DNBodyCollisionSpaceNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CollisionSpace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
CollisionSpace 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 X3DNBodyCollisionSpaceNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CollisionSpace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
CollisionSpace 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 X3DNBodyCollisionSpaceNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CollisionSpace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface CollisionSpace

Method Summary

Method Detail

getBboxCenter

setBboxCenter

getBboxSize

setBboxSize

getCollidables

setCollidables

addCollidables

setCollidables

getEnabled

setEnabled

getMetadata

setMetadata

getUseGeometry

setUseGeometry

setDEF

setUSE

setCssClass