official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: CollisionCollection

X3D: 3.3
Component: RigidBodyPhysics
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. CollisionCollection

The CollisionCollection node holds a collection of objects in the collidables field that can be managed as a single entity for resolution of inter-object collisions with other groups of collidable objects. A group consists of both collidable objects as well as spaces that may be collided against each other. A set of parameters are provided that specify default values that will be assigned to all Contact nodes generated from the CollisionSensor node. A user may then override the individual Contact node by inserting a script between the output of the sensor and the input to the RigidBodyCollection node if it is desired to process the contact stream.

HTML Encoding and Default Values⤴

<CollisionCollection bounce='0' collidables='x3dom.nodeTypes.X3DNBodyCollidableNode' enabled='true' frictionCoefficients='0,0' metadata='X3DMetadataObject' minBounceSpeed='0.1' slipFactors='0,0' softnessConstantForceMix='0.0001' softnessErrorCorrection='0.8' surfaceSpeed='0,0' ></CollisionCollection>

Inheritance⤴


Constructor⤴

CollisionCollection(ctx)⤴

Constructor for CollisionCollection

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
bounce SFFloat 0 [0,1] The bounce field indicates how bouncy the surface contact is. A value of 0 indicates no bounce at all while a value of 1 indicates maximum bounce.
collidables MFNode X3DNBodyCollidableNode The collidables field can be managed as a single entity for resolution of inter-object collisions with other groups of collidable objects.
enabled SFBool true The enabled field is used to control whether the collision detection system for this collection should be run at the end of this frame. A value of TRUE enables it while a value of FALSE disables it. A CollisionSensor node watching this collection does not report any outputs for this collection for this frame if it is not enabled.
frictionCoefficients SFVec2f 0,0 [0, inf) Friction Coefficients
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
minBounceSpeed SFFloat 0.1 [0, inf) The minBounceSpeed field indicates the minimum speed, in speed base units, that an object shall have before an object will bounce. If the object is below this speed, it will not bounce, effectively having an equivalent value for the bounce field of zero.
slipFactors SFVec2f 0,0 (-inf, inf) Slip factors
softnessConstantForceMix SFFloat 0.0001 [0,1] The softnessConstantForceMix value applies a constant force value to make the colliding surfaces appear to be somewhat soft.
softnessErrorCorrection SFFloat 0.8 [0,1] The softnessErrorCorrection determines how much of the collision error should be fixed in a set of evaluations. The value is limited to the range of [0,1]. A value of 0 specifies no error correction while a value of 1 specifies that all errors should be corrected in a single step.
surfaceSpeed SFVec2f 0,0 (-inf, inf) The surfaceSpeed field defines the speed in the two friction directions in speed base units. This is used to indicate if the contact surface is moving independently of the motion of the bodies.