java.lang.Object

org.web3d.x3d.jsail.PointingDeviceSensor.TouchSensorObject

All Implemented Interfaces:: X3DChildNode, X3DNode, X3DSensorNode, TouchSensor, X3DPointingDeviceSensorNode, X3DTouchSensorNode

public class TouchSensorObject
extends X3DConcreteNode
implements TouchSensor

TouchSensor tracks location and state of the pointing device, detecting when a user points at or selects (activates) geometry.

X3D node tooltip: [X3DTouchSensorNode] TouchSensor tracks location and state of the pointing device, detecting when a user points at or selects (activates) geometry.

Hint: this sensor detects user interactions affecting peer nodes and their child geometry.
Hint: X3D Architecture 20.2.1 Overview of pointing device sensors https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#OverviewOfPointingDeviceSensors
Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#Activatingandmanipulating
Hint: example scenes and authoring assets at http://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: TouchSensor, X3D Tooltips: TouchSensor, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`COMPONENT`	String constant COMPONENT defines X3D component for the TouchSensor 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_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_HITNORMAL_CHANGED`	fromField ROUTE name for SFVec3f field named hitNormal_changed.
`static java.lang.String`	`fromField_HITPOINT_CHANGED`	fromField ROUTE name for SFVec3f field named hitPoint_changed.
`static java.lang.String`	`fromField_HITTEXCOORD_CHANGED`	fromField ROUTE name for SFVec2f field named hitTexCoord_changed.
`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_METADATA`	fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_TOUCHTIME`	fromField ROUTE name for SFTime field named touchTime.
`static ISObject`	`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 X3DMetadataObject`	`METADATA_DEFAULT_VALUE`	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
`static java.lang.String`	`NAME`	String constant NAME provides name of this element: TouchSensor.
`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_METADATA`	toField ROUTE name for SFNode field named metadata.

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
`TouchSensorObject()`	Constructor for TouchSensorObject to initialize member variables with default values.
`TouchSensorObject(java.lang.String DEFlabel)`	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
`TouchSensorObject`	`addComments(java.lang.String newComment)`	Add comment as String to contained commentsList.
`TouchSensorObject`	`addComments(java.lang.String[] newComments)`	Add comments as String[] array to contained commentsList.
`TouchSensorObject`	`addComments(CommentsBlock newCommentsBlock)`	Add CommentsBlock to contained commentsList.
`TouchSensorObject`	`clearIS()`	Utility method to clear SFNode value of IS field.
`TouchSensorObject`	`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.
`java.lang.String`	`getComponent()`	Defines X3D component for the TouchSensor 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: TouchSensor
`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.
`float[]`	`getHitNormal()`	Provide array of 3-tuple float results from outputOnly SFVec3f field named hitNormal_changed.
`float[]`	`getHitPoint()`	Provide array of 3-tuple float results from outputOnly SFVec3f field named hitPoint_changed.
`float[]`	`getHitTexCoord()`	Provide array of 2-tuple float results from outputOnly SFVec2f field named hitTexCoord_changed.
`ISObject`	`getIS()`	Provide ISObject 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.
`X3DMetadataObject`	`getMetadata()`	Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`double`	`getTouchTime()`	Provide double value in seconds from outputOnly SFTime field named touchTime.
`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.
`TouchSensorObject`	`setCssClass(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named class.
`TouchSensorObject`	`setCssClass(SFStringObject newValue)`	Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`TouchSensorObject`	`setDEF(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named DEF.
`TouchSensorObject`	`setDEF(SFStringObject newValue)`	Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`TouchSensorObject`	`setDescription(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named description.
`TouchSensorObject`	`setDescription(SFStringObject newValue)`	Assign typed object value to SFString description field, similar to `setDescription(String)`.
`TouchSensorObject`	`setEnabled(boolean newValue)`	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
`TouchSensorObject`	`setEnabled(SFBoolObject newValue)`	Assign typed object value to SFBool enabled field, similar to `setEnabled(boolean)`.
`TouchSensorObject`	`setIS(ISObject newValue)`	Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
`TouchSensorObject`	`setMetadata(ProtoInstanceObject newValue)`	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`TouchSensorObject`	`setMetadata(X3DMetadataObject newValue)`	Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`TouchSensorObject`	`setUSE(java.lang.String newValue)`	Accessor method to assign String value to inputOutput SFString field named USE.
`TouchSensorObject`	`setUSE(SFStringObject newValue)`	Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`TouchSensorObject`	`setUSE(TouchSensorObject 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

clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, 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: TouchSensor.
  
  See Also:
  
  Constant Field Values
- COMPONENT
  
  public static final java.lang.String COMPONENT
  
  String constant COMPONENT defines X3D component for the TouchSensor 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
- 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 ISObject IS_DEFAULT_VALUE
  
  SFNode field named IS has default value null (Java syntax) or NULL (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).
- 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_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_HITNORMAL_CHANGED
  
  public static final java.lang.String fromField_HITNORMAL_CHANGED
  
  fromField ROUTE name for SFVec3f field named hitNormal_changed.
  
  See Also:
  
  Constant Field Values
- fromField_HITPOINT_CHANGED
  
  public static final java.lang.String fromField_HITPOINT_CHANGED
  
  fromField ROUTE name for SFVec3f field named hitPoint_changed.
  
  See Also:
  
  Constant Field Values
- fromField_HITTEXCOORD_CHANGED
  
  public static final java.lang.String fromField_HITTEXCOORD_CHANGED
  
  fromField ROUTE name for SFVec2f field named hitTexCoord_changed.
  
  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_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_TOUCHTIME
  
  public static final java.lang.String fromField_TOUCHTIME
  
  fromField ROUTE name for SFTime field named touchTime.
  
  See Also:
  
  Constant Field Values
Constructor Details
- TouchSensorObject
  
  public TouchSensorObject()
  
  Constructor for TouchSensorObject to initialize member variables with default values.
- TouchSensorObject
  
  public TouchSensorObject(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: TouchSensor
  
  Specified by:
  
  getElementName in class X3DConcreteElement
  
  Returns:
  
  name of this element
- getComponent
  
  public final java.lang.String getComponent()
  
  Defines X3D component for the TouchSensor 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
- 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 TouchSensor
  
  Specified by:
  
  getDescription in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  getDescription in interface X3DTouchSensorNode
  
  Returns:
  
  value of description field
- setDescription
  
  public TouchSensorObject 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 TouchSensor
  
  Specified by:
  
  setDescription in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  setDescription in interface X3DTouchSensorNode
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setDescription
  
  public TouchSensorObject setDescription(SFStringObject newValue)
  
  Assign typed object value to SFString description field, similar to setDescription(String).
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  TouchSensorObject - 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 TouchSensor
  
  Specified by:
  
  getEnabled in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  getEnabled in interface X3DSensorNode
  
  Specified by:
  
  getEnabled in interface X3DTouchSensorNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  public TouchSensorObject 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 TouchSensor
  
  Specified by:
  
  setEnabled in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  setEnabled in interface X3DSensorNode
  
  Specified by:
  
  setEnabled in interface X3DTouchSensorNode
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setEnabled
  
  public TouchSensorObject setEnabled(SFBoolObject newValue)
  
  Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getHitNormal
  
  public float[] getHitNormal()
  Provide array of 3-tuple float results from outputOnly SFVec3f field named hitNormal_changed.
  
  Tooltip: When pointing device selects geometry, send event containing surface normal vector at the hitPoint.
  
  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:
  
  getHitNormal in interface TouchSensor
  
  Returns:
  
  value of hitNormal_changed field
- getHitPoint
  
  public float[] getHitPoint()
  Provide array of 3-tuple float results from outputOnly SFVec3f field named hitPoint_changed.
  
  Tooltip: When pointing device selects geometry, send event containing 3D point on surface of underlying geometry, as measured in reference frame for TouchSensor's local coordinate system.
  
  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:
  
  getHitPoint in interface TouchSensor
  
  Returns:
  
  value of hitPoint_changed field
- getHitTexCoord
  
  public float[] getHitTexCoord()
  Provide array of 2-tuple float results from outputOnly SFVec2f field named hitTexCoord_changed.
  
  Tooltip: When pointing device selects geometry, send event containing texture coordinates of surface at the hitPoint.
  
  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:
  
  getHitTexCoord in interface TouchSensor
  
  Returns:
  
  value of hitTexCoord_changed field
- getIS
  
  public ISObject getIS()
  
  Provide ISObject 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 TouchSensorObject setIS(ISObject newValue)
  
  Accessor method to assign ISObject 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:
  
  TouchSensorObject - 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 TouchSensorObject clearIS()
  
  Utility method to clear SFNode value of IS field.
  
  Returns:
  
  TouchSensorObject - 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 pointing device selection is activated, output event isActive=false is sent when pointing device is deselected.
  
  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 TouchSensor
  
  Specified by:
  
  getIsActive in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  getIsActive in interface X3DSensorNode
  
  Specified by:
  
  getIsActive in interface X3DTouchSensorNode
  
  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 TouchSensor
  
  Specified by:
  
  getIsOver in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  getIsOver in interface X3DTouchSensorNode
  
  Returns:
  
  value of isOver field
- getMetadata
  
  public X3DMetadataObject getMetadata()
  
  Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Specified by:
  
  getMetadata in interface TouchSensor
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Specified by:
  
  getMetadata in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  getMetadata in interface X3DSensorNode
  
  Specified by:
  
  getMetadata in interface X3DTouchSensorNode
  
  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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata, X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  
  public TouchSensorObject setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Specified by:
  
  setMetadata in interface TouchSensor
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DPointingDeviceSensorNode
  
  Specified by:
  
  setMetadata in interface X3DSensorNode
  
  Specified by:
  
  setMetadata in interface X3DTouchSensorNode
  
  Specified by:
  
  setMetadata in class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  TouchSensorObject - 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata, X3D Scene Authoring Hints: Metadata Nodes
- clearMetadata
  
  public TouchSensorObject clearMetadata()
  
  Utility method to clear SFNode value of metadata field.
  
  Returns:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- setMetadata
  
  public TouchSensorObject setMetadata(ProtoInstanceObject 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:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  setMetadata(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
- getTouchTime
  
  public double getTouchTime()
  Provide double value in seconds from outputOnly SFTime field named touchTime.
  
  Tooltip: Time event generated when sensor is touched by pointing device, and then deselected by the user.
  
  Hint: touchTime event is generated when following three conditions are all met: (a) pointing device was pointing towards geometry when initially activated (isActive=true), (b) pointing device is currently pointing towards the geometry (isOver=true), and (c) pointing device selection is deactivated/deselected by user (isActive=false event is also generated).
  
  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:
  
  getTouchTime in interface TouchSensor
  
  Specified by:
  
  getTouchTime in interface X3DTouchSensorNode
  
  Returns:
  
  value of touchTime 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 TouchSensorObject 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:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setDEF
  
  public TouchSensorObject setDEF(SFStringObject newValue)
  
  Assign typed object value to SFString DEF field, similar to setDEF(String).
  
  Parameters:
  
  newValue - is new value for the DEF field.
  
  Returns:
  
  TouchSensorObject - 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 TouchSensorObject 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:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUSE
  
  public TouchSensorObject setUSE(SFStringObject newValue)
  
  Assign typed object value to SFString USE field, similar to setUSE(String).
  
  Parameters:
  
  newValue - is new value for the USE field.
  
  Returns:
  
  TouchSensorObject - 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 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
  Overrides:
  
  getCssClass in class X3DConcreteNode
  
  Returns:
  
  value of class field
  
  See Also:
  
  W3C Cascading Style Sheets
- setCssClass
  
  public final TouchSensorObject 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 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 class X3DConcreteNode
  
  Parameters:
  
  newValue - is new value for the class field.
  
  Returns:
  
  TouchSensorObject - 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 TouchSensorObject setCssClass(SFStringObject newValue)
  
  Assign typed object value to SFString cssClass field, similar to setCssClass(String).
  
  Parameters:
  
  newValue - is new value for the class field.
  
  Returns:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- setUSE
  
  public TouchSensorObject setUSE(TouchSensorObject 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:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addComments
  
  public TouchSensorObject addComments(java.lang.String newComment)
  
  Add comment as String to contained commentsList.
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newComment - initial value
  
  Returns:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addComments
  
  public TouchSensorObject 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:
  
  TouchSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
- addComments
  
  public TouchSensorObject addComments(CommentsBlock newCommentsBlock)
  
  Add CommentsBlock to contained commentsList.
  
  Specified by:
  
  addComments in class X3DConcreteElement
  
  Parameters:
  
  newCommentsBlock - block of comments to add
  
  Returns:
  
  TouchSensorObject - 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:
  
  X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.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:
  
  X3DObject.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:
  
  X3DObject.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
- 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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
- 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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
- 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 TouchSensorObject