Interface X3DTouchSensorNode
- All Superinterfaces:
X3DChildNode
,X3DNode
,X3DPointingDeviceSensorNode
,X3DSensorNode
- All Known Subinterfaces:
GeoTouchSensor
,TouchSensor
- All Known Implementing Classes:
GeoTouchSensor
,TouchSensor
Base type for all touch-style pointing device sensors.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionProvide String value from inputOutput SFString field named description.boolean
Provide boolean value from inputOutput SFBool field named enabled.boolean
Provide boolean value from outputOnly SFBool field named isActive.boolean
Provide boolean value from outputOnly SFBool field named isOver.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.double
Provide double value in seconds from outputOnly SFTime field named touchTime.setDescription
(String newValue) Accessor method to assign String value to inputOutput SFString field named description.setEnabled
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named enabled.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
-
Method Details
-
getDescription
String getDescription()Provide String value from inputOutput SFString field named description.- Specified by:
getDescription
in interfaceX3DPointingDeviceSensorNode
- Specified by:
getDescription
in interfaceX3DSensorNode
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.- Specified by:
setDescription
in interfaceX3DPointingDeviceSensorNode
- Specified by:
setDescription
in interfaceX3DSensorNode
- Parameters:
newValue
- is new value for the description field.- Returns:
X3DTouchSensorNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getEnabled
boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.- Specified by:
getEnabled
in interfaceX3DPointingDeviceSensorNode
- Specified by:
getEnabled
in interfaceX3DSensorNode
- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.- Specified by:
setEnabled
in interfaceX3DPointingDeviceSensorNode
- Specified by:
setEnabled
in interfaceX3DSensorNode
- Parameters:
newValue
- is new value for the enabled field.- Returns:
X3DTouchSensorNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIsActive
boolean getIsActive()Provide boolean value from outputOnly SFBool field named isActive.- Specified by:
getIsActive
in interfaceX3DPointingDeviceSensorNode
- Specified by:
getIsActive
in interfaceX3DSensorNode
- Returns:
- value of isActive field
-
getIsOver
boolean getIsOver()Provide boolean value from outputOnly SFBool field named isOver.- Specified by:
getIsOver
in interfaceX3DPointingDeviceSensorNode
- Returns:
- value of isOver field
-
getMetadata
X3DMetadataObject getMetadata()Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DPointingDeviceSensorNode
- Specified by:
getMetadata
in interfaceX3DSensorNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
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 interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DPointingDeviceSensorNode
- Specified by:
setMetadata
in interfaceX3DSensorNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
X3DTouchSensorNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getTouchTime
double getTouchTime()Provide double value in seconds from outputOnly SFTime field named touchTime.- Returns:
- value of touchTime field
-