RigidBodyCollection (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode

All Known Implementing Classes:

RigidBodyCollectionObject
```
public interface RigidBodyCollection
extends X3DChildNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.2 or later) [X3DChildNode] RigidBodyCollection represents a system of bodies that interact within a single physics model. *

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addBodies(X3DNode[] newValue)` Add array of child bodies nodes to array of existing nodes (if any).
`void`	`addJoints(X3DNode[] newValue)` Add array of child joints nodes to array of existing nodes (if any).
`boolean`	`getAutoDisable()` Provide boolean value from inputOutput SFBool field named autoDisable.
`X3DNode[]`	`getBodies()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field bodies.
`CollisionCollection`	`getCollider()` Provide CollisionCollection instance (using a properly typed node) from initializeOnly SFNode field collider.
`float`	`getConstantForceMix()` Provide float value from inputOutput SFFloat field named constantForceMix.
`float`	`getContactSurfaceThickness()` Provide float value from inputOutput SFFloat field named contactSurfaceThickness.
`float`	`getDisableAngularSpeed()` Provide float value from inputOutput SFFloat field named disableAngularSpeed.
`float`	`getDisableLinearSpeed()` Provide float value from inputOutput SFFloat field named disableLinearSpeed.
`double`	`getDisableTime()` Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named disableTime.
`boolean`	`getEnabled()` Provide boolean value from inputOutput SFBool field named enabled.
`float`	`getErrorCorrection()` Provide float value from inputOutput SFFloat field named errorCorrection.
`float[]`	`getGravity()` Provide array of 3-tuple float results from inputOutput SFVec3f field named gravity.
`int`	`getIterations()` Provide int value from inputOutput SFInt32 field named iterations.
`X3DNode[]`	`getJoints()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field joints.
`float`	`getMaxCorrectionSpeed()` Provide float value from inputOutput SFFloat field named maxCorrectionSpeed.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`boolean`	`getPreferAccuracy()` Provide boolean value from inputOutput SFBool field named preferAccuracy.
`RigidBodyCollection`	`setAutoDisable(boolean newValue)` Assign boolean value to inputOutput SFBool field named autoDisable.
`void`	`setBodies(X3DNode newValue)` Set single child bodies node, replacing prior array of existing nodes (if any).
`RigidBodyCollection`	`setBodies(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field bodies.
`RigidBodyCollection`	`setCollider(CollisionCollection newValue)` Assign CollisionCollection instance (using a properly typed node) to initializeOnly SFNode field collider.
`RigidBodyCollection`	`setConstantForceMix(float newValue)` Assign float value to inputOutput SFFloat field named constantForceMix.
`RigidBodyCollection`	`setContactSurfaceThickness(float newValue)` Assign float value to inputOutput SFFloat field named contactSurfaceThickness.
`RigidBodyCollection`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`RigidBodyCollection`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`RigidBodyCollection`	`setDisableAngularSpeed(float newValue)` Assign float value to inputOutput SFFloat field named disableAngularSpeed.
`RigidBodyCollection`	`setDisableLinearSpeed(float newValue)` Assign float value to inputOutput SFFloat field named disableLinearSpeed.
`RigidBodyCollection`	`setDisableTime(double newValue)` Assign double value in seconds within allowed range of [0,infinity) to inputOutput SFTime field named disableTime.
`RigidBodyCollection`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`RigidBodyCollection`	`setErrorCorrection(float newValue)` Assign float value to inputOutput SFFloat field named errorCorrection.
`RigidBodyCollection`	`setGravity(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named gravity.
`RigidBodyCollection`	`setIterations(int newValue)` Assign int value to inputOutput SFInt32 field named iterations.
`void`	`setJoints(X3DNode newValue)` Set single child joints node, replacing prior array of existing nodes (if any).
`RigidBodyCollection`	`setJoints(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field joints.
`RigidBodyCollection`	`setMaxCorrectionSpeed(float newValue)` Assign float value to inputOutput SFFloat field named maxCorrectionSpeed.
`RigidBodyCollection`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`RigidBodyCollection`	`setPreferAccuracy(boolean newValue)` Assign boolean value to inputOutput SFBool field named preferAccuracy.
`RigidBodyCollection`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getAutoDisable
```
boolean getAutoDisable()
```
    Provide boolean value from inputOutput SFBool field named autoDisable.
    
    Tooltip: autoDisable toggles operation of disableAngularSpeed, disableLinearSpeed, disableTime. *
    
    Returns:
    
    value of autoDisable field
  - setAutoDisable
```
RigidBodyCollection setAutoDisable(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named autoDisable.
    
    Tooltip: autoDisable toggles operation of disableAngularSpeed, disableLinearSpeed, disableTime.
    
    Parameters:
    
    newValue - is new value for the autoDisable field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getBodies
```
X3DNode[] getBodies()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field bodies.
    
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to RigidBody.
    
    Returns:
    
    value of bodies field
    
    See Also:
    
    RigidBodyObject
  - setBodies
```
RigidBodyCollection setBodies(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field bodies.
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to RigidBody.
    
    Parameters:
    
    newValue - is new value for the bodies field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addBodies
```
void addBodies(X3DNode[] newValue)
```
    Add array of child bodies nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to RigidBody.
    
    Parameters:
    
    newValue - is new value array to be appended the bodies field.
  - setBodies
```
void setBodies(X3DNode newValue)
```
    Set single child bodies node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the bodies field
  - getCollider
```
CollisionCollection getCollider()
```
    Provide CollisionCollection instance (using a properly typed node) from initializeOnly SFNode field collider.
    
    Returns:
    
    value of collider field
  - setCollider
```
RigidBodyCollection setCollider(CollisionCollection newValue)
```
    Assign CollisionCollection instance (using a properly typed node) to initializeOnly SFNode field collider.
    
    Parameters:
    
    newValue - is new value for the collider field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getConstantForceMix
```
float getConstantForceMix()
```
    Provide float value from inputOutput SFFloat field named constantForceMix.
    
    Tooltip: [0,+infinity) constantForceMix modifies damping calculations by violating normal constraints while applying small, constant forces in those calculations.
    - Hint: this allows joints and bodies to be a fraction springy, and helps to eliminate numerical instability.
    - Hint: spring-driven or spongy connections can be emulated by combined use of errorCorrection and constantForceMix.
    Returns:
    
    value of constantForceMix field
  - setConstantForceMix
```
RigidBodyCollection setConstantForceMix(float newValue)
```
    Assign float value to inputOutput SFFloat field named constantForceMix.
    
    Tooltip: [0,+infinity) constantForceMix modifies damping calculations by violating normal constraints while applying small, constant forces in those calculations. Hint: this allows joints and bodies to be a fraction springy, and helps to eliminate numerical instability. Hint: spring-driven or spongy connections can be emulated by combined use of errorCorrection and constantForceMix.
    
    Parameters:
    
    newValue - is new value for the constantForceMix field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getContactSurfaceThickness
```
float getContactSurfaceThickness()
```
    Provide float value from inputOutput SFFloat field named contactSurfaceThickness.
    
    Tooltip: [0,+infinity) contactSurfaceThickness defines how far bodies may interpenetrate after a collision, allowing simulation of softer bodies that deform somewhat during collision. *
    
    Returns:
    
    value of contactSurfaceThickness field
  - setContactSurfaceThickness
```
RigidBodyCollection setContactSurfaceThickness(float newValue)
```
    Assign float value to inputOutput SFFloat field named contactSurfaceThickness.
    
    Tooltip: [0,+infinity) contactSurfaceThickness defines how far bodies may interpenetrate after a collision, allowing simulation of softer bodies that deform somewhat during collision.
    
    Parameters:
    
    newValue - is new value for the contactSurfaceThickness field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDisableAngularSpeed
```
float getDisableAngularSpeed()
```
    Provide float value from inputOutput SFFloat field named disableAngularSpeed.
    
    Tooltip: [0,+infinity) disableAngularSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculations, reducing numeric instabilities.
    - Hint: only activated if autoDisable='true'.
    Returns:
    
    value of disableAngularSpeed field
  - setDisableAngularSpeed
```
RigidBodyCollection setDisableAngularSpeed(float newValue)
```
    Assign float value to inputOutput SFFloat field named disableAngularSpeed.
    
    Tooltip: [0,+infinity) disableAngularSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculations, reducing numeric instabilities. Hint: only activated if autoDisable='true'.
    
    Parameters:
    
    newValue - is new value for the disableAngularSpeed field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDisableLinearSpeed
```
float getDisableLinearSpeed()
```
    Provide float value from inputOutput SFFloat field named disableLinearSpeed.
    
    Tooltip: [0,+infinity) disableLinearSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculation, reducing numeric instabilitiess.
    - Hint: only activated if autoDisable='true'.
    Returns:
    
    value of disableLinearSpeed field
  - setDisableLinearSpeed
```
RigidBodyCollection setDisableLinearSpeed(float newValue)
```
    Assign float value to inputOutput SFFloat field named disableLinearSpeed.
    
    Tooltip: [0,+infinity) disableLinearSpeed defines lower-limit tolerance value when body is considered at rest and not part of rigid body calculation, reducing numeric instabilitiess. Hint: only activated if autoDisable='true'.
    
    Parameters:
    
    newValue - is new value for the disableLinearSpeed field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDisableTime
```
double getDisableTime()
```
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named disableTime.
    
    Tooltip: [0,+infinity) disableTime defines interval when body becomes at rest and not part of rigid body calculations, reducing numeric instabilities.
    - Hint: only activated if autoDisable='true'
    - Hint: disableTime is an SFTime duration interval, not an absolute clock time.
    Returns:
    
    value of disableTime field
  - setDisableTime
```
RigidBodyCollection setDisableTime(double newValue)
```
    Assign double value in seconds within allowed range of [0,infinity) to inputOutput SFTime field named disableTime.
    
    Tooltip: [0,+infinity) disableTime defines interval when body becomes at rest and not part of rigid body calculations, reducing numeric instabilities. Hint: only activated if autoDisable='true' Hint: disableTime is an SFTime duration interval, not an absolute clock time.
    
    Parameters:
    
    newValue - is new value for the disableTime field.
    
    Returns:
    
    RigidBodyCollection - 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. *
    
    Returns:
    
    value of enabled field
  - setEnabled
```
RigidBodyCollection setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getErrorCorrection
```
float getErrorCorrection()
```
    Provide float value from inputOutput SFFloat field named errorCorrection.
    
    Tooltip: [0,1] errorCorrection describes how quickly intersection errors due to floating-point inaccuracies are resolved (0=no correction, 1=all corrected in single step). *
    
    Returns:
    
    value of errorCorrection field
  - setErrorCorrection
```
RigidBodyCollection setErrorCorrection(float newValue)
```
    Assign float value to inputOutput SFFloat field named errorCorrection.
    
    Tooltip: [0,1] errorCorrection describes how quickly intersection errors due to floating-point inaccuracies are resolved (0=no correction, 1=all corrected in single step).
    
    Parameters:
    
    newValue - is new value for the errorCorrection field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getGravity
```
float[] getGravity()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named gravity.
    
    Tooltip: gravity indicates direction and strength of local gravity vector for this collection of bodies (units m/sec^2). *
    
    Returns:
    
    value of gravity field
  - setGravity
```
RigidBodyCollection setGravity(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named gravity.
    
    Tooltip: gravity indicates direction and strength of local gravity vector for this collection of bodies (units m/sec^2).
    
    Parameters:
    
    newValue - is new value for the gravity field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIterations
```
int getIterations()
```
    Provide int value from inputOutput SFInt32 field named iterations.
    
    Tooltip: [0,+infinity) iterations controls number of iterations performed over collectioned joints and bodies during each evaluation. *
    
    Returns:
    
    value of iterations field
  - setIterations
```
RigidBodyCollection setIterations(int newValue)
```
    Assign int value to inputOutput SFInt32 field named iterations.
    
    Tooltip: [0,+infinity) iterations controls number of iterations performed over collectioned joints and bodies during each evaluation.
    
    Parameters:
    
    newValue - is new value for the iterations field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getJoints
```
X3DNode[] getJoints()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field joints.
    
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DRigidJointNode.
    
    Returns:
    
    value of joints field
    
    See Also:
    
    X3DRigidJointNode
  - setJoints
```
RigidBodyCollection setJoints(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field joints.
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DRigidJointNode.
    
    Parameters:
    
    newValue - is new value for the joints field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addJoints
```
void addJoints(X3DNode[] newValue)
```
    Add array of child joints nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DRigidJointNode.
    
    Parameters:
    
    newValue - is new value array to be appended the joints field.
  - setJoints
```
void setJoints(X3DNode newValue)
```
    Set single child joints node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the joints field
  - getMaxCorrectionSpeed
```
float getMaxCorrectionSpeed()
```
    Provide float value from inputOutput SFFloat field named maxCorrectionSpeed.
    
    Tooltip: [0,+infinity) or -1, maxCorrectionSpeed . *
    
    Returns:
    
    value of maxCorrectionSpeed field
  - setMaxCorrectionSpeed
```
RigidBodyCollection setMaxCorrectionSpeed(float newValue)
```
    Assign float value to inputOutput SFFloat field named maxCorrectionSpeed.
    
    Tooltip: [0,+infinity) or -1, maxCorrectionSpeed .
    
    Parameters:
    
    newValue - is new value for the maxCorrectionSpeed field.
    
    Returns:
    
    RigidBodyCollection - 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
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
RigidBodyCollection 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
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    RigidBodyCollection - 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
  - getPreferAccuracy
```
boolean getPreferAccuracy()
```
    Provide boolean value from inputOutput SFBool field named preferAccuracy.
    
    Tooltip: preferAccuracy provides hint for performance preference: higher accuracy or faster computational speed. *
    
    Returns:
    
    value of preferAccuracy field
  - setPreferAccuracy
```
RigidBodyCollection setPreferAccuracy(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named preferAccuracy.
    
    Tooltip: preferAccuracy provides hint for performance preference: higher accuracy or faster computational speed.
    
    Parameters:
    
    newValue - is new value for the preferAccuracy field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
RigidBodyCollection 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
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
RigidBodyCollection 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
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
RigidBodyCollection 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
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    RigidBodyCollection - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface RigidBodyCollection

Method Summary

Method Detail

getAutoDisable

setAutoDisable

getBodies

setBodies

addBodies

setBodies

getCollider

setCollider

getConstantForceMix

setConstantForceMix

getContactSurfaceThickness

setContactSurfaceThickness

getDisableAngularSpeed

setDisableAngularSpeed

getDisableLinearSpeed

setDisableLinearSpeed

getDisableTime

setDisableTime

getEnabled

setEnabled

getErrorCorrection

setErrorCorrection

getGravity

setGravity

getIterations

setIterations

getJoints

setJoints

addJoints

setJoints

getMaxCorrectionSpeed

setMaxCorrectionSpeed

getMetadata

setMetadata

getPreferAccuracy

setPreferAccuracy

setDEF

setUSE

setCssClass