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

Class BaseKeySensor

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

NRKeySensor, OGLKeySensor

public class BaseKeySensor
extends BaseSensorNode
implements VRMLKeyDeviceSensorNodeType

Base common implementation of a KeySensor node.

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

Version:

$Revision: 1.14 $

Author:

Justin Couch

See Also:

• Xj3DKeyCode
• Xj3DKeyEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_ACTION_PRESS	Index of the actionKeyPress field
protected static final int	FIELD_ACTION_RELEASE	Index of the actionKeyRelease field
protected static final int	FIELD_ALTKEY	Index of the altKey field
protected static final int	FIELD_CONTROLKEY	Index of the controlKey field
protected static final int	FIELD_KEY_PRESS	Index of the keyPress field
protected static final int	FIELD_KEY_RELEASE	Index of the keyRelease field
protected static final int	FIELD_SHIFTKEY	Index of the shiftKey field
protected static final int	LAST_KEYSENSOR_INDEX	The last index to use
protected static final int	NUM_FIELDS	Number of fields constant
protected int	vfActionKeyPress	SFInt32 actionKeyPress eventOut
protected int	vfActionKeyRelease	SFInt32 actionKeyPress eventOut
protected boolean	vfAltKey	SFBool altKey_changed eventOut
protected boolean	vfControlKey	SFBool controlKey_changed eventOut
protected String	vfKeyPress	SFInt32 keyPress eventOut
protected String	vfKeyRelease	SFInt32 keyRelease eventOut
protected boolean	vfShiftKey	SFBool shiftKey_changed 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
BaseKeySensor()	Construct a default viewpoint instance
BaseKeySensor(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.

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

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

getEnabled, getIsActive, setEnabled

Field Details

FIELD_KEY_PRESS

protected static final int FIELD_KEY_PRESS

Index of the keyPress field

See Also:

• Constant Field Values

FIELD_KEY_RELEASE

protected static final int FIELD_KEY_RELEASE

Index of the keyRelease field

See Also:

• Constant Field Values

FIELD_ACTION_PRESS

protected static final int FIELD_ACTION_PRESS

Index of the actionKeyPress field

See Also:

• Constant Field Values

FIELD_ACTION_RELEASE

protected static final int FIELD_ACTION_RELEASE

Index of the actionKeyRelease field

See Also:

• Constant Field Values

FIELD_SHIFTKEY

protected static final int FIELD_SHIFTKEY

Index of the shiftKey field

See Also:

• Constant Field Values

FIELD_CONTROLKEY

protected static final int FIELD_CONTROLKEY

Index of the controlKey field

See Also:

• Constant Field Values

FIELD_ALTKEY

protected static final int FIELD_ALTKEY

Index of the altKey field

See Also:

• Constant Field Values

LAST_KEYSENSOR_INDEX

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

vfKeyPress

protected String vfKeyPress

SFInt32 keyPress eventOut

vfKeyRelease

protected String vfKeyRelease

SFInt32 keyRelease eventOut

vfActionKeyPress

protected int vfActionKeyPress

SFInt32 actionKeyPress eventOut

vfActionKeyRelease

protected int vfActionKeyRelease

SFInt32 actionKeyPress eventOut

vfShiftKey

protected boolean vfShiftKey

SFBool shiftKey_changed eventOut

vfControlKey

protected boolean vfControlKey

SFBool controlKey_changed eventOut

vfAltKey

protected boolean vfAltKey

SFBool altKey_changed eventOut

Constructor Details

BaseKeySensor

public BaseKeySensor()

Construct a default viewpoint instance

BaseKeySensor

public BaseKeySensor(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 KeySensors.

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.

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.

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.