All Superinterfaces:: X3DBoundedObject, X3DChildNode, X3DGroupingNode, X3DNode, X3DSensorNode

All Known Implementing Classes:: Collision

public interface Collision extends X3DGroupingNode, X3DSensorNode

Collision detects camera-to-object contact using current view and NavigationInfo avatarSize.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. Collision node tooltip: [X3DGroupingNode,X3DSensorNode] Collision detects camera-to-object contact using current view and NavigationInfo avatarSize. Collision is a Grouping node that reports collision detection for its children.

Hint: Collision can contain a single proxy child node for substitute collision-detection geometry. Improve run-time performance by using proxy with simpler contact-calculation geometry.
Hint: proxy shapes are not rendered and remain invisible.
Hint: apply containerField='proxy' to uniquely identify the proxy child Shape or grouping node.
Warning: PointSet, IndexedLineSet, LineSet and Text are not collidable geometry do not trigger collisions.
Hint: NavigationInfo types '"WALK" "FLY"' support camera-to-object collision detection.
Hint: content must be visible to be collidable and to be pickable.
Hint: insert a Shape node before adding geometry or Appearance.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

Method Summary

Modifier and Type

Method

Description

void

addChildren(X3DNode[] newValue)

Add array of children nodes to array of existing nodes (if any).

float[]

getBboxCenter()

Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

boolean

getBboxDisplay()

Provide boolean value from inputOutput SFBool field named bboxDisplay.

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[]

getChildren()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.

double

getCollideTime()

Provide double value in seconds from outputOnly SFTime field named collideTime.

String

getDescription()

Provide String value from inputOutput SFString field named description.

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

boolean

getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

X3DChildNode

getProxy()

Provide org.web3d.x3d.sai.Core.X3DChildNode instance (using a properly typed node) from initializeOnly SFNode field proxy.

boolean

getVisible()

Provide boolean value from inputOutput SFBool field named visible.

Collision

setBboxCenter(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Collision

setBboxDisplay(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.

Collision

setBboxSize(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

void

setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

Collision

setChildren(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

Collision

setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

Collision

setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

Collision

setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Collision

setProxy(X3DChildNode newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode instance (using a properly typed node) to initializeOnly SFNode field proxy.

Collision

setVisible(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named visible.

Method Details
- getBboxCenter
  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.
  
  Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  getBboxCenter in interface X3DBoundedObject
  
  Specified by:
  
  getBboxCenter in interface X3DGroupingNode
  
  Returns:
  
  value of bboxCenter field
- setBboxCenter
  Collision setBboxCenter(float[] newValue)
  
  Accessor method to 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.
  
  Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  setBboxCenter in interface X3DBoundedObject
  
  Specified by:
  
  setBboxCenter in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the bboxCenter field.
  
  Returns:
  
  Collision - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBboxDisplay
  boolean getBboxDisplay()
  
  Provide boolean value from inputOutput SFBool field named bboxDisplay.
  
  Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
  
  Hint: the bounding box is displayed regardless of whether contained content is visible.
  
  Specified by:
  
  getBboxDisplay in interface X3DBoundedObject
  
  Specified by:
  
  getBboxDisplay in interface X3DGroupingNode
  
  Returns:
  
  value of bboxDisplay field
- setBboxDisplay
  Collision setBboxDisplay(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
  
  Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
  
  Hint: the bounding box is displayed regardless of whether contained content is visible.
  
  Specified by:
  
  setBboxDisplay in interface X3DBoundedObject
  
  Specified by:
  
  setBboxDisplay in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the bboxDisplay field.
  
  Returns:
  
  Collision - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBboxSize
  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: or [0,+infinity) 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.
  
  Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  getBboxSize in interface X3DBoundedObject
  
  Specified by:
  
  getBboxSize in interface X3DGroupingNode
  
  Returns:
  
  value of bboxSize field
- setBboxSize
  Collision setBboxSize(float[] newValue)
  
  Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
  
  Tooltip: or [0,+infinity) 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.
  
  Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  setBboxSize in interface X3DBoundedObject
  
  Specified by:
  
  setBboxSize in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the bboxSize field.
  
  Returns:
  
  Collision - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getChildren
  X3DNode[] getChildren()
  
  Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.
  
  Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
  
  Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
  
  Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
  
  Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
  
  Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#GroupingAndChildrenNodes
  
  Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
  
  Specified by:
  
  getChildren in interface X3DGroupingNode
  
  Returns:
  
  value of children field
  
  See Also:
  
  X3DChildNode
- setChildren
  Collision setChildren(X3DNode[] newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
  
  Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
  
  Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
  
  Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
  
  Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
  
  Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#GroupingAndChildrenNodes
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
  
  Specified by:
  
  setChildren in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the children field.
  
  Returns:
  
  Collision - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addChildren
  
  void addChildren(X3DNode[] newValue)
  
  Add array of children nodes to array of existing nodes (if any).
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
  
  Specified by:
  
  addChildren in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value array to be appended the children field.
- setChildren
  
  void setChildren(X3DNode newValue)
  
  Set single children node, replacing prior array of existing nodes (if any).
  
  Specified by:
  
  setChildren in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new node for the children field
- getCollideTime
  double getCollideTime()
  
  Provide double value in seconds from outputOnly SFTime field named collideTime.
  
  Tooltip: Time of collision between camera (avatar) and geometry.
  
  Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
  
  Returns:
  
  value of collideTime field
- getDescription
  String getDescription()
  
  Provide String value from inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose of the node.
  
  Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
  
  Specified by:
  
  getDescription in interface X3DSensorNode
  
  Returns:
  
  value of description field
- setDescription
  Collision setDescription(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose of the node.
  
  Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
  
  Specified by:
  
  setDescription in interface X3DSensorNode
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  Collision - 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 collision detection for children and all descendants.
  
  Hint: former name "collide" in VRML97 specification.
  
  Specified by:
  
  getEnabled in interface X3DSensorNode
  
  Returns:
  
  value of enabled field
- setEnabled
  Collision setEnabled(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables collision detection for children and all descendants.
  
  Hint: former name "collide" in VRML97 specification.
  
  Specified by:
  
  setEnabled in interface X3DSensorNode
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  Collision - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getIsActive
  boolean getIsActive()
  
  Provide boolean value from outputOnly SFBool field named isActive.
  
  Tooltip: isActive true/false events are sent when triggering the sensor. isActive=true when view-object collision occurs, isActive=false when view-object collision no longer occurs.
  
  Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
  
  Specified by:
  
  getIsActive in interface X3DSensorNode
  
  Returns:
  
  value of isActive field
- getMetadata
  X3DMetadataObject getMetadata()
  
  Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DGroupingNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Specified by:
  
  getMetadata in interface X3DSensorNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  Collision setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DGroupingNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DSensorNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  Collision - 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
- getProxy
  X3DChildNode getProxy()
  
  Provide org.web3d.x3d.sai.Core.X3DChildNode instance (using a properly typed node) from initializeOnly SFNode field proxy.
  
  Tooltip: [X3DChildNode] The proxy node is used as a substitute for Collision children during collision detection, simplifying collision-intersection computations.
  
  Hint: The proxy node is used strictly for collision detection and is not drawn.
  
  Warning: the proxy node must have containerField='proxy' or it is simply treated like other children nodes.
  
  Warning: insert a Shape node before adding geometry or Appearance.
  
  Returns:
  
  value of proxy field
- setProxy
  Collision setProxy(X3DChildNode newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode instance (using a properly typed node) to initializeOnly SFNode field proxy.
  
  Tooltip: [X3DChildNode] The proxy node is used as a substitute for Collision children during collision detection, simplifying collision-intersection computations.
  
  Hint: The proxy node is used strictly for collision detection and is not drawn.
  
  Warning: the proxy node must have containerField='proxy' or it is simply treated like other children nodes.
  
  Warning: insert a Shape node before adding geometry or Appearance.
  
  Parameters:
  
  newValue - is new value for the proxy field.
  
  Returns:
  
  Collision - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getVisible
  boolean getVisible()
  
  Provide boolean value from inputOutput SFBool field named visible.
  
  Tooltip: Whether or not renderable content within this node is visually displayed.
  
  Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
  
  Hint: content must be visible to be collidable and to be pickable.
  
  Specified by:
  
  getVisible in interface X3DBoundedObject
  
  Specified by:
  
  getVisible in interface X3DGroupingNode
  
  Returns:
  
  value of visible field
- setVisible
  Collision setVisible(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named visible.
  
  Tooltip: Whether or not renderable content within this node is visually displayed.
  
  Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
  
  Hint: content must be visible to be collidable and to be pickable.
  
  Specified by:
  
  setVisible in interface X3DBoundedObject
  
  Specified by:
  
  setVisible in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  Collision - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface Collision

Method Summary

Method Details

getBboxCenter

setBboxCenter

getBboxDisplay

setBboxDisplay

getBboxSize

setBboxSize

getChildren

setChildren

addChildren

setChildren

getCollideTime

getDescription

setDescription

getEnabled

setEnabled

getIsActive

getMetadata

setMetadata

getProxy

setProxy

getVisible

setVisible