Interface X3DEnvironmentalSensorNode
- All Superinterfaces:
X3DChildNode
,X3DNode
,X3DSensorNode
- All Known Subinterfaces:
GeoProximitySensor
,ProximitySensor
,TransformSensor
,VisibilitySensor
- All Known Implementing Classes:
GeoProximitySensor
,ProximitySensor
,TransformSensor
,VisibilitySensor
public interface X3DEnvironmentalSensorNode extends X3DSensorNode
Base type for the environmental sensor nodes ProximitySensor, TransformSensor and VisibilitySensor.
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 boolean
getEnabled()
Provide boolean value from inputOutput SFBool field named enabled.boolean
getIsActive()
Provide boolean value from outputOnly SFBool field named isActive.X3DMetadataObject
getMetadata()
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float[]
getSize()
Provide array of 3-tuple float results within allowed range of [0,infinity) from initializeOnly SFVec3f field named size.X3DEnvironmentalSensorNode
setEnabled(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named enabled.X3DEnvironmentalSensorNode
setMetadata(X3DMetadataObject newValue)
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.X3DEnvironmentalSensorNode
setSize(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named size.
-
Method Details
-
getEnabled
boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.- 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 interfaceX3DSensorNode
- Parameters:
newValue
- is new value for the enabled field.- Returns:
X3DEnvironmentalSensorNode
- 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 interfaceX3DSensorNode
- Returns:
- value of isActive 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 interfaceX3DSensorNode
- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
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 interfaceX3DSensorNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
X3DEnvironmentalSensorNode
- 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
-
getSize
float[] getSize()Provide array of 3-tuple float results within allowed range of [0,infinity) from initializeOnly SFVec3f field named size.- Returns:
- value of size field
-
setSize
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named size.- Parameters:
newValue
- is new value for the size field.- Returns:
X3DEnvironmentalSensorNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-