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

Class BaseStringSensor

java.lang.Object

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

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

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

All Implemented Interfaces:

EventListener, VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLKeyDeviceSensorNodeType, VRMLNodeType, VRMLSensorNodeType, VRMLWorldRootChildNodeType, Xj3DKeyListener

Direct Known Subclasses:

NRStringSensor, OGLStringSensor

public class BaseStringSensor
extends BaseSensorNode
implements VRMLKeyDeviceSensorNodeType

Base common implementation of a StringSensor node.

UI toolkit specific key mappings are handled through the Xj3DKeyEvent object. This object determines the key's properties - whether a character or control key.

Version:

$Revision: 1.7 $

Author:

Justin Couch

See Also:

• Xj3DKeyEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_DELETION_ALLOWED	Index of the deletionAllowed field
protected static final int	FIELD_ENTERED_TEXT	Index of the enteredText field
protected static final int	FIELD_FINAL_TEXT	Index of the finalText field
protected static final int	LAST_STRINGSENSOR_INDEX	The last index to use
protected static final int	NUM_FIELDS	Number of fields constant
protected boolean	vfDeletionAllowed	SFBool deletionAllowed field
protected String	vfEnteredText	SFString enteredText eventOut
protected String	vfFinalText	SFString finalText eventOut

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
BaseStringSensor()	Construct a default StringSensor instance
BaseStringSensor(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.
void	keyPressed(Xj3DKeyEvent evt)	Notification of a key press event.
void	keyReleased(Xj3DKeyEvent evt)	Notification of a key release event.
boolean	requiresLastEventOnly()	See if this key device sensor requires only the last key sent or all of them.
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, boolean value)	Set the value of the field at the given index as a boolean.

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, 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_DELETION_ALLOWED

protected static final int FIELD_DELETION_ALLOWED

Index of the deletionAllowed field

See Also:

• Constant Field Values

FIELD_ENTERED_TEXT

protected static final int FIELD_ENTERED_TEXT

Index of the enteredText field

See Also:

• Constant Field Values

FIELD_FINAL_TEXT

protected static final int FIELD_FINAL_TEXT

Index of the finalText field

See Also:

• Constant Field Values

LAST_STRINGSENSOR_INDEX

protected static final int LAST_STRINGSENSOR_INDEX

The last index to use

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

vfEnteredText

protected String vfEnteredText

SFString enteredText eventOut

vfFinalText

protected String vfFinalText

SFString finalText eventOut

vfDeletionAllowed

protected boolean vfDeletionAllowed

SFBool deletionAllowed field

Constructor Details

BaseStringSensor

public BaseStringSensor()

Construct a default StringSensor instance

BaseStringSensor

public BaseStringSensor(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 - Incorrect Node Type

Method Details

requiresLastEventOnly

public boolean requiresLastEventOnly()

See if this key device sensor requires only the last key sent or all of them. Always returns true for StringSensors.

Specified by:

requiresLastEventOnly in interface VRMLKeyDeviceSensorNodeType

Returns:

true if this only requires the last key event

keyPressed

public void keyPressed(Xj3DKeyEvent evt)

Notification of a key press event. Ignored. All manipulation of the working string is processed in the keyReleased( ) method.

Specified by:

keyPressed in interface Xj3DKeyListener

Parameters:

evt - The key event that caused this method to be called

keyReleased

public void keyReleased(Xj3DKeyEvent evt)

Notification of a key release event. All manipulation of the working string is processed in this method.

Specified by:

keyReleased in interface Xj3DKeyListener

Parameters:

evt - The key event that caused this method to be called

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,
 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 index is not a valid field

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