ProximitySensor (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DEnvironmentalSensorNode, X3DNode, X3DSensorNode

All Known Implementing Classes:

ProximitySensorObject
```
public interface ProximitySensor
extends X3DEnvironmentalSensorNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DEnvironmentalSensorNode] ProximitySensor generates events when the viewer enters, exits and moves within a region of space (defined by a box).
- Hint: multiple USEd instances are cumulative, but avoid overlaps.
- Hint: can first use Transform to relocate/reorient box.
- Hint: surround entire world to start behaviors once scene is loaded.
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: ProximitySensor, X3D Tooltips: ProximitySensor, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`float[]`	`getCenter()` Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
`float[]`	`getCenterOfRotation()` Provide array of 3-tuple float results unit axis, angle (in radians) from outputOnly SFVec3f field named centerOfRotation_changed.
`boolean`	`getEnabled()` Provide boolean value from inputOutput SFBool field named enabled.
`double`	`getEnterTime()` Provide double value in seconds from outputOnly SFTime field named enterTime.
`double`	`getExitTime()` Provide double value in seconds from outputOnly SFTime field named exitTime.
`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.
`float[]`	`getOrientation()` Provide array of 4-tuple float results unit axis, angle (in radians) from outputOnly SFRotation field named orientation_changed.
`float[]`	`getPosition()` Provide array of 3-tuple float results from outputOnly SFVec3f field named position_changed.
`float[]`	`getSize()` Provide array of 3-tuple float results within allowed range of [0,infinity) from initializeOnly SFVec3f field named size.
`ProximitySensor`	`setCenter(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named center.
`ProximitySensor`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ProximitySensor`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ProximitySensor`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`ProximitySensor`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ProximitySensor`	`setSize(float[] newValue)` Assign 3-tuple float array within allowed range of [0,infinity) to initializeOnly SFVec3f field named size.
`ProximitySensor`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getCenter
```
float[] getCenter()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
    
    Tooltip: Position offset from origin of local coordinate system. *
    
    Returns:
    
    value of center field
  - setCenter
```
ProximitySensor setCenter(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named center.
    
    Tooltip: Position offset from origin of local coordinate system.
    
    Parameters:
    
    newValue - is new value for the center field.
    
    Returns:
    
    ProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getCenterOfRotation
```
float[] getCenterOfRotation()
```
    Provide array of 3-tuple float results unit axis, angle (in radians) from outputOnly SFVec3f field named centerOfRotation_changed.
    
    Tooltip: Sends changed centerOfRotation values, likely caused by user interaction.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of centerOfRotation_changed field
  - getEnabled
```
boolean getEnabled()
```
    Provide boolean value from inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation. *
    
    Specified by:
    
    getEnabled in interface X3DEnvironmentalSensorNode
    
    Specified by:
    
    getEnabled in interface X3DSensorNode
    
    Returns:
    
    value of enabled field
  - setEnabled
```
ProximitySensor setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Specified by:
    
    setEnabled in interface X3DEnvironmentalSensorNode
    
    Specified by:
    
    setEnabled in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    ProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getEnterTime
```
double getEnterTime()
```
    Provide double value in seconds from outputOnly SFTime field named enterTime.
    
    Tooltip: Time event generated when user's camera enters the box.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of enterTime field
  - getExitTime
```
double getExitTime()
```
    Provide double value in seconds from outputOnly SFTime field named exitTime.
    
    Tooltip: Time event generated when user's camera exits the box.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of exitTime field
  - getIsActive
```
boolean getIsActive()
```
    Provide boolean value from outputOnly SFBool field named isActive.
    
    Tooltip: isActive true/false events are sent as viewer enters/exits Proximity box. isActive=true when viewer enters Proximity box, isActive=false when viewer exits Proximity box.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getIsActive in interface X3DEnvironmentalSensorNode
    
    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 X3DEnvironmentalSensorNode
    
    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
```
ProximitySensor 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 X3DEnvironmentalSensorNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ProximitySensor - 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
  - getOrientation
```
float[] getOrientation()
```
    Provide array of 4-tuple float results unit axis, angle (in radians) from outputOnly SFRotation field named orientation_changed.
    
    Tooltip: Sends rotation event relative to center.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of orientation_changed field
  - getPosition
```
float[] getPosition()
```
    Provide array of 3-tuple float results from outputOnly SFVec3f field named position_changed.
    
    Tooltip: Sends translation event relative to center.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of position_changed field
  - getSize
```
float[] getSize()
```
    Provide array of 3-tuple float results within allowed range of [0,infinity) from initializeOnly SFVec3f field named size.
    
    Tooltip: [0,+infinity) size of Proximity box.
    - Hint: size 0 0 0 is same as enabled false.
    Specified by:
    
    getSize in interface X3DEnvironmentalSensorNode
    
    Returns:
    
    value of size field
  - setSize
```
ProximitySensor setSize(float[] newValue)
```
    Assign 3-tuple float array within allowed range of [0,infinity) to initializeOnly SFVec3f field named size.
    
    Tooltip: [0,+infinity) size of Proximity box. Hint: size 0 0 0 is same as enabled false.
    
    Specified by:
    
    setSize in interface X3DEnvironmentalSensorNode
    
    Parameters:
    
    newValue - is new value for the size field.
    
    Returns:
    
    ProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
ProximitySensor 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 X3DEnvironmentalSensorNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
ProximitySensor 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 X3DEnvironmentalSensorNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
ProximitySensor 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 X3DEnvironmentalSensorNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ProximitySensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ProximitySensor

Method Summary

Method Detail

getCenter

setCenter

getCenterOfRotation

getEnabled

setEnabled

getEnterTime

getExitTime

getIsActive

getMetadata

setMetadata

getOrientation

getPosition

getSize

setSize

setDEF

setUSE

setCssClass