official documentation

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

Class: Collision

X3D: 3.3
Component: Navigation
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. Collision

Collision detects camera-to-object contact using current Viewpoint and NavigationInfo avatarSize. Collision is a Grouping node that handles collision detection for its children. Collision can contain a single proxy child node for substitute collision-detection geometry. Note: proxy geometry is not rendered. Note: PointSet, IndexedLineSet, LineSet and Text do not trigger collisions. Hint: improve performance using proxy for simpler contact-calculation geometry. Hint: NavigationInfo types ''WALK' 'FLY'' support camera-to-object collision detection. Hint: insert a Shape node before adding geometry or Appearance.

HTML Encoding and Default Values⤴

<Collision bboxCenter='0,0,0' bboxColor='1, 1, 0' bboxDisplay='false' bboxMargin='0.01' bboxSize='-1,-1,-1' children='X3DChildNode' collideTime='0' enabled='true' isActive='true' metadata='X3DMetadataObject' proxy='x3dom.nodeTypes.X3DGroupingNode' render='true' visible='true' ></Collision>

Inheritance⤴


Constructor⤴

Collision(ctx)⤴

Constructor for Collision

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
children MFNode X3DChildNode X3DGroupingNode Grouping nodes have a field that contains a list of children nodes. Each grouping node defines a coordinate space for its children. This coordinate space is relative to the coordinate space of the node of which the group node is a child. Such a node is called a parent node. This means that transformations accumulate down the scene graph hierarchy.
collideTime SFTime 0 NOT YET IMPLEMENTED. The time of collision.
enabled SFBool true Enables/disables collision detection for children and all descendants. Hint: former name quotecollidequote in VRML 97 specification.
isActive SFBool true NOT YET IMPLEMENTED. The value of the isActive field indicates the current state of the Collision node. An isActive TRUE event is generated when a collision occurs. An isActive FALSE event is generated when a collision no longer occurs.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
proxy SFNode X3DGroupingNode alternate object to be checked for collision, in place of the children of this node.
render SFBool true X3DBoundedObject Flag to enable/disable rendering
visible SFBool true X3DBoundedObject Flag to enable/disable rendering, alias for render