Package org.web3d.x3d.sai.RigidBodyPhysics

Interface CollisionSensor

All Superinterfaces:
X3DChildNode, X3DNode, X3DSensorNode
All Known Implementing Classes:
CollisionSensorObject
public interface CollisionSensor
extends X3DSensorNode
CollisionSensor generates collision-detection events.

X3D node tooltip: (X3D version 3.2 or later) [X3DSensorNode] CollisionSensor generates collision-detection events.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: CollisionSensor, X3D Tooltips: CollisionSensor, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    CollisionCollection getCollider()
    Provide CollisionCollection instance (using a properly typed node) from inputOutput SFNode field collider.
    X3DNode[] getContacts()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from outputOnly MFNode field contacts.
    boolean getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    X3DNode[] getIntersections()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from outputOnly MFNode field intersections.
    boolean getIsActive()
    Provide boolean value from outputOnly SFBool field named isActive.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    CollisionSensor setCollider​(CollisionCollection newValue)
    Accessor method to assign CollisionCollection instance (using a properly typed node) to inputOutput SFNode field collider.
    CollisionSensor setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    CollisionSensor setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

  • Method Details

    • getCollider

      CollisionCollection getCollider()
      Provide CollisionCollection instance (using a properly typed node) from inputOutput SFNode field collider.
      Returns:
      value of collider field

    • setCollider

      CollisionSensor setCollider​(CollisionCollection newValue)
      Accessor method to assign CollisionCollection instance (using a properly typed node) to inputOutput SFNode field collider.
      Parameters:
      newValue - is new value for the collider field.
      Returns:
      CollisionSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getContacts

      X3DNode[] getContacts()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from outputOnly MFNode field contacts.

      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Contact.
      Returns:
      value of contacts field
      See Also:
      ContactObject

    • getEnabled

      boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface X3DSensorNode
      Returns:
      value of enabled field

    • setEnabled

      CollisionSensor 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 X3DSensorNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      CollisionSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIntersections

      X3DNode[] getIntersections()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from outputOnly MFNode field intersections.

      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollidableNode.
      Returns:
      value of intersections field
      See Also:
      X3DNBodyCollidableNode

    • getIsActive

      boolean getIsActive()
      Provide boolean value from outputOnly SFBool field named isActive.

      Tooltip: isActive true/false events are sent when sensing starts/stops.
      • 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 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.
      Specified by:
      getMetadata in interface X3DChildNode
      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

      CollisionSensor setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign 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.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSensorNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      CollisionSensor - 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