java.lang.Object

org.web3d.x3d.jsail.PointingDeviceSensor.PlaneSensor

All Implemented Interfaces:: X3DChildNode, X3DNode, X3DSensorNode, PlaneSensor, X3DDragSensorNode, X3DPointingDeviceSensorNode

public class PlaneSensor
extends X3DConcreteNode
implements PlaneSensor

PlaneSensor converts pointing device motion into 2D translation parallel to the local Z=0 plane.

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 https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/pointingDeviceSensor.html#OverviewOfPointingDeviceSensors
Hint: X3D Architecture 20.2.2 Drag sensors https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/pointingDeviceSensor.html#DragSensors
Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/pointingDeviceSensor.html#Activatingandmanipulating
Hint: example scenes and authoring assets at https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter08UserInteractivity

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:: X3D Abstract Specification: PlaneSensor, X3D Tooltips: PlaneSensor, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`AUTOOFFSET_DEFAULT_VALUE`	SFBool field named autoOffset has default value true (Java syntax) or true (XML syntax).
`static float[]`	`AXISROTATION_DEFAULT_VALUE`	SFRotation field named axisRotation has default value {0f,1f,0f,0f} (Java syntax) or 0 1 0 0 (XML syntax).
`static java.lang.String`	`COMPONENT`	String constant COMPONENT defines X3D component for the PlaneSensor element: PointingDeviceSensor
`static java.lang.String`	`containerField_DEFAULT_VALUE`	containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`DESCRIPTION_DEFAULT_VALUE`	SFString field named description has default value equal to an empty string.
`static boolean`	`ENABLED_DEFAULT_VALUE`	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
`static java.lang.String`	`fromField_AUTOOFFSET`	fromField ROUTE name for SFBool field named autoOffset.
`static java.lang.String`	`fromField_AXISROTATION`	fromField ROUTE name for SFRotation field named axisRotation.
`static java.lang.String`	`fromField_DESCRIPTION`	fromField ROUTE name for SFString field named description.
`static java.lang.String`	`fromField_ENABLED`	fromField ROUTE name for SFBool field named enabled.
`static java.lang.String`	`fromField_IS`	fromField ROUTE name for SFNode field named IS.
`static java.lang.String`	`fromField_ISACTIVE`	fromField ROUTE name for SFBool field named isActive.
`static java.lang.String`	`fromField_ISOVER`	fromField ROUTE name for SFBool field named isOver.
`static java.lang.String`	`fromField_MAXPOSITION`	fromField ROUTE name for SFVec2f field named maxPosition.
`static java.lang.String`	`fromField_METADATA`	fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_MINPOSITION`	fromField ROUTE name for SFVec2f field named minPosition.
`static java.lang.String`	`fromField_OFFSET`	fromField ROUTE name for SFVec3f field named offset.
`static java.lang.String`	`fromField_TRACKPOINT_CHANGED`	fromField ROUTE name for SFVec3f field named trackPoint_changed.
`static java.lang.String`	`fromField_TRANSLATION_CHANGED`	fromField ROUTE name for SFVec3f field named translation_changed.
`static IS`	`IS_DEFAULT_VALUE`	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
`static int`	`LEVEL`	Integer constant LEVEL provides default X3D PointingDeviceSensor component level for this element: 1
`static float[]`	`MAXPOSITION_DEFAULT_VALUE`	SFVec2f field named maxPosition has default value {-1f,-1f} (Java syntax) or -1 -1 (XML syntax).
`static X3DMetadataObject`	`METADATA_DEFAULT_VALUE`	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
`static float[]`	`MINPOSITION_DEFAULT_VALUE`	SFVec2f field named minPosition has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
`static java.lang.String`	`NAME`	String constant NAME provides name of this element: PlaneSensor.
`static float[]`	`OFFSET_DEFAULT_VALUE`	SFVec3f field named offset has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
`static java.lang.String`	`toField_AUTOOFFSET`	toField ROUTE name for SFBool field named autoOffset.
`static java.lang.String`	`toField_AXISROTATION`	toField ROUTE name for SFRotation field named axisRotation.
`static java.lang.String`	`toField_DESCRIPTION`	toField ROUTE name for SFString field named description.
`static java.lang.String`	`toField_ENABLED`	toField ROUTE name for SFBool field named enabled.
`static java.lang.String`	`toField_MAXPOSITION`	toField ROUTE name for SFVec2f field named maxPosition.
`static java.lang.String`	`toField_METADATA`	toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_MINPOSITION`	toField ROUTE name for SFVec2f field named minPosition.
`static java.lang.String`	`toField_OFFSET`	toField ROUTE name for SFVec3f field named offset.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

validationResult

Constructor Summary

Constructors
Constructor	Description
`PlaneSensor()`	Constructor for PlaneSensor to initialize member variables with default values.
`PlaneSensor(java.lang.String DEFlabel)`	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
`PlaneSensor`	`addComments(java.lang.String newComment)`	Add comment as String to contained commentsList.
`PlaneSensor`	`addComments(java.lang.String[] newComments)`	Add comments as String[] array to contained commentsList.
`PlaneSensor`	`addComments(CommentsBlock newCommentsBlock)`	Add CommentsBlock to contained commentsList.
`PlaneSensor`	`clearIS()`	Utility method to clear SFNode value of IS field.
`PlaneSensor`	`clearMetadata()`	Utility method to clear SFNode value of metadata field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)`	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)`	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)`	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)`	Indicate accessType corresponding to given fieldName.
`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`	`getComponent()`	Defines X3D component for the PlaneSensor element: PointingDeviceSensor
`int`	`getComponentLevel()`	Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()`	containerField describes typical field relationship of a node to its parent.
`java.lang.String`	`getCssClass()`	Provide String value from inputOutput SFString field named class.
`java.lang.String`	`getDEF()`	Provide String value from inputOutput SFString field named DEF.
`java.lang.String`	`getDescription()`	Provide String value from inputOutput SFString field named description.
`java.lang.String`	`getElementName()`	Provides name of this element: PlaneSensor
`boolean`	`getEnabled()`	Provide boolean value from inputOutput SFBool field named enabled.
`java.lang.String`	`getFieldType(java.lang.String fieldName)`	Indicate type corresponding to given fieldName.
`IS`	`getIS()`	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
`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 org.web3d.x3d.sai.Core.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.
`java.lang.String`	`getUSE()`	Provide String value from inputOutput SFString field named USE.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)`	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasIS()`	Indicate whether an object is available for inputOutput SFNode field IS.
`boolean`	`hasMetadata()`	Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)`	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()`	Initialize all member variables to default values.
`PlaneSensor`	`setAutoOffset(boolean newValue)`	Accessor method to assign boolean value to inputOutput SFBool field named autoOffset.
`PlaneSensor`	`setAutoOffset(SFBool newValue)`	Assign typed object value to SFBool autoOffset field, similar to `setAutoOffset(boolean)`.
`PlaneSensor`	`setAxisRotation(double[] newArray)`	Utility method: double-precision set-array accessor for X3D floating-point type, similar to `setAxisRotation(float[])`.
`PlaneSensor`	`setAxisRotation(double x, double y, double z, double angleRadians)`	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to `setAxisRotation(float[])`.
`PlaneSensor`	`setAxisRotation(float[] newValue)`	Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named axisRotation.
`PlaneSensor`	`setAxisRotation(float x, float y, float z, float angleRadians)`	Assign values to SFRotation axisRotation field, similar to `setAxisRotation(float[])`.
`PlaneSensor`	`setAxisRotation(SFRotation newValue)`	Assign typed object value to SFRotation axisRotation field, similar to `setAxisRotation(float[])`.
`PlaneSensor`	`setCssClass(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named class.
`PlaneSensor`	`setCssClass(SFString newValue)`	Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`PlaneSensor`	`setDEF(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named DEF.
`PlaneSensor`	`setDEF(SFString newValue)`	Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`PlaneSensor`	`setDescription(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named description.
`PlaneSensor`	`setDescription(SFString newValue)`	Assign typed object value to SFString description field, similar to `setDescription(String)`.
`PlaneSensor`	`setEnabled(boolean newValue)`	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
`PlaneSensor`	`setEnabled(SFBool newValue)`	Assign typed object value to SFBool enabled field, similar to `setEnabled(boolean)`.
`PlaneSensor`	`setIS(IS newValue)`	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
`PlaneSensor`	`setMaxPosition(double[] newArray)`	Utility method: double-precision set-array accessor for X3D floating-point type, similar to `setMaxPosition(float[])`.
`PlaneSensor`	`setMaxPosition(double x, double y)`	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to `setMaxPosition(float[])`.
`PlaneSensor`	`setMaxPosition(float[] newValue)`	Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named maxPosition.
`PlaneSensor`	`setMaxPosition(float x, float y)`	Assign values to SFVec2f maxPosition field, similar to `setMaxPosition(float[])`.
`PlaneSensor`	`setMaxPosition(SFVec2f newValue)`	Assign typed object value to SFVec2f maxPosition field, similar to `setMaxPosition(float[])`.
`PlaneSensor`	`setMetadata(ProtoInstance newValue)`	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`PlaneSensor`	`setMetadata(X3DMetadataObject newValue)`	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`PlaneSensor`	`setMinPosition(double[] newArray)`	Utility method: double-precision set-array accessor for X3D floating-point type, similar to `setMinPosition(float[])`.
`PlaneSensor`	`setMinPosition(double x, double y)`	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to `setMinPosition(float[])`.
`PlaneSensor`	`setMinPosition(float[] newValue)`	Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named minPosition.
`PlaneSensor`	`setMinPosition(float x, float y)`	Assign values to SFVec2f minPosition field, similar to `setMinPosition(float[])`.
`PlaneSensor`	`setMinPosition(SFVec2f newValue)`	Assign typed object value to SFVec2f minPosition field, similar to `setMinPosition(float[])`.
`PlaneSensor`	`setOffset(double[] newArray)`	Utility method: double-precision set-array accessor for X3D floating-point type, similar to `setOffset(float[])`.
`PlaneSensor`	`setOffset(double x, double y, double z)`	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to `setOffset(float[])`.
`PlaneSensor`	`setOffset(float[] newValue)`	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named offset.
`PlaneSensor`	`setOffset(float x, float y, float z)`	Assign values to SFVec3f offset field, similar to `setOffset(float[])`.
`PlaneSensor`	`setOffset(SFVec3f newValue)`	Assign typed object value to SFVec3f offset field, similar to `setOffset(float[])`.
`PlaneSensor`	`setUSE(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named USE.
`PlaneSensor`	`setUSE(SFString newValue)`	Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`PlaneSensor`	`setUSE(PlaneSensor DEFnode)`	Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`java.lang.String`	`toStringClassicVRML(int indentLevel)`	Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)`	Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)`	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()`	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- NAME
  
  public static final java.lang.String NAME
  
  String constant NAME provides name of this element: PlaneSensor.
  
  See Also:
  
  Constant Field Values
- COMPONENT
  
  public static final java.lang.String COMPONENT
  
  String constant COMPONENT defines X3D component for the PlaneSensor element: PointingDeviceSensor
  
  See Also:
  
  Constant Field Values
- LEVEL
  
  public static final int LEVEL
  
  Integer constant LEVEL provides default X3D PointingDeviceSensor component level for this element: 1
  
  See Also:
  
  Constant Field Values
- AUTOOFFSET_DEFAULT_VALUE
  
  public static final boolean AUTOOFFSET_DEFAULT_VALUE
  
  SFBool field named autoOffset has default value true (Java syntax) or true (XML syntax).
  
  See Also:
  
  Constant Field Values
- AXISROTATION_DEFAULT_VALUE
  
  public static final float[] AXISROTATION_DEFAULT_VALUE
  
  SFRotation field named axisRotation has default value {0f,1f,0f,0f} (Java syntax) or 0 1 0 0 (XML syntax).
- DESCRIPTION_DEFAULT_VALUE
  
  public static final java.lang.String DESCRIPTION_DEFAULT_VALUE
  
  SFString field named description has default value equal to an empty string.
  
  See Also:
  
  Constant Field Values
- ENABLED_DEFAULT_VALUE
  
  public static final boolean ENABLED_DEFAULT_VALUE
  
  SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
  
  See Also:
  
  Constant Field Values
- IS_DEFAULT_VALUE
  
  public static final IS IS_DEFAULT_VALUE
  
  SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
- MAXPOSITION_DEFAULT_VALUE
  
  public static final float[] MAXPOSITION_DEFAULT_VALUE
  
  SFVec2f field named maxPosition has default value {-1f,-1f} (Java syntax) or -1 -1 (XML syntax).
- METADATA_DEFAULT_VALUE
  
  public static final X3DMetadataObject METADATA_DEFAULT_VALUE
  
  SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
- MINPOSITION_DEFAULT_VALUE
  
  public static final float[] MINPOSITION_DEFAULT_VALUE
  
  SFVec2f field named minPosition has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
- OFFSET_DEFAULT_VALUE
  
  public static final float[] OFFSET_DEFAULT_VALUE
  
  SFVec3f field named offset has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
- containerField_DEFAULT_VALUE
  
  public static final java.lang.String containerField_DEFAULT_VALUE
  
  containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
  
  See Also:
  
  X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
- fromField_AUTOOFFSET
  
  public static final java.lang.String fromField_AUTOOFFSET
  
  fromField ROUTE name for SFBool field named autoOffset.
  
  See Also:
  
  Constant Field Values
- toField_AUTOOFFSET
  
  public static final java.lang.String toField_AUTOOFFSET
  
  toField ROUTE name for SFBool field named autoOffset.
  
  See Also:
  
  Constant Field Values
- fromField_AXISROTATION
  
  public static final java.lang.String fromField_AXISROTATION
  
  fromField ROUTE name for SFRotation field named axisRotation.
  
  See Also:
  
  Constant Field Values
- toField_AXISROTATION
  
  public static final java.lang.String toField_AXISROTATION
  
  toField ROUTE name for SFRotation field named axisRotation.
  
  See Also:
  
  Constant Field Values
- fromField_DESCRIPTION
  
  public static final java.lang.String fromField_DESCRIPTION
  
  fromField ROUTE name for SFString field named description.
  
  See Also:
  
  Constant Field Values
- toField_DESCRIPTION
  
  public static final java.lang.String toField_DESCRIPTION
  
  toField ROUTE name for SFString field named description.
  
  See Also:
  
  Constant Field Values
- fromField_ENABLED
  
  public static final java.lang.String fromField_ENABLED
  
  fromField ROUTE name for SFBool field named enabled.
  
  See Also:
  
  Constant Field Values
- toField_ENABLED
  
  public static final java.lang.String toField_ENABLED
  
  toField ROUTE name for SFBool field named enabled.
  
  See Also:
  
  Constant Field Values
- fromField_IS
  
  public static final java.lang.String fromField_IS
  
  fromField ROUTE name for SFNode field named IS.
  
  See Also:
  
  Constant Field Values
- fromField_ISACTIVE
  
  public static final java.lang.String fromField_ISACTIVE
  
  fromField ROUTE name for SFBool field named isActive.
  
  See Also:
  
  Constant Field Values
- fromField_ISOVER
  
  public static final java.lang.String fromField_ISOVER
  
  fromField ROUTE name for SFBool field named isOver.
  
  See Also:
  
  Constant Field Values
- fromField_MAXPOSITION
  
  public static final java.lang.String fromField_MAXPOSITION
  
  fromField ROUTE name for SFVec2f field named maxPosition.
  
  See Also:
  
  Constant Field Values
- toField_MAXPOSITION
  
  public static final java.lang.String toField_MAXPOSITION
  
  toField ROUTE name for SFVec2f field named maxPosition.
  
  See Also:
  
  Constant Field Values
- fromField_METADATA
  
  public static final java.lang.String fromField_METADATA
  
  fromField ROUTE name for SFNode field named metadata.
  
  See Also:
  
  Constant Field Values
- toField_METADATA
  
  public static final java.lang.String toField_METADATA
  
  toField ROUTE name for SFNode field named metadata.
  
  See Also:
  
  Constant Field Values
- fromField_MINPOSITION
  
  public static final java.lang.String fromField_MINPOSITION
  
  fromField ROUTE name for SFVec2f field named minPosition.
  
  See Also:
  
  Constant Field Values
- toField_MINPOSITION
  
  public static final java.lang.String toField_MINPOSITION
  
  toField ROUTE name for SFVec2f field named minPosition.
  
  See Also:
  
  Constant Field Values
- fromField_OFFSET
  
  public static final java.lang.String fromField_OFFSET
  
  fromField ROUTE name for SFVec3f field named offset.
  
  See Also:
  
  Constant Field Values
- toField_OFFSET
  
  public static final java.lang.String toField_OFFSET
  
  toField ROUTE name for SFVec3f field named offset.
  
  See Also:
  
  Constant Field Values
- fromField_TRACKPOINT_CHANGED
  
  public static final java.lang.String fromField_TRACKPOINT_CHANGED
  
  fromField ROUTE name for SFVec3f field named trackPoint_changed.
  
  See Also:
  
  Constant Field Values
- fromField_TRANSLATION_CHANGED
  
  public static final java.lang.String fromField_TRANSLATION_CHANGED
  
  fromField ROUTE name for SFVec3f field named translation_changed.
  
  See Also:
  
  Constant Field Values
Constructor Details
- PlaneSensor
  
  public PlaneSensor()
  
  Constructor for PlaneSensor to initialize member variables with default values.
- PlaneSensor
  
  public PlaneSensor(java.lang.String DEFlabel)
  
  Utility constructor that assigns DEF label after initializing member variables with default values.
  
  Parameters:
  
  DEFlabel - unique DEF name for this X3D node
Method Details
- getElementName
  
  public final java.lang.String getElementName()
  
  Provides name of this element: PlaneSensor
  
  Specified by:
  
  getElementName in class X3DConcreteElement
  
  Returns:
  
  name of this element
- getComponent
  
  public final java.lang.String getComponent()
  
  Defines X3D component for the PlaneSensor element: PointingDeviceSensor
  
  Specified by:
  
  getComponent in class X3DConcreteElement
  
  Returns:
  
  X3D component for this element
- getComponentLevel
  
  public final int getComponentLevel()
  
  Provides default X3D component level for this element: 1
  
  Specified by:
  
  getComponentLevel in class X3DConcreteElement
  
  Returns:
  
  default X3D component level for this element
- getFieldType
  
  public java.lang.String getFieldType(java.lang.String fieldName)
  
  Indicate type corresponding to given fieldName.
  
  Specified by:
  
  getFieldType in class X3DConcreteElement
  
  Parameters:
  
  fieldName - name of field in this X3D node
  
  Returns:
  
  X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
  
  See Also:
  
  ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
- getAccessType
  
  public java.lang.String getAccessType(java.lang.String fieldName)
  
  Indicate accessType corresponding to given fieldName.
  
  Specified by:
  
  getAccessType in class X3DConcreteElement
  
  Parameters:
  
  fieldName - name of field in this X3D node
  
  Returns:
  
  X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
  
  See Also:
  
  ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
- getContainerFieldDefault
  
  public final java.lang.String getContainerFieldDefault()
  
  containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
  
  Specified by:
  
  getContainerFieldDefault in class X3DConcreteNode
  
  Returns:
  
  default containerField value
  
  See Also:
  
  X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
- initialize
  
  public final void initialize()
  
  Initialize all member variables to default values.
  
  Overrides:
  
  initialize in class X3DConcreteNode
- getAutoOffset
  
  public 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 PlaneSensor
  
  Specified by:
  
  getAutoOffset in interface X3DDragSensorNode
  
  Returns:
  
  value of autoOffset field
- setAutoOffset
  
  public PlaneSensor setAutoOffset(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named autoOffset.
  
  Tooltip: Determines whether previous offset values are remembered/accumulated. *
  
  Specified by:
  
  setAutoOffset in interface PlaneSensor
  
  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).
- setAutoOffset
  
  public PlaneSensor setAutoOffset(SFBool newValue)
  
  Assign typed object value to SFBool autoOffset field, similar to setAutoOffset(boolean).
  
  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
  
  public 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. *
  
  Specified by:
  
  getAxisRotation in interface PlaneSensor
  
  Returns:
  
  value of axisRotation field
- setAxisRotation
  
  public PlaneSensor setAxisRotation(float[] newValue)
  
  Accessor method to 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. *
  
  Specified by:
  
  setAxisRotation in interface PlaneSensor
  
  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).
- setAxisRotation
  
  public PlaneSensor setAxisRotation(SFRotation newValue)
  
  Assign typed object value to SFRotation axisRotation field, similar to setAxisRotation(float[]).
  
  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).
- setAxisRotation
  
  public PlaneSensor setAxisRotation(float x, float y, float z, float angleRadians)
  
  Assign values to SFRotation axisRotation field, similar to setAxisRotation(float[]).
  
  Parameters:
  
  x - first component of axis
  
  y - second component of axis
  
  z - third component of axis
  
  angleRadians - fourth component of rotation around axis
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setAxisRotation
  
  public PlaneSensor setAxisRotation(double x, double y, double z, double angleRadians)
  
  Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAxisRotation(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  angleRadians - fourth component
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setAxisRotation
  
  public PlaneSensor setAxisRotation(double[] newArray)
  
  Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAxisRotation(float[]).
  
  Parameters:
  
  newArray - is new value for field
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDescription
  
  public java.lang.String getDescription()
  Provide String value from inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose 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 PlaneSensor
  
  Specified by:
  
  getDescription in interface X3DDragSensorNode
  
  Specified by:
  
  getDescription in interface X3DPointingDeviceSensorNode
  
  Returns:
  
  value of description field
- setDescription
  
  public PlaneSensor setDescription(java.lang.String newValue)
  Accessor method to assign String value to inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose 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 PlaneSensor
  
  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).
- setDescription
  
  public PlaneSensor setDescription(SFString newValue)
  
  Assign typed object value to SFString description field, similar to setDescription(String).
  
  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
  
  public boolean getEnabled()
  
  Provide boolean value from inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  getEnabled in interface PlaneSensor
  
  Specified by:
  
  getEnabled in interface X3DDragSensorNode
  
  Specified by:
  
  getEnabled in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  getEnabled in interface X3DSensorNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  public PlaneSensor 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 PlaneSensor
  
  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).
- setEnabled
  
  public PlaneSensor setEnabled(SFBool newValue)
  
  Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
  
  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).
- getIS
  
  public IS getIS()
  
  Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
  
  Specified by:
  
  getIS in class X3DConcreteNode
  
  Returns:
  
  value of IS field
  
  See Also:
  
  X3D Tooltips: IS, X3D Tooltips: connect
- setIS
  
  public PlaneSensor setIS(IS newValue)
  
  Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
  
  Specified by:
  
  setIS in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the IS field.
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Tooltips: IS, X3D Tooltips: connect
- clearIS
  
  public PlaneSensor clearIS()
  
  Utility method to clear SFNode value of IS field.
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- hasIS
  
  public boolean hasIS()
  
  Indicate whether an object is available for inputOutput SFNode field IS.
  
  Returns:
  
  whether a concrete statement or CommentsBlock is available.
  
  See Also:
  
  getIS()
- getIsActive
  
  public 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, instead only use it a source for ROUTE events.
  Specified by:
  
  getIsActive in interface PlaneSensor
  
  Specified by:
  
  getIsActive in interface X3DDragSensorNode
  
  Specified by:
  
  getIsActive in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  getIsActive in interface X3DSensorNode
  
  Returns:
  
  value of isActive field
- getIsOver
  
  public 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, instead only use it a source for ROUTE events.
  Specified by:
  
  getIsOver in interface PlaneSensor
  
  Specified by:
  
  getIsOver in interface X3DDragSensorNode
  
  Specified by:
  
  getIsOver in interface X3DPointingDeviceSensorNode
  
  Returns:
  
  value of isOver field
- getMaxPosition
  
  public 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).
  Specified by:
  
  getMaxPosition in interface PlaneSensor
  
  Returns:
  
  value of maxPosition field
- setMaxPosition
  
  public PlaneSensor setMaxPosition(float[] newValue)
  Accessor method to 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).
  Specified by:
  
  setMaxPosition in interface PlaneSensor
  
  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).
- setMaxPosition
  
  public PlaneSensor setMaxPosition(SFVec2f newValue)
  
  Assign typed object value to SFVec2f maxPosition field, similar to setMaxPosition(float[]).
  
  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).
- setMaxPosition
  
  public PlaneSensor setMaxPosition(float x, float y)
  
  Assign values to SFVec2f maxPosition field, similar to setMaxPosition(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setMaxPosition
  
  public PlaneSensor setMaxPosition(double x, double y)
  
  Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setMaxPosition(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setMaxPosition
  
  public PlaneSensor setMaxPosition(double[] newArray)
  
  Utility method: double-precision set-array accessor for X3D floating-point type, similar to setMaxPosition(float[]).
  
  Parameters:
  
  newArray - is new value for field
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getMetadata
  
  public X3DMetadataObject getMetadata()
  
  Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Specified by:
  
  getMetadata in interface PlaneSensor
  
  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:
  
  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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata, X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  
  public PlaneSensor setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Specified by:
  
  setMetadata in interface PlaneSensor
  
  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
  
  Specified by:
  
  setMetadata in class X3DConcreteNode
  
  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:
  
  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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata, X3D Scene Authoring Hints: Metadata Nodes
- clearMetadata
  
  public PlaneSensor clearMetadata()
  
  Utility method to clear SFNode value of metadata field.
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- setMetadata
  
  public PlaneSensor setMetadata(ProtoInstance newValue)
  
  Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Specified by:
  
  setMetadata in class X3DConcreteNode
  
  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:
  
  setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)
- hasMetadata
  
  public boolean hasMetadata()
  
  Indicate whether an object is available for inputOutput SFNode field metadata.
  
  Returns:
  
  whether a properly typed node or ProtoInstance or CommentsBlock is available.
  
  See Also:
  
  getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
- getMinPosition
  
  public 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).
  Specified by:
  
  getMinPosition in interface PlaneSensor
  
  Returns:
  
  value of minPosition field
- setMinPosition
  
  public PlaneSensor setMinPosition(float[] newValue)
  Accessor method to 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).
  Specified by:
  
  setMinPosition in interface PlaneSensor
  
  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).
- setMinPosition
  
  public PlaneSensor setMinPosition(SFVec2f newValue)
  
  Assign typed object value to SFVec2f minPosition field, similar to setMinPosition(float[]).
  
  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).
- setMinPosition
  
  public PlaneSensor setMinPosition(float x, float y)
  
  Assign values to SFVec2f minPosition field, similar to setMinPosition(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setMinPosition
  
  public PlaneSensor setMinPosition(double x, double y)
  
  Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setMinPosition(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setMinPosition
  
  public PlaneSensor setMinPosition(double[] newArray)
  
  Utility method: double-precision set-array accessor for X3D floating-point type, similar to setMinPosition(float[]).
  
  Parameters:
  
  newArray - is new value for field
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getOffset
  
  public 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.
  Specified by:
  
  getOffset in interface PlaneSensor
  
  Returns:
  
  value of offset field
- setOffset
  
  public PlaneSensor setOffset(float[] newValue)
  Accessor method to 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.
  Specified by:
  
  setOffset in interface PlaneSensor
  
  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).
- setOffset
  
  public PlaneSensor setOffset(SFVec3f newValue)
  
  Assign typed object value to SFVec3f offset field, similar to setOffset(float[]).
  
  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).
- setOffset
  
  public PlaneSensor setOffset(float x, float y, float z)
  
  Assign values to SFVec3f offset field, similar to setOffset(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setOffset
  
  public PlaneSensor setOffset(double x, double y, double z)
  
  Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setOffset(float[]).
  
  Parameters:
  
  x - first component
  
  y - second component
  
  z - third component
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setOffset
  
  public PlaneSensor setOffset(double[] newArray)
  
  Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOffset(float[]).
  
  Parameters:
  
  newArray - is new value for field
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getTrackPoint
  
  public 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, instead only use it a source for ROUTE events.
  
  Warning: trackPoint_changed events represent unclamped intersection points on plane surface. Browsers can interpret drags off of the surface in various ways. Note that translation_changed events are clamped by minPosition/maxPosition and thus may be preferable.
  Specified by:
  
  getTrackPoint in interface PlaneSensor
  
  Specified by:
  
  getTrackPoint in interface X3DDragSensorNode
  
  Returns:
  
  value of trackPoint_changed field
- getTranslation
  
  public 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, instead only use it a source for ROUTE events.
  Specified by:
  
  getTranslation in interface PlaneSensor
  
  Returns:
  
  value of translation_changed field
- getDEF
  
  public java.lang.String getDEF()
  Provide String value from 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  Overrides:
  
  getDEF in class X3DConcreteNode
  
  Returns:
  
  value of DEF field
  
  See Also:
  
  X3D Scene Authoring Hints: Naming Conventions
- setDEF
  
  public final PlaneSensor setDEF(java.lang.String newValue)
  Accessor method to 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  
  Note that setting the DEF value clears the USE value.
  Specified by:
  
  setDEF in class X3DConcreteNode
  
  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).
- setDEF
  
  public PlaneSensor setDEF(SFString newValue)
  
  Assign typed object value to SFString DEF field, similar to setDEF(String).
  
  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).
- getUSE
  
  public java.lang.String getUSE()
  Provide String value from 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.
  Overrides:
  
  getUSE in class X3DConcreteNode
  
  Returns:
  
  value of USE field
  
  See Also:
  
  X3D Scene Authoring Hints: Naming Conventions
- setUSE
  
  public final PlaneSensor setUSE(java.lang.String newValue)
  Accessor method to 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 class X3DConcreteNode
  
  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).
- setUSE
  
  public PlaneSensor setUSE(SFString newValue)
  
  Assign typed object value to SFString USE field, similar to setUSE(String).
  
  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).
- getCssClass
  
  public java.lang.String getCssClass()
  Provide String value from inputOutput SFString field named class.
  
  Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
  
  Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
  Overrides:
  
  getCssClass in class X3DConcreteNode
  
  Returns:
  
  value of class field
  
  See Also:
  
  W3C Cascading Style Sheets
- setCssClass
  
  public final PlaneSensor setCssClass(java.lang.String newValue)
  Accessor method to assign String value to inputOutput SFString field named class.
  
  Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
  
  Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
  Specified by:
  
  setCssClass in class X3DConcreteNode
  
  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).
  
  See Also:
  
  W3C Cascading Style Sheets
- setCssClass
  
  public PlaneSensor setCssClass(SFString newValue)
  
  Assign typed object value to SFString cssClass field, similar to setCssClass(String).
  
  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).
- setUSE
  
  public PlaneSensor setUSE(PlaneSensor DEFnode)
  
  Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
  
  Warning: note that 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.
  
  Parameters:
  
  DEFnode - must have a DEF value defined
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addComments
  
  public PlaneSensor addComments(java.lang.String newComment)
  
  Add comment as String to contained commentsList.
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newComment - initial value
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addComments
  
  public PlaneSensor addComments(java.lang.String[] newComments)
  
  Add comments as String[] array to contained commentsList.
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newComments - array of comments
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addComments
  
  public PlaneSensor addComments(CommentsBlock newCommentsBlock)
  
  Add CommentsBlock to contained commentsList.
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newCommentsBlock - block of comments to add
  
  Returns:
  
  PlaneSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- toStringX3D
  
  public java.lang.String toStringX3D(int indentLevel)
  
  Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
  
  Specified by:
  
  toStringX3D in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  X3D string
  
  See Also:
  
  X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
- toStringClassicVRML
  
  public java.lang.String toStringClassicVRML(int indentLevel)
  
  Recursive method to provide ClassicVRML string serialization.
  
  Specified by:
  
  toStringClassicVRML in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  ClassicVRML string
  
  See Also:
  
  X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
- toStringVRML97
  
  public java.lang.String toStringVRML97(int indentLevel)
  
  Recursive method to provide VRML97 string serialization.
  
  Specified by:
  
  toStringVRML97 in class X3DConcreteElement
  
  Parameters:
  
  indentLevel - number of levels of indentation for this element
  
  Returns:
  
  VRML97 string
  
  See Also:
  
  X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
- findElementByNameValue
  
  public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
  
  Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
  
  Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
  
  Warning: more than one element may be found that has the same name, this method does not handle that case.
  
  Specified by:
  
  findElementByNameValue in class X3DConcreteElement
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  object reference to found element, null otherwise
  
  See Also:
  
  findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
- findElementByNameValue
  
  public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
  
  Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
  
  Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
  
  Warning: more than one element may be found that has the same name, this method does not handle that case.
  
  Specified by:
  
  findElementByNameValue in class X3DConcreteElement
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
  
  Returns:
  
  object reference to found element, null otherwise
  
  See Also:
  
  findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
- hasElementByNameValue
  
  public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
  
  Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
  
  Parameters:
  
  nameValue - is value of the name field being searched for in this element and child elements(if any)
  
  elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
  
  Returns:
  
  whether node is found
  
  See Also:
  
  findElementByNameValue(String, String)
- findNodeByDEF
  
  public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
  
  Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
  
  Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
  
  Warning: more than one element may be found that has the same DEF, this method does not handle that case.
  
  Specified by:
  
  findNodeByDEF in class X3DConcreteElement
  
  Parameters:
  
  DEFvalue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  object reference to found node, null otherwise
  
  See Also:
  
  findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
- hasNodeByDEF
  
  public boolean hasNodeByDEF(java.lang.String DEFvalue)
  
  Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
  
  Parameters:
  
  DEFvalue - is value of the name field being searched for in this element and child elements(if any)
  
  Returns:
  
  whether node is found
  
  See Also:
  
  findNodeByDEF(String)
- validate
  
  public java.lang.String validate()
  
  Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
  
  Specified by:
  
  validate in class X3DConcreteElement
  
  Returns:
  
  validation results (if any)

Class PlaneSensor