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

Class BasePlaneSensor

java.lang.Object

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

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

org.web3d.vrml.renderer.common.nodes.BaseDragSensorNode

org.web3d.vrml.renderer.common.nodes.sensor.BasePlaneSensor

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLDragSensorNodeType, VRMLNodeType, VRMLPointingDeviceSensorNodeType, VRMLSensorNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRPlaneSensor, OGLPlaneSensor

public abstract class BasePlaneSensor
extends BaseDragSensorNode

Implementation of a PlaneSensor node.

Version:

$Revision: 1.14 $

Author:

Alan Hudson, Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_AXIS_ROTATION	The field index for axisRotation
protected static final int	FIELD_MAXPOSITION	The field index for maxPosition
protected static final int	FIELD_MINPOSITION	The field index for minPosition
protected static final int	FIELD_OFFSET	The field index for offset
protected static final int	FIELD_TRANSLATION_CHANGED	The field index for translation_changed
protected static final int	LAST_PLANESENSOR_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected float[]	vfAxisRotation	The value of the axisRotation field
protected float[]	vfMaxPosition	The value of the maxPosition field
protected float[]	vfMinPosition	The value of the minPosition field
protected float[]	vfOffset	The value of the offset field
protected float[]	vfTranslationChanged	The value of the translation_changed field

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

FIELD_AUTOOFFSET, FIELD_DESCRIPTION, FIELD_IS_OVER, FIELD_TRACKPOINT_CHANGED, initialPosition, intersectionUtils, LAST_DRAG_SENSOR_INDEX, vfAutoOffset, vfDescription, vfIsOver, vfTrackPointChanged, wkPoint

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

FIELD_ENABLED, FIELD_IS_ACTIVE, 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
BasePlaneSensor()	Construct a new time sensor object
BasePlaneSensor(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.
void	notifySensorDragEnd(float[] position, float[] direction)	Notification that this sensor has finished a drag action.
protected void	processDrag(float[] location, float[] direction)	Convenience method to generate the tracking output based on the input hit position.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as a float array.

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

copy, getAutoOffset, getDescription, getIsOver, getPrimaryType, getTrackPointChanged, notifySensorDragChange, notifySensorDragStart, requiresPointOnly, setAutoOffset, setDescription, setIsOver, setValue, setValue

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, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, 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

getSecondaryType, 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, updateRefCount

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

getEnabled, getIsActive, setEnabled

Field Details

FIELD_MAXPOSITION

protected static final int FIELD_MAXPOSITION

The field index for maxPosition

See Also:

• Constant Field Values

FIELD_MINPOSITION

protected static final int FIELD_MINPOSITION

The field index for minPosition

See Also:

• Constant Field Values

FIELD_TRANSLATION_CHANGED

protected static final int FIELD_TRANSLATION_CHANGED

The field index for translation_changed

See Also:

• Constant Field Values

FIELD_OFFSET

protected static final int FIELD_OFFSET

The field index for offset

See Also:

• Constant Field Values

FIELD_AXIS_ROTATION

protected static final int FIELD_AXIS_ROTATION

The field index for axisRotation

See Also:

• Constant Field Values

LAST_PLANESENSOR_INDEX

protected static final int LAST_PLANESENSOR_INDEX

The last field index used by this class

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

vfMaxPosition

protected float[] vfMaxPosition

The value of the maxPosition field

vfMinPosition

protected float[] vfMinPosition

The value of the minPosition field

vfOffset

protected float[] vfOffset

The value of the offset field

vfTranslationChanged

protected float[] vfTranslationChanged

The value of the translation_changed field

vfAxisRotation

protected float[] vfAxisRotation

The value of the axisRotation field

Constructor Details

BasePlaneSensor

public BasePlaneSensor()

Construct a new time sensor object

BasePlaneSensor

public BasePlaneSensor(VRMLNodeType node)

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

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the same type

Method Details

notifySensorDragEnd

public void notifySensorDragEnd(float[] position,
 float[] direction)

Notification that this sensor has finished a drag action.

Specified by:

notifySensorDragEnd in interface VRMLDragSensorNodeType

Overrides:

notifySensorDragEnd in class BaseDragSensorNode

Parameters:

position - Where the sensor origin is in local coordinates

direction - Vector showing the direction the sensor is pointing

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.

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.

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.

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.

Returns:

The number of fields.

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 BaseDragSensorNode

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 BaseDragSensorNode

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,
 float[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a float array. This is be used to set 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

processDrag

protected void processDrag(float[] location,
 float[] direction)

Convenience method to generate the tracking output based on the input hit position.

Specified by:

processDrag in class BaseDragSensorNode

Parameters:

location - The position of the mouse locally

direction - Vector showing the direction the sensor is pointing