org.web3d.x3d.sai.EnvironmentalSensor

Interface X3DEnvironmentalSensorNode

All Superinterfaces:

X3DChildNode, X3DNode, X3DSensorNode

All Known Subinterfaces:

GeoProximitySensor, ProximitySensor, TransformSensor, VisibilitySensor

All Known Implementing Classes:

GeoProximitySensorObject, ProximitySensorObject, TransformSensorObject, VisibilitySensorObject

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).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: TODO, X3D Tooltips, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method and 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 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	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
X3DEnvironmentalSensorNode	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
X3DEnvironmentalSensorNode	setEnabled(boolean newValue) Assign boolean value to inputOutput SFBool field named enabled.
X3DEnvironmentalSensorNode	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DEnvironmentalSensorNode	setSize(float[] newValue) Assign 3-tuple float array within allowed range of [0,infinity) to initializeOnly SFVec3f field named size.
X3DEnvironmentalSensorNode	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getEnabled

boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Specified by:

getEnabled in interface X3DSensorNode

Returns:

value of enabled field

setEnabled

X3DEnvironmentalSensorNode setEnabled(boolean newValue)

Assign boolean value to inputOutput SFBool field named enabled.

Specified by:

setEnabled in interface X3DSensorNode

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 interface X3DSensorNode

Returns:

value of isActive field

getMetadata

X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DSensorNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

X3DEnvironmentalSensorNode setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DSensorNode

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

X3DEnvironmentalSensorNode setSize(float[] newValue)

Assign 3-tuple float array within allowed range of [0,infinity) 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).

setDEF

X3DEnvironmentalSensorNode setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DChildNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface X3DSensorNode

Parameters:

newValue - is new value for the DEF field.

Returns:

X3DEnvironmentalSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

X3DEnvironmentalSensorNode setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

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 interface X3DChildNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in interface X3DSensorNode

Parameters:

newValue - is new value for the USE field.

Returns:

X3DEnvironmentalSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCssClass

X3DEnvironmentalSensorNode setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in interface X3DChildNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface X3DSensorNode

Parameters:

newValue - is new value for the class field.

Returns:

X3DEnvironmentalSensorNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).