Interface X3DPointingDeviceSensorNode
- All Superinterfaces:
X3DChildNode,X3DNode,X3DSensorNode
- All Known Subinterfaces:
CylinderSensor,GeoTouchSensor,PlaneSensor,SphereSensor,TouchSensor,X3DDragSensorNode,X3DTouchSensorNode
- All Known Implementing Classes:
CylinderSensorObject,GeoTouchSensorObject,PlaneSensorObject,SphereSensorObject,TouchSensorObject
public interface X3DPointingDeviceSensorNode extends X3DSensorNode
Base type for all pointing device sensors.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description java.lang.StringgetDescription()Provide String value from inputOutput SFString field named description.booleangetEnabled()Provide boolean value from inputOutput SFBool field named enabled.booleangetIsActive()Provide boolean value from outputOnly SFBool field named isActive.booleangetIsOver()Provide boolean value from outputOnly SFBool field named isOver.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.X3DPointingDeviceSensorNodesetDescription(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named description.X3DPointingDeviceSensorNodesetEnabled(boolean newValue)Accessor method to assign boolean value to inputOutput SFBool field named enabled.X3DPointingDeviceSensorNodesetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
-
Method Details
-
getDescription
java.lang.String getDescription()Provide String value from inputOutput SFString field named description.- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.- Parameters:
newValue- is new value for the description field.- Returns:
X3DPointingDeviceSensorNode- 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:
getEnabledin interfaceX3DSensorNode- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.- Specified by:
setEnabledin interfaceX3DSensorNode- Parameters:
newValue- is new value for the enabled field.- Returns:
X3DPointingDeviceSensorNode- 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:
getIsActivein interfaceX3DSensorNode- Returns:
- value of isActive field
-
getIsOver
boolean getIsOver()Provide boolean value from outputOnly SFBool field named isOver.- Returns:
- value of isOver field
-
getMetadata
X3DMetadataObject getMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadatain interfaceX3DChildNode- Specified by:
getMetadatain interfaceX3DNode- Specified by:
getMetadatain interfaceX3DSensorNode- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadatain interfaceX3DChildNode- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain interfaceX3DSensorNode- Parameters:
newValue- is new value for the metadata field.- Returns:
X3DPointingDeviceSensorNode- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-