PlaneSensor (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DDragSensorNode, X3DNode, X3DPointingDeviceSensorNode, X3DSensorNode

All Known Implementing Classes:

PlaneSensorObject
```
public interface PlaneSensor
extends X3DDragSensorNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DDragSensorNode] PlaneSensor converts pointing device motion into 2D translation parallel to the local Z=0 plane.
- Hint: create a LineSensor by constraining one axis: (minPosition.x=maxPosition.x) or (minPosition.y=maxPosition.y).
- Hint: this sensor detects user interactions affecting peer nodes and their child geometry.
- Hint: add semi-transparent surrounding geometry to see the effect of the sensor.
- Hint: X3D Architecture 20.2.1 Overview of pointing device sensors
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#OverviewOfPointingDeviceSensors
- Hint: X3D Architecture 20.2.2 Drag sensors
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#DragSensors
- Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#Activatingandmanipulating
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: PlaneSensor, X3D Tooltips: PlaneSensor, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getAutoOffset()` Provide boolean value from inputOutput SFBool field named autoOffset.
`float[]`	`getAxisRotation()` Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named axisRotation.
`java.lang.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.
`boolean`	`getIsOver()` Provide boolean value from outputOnly SFBool field named isOver.
`float[]`	`getMaxPosition()` Provide array of 2-tuple float results from inputOutput SFVec2f field named maxPosition.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float[]`	`getMinPosition()` Provide array of 2-tuple float results from inputOutput SFVec2f field named minPosition.
`float[]`	`getOffset()` Provide array of 3-tuple float results from inputOutput SFVec3f field named offset.
`float[]`	`getTrackPoint()` Provide array of 3-tuple float results from outputOnly SFVec3f field named trackPoint_changed.
`float[]`	`getTranslation()` Provide array of 3-tuple float results from outputOnly SFVec3f field named translation_changed.
`PlaneSensor`	`setAutoOffset(boolean newValue)` Assign boolean value to inputOutput SFBool field named autoOffset.
`PlaneSensor`	`setAxisRotation(float[] newValue)` Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named axisRotation.
`PlaneSensor`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`PlaneSensor`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`PlaneSensor`	`setDescription(java.lang.String newValue)` Assign String value to inputOutput SFString field named description.
`PlaneSensor`	`setEnabled(boolean newValue)` Assign boolean value to inputOutput SFBool field named enabled.
`PlaneSensor`	`setMaxPosition(float[] newValue)` Assign 2-tuple float array to inputOutput SFVec2f field named maxPosition.
`PlaneSensor`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`PlaneSensor`	`setMinPosition(float[] newValue)` Assign 2-tuple float array to inputOutput SFVec2f field named minPosition.
`PlaneSensor`	`setOffset(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named offset.
`PlaneSensor`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getAutoOffset
```
boolean getAutoOffset()
```
    Provide boolean value from inputOutput SFBool field named autoOffset.
    
    Tooltip: Determines whether previous offset values are remembered/accumulated. *
    
    Specified by:
    
    getAutoOffset in interface X3DDragSensorNode
    
    Returns:
    
    value of autoOffset field
  - setAutoOffset
```
PlaneSensor setAutoOffset(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named autoOffset.
    
    Tooltip: Determines whether previous offset values are remembered/accumulated.
    
    Specified by:
    
    setAutoOffset in interface X3DDragSensorNode
    
    Parameters:
    
    newValue - is new value for the autoOffset field.
    
    Returns:
    
    PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getAxisRotation
```
float[] getAxisRotation()
```
    Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named axisRotation.
    
    Tooltip: axisRotation determines local sensor coordinate system by rotating the local coordinate system. *
    
    Returns:
    
    value of axisRotation field
  - setAxisRotation
```
PlaneSensor setAxisRotation(float[] newValue)
```
    Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named axisRotation.
    
    Tooltip: axisRotation determines local sensor coordinate system by rotating the local coordinate system.
    
    Parameters:
    
    newValue - is new value for the axisRotation field.
    
    Returns:
    
    PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDescription
```
java.lang.String getDescription()
```
    Provide String value from inputOutput SFString field named description.
    
    Tooltip: Author-provided text tooltip that tells users the expected action of this node.
    - Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
    - 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 X3DDragSensorNode
    
    Specified by:
    
    getDescription in interface X3DPointingDeviceSensorNode
    
    Returns:
    
    value of description field
  - setDescription
```
PlaneSensor setDescription(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named description.
    
    Tooltip: Author-provided text tooltip that tells users the expected action of this node. Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable. 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 X3DDragSensorNode
    
    Specified by:
    
    setDescription in interface X3DPointingDeviceSensorNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    PlaneSensor - 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 X3DDragSensorNode
    
    Specified by:
    
    getEnabled in interface X3DPointingDeviceSensorNode
    
    Specified by:
    
    getEnabled in interface X3DSensorNode
    
    Returns:
    
    value of enabled field
  - setEnabled
```
PlaneSensor setEnabled(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named enabled.
    
    Tooltip: Enables/disables node operation.
    
    Specified by:
    
    setEnabled in interface X3DDragSensorNode
    
    Specified by:
    
    setEnabled in interface X3DPointingDeviceSensorNode
    
    Specified by:
    
    setEnabled in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the enabled field.
    
    Returns:
    
    PlaneSensor - 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: Select geometry by activating the pointing device (e.g. clicking the mouse) to generate isActive events. Output event isActive=true is sent when geometry is selected (e.g. when primary mouse button is pressed), output event isActive=false is sent when geometry is deselected (e.g. when primary mouse button is released).
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getIsActive in interface X3DDragSensorNode
    
    Specified by:
    
    getIsActive in interface X3DPointingDeviceSensorNode
    
    Specified by:
    
    getIsActive in interface X3DSensorNode
    
    Returns:
    
    value of isActive field
  - getIsOver
```
boolean getIsOver()
```
    Provide boolean value from outputOnly SFBool field named isOver.
    
    Tooltip: Hover over geometry by aiming the mouse (or pointing device) to generate isOver events. Sensor sends output event isOver=true event when pointing device moves over sensor's geometry, and later sends output event isOver=false event when pointing device moves off.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getIsOver in interface X3DDragSensorNode
    
    Specified by:
    
    getIsOver in interface X3DPointingDeviceSensorNode
    
    Returns:
    
    value of isOver field
  - getMaxPosition
```
float[] getMaxPosition()
```
    Provide array of 2-tuple float results from inputOutput SFVec2f field named maxPosition.
    
    Tooltip: minPosition and maxPosition clamp translations to a range of values measured from origin of Z=0 plane default maxPosition < minPosition means no clamping.
    - Hint: create a LineSensor by constraining one axis (minPosition.x=maxPosition.x) or (minPosition.y=maxPosition.y).
    Returns:
    
    value of maxPosition field
  - setMaxPosition
```
PlaneSensor setMaxPosition(float[] newValue)
```
    Assign 2-tuple float array to inputOutput SFVec2f field named maxPosition.
    
    Tooltip: minPosition and maxPosition clamp translations to a range of values measured from origin of Z=0 plane default maxPosition < minPosition means no clamping. Hint: create a LineSensor by constraining one axis (minPosition.x=maxPosition.x) or (minPosition.y=maxPosition.y).
    
    Parameters:
    
    newValue - is new value for the maxPosition field.
    
    Returns:
    
    PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - 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 X3DDragSensorNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DPointingDeviceSensorNode
    
    Specified by:
    
    getMetadata in interface X3DSensorNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
PlaneSensor 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 X3DDragSensorNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DPointingDeviceSensorNode
    
    Specified by:
    
    setMetadata in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    PlaneSensor - 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
  - getMinPosition
```
float[] getMinPosition()
```
    Provide array of 2-tuple float results from inputOutput SFVec2f field named minPosition.
    
    Tooltip: minPosition and maxPosition clamp translations to a range of values measured from origin of Z=0 plane default maxPosition < minPosition means no clamping.
    - Hint: create a LineSensor by constraining one axis (minPosition.x=maxPosition.x) or (minPosition.y=maxPosition.y).
    Returns:
    
    value of minPosition field
  - setMinPosition
```
PlaneSensor setMinPosition(float[] newValue)
```
    Assign 2-tuple float array to inputOutput SFVec2f field named minPosition.
    
    Tooltip: minPosition and maxPosition clamp translations to a range of values measured from origin of Z=0 plane default maxPosition < minPosition means no clamping. Hint: create a LineSensor by constraining one axis (minPosition.x=maxPosition.x) or (minPosition.y=maxPosition.y).
    
    Parameters:
    
    newValue - is new value for the minPosition field.
    
    Returns:
    
    PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getOffset
```
float[] getOffset()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named offset.
    
    Tooltip: Sends event and remembers last value sensed.
    - Warning: ROUTE connecting translation_changed to set_offset creates a self-reinforcing positive feedback loop and results in unmanageable response.
    Returns:
    
    value of offset field
  - setOffset
```
PlaneSensor setOffset(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named offset.
    
    Tooltip: Sends event and remembers last value sensed. Warning: ROUTE connecting translation_changed to set_offset creates a self-reinforcing positive feedback loop and results in unmanageable response.
    
    Parameters:
    
    newValue - is new value for the offset field.
    
    Returns:
    
    PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getTrackPoint
```
float[] getTrackPoint()
```
    Provide array of 3-tuple float results from outputOnly SFVec3f field named trackPoint_changed.
    
    Tooltip: trackPoint_changed events give intersection point of bearing with sensor's virtual geometry.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getTrackPoint in interface X3DDragSensorNode
    
    Returns:
    
    value of trackPoint_changed field
  - getTranslation
```
float[] getTranslation()
```
    Provide array of 3-tuple float results from outputOnly SFVec3f field named translation_changed.
    
    Tooltip: translation_changed events equal sum of relative translation change plus offset value.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of translation_changed field
  - setDEF
```
PlaneSensor 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 X3DDragSensorNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DPointingDeviceSensorNode
    
    Specified by:
    
    setDEF in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
PlaneSensor 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 X3DDragSensorNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DPointingDeviceSensorNode
    
    Specified by:
    
    setUSE in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
PlaneSensor 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 X3DDragSensorNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DPointingDeviceSensorNode
    
    Specified by:
    
    setCssClass in interface X3DSensorNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface PlaneSensor

Method Summary

Method Detail

getAutoOffset

setAutoOffset

getAxisRotation

setAxisRotation

getDescription

setDescription

getEnabled

setEnabled

getIsActive

getIsOver

getMaxPosition

setMaxPosition

getMetadata

setMetadata

getMinPosition

setMinPosition

getOffset

setOffset

getTrackPoint

getTranslation

setDEF

setUSE

setCssClass