CollisionSpaceObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.RigidBodyPhysics.CollisionSpaceObject

All Implemented Interfaces:

X3DNode, X3DBoundedObject, CollisionSpace, X3DNBodyCollisionSpaceNode
```
public class CollisionSpaceObject
extends X3DConcreteNode
implements CollisionSpace
```
X3D node tooltip: (X3D version 3.2 or later) 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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

X3D Abstract Specification: CollisionSpace, X3D Tooltips: CollisionSpace, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static float[]`	`BBOXCENTER_DEFAULT_VALUE` SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
`static float[]`	`BBOXSIZE_DEFAULT_VALUE` SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the CollisionSpace element: RigidBodyPhysics
`static boolean`	`ENABLED_DEFAULT_VALUE` SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
`static java.lang.String`	`fromField_COLLIDABLES` fromField ROUTE name for MFNode field named collidables.
`static java.lang.String`	`fromField_ENABLED` fromField ROUTE name for SFBool field named enabled.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_USEGEOMETRY` fromField ROUTE name for SFBool field named useGeometry.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: CollisionSpace.
`static java.lang.String`	`toField_COLLIDABLES` toField ROUTE name for MFNode field named collidables.
`static java.lang.String`	`toField_ENABLED` toField ROUTE name for SFBool field named enabled.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_USEGEOMETRY` toField ROUTE name for SFBool field named useGeometry.
`static boolean`	`USEGEOMETRY_DEFAULT_VALUE` SFBool field named useGeometry has default value false (Java syntax) or false (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`CollisionSpaceObject()` Constructor for CollisionSpaceObject to initialize member variables with default values.
`CollisionSpaceObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CollisionSpaceObject`	`addCollidables(X3DNode newValue)` Add single child collidables node to array of existing nodes (if any).
`void`	`addCollidables(X3DNode[] newValue)` Add array of child collidables nodes to array of existing nodes (if any).
`CollisionSpaceObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`CollisionSpaceObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`CollisionSpaceObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`CollisionSpaceObject`	`clearCollidables()` Utility method to clear MFNode value of collidables field.
`CollisionSpaceObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`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 X3DPrototypeInstance objects) with acceptable node types limited to X3DNBodyCollisionSpaceNode\|X3DNBodyCollidableNode, from inputOutput MFNode field collidables.
`java.util.ArrayList<X3DNode>`	`getCollidablesList()` Utility method to get ArrayList value of MFNode collidables field, similar to `getCollidables()`.
`java.lang.String`	`getComponent()` Defines X3D component for the CollisionSpace element: RigidBodyPhysics
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getElementName()` Provides name of this element: CollisionSpace
`boolean`	`getEnabled()` Provide boolean value from inputOutput SFBool field named enabled.
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`ProtoInstanceObject`	`getMetadataProtoInstance()` Provide properly typed ProtoInstance for inputOutput SFNode field metadata, if available.
`boolean`	`getUseGeometry()` Provide boolean value from inputOutput SFBool field named useGeometry.
`boolean`	`hasCollidables()` Indicate whether an object is available for inputOutput MFNode field collidables.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()` Initialize all member variables to default values.
`CollisionSpaceObject`	`setBboxCenter(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`CollisionSpaceObject`	`setBboxCenter(float x, float y, float z)` Assign values to SFVec3f bboxCenter field, similar to `setBboxCenter(float[])`.
`CollisionSpaceObject`	`setBboxCenter(SFVec3fObject newValue)` Assign typed object value to SFVec3f bboxCenter field, similar to `setBboxCenter(float[])`.
`CollisionSpaceObject`	`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.
`CollisionSpaceObject`	`setBboxSize(float x, float y, float z)` Assign values to SFVec3f bboxSize field, similar to `setBboxSize(float[])`.
`CollisionSpaceObject`	`setBboxSize(SFVec3fObject newValue)` Assign typed object value to SFVec3f bboxSize field, similar to `setBboxSize(float[])`.
`CollisionSpaceObject`	`setCollidables(java.util.ArrayList<X3DNode> newValue)` Assign ArrayList value of MFNode collidables field, similar to `setCollidables(X3DNode[])`.
`void`	`setCollidables(X3DNode newValue)` Set single child collidables node, replacing prior array of existing nodes (if any).
`CollisionSpaceObject`	`setCollidables(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or X3DPrototypeInstance objects) with acceptable node types limited to X3DNBodyCollisionSpaceNode\|X3DNBodyCollidableNode, to inputOutput MFNode field collidables.
`CollisionSpaceObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`CollisionSpaceObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`CollisionSpaceObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`CollisionSpaceObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`CollisionSpaceObject`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`CollisionSpaceObject`	`setEnabled(SFBoolObject newValue)` Assign typed object value to SFBool enabled field, similar to `setEnabled(boolean)`.
`CollisionSpaceObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`CollisionSpaceObject`	`setMetadata(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to metadata field.
`CollisionSpaceObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`CollisionSpaceObject`	`setUSE(CollisionSpaceObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`CollisionSpaceObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`CollisionSpaceObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`CollisionSpaceObject`	`setUseGeometry(boolean newValue)` Assign boolean value to inputOutput SFBool field named useGeometry.
`CollisionSpaceObject`	`setUseGeometry(SFBoolObject newValue)` Assign typed object value to SFBool useGeometry field, similar to `setUseGeometry(boolean)`.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: CollisionSpace.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the CollisionSpace element: RigidBodyPhysics
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D RigidBodyPhysics component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - BBOXCENTER_DEFAULT_VALUE
```
public static final float[] BBOXCENTER_DEFAULT_VALUE
```
    SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
  - BBOXSIZE_DEFAULT_VALUE
```
public static final float[] BBOXSIZE_DEFAULT_VALUE
```
    SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
  - ENABLED_DEFAULT_VALUE
```
public static final boolean ENABLED_DEFAULT_VALUE
```
    SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - USEGEOMETRY_DEFAULT_VALUE
```
public static final boolean USEGEOMETRY_DEFAULT_VALUE
```
    SFBool field named useGeometry has default value false (Java syntax) or false (XML syntax).
    
    See Also:
    
    Constant Field Values
  - fromField_COLLIDABLES
```
public static final java.lang.String fromField_COLLIDABLES
```
    fromField ROUTE name for MFNode field named collidables.
    
    See Also:
    
    Constant Field Values
  - toField_COLLIDABLES
```
public static final java.lang.String toField_COLLIDABLES
```
    toField ROUTE name for MFNode field named collidables.
    
    See Also:
    
    Constant Field Values
  - fromField_ENABLED
```
public static final java.lang.String fromField_ENABLED
```
    fromField ROUTE name for SFBool field named enabled.
    
    See Also:
    
    Constant Field Values
  - toField_ENABLED
```
public static final java.lang.String toField_ENABLED
```
    toField ROUTE name for SFBool field named enabled.
    
    See Also:
    
    Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - fromField_USEGEOMETRY
```
public static final java.lang.String fromField_USEGEOMETRY
```
    fromField ROUTE name for SFBool field named useGeometry.
    
    See Also:
    
    Constant Field Values
  - toField_USEGEOMETRY
```
public static final java.lang.String toField_USEGEOMETRY
```
    toField ROUTE name for SFBool field named useGeometry.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CollisionSpaceObject
```
public CollisionSpaceObject()
```
    Constructor for CollisionSpaceObject to initialize member variables with default values.
  - CollisionSpaceObject
```
public CollisionSpaceObject(java.lang.String DEFlabel)
```
    Utility constructor that assigns DEF label after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: CollisionSpace
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the CollisionSpace element: RigidBodyPhysics
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 1
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - getBboxCenter
```
public 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.
    Specified by:
    
    getBboxCenter in interface X3DBoundedObject
    
    Specified by:
    
    getBboxCenter in interface CollisionSpace
    
    Specified by:
    
    getBboxCenter in interface X3DNBodyCollisionSpaceNode
    
    Returns:
    
    value of bboxCenter field
  - setBboxCenter
```
public CollisionSpaceObject 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.
    
    Specified by:
    
    setBboxCenter in interface X3DBoundedObject
    
    Specified by:
    
    setBboxCenter in interface CollisionSpace
    
    Specified by:
    
    setBboxCenter in interface X3DNBodyCollisionSpaceNode
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setBboxCenter
```
public CollisionSpaceObject setBboxCenter(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setBboxCenter
```
public CollisionSpaceObject setBboxCenter(float x,
                                          float y,
                                          float z)
```
    Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getBboxSize
```
public 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.
    Specified by:
    
    getBboxSize in interface X3DBoundedObject
    
    Specified by:
    
    getBboxSize in interface CollisionSpace
    
    Specified by:
    
    getBboxSize in interface X3DNBodyCollisionSpaceNode
    
    Returns:
    
    value of bboxSize field
  - setBboxSize
```
public CollisionSpaceObject 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.
    
    Specified by:
    
    setBboxSize in interface X3DBoundedObject
    
    Specified by:
    
    setBboxSize in interface CollisionSpace
    
    Specified by:
    
    setBboxSize in interface X3DNBodyCollisionSpaceNode
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setBboxSize
```
public CollisionSpaceObject setBboxSize(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setBboxSize
```
public CollisionSpaceObject setBboxSize(float x,
                                        float y,
                                        float z)
```
    Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getCollidables
```
public X3DNode[] getCollidables()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or X3DPrototypeInstance objects) 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.
    
    Specified by:
    
    getCollidables in interface CollisionSpace
    
    Returns:
    
    value of collidables field
    
    See Also:
    
    X3DNBodyCollisionSpaceNode, X3DNBodyCollidableNode
  - getCollidablesList
```
public java.util.ArrayList<X3DNode> getCollidablesList()
```
    Utility method to get ArrayList value of MFNode collidables field, similar to getCollidables().
    
    Returns:
    
    value of collidables field
  - setCollidables
```
public CollisionSpaceObject setCollidables(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or X3DPrototypeInstance objects) with acceptable node types limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode, to inputOutput MFNode field collidables.
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.
    
    Specified by:
    
    setCollidables in interface CollisionSpace
    
    Parameters:
    
    newValue - is new value for the collidables field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setCollidables
```
public CollisionSpaceObject setCollidables(java.util.ArrayList<X3DNode> newValue)
```
    Assign ArrayList value of MFNode collidables field, similar to setCollidables(X3DNode[]).
    
    Parameters:
    
    newValue - is new value for the collidables field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - addCollidables
```
public CollisionSpaceObject addCollidables(X3DNode newValue)
```
    Add single child collidables node 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 to be appended the collidables field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - addCollidables
```
public 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.
    
    Specified by:
    
    addCollidables in interface CollisionSpace
    
    Parameters:
    
    newValue - is new value array to be appended the collidables field.
  - setCollidables
```
public void setCollidables(X3DNode newValue)
```
    Set single child collidables node, replacing prior array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.
    
    Specified by:
    
    setCollidables in interface CollisionSpace
    
    Parameters:
    
    newValue - is new node for the collidables field (restricted to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode)
  - clearCollidables
```
public CollisionSpaceObject clearCollidables()
```
    Utility method to clear MFNode value of collidables field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - hasCollidables
```
public boolean hasCollidables()
```
    Indicate whether an object is available for inputOutput MFNode field collidables.
    
    Returns:
    
    whether a properly typed node or ProtoInstance array or CommentsBlock is available.
    
    See Also:
    
    getCollidables()
  - getEnabled
```
public boolean getEnabled()
```
    Provide boolean value from inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation. *
    
    Specified by:
    
    getEnabled in interface CollisionSpace
    
    Specified by:
    
    getEnabled in interface X3DNBodyCollisionSpaceNode
    
    Returns:
    
    value of enabled field
  - setEnabled
```
public CollisionSpaceObject setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Specified by:
    
    setEnabled in interface CollisionSpace
    
    Specified by:
    
    setEnabled in interface X3DNBodyCollisionSpaceNode
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setEnabled
```
public CollisionSpaceObject setEnabled(SFBoolObject newValue)
```
    Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface CollisionSpace
    
    Specified by:
    
    getMetadata in interface X3DNBodyCollisionSpaceNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public CollisionSpaceObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface CollisionSpace
    
    Specified by:
    
    setMetadata in interface X3DNBodyCollisionSpaceNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public CollisionSpaceObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public CollisionSpaceObject setMetadata(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to metadata field. Warning: ProtoInstance must match acceptable node type X3DMetadataObject.
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the metadata field
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setMetadata(X3DMetadataObject), X3D Scene Authoring Hints: Metadata Nodes
  - getMetadataProtoInstance
```
public ProtoInstanceObject getMetadataProtoInstance()
```
    Provide properly typed ProtoInstance for inputOutput SFNode field metadata, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getMetadata(), X3D Scene Authoring Hints: Metadata Nodes
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getUseGeometry
```
public 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.
    Specified by:
    
    getUseGeometry in interface CollisionSpace
    
    Returns:
    
    value of useGeometry field
  - setUseGeometry
```
public CollisionSpaceObject 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.
    
    Specified by:
    
    setUseGeometry in interface CollisionSpace
    
    Parameters:
    
    newValue - is new value for the useGeometry field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setUseGeometry
```
public CollisionSpaceObject setUseGeometry(SFBoolObject newValue)
```
    Assign typed object value to SFBool useGeometry field, similar to setUseGeometry(boolean).
    
    Parameters:
    
    newValue - is new value for the useGeometry field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setDEF
```
public final CollisionSpaceObject 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 X3DNode
    
    Specified by:
    
    setDEF in interface CollisionSpace
    
    Specified by:
    
    setDEF in interface X3DNBodyCollisionSpaceNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setDEF
```
public CollisionSpaceObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setUSE
```
public final CollisionSpaceObject 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 X3DNode
    
    Specified by:
    
    setUSE in interface CollisionSpace
    
    Specified by:
    
    setUSE in interface X3DNBodyCollisionSpaceNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setUSE
```
public CollisionSpaceObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setCssClass
```
public final CollisionSpaceObject 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 X3DNode
    
    Specified by:
    
    setCssClass in interface CollisionSpace
    
    Specified by:
    
    setCssClass in interface X3DNBodyCollisionSpaceNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public CollisionSpaceObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setIS
```
public CollisionSpaceObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public CollisionSpaceObject setUSE(CollisionSpaceObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    Warning: note that 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.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - addComments
```
public CollisionSpaceObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public CollisionSpaceObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public CollisionSpaceObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    CollisionSpaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class CollisionSpaceObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

BBOXCENTER_DEFAULT_VALUE

BBOXSIZE_DEFAULT_VALUE

ENABLED_DEFAULT_VALUE

USEGEOMETRY_DEFAULT_VALUE

fromField_COLLIDABLES

toField_COLLIDABLES

fromField_ENABLED

toField_ENABLED

fromField_METADATA

toField_METADATA

fromField_USEGEOMETRY

toField_USEGEOMETRY

Constructor Detail

CollisionSpaceObject

CollisionSpaceObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

initialize

getBboxCenter

setBboxCenter

setBboxCenter

setBboxCenter

getBboxSize

setBboxSize

setBboxSize

setBboxSize

getCollidables

getCollidablesList

setCollidables

setCollidables

addCollidables

addCollidables

setCollidables

clearCollidables

hasCollidables

getEnabled

setEnabled

setEnabled

getMetadata

setMetadata

clearMetadata

setMetadata

getMetadataProtoInstance

hasMetadata

getUseGeometry

setUseGeometry

setUseGeometry

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue