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

Class BaseTouchSensor

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

NRTouchSensor, OGLTouchSensor

public class BaseTouchSensor
extends BaseSensorNode
implements VRMLTouchSensorNodeType

Common base implementation of a TouchSensor node.

Version:

$Revision: 1.17 $

Author:

Alan Hudson, Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_DESCRIPTION	The field index for description
protected static final int	FIELD_HITNORMAL_CHANGED	The field index for hitNormal_Changed
protected static final int	FIELD_HITPOINT_CHANGED	The field index for hitPoint_Changed
protected static final int	FIELD_HITTEXCOORD_CHANGED	The field index for hitTexCoord_Changed
protected static final int	FIELD_IS_OVER	The field index for isOver
protected static final int	FIELD_TOUCH_TIME	The field index for touchTime
protected static final int	LAST_TOUCHSENSOR_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected String	vfDescription	The value of the description field
protected float[]	vfHitNormalChanged	The value of the hitNormal_changed field
protected float[]	vfHitPointChanged	The value of the hitPoint_changed field
protected float[]	vfHitTexCoordChanged	The value of the hitTexCoordChanged field
protected boolean	vfIsOver	The value of the isOver field
protected double	vfTouchTime	The value of the touchTime field

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
BaseTouchSensor()	Construct a new time sensor object
BaseTouchSensor(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get the description to associate with the link.
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.
boolean	getIsOver()	Get the current value of the isOver 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.
void	notifyHitChanged(float[] hitPoint, float[] hitNormal, float[] hitTexCoord)	Notify the node that the device moved.
void	notifyPressed(int button, double simTime, float[] hitPoint, float[] hitNormal, float[] hitTexCoord)	Notify the node that a button was pushed down
void	notifyReleased(int button, double simTime, float[] hitPoint, float[] hitNormal, float[] hitTexCoord)	Notify the node that a button was released
boolean	requiresPointOnly()	Flag to notify the user whether the node implementation only needs the hit point information, or it needs everything else as well.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setDescription(String desc)	Set the description string for this link.
void	setIsOver(boolean newIsOver)	Set the flag describing whether the pointing device is over this sensor.
void	setValue(int index, String value)	Set the value of the field at the given index as an array of floats.

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

copy, getEnabled, getIsActive, setEnabled, setValue

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

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

getEnabled, getIsActive, setEnabled

Field Details

FIELD_HITNORMAL_CHANGED

protected static final int FIELD_HITNORMAL_CHANGED

The field index for hitNormal_Changed

See Also:

• Constant Field Values

FIELD_HITPOINT_CHANGED

protected static final int FIELD_HITPOINT_CHANGED

The field index for hitPoint_Changed

See Also:

• Constant Field Values

FIELD_HITTEXCOORD_CHANGED

protected static final int FIELD_HITTEXCOORD_CHANGED

The field index for hitTexCoord_Changed

See Also:

• Constant Field Values

FIELD_IS_OVER

protected static final int FIELD_IS_OVER

The field index for isOver

See Also:

• Constant Field Values

FIELD_TOUCH_TIME

protected static final int FIELD_TOUCH_TIME

The field index for touchTime

See Also:

• Constant Field Values

FIELD_DESCRIPTION

protected static final int FIELD_DESCRIPTION

The field index for description

See Also:

• Constant Field Values

LAST_TOUCHSENSOR_INDEX

protected static final int LAST_TOUCHSENSOR_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

vfHitNormalChanged

protected float[] vfHitNormalChanged

The value of the hitNormal_changed field

vfHitPointChanged

protected float[] vfHitPointChanged

The value of the hitPoint_changed field

vfHitTexCoordChanged

protected float[] vfHitTexCoordChanged

The value of the hitTexCoordChanged field

vfIsOver

protected boolean vfIsOver

The value of the isOver field

vfTouchTime

protected double vfTouchTime

The value of the touchTime field

vfDescription

protected String vfDescription

The value of the description field

Constructor Details

BaseTouchSensor

public BaseTouchSensor()

Construct a new time sensor object

BaseTouchSensor

public BaseTouchSensor(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

requiresPointOnly

public boolean requiresPointOnly()

Flag to notify the user whether the node implementation only needs the hit point information, or it needs everything else as well. This is an optimisation method that allows the internals of the event model to avoid doing unnecessary work. If the return value is true, then the hitNormal and hitTexCoord parameter values will not be supplied (they'll be null references).

Specified by:

requiresPointOnly in interface VRMLPointingDeviceSensorNodeType

Returns:

true if the node implementation only requires hitPoint information

getDescription

public String getDescription()

Get the description to associate with the link. This is a line of text suitable for mouse overs, status information etc. If there is no description set then it returns null.

Specified by:

getDescription in interface VRMLPointingDeviceSensorNodeType

Returns:

The current description or null

setDescription

public void setDescription(String desc)

Set the description string for this link. Setting a value of null will clear the current description.

Specified by:

setDescription in interface VRMLPointingDeviceSensorNodeType

Parameters:

desc - The new description to set

setIsOver

public void setIsOver(boolean newIsOver)

Set the flag describing whether the pointing device is over this sensor. The result should be that isOver SFBool output only field is set appropriately at the node level.

Specified by:

setIsOver in interface VRMLPointingDeviceSensorNodeType

Parameters:

newIsOver - The new value for isOver

getIsOver

public boolean getIsOver()

Get the current value of the isOver field.

Specified by:

getIsOver in interface VRMLPointingDeviceSensorNodeType

Returns:

The current value of isOver

notifyPressed

public void notifyPressed(int button,
 double simTime,
 float[] hitPoint,
 float[] hitNormal,
 float[] hitTexCoord)

Notify the node that a button was pushed down

Specified by:

notifyPressed in interface VRMLTouchSensorNodeType

Parameters:

button - The button that was pressed

simTime - The VRML simulation time it happened

hitPoint - The location clicked in object space coordinates

hitNormal - Surface normal vector at the intersection point

hitTexCoord - The texture coordinate at the intersection point

notifyReleased

public void notifyReleased(int button,
 double simTime,
 float[] hitPoint,
 float[] hitNormal,
 float[] hitTexCoord)

Notify the node that a button was released

Specified by:

notifyReleased in interface VRMLTouchSensorNodeType

Parameters:

button - The button that was released

simTime - The VRML simulation time it happened

hitPoint - The location clicked in object space coordinates

hitNormal - Surface normal vector at the intersection point

hitTexCoord - The texture coordinate at the intersection point

notifyHitChanged

public void notifyHitChanged(float[] hitPoint,
 float[] hitNormal,
 float[] hitTexCoord)

Notify the node that the device moved.

Specified by:

notifyHitChanged in interface VRMLTouchSensorNodeType

Parameters:

hitPoint - The current location in object space coordinates

hitNormal - Surface normal vector at the intersection point

hitTexCoord - The texture coordinate at the intersection point

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

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,
 String value)
              throws InvalidFieldException

Set the value of the field at the given index as an array of floats. This would be used to set SFString field "title".

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

Throws:

InvalidFieldException - The field index is not know