official documentation

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

Class: CollidableShape

X3D: 3.3
Component: RigidBodyPhysics
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. CollidableShape

The CollidableShape node represents the glue between the collision detection system, the rigid body model, and the renderable scene graph. Its job is to take a single piece of geometry wrapped in a Shape node and provide a way for the physics model body to move the geometry. In addition, it allows the collision detection system to determine the location of the geometry primitives that it uses for collision management. When placed under a part of the transformation hierarchy, it can be used to visually represent the movement of the object.

HTML Encoding and Default Values⤴

<CollidableShape bboxCenter='0,0,0' bboxColor='1, 1, 0' bboxDisplay='false' bboxMargin='0.01' bboxSize='-1,-1,-1' enabled='true' metadata='X3DMetadataObject' render='true' rotation='0,0,1,0' shape='x3dom.nodeTypes.Shape' transform='x3dom.nodeTypes.Transform' translation='0,0,0' visible='true' ></CollidableShape>

Inheritance⤴


Constructor⤴

CollidableShape(ctx)⤴

Constructor for CollidableShape

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
bboxCenter SFVec3f 0,0,0 [-inf, inf] X3DBoundedObject Center of the bounding box
bboxColor SFColor 1, 1, 0 X3DBoundedObject Color of the bounding box
bboxDisplay SFVec3f false X3DBoundedObject Flag to enable display of the bounding box
bboxMargin SFFloat 0.01 [-inf, inf] X3DBoundedObject Size of additional margin around the bounding box scaled up by the diameter.
bboxSize SFVec3f -1,-1,-1 [0, inf] or -1 X3DBoundedObject Size of the bounding box
enabled SFBool true X3DNBodyCollidableNode The enabled field is used to specify whether a collidable object is eligible for collision detection interactions.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
render SFBool true X3DBoundedObject Flag to enable/disable rendering
rotation SFRotation 0,0,1,0 [0,1] X3DNBodyCollidableNode The rotation field defines rotation about the body's center that the collidable node occupies.
shape SFNode Shape The shape field uses the geometry proxy for specifying which geometry best represents the collidable object.
transform SFNode Transform Transformation child node.
translation SFVec3f 0,0,0 (-inf, inf) X3DNBodyCollidableNode The translation field defines an offset from the body's center that the collidable node occupies. This can be used to place the collidable geometry in a different location relative to the actual rigid body that has the physics model being applied.
visible SFBool true X3DBoundedObject Flag to enable/disable rendering, alias for render