Package org.web3d.vrml.renderer.common.nodes.environment

Class BaseProximitySensor

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.BaseSensorNode

org.web3d.vrml.renderer.common.nodes.environment.BaseProximitySensor

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLEnvironmentalSensorNodeType, VRMLNodeType, VRMLSensorNodeType, VRMLTimeDependentNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRProximitySensor, OGLProximitySensor

public abstract class BaseProximitySensor
extends BaseSensorNode
implements VRMLEnvironmentalSensorNodeType, VRMLTimeDependentNodeType

Common base implementation of a ProximitySensor node.

Version:

$Revision: 1.8 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_CENTER	The field index for center
protected static final int	FIELD_CENTEROFROTATION_CHANGED	The field index for centerOfRotation_changed
protected static final int	FIELD_ENABLED	The field index for enabled
protected static final int	FIELD_ENTER_TIME	The field index for enterTime
protected static final int	FIELD_EXIT_TIME	The field index for exitTime
protected static final int	FIELD_IS_ACTIVE	The field index for isActive
protected static final int	FIELD_ORIENTATION_CHANGED	The field index for orientation_changed
protected static final int	FIELD_POSITION_CHANGED	The field index for position_changed
protected static final int	FIELD_SIZE	The field index for size
protected static final int	LAST_PROXIMITYSENSOR_INDEX	The last field index used by this class
protected float[]	vfCenter	The value of the center field
protected float[]	vfCenterOfRotationChanged	The value of the centerOfRotation_changed field
protected double	vfEnterTime	The value of the enterTime field
protected double	vfExitTime	The value of the exitTime field
protected float[]	vfOrientationChanged	The value of the orientation_changed field
protected float[]	vfPositionChanged	The value of the position_changed field
protected float[]	vfSize	The value of the size field
protected VRMLClock	vrmlClock	The sim clock this node uses

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseSensorNode

LAST_SENSOR_INDEX, vfEnabled, vfIsActive

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Constructor	Description
BaseProximitySensor()	Construct a new proximity sensor object
BaseProximitySensor(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
int	getPrimaryType()	Get the primary type of this node.
int[]	getSecondaryType()	Get the secondary type of this node.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
protected void	setCenter(float[] val)	Update the center of the sensor.
protected void	setSize(float[] val)	Update the size of the sensor.
void	setValue(int index, boolean value)	Set the value of the field at the given index as a boolean.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.
void	setVRMLClock(VRMLClock clk)	Set the vrmlClock that this time dependent node will be running with.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.BaseSensorNode

copy, getEnabled, getIsActive, setEnabled

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

allEventsComplete

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Methods inherited from interface org.web3d.vrml.nodes.VRMLSensorNodeType

getEnabled, getIsActive, setEnabled

Field Details

FIELD_CENTER

protected static final int FIELD_CENTER

The field index for center

See Also:

• Constant Field Values

FIELD_SIZE

protected static final int FIELD_SIZE

The field index for size

See Also:

• Constant Field Values

FIELD_ENABLED

protected static final int FIELD_ENABLED

The field index for enabled

See Also:

• Constant Field Values

FIELD_IS_ACTIVE

protected static final int FIELD_IS_ACTIVE

The field index for isActive

See Also:

• Constant Field Values

FIELD_POSITION_CHANGED

protected static final int FIELD_POSITION_CHANGED

The field index for position_changed

See Also:

• Constant Field Values

FIELD_ORIENTATION_CHANGED

protected static final int FIELD_ORIENTATION_CHANGED

The field index for orientation_changed

See Also:

• Constant Field Values

FIELD_CENTEROFROTATION_CHANGED

protected static final int FIELD_CENTEROFROTATION_CHANGED

The field index for centerOfRotation_changed

See Also:

• Constant Field Values

FIELD_ENTER_TIME

protected static final int FIELD_ENTER_TIME

The field index for enterTime

See Also:

• Constant Field Values

FIELD_EXIT_TIME

protected static final int FIELD_EXIT_TIME

The field index for exitTime

See Also:

• Constant Field Values

LAST_PROXIMITYSENSOR_INDEX

protected static final int LAST_PROXIMITYSENSOR_INDEX

The last field index used by this class

See Also:

• Constant Field Values

vfCenter

protected float[] vfCenter

The value of the center field

vfSize

protected float[] vfSize

The value of the size field

vfCenterOfRotationChanged

protected float[] vfCenterOfRotationChanged

The value of the centerOfRotation_changed field

vfPositionChanged

protected float[] vfPositionChanged

The value of the position_changed field

vfOrientationChanged

protected float[] vfOrientationChanged

The value of the orientation_changed field

vfEnterTime

protected double vfEnterTime

The value of the enterTime field

vfExitTime

protected double vfExitTime

The value of the exitTime field

vrmlClock

protected VRMLClock vrmlClock

The sim clock this node uses

Constructor Details

BaseProximitySensor

public BaseProximitySensor()

Construct a new proximity sensor object

BaseProximitySensor

public BaseProximitySensor(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not the right type, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the right type

Method Details

setVRMLClock

public void setVRMLClock(VRMLClock clk)

Set the vrmlClock that this time dependent node will be running with.

Specified by:

setVRMLClock in interface VRMLTimeDependentNodeType

Parameters:

clk - The vrmlClock to use for this node

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Specified by:

getFieldIndex in interface VRMLNode

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Specified by:

getNodeFieldIndices in interface VRMLNode

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Specified by:

getFieldDeclaration in interface VRMLNode

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

getSecondaryType

public int[] getSecondaryType()

Get the secondary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getSecondaryType in interface VRMLNode

Overrides:

getSecondaryType in class AbstractNode

Returns:

The secondary type

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class BaseSensorNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class BaseSensorNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 boolean value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a boolean. This is be used to set SFBool field types isActive, enabled and loop.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class BaseSensorNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The field value is not legal for the field specified.

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an array of floats. This would be used to set MFFloat, SFVec2f, SFVec3f and SFRotation field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setSize

protected void setSize(float[] val)

Update the size of the sensor. May be overridden by derived classes but should make sure to call this as well

Parameters:

val - The new size to use

setCenter

protected void setCenter(float[] val)

Update the center of the sensor. May be overridden by derived classes but should make sure to call this as well

Parameters:

val - The new center to use