CollisionSensor (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode, X3DSensorNode

All Known Implementing Classes:

CollisionSensorObject
```
public interface CollisionSensor
extends X3DSensorNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.2 or later) [X3DSensorNode] CollisionSensor generates collision-detection events.
- Hint: contains CollisionCollection node (containerField='collider').
- Hint: CollisionSensor also has output events: CollidableOffset and CollidableShape nodes (containerField='intersections'), Contact nodes (containerField='contacts').
- Hint: event timing details are explained in X3D Specification 4.4.8.3 Execution model
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#ExecutionModel
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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)` Assign CollisionCollection instance (using a properly typed node) to inputOutput SFNode field collider.
`CollisionSensor`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`CollisionSensor`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`CollisionSensor`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`CollisionSensor`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`CollisionSensor`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    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)
```
    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.
    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.
    
    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)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    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
  - setDEF
```
CollisionSensor setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CollisionSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
CollisionSensor setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CollisionSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
CollisionSensor setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CollisionSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface CollisionSensor

Method Summary

Method Detail

getCollider

setCollider

getContacts

getEnabled

setEnabled

getIntersections

getIsActive

getMetadata

setMetadata

setDEF

setUSE

setCssClass