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

Class BaseJoystickSensor

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.extensions.BaseHIDSensor

org.web3d.vrml.renderer.common.nodes.extensions.BaseJoystickSensor

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLDeviceSensorNodeType, VRMLNodeType, VRMLSensorNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRJoystickSensor, OGLJoystickSensor

public class BaseJoystickSensor
extends BaseHIDSensor

Common base implementation of a JoystickSensor

This node is an custom extension to Xj3D node.

Version:

$Revision: 1.3 $

Author:

Alan Hudson

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.extensions.BaseHIDSensor

FIELD_AXIS_MAX_VALUE, FIELD_AXIS_MIN_VALUE, FIELD_AXIS_NAME, FIELD_AXIS_RESOLUTION, FIELD_AXIS_VALUE, FIELD_AXIS_WRAP, FIELD_ENABLED, FIELD_IS_ACTIVE, FIELD_MANUFACTURER_NAME, FIELD_NAME, FIELD_NUM_AXES, FIELD_NUM_OUTPUTS, FIELD_OUTPUT_MAX_VALUE, FIELD_OUTPUT_MIN_VALUE, FIELD_OUTPUT_NAME, FIELD_OUTPUT_RESOLUTION, FIELD_OUTPUT_VALUE, FIELD_OUTPUT_WRAP, LAST_HIDSENSOR_INDEX, vfAxisMaxValue, vfAxisMinValue, vfAxisName, vfAxisResolution, vfAxisValue, vfAxisWrap, vfEnabled, vfIsActive, vfManufacturerName, vfName, vfNumAxes, vfNumOutputs, vfOutputMaxValue, vfOutputMinValue, vfOutputName, vfOutputResolution, vfOutputValue, vfOutputWrap

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
BaseJoystickSensor()	Construct a default node with an empty info array any the title set to the empty string.
BaseJoystickSensor(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	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setDevice(org.j3d.device.input.InputDevice device)	Set the real device backing this node.
void	update(org.j3d.device.input.DeviceState state)	Update this nodes field from the underlying device.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.extensions.BaseHIDSensor

copy, getEnabled, getIsActive, getName, getPrimaryType, setEnabled, setName, setValue, 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, updateRefCount

Constructor Details

BaseJoystickSensor

public BaseJoystickSensor()

Construct a default node with an empty info array any the title set to the empty string.

BaseJoystickSensor

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

setDevice

public void setDevice(org.j3d.device.input.InputDevice device)

Set the real device backing this node. This will not be called if the device name does not map to a live device.

Parameters:

device - The real device.

update

public void update(org.j3d.device.input.DeviceState state)

Update this nodes field from the underlying device.

Parameters:

state - The device state.

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

Overrides:

getFieldIndex in class BaseHIDSensor

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.

Specified by:

getFieldDeclaration in interface VRMLNode

Overrides:

getFieldDeclaration in class BaseHIDSensor

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

Overrides:

getNumFields in class BaseHIDSensor

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 BaseHIDSensor

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 BaseHIDSensor

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.