All Superinterfaces:: X3DBoundedObject, X3DChildNode, X3DNBodyCollidableNode, X3DNode

All Known Implementing Classes:: CollidableOffset

public interface CollidableOffset extends X3DNBodyCollidableNode

CollidableOffset repositions geometry relative to center of owning body.

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. CollidableOffset node tooltip: (X3D version 3.2 or later) [X3DNBodyCollidableNode] CollidableOffset repositions geometry relative to center of owning body. Contains a single CollidableShape or CollidableOffset node (containerField='collidable').

Hint: content must be visible to be collidable and to be pickable.

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

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.

X3DNBodyCollidableNode

getCollidable()

Provide org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode instance (using a properly typed node) from initializeOnly SFNode field collidable.

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

X3DMetadataObject

getMetadata()

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

float[]

getRotation()

Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.

float[]

getTranslation()

Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.

boolean

getVisible()

Provide boolean value from inputOutput SFBool field named visible.

CollidableOffset

setBboxCenter(float[] newValue)

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

CollidableOffset

setBboxDisplay(boolean newValue)

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

CollidableOffset

setBboxSize(float[] newValue)

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

CollidableOffset

setCollidable(X3DNBodyCollidableNode newValue)

Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode instance (using a properly typed node) to initializeOnly SFNode field collidable.

CollidableOffset

setEnabled(boolean newValue)

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

CollidableOffset

setMetadata(X3DMetadataObject newValue)

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

CollidableOffset

setRotation(float[] newValue)

Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.

CollidableOffset

setTranslation(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.

CollidableOffset

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 X3DNBodyCollidableNode
  
  Returns:
  
  value of bboxCenter field
- setBboxCenter
  CollidableOffset 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 X3DNBodyCollidableNode
  
  Parameters:
  
  newValue - is new value for the bboxCenter field.
  
  Returns:
  
  CollidableOffset - 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 X3DNBodyCollidableNode
  
  Returns:
  
  value of bboxDisplay field
- setBboxDisplay
  CollidableOffset 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 X3DNBodyCollidableNode
  
  Parameters:
  
  newValue - is new value for the bboxDisplay field.
  
  Returns:
  
  CollidableOffset - 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 X3DNBodyCollidableNode
  
  Returns:
  
  value of bboxSize field
- setBboxSize
  CollidableOffset 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 X3DNBodyCollidableNode
  
  Parameters:
  
  newValue - is new value for the bboxSize field.
  
  Returns:
  
  CollidableOffset - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getCollidable
  X3DNBodyCollidableNode getCollidable()
  
  Provide org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode instance (using a properly typed node) from initializeOnly SFNode field collidable.
  
  Tooltip: [X3DNBodyCollidableNode] The collidable field holds a reference to a single nested item of a collidable scene graph.
  
  Warning: if there are multiple transformation paths to this reference, the results are undefined.
  
  Returns:
  
  value of collidable field
- setCollidable
  CollidableOffset setCollidable(X3DNBodyCollidableNode newValue)
  
  Accessor method to assign org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode instance (using a properly typed node) to initializeOnly SFNode field collidable.
  
  Tooltip: [X3DNBodyCollidableNode] The collidable field holds a reference to a single nested item of a collidable scene graph.
  
  Warning: if there are multiple transformation paths to this reference, the results are undefined.
  
  Parameters:
  
  newValue - is new value for the collidable field.
  
  Returns:
  
  CollidableOffset - 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. *
  
  Specified by:
  
  getEnabled in interface X3DNBodyCollidableNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  CollidableOffset setEnabled(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  setEnabled in interface X3DNBodyCollidableNode
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  CollidableOffset - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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 X3DNBodyCollidableNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  CollidableOffset 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 X3DNBodyCollidableNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  CollidableOffset - 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
- getRotation
  float[] getRotation()
  
  Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
  
  Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system.
  
  Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
  
  Specified by:
  
  getRotation in interface X3DNBodyCollidableNode
  
  Returns:
  
  value of rotation field
- setRotation
  CollidableOffset setRotation(float[] newValue)
  
  Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
  
  Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system.
  
  Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
  
  Specified by:
  
  setRotation in interface X3DNBodyCollidableNode
  
  Parameters:
  
  newValue - is new value for the rotation field.
  
  Returns:
  
  CollidableOffset - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getTranslation
  float[] getTranslation()
  
  Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.
  
  Tooltip: Position (x, y, z in meters) of children relative to local coordinate system.
  
  Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
  
  Specified by:
  
  getTranslation in interface X3DNBodyCollidableNode
  
  Returns:
  
  value of translation field
- setTranslation
  CollidableOffset setTranslation(float[] newValue)
  
  Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.
  
  Tooltip: Position (x, y, z in meters) of children relative to local coordinate system.
  
  Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
  
  Specified by:
  
  setTranslation in interface X3DNBodyCollidableNode
  
  Parameters:
  
  newValue - is new value for the translation field.
  
  Returns:
  
  CollidableOffset - 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 X3DNBodyCollidableNode
  
  Returns:
  
  value of visible field
- setVisible
  CollidableOffset 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 X3DNBodyCollidableNode
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  CollidableOffset - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface CollidableOffset

Method Summary

Method Details

getBboxCenter

setBboxCenter

getBboxDisplay

setBboxDisplay

getBboxSize

setBboxSize

getCollidable

setCollidable

getEnabled

setEnabled

getMetadata

setMetadata

getRotation

setRotation

getTranslation

setTranslation

getVisible

setVisible