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

Class BaseHIDSensor

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseGamepadSensor, BaseJoystickSensor, BaseWheelSensor

public abstract class BaseHIDSensor
extends AbstractNode
implements VRMLDeviceSensorNodeType

Common base implementation of a GamepadSensor

This node is an custom extension to Xj3D node.

Version:

$Revision: 1.3 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_AXIS_MAX_VALUE	Index of the axisMaxValue field
protected static final int	FIELD_AXIS_MIN_VALUE	Index of the axisMinValue field
protected static final int	FIELD_AXIS_NAME	Index of the axisName field
protected static final int	FIELD_AXIS_RESOLUTION	Index of the axisResolution field
protected static final int	FIELD_AXIS_VALUE	Index of the axisValue field
protected static final int	FIELD_AXIS_WRAP	Index of the axisWrap field
protected static final int	FIELD_ENABLED	Index of the enabled field
protected static final int	FIELD_IS_ACTIVE	Index of the isActive field
protected static final int	FIELD_MANUFACTURER_NAME	Index of the manufacturerName field
protected static final int	FIELD_NAME	Index of the name field
protected static final int	FIELD_NUM_AXES	Index of the numAxes field
protected static final int	FIELD_NUM_OUTPUTS	Index of the numOutputs field
protected static final int	FIELD_OUTPUT_MAX_VALUE	Index of the outputMaxValue field
protected static final int	FIELD_OUTPUT_MIN_VALUE	Index of the outputMinValue field
protected static final int	FIELD_OUTPUT_NAME	Index of the outputName field
protected static final int	FIELD_OUTPUT_RESOLUTION	Index of the outputResolution field
protected static final int	FIELD_OUTPUT_VALUE	Index of the outputValue field
protected static final int	FIELD_OUTPUT_WRAP	Index of the axisWrap field
protected static final int	LAST_HIDSENSOR_INDEX	The last field index used by this class
protected float[]	vfAxisMaxValue	eventOut MFFloat axisMaxValue
protected float[]	vfAxisMinValue	eventOut MFFloat axisMinValue
protected String[]	vfAxisName	eventOut MFString axisName
protected float[]	vfAxisResolution	eventOut MFFloat axisResolution
protected float[]	vfAxisValue	eventOut MFFloat axisValue
protected boolean[]	vfAxisWrap	eventOut MFBool axisWrap
protected boolean	vfEnabled	exposedField SFBool enabled
protected boolean	vfIsActive	eventOut SFBool isActive
protected String	vfManufacturerName	eventOut SFString manufacturerName
protected String	vfName	field SFString name
protected int	vfNumAxes	eventOut SFInt numAxes
protected int	vfNumOutputs	eventOut SFInt numOutputs
protected float[]	vfOutputMaxValue	eventOut MFFloat outputMaxValue
protected float[]	vfOutputMinValue	eventOut MFFloat outputMinValue
protected String[]	vfOutputName	eventOut MFString outputName
protected float[]	vfOutputResolution	eventOut MFFloat outputResolution
protected float[]	vfOutputValue	eventIn MFFloat outputValue
protected boolean[]	vfOutputWrap	eventOut MFBoolean outputWrap

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
BaseHIDSensor(String nodeName)	Construct a default node with an empty info array any the title set to the empty string.

Method Summary

Modifier and Type	Method	Description
protected void	copy(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.
boolean	getEnabled()	Accessor method to get current value of field enabled, default value is true.
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	getIsActive()	Get the current value of the isActive field
String	getName()	Get the name field.
int	getNumFields()	Get the number of fields.
int	getPrimaryType()	Get the primary type of this node.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setEnabled(boolean state)	Set a new state for the enabled field.
protected void	setName(String name)	Set a new state for the name field.
void	setValue(int index, boolean value)	Set the value of the field at the given index as a boolean.
void	setValue(int index, String value)	Set the value of the field at the given index as a String.

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.nodes.VRMLDeviceSensorNodeType

setDevice, update

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

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

Field Details

FIELD_NAME

protected static final int FIELD_NAME

Index of the name field

See Also:

• Constant Field Values

FIELD_OUTPUT_VALUE

protected static final int FIELD_OUTPUT_VALUE

Index of the outputValue field

See Also:

• Constant Field Values

FIELD_IS_ACTIVE

protected static final int FIELD_IS_ACTIVE

Index of the isActive field

See Also:

• Constant Field Values

FIELD_AXIS_VALUE

protected static final int FIELD_AXIS_VALUE

Index of the axisValue field

See Also:

• Constant Field Values

FIELD_AXIS_MIN_VALUE

protected static final int FIELD_AXIS_MIN_VALUE

Index of the axisMinValue field

See Also:

• Constant Field Values

FIELD_AXIS_MAX_VALUE

protected static final int FIELD_AXIS_MAX_VALUE

Index of the axisMaxValue field

See Also:

• Constant Field Values

FIELD_AXIS_NAME

protected static final int FIELD_AXIS_NAME

Index of the axisName field

See Also:

• Constant Field Values

FIELD_AXIS_RESOLUTION

protected static final int FIELD_AXIS_RESOLUTION

Index of the axisResolution field

See Also:

• Constant Field Values

FIELD_AXIS_WRAP

protected static final int FIELD_AXIS_WRAP

Index of the axisWrap field

See Also:

• Constant Field Values

FIELD_MANUFACTURER_NAME

protected static final int FIELD_MANUFACTURER_NAME

Index of the manufacturerName field

See Also:

• Constant Field Values

FIELD_NUM_AXES

protected static final int FIELD_NUM_AXES

Index of the numAxes field

See Also:

• Constant Field Values

FIELD_NUM_OUTPUTS

protected static final int FIELD_NUM_OUTPUTS

Index of the numOutputs field

See Also:

• Constant Field Values

FIELD_OUTPUT_NAME

protected static final int FIELD_OUTPUT_NAME

Index of the outputName field

See Also:

• Constant Field Values

FIELD_OUTPUT_MIN_VALUE

protected static final int FIELD_OUTPUT_MIN_VALUE

Index of the outputMinValue field

See Also:

• Constant Field Values

FIELD_OUTPUT_MAX_VALUE

protected static final int FIELD_OUTPUT_MAX_VALUE

Index of the outputMaxValue field

See Also:

• Constant Field Values

FIELD_OUTPUT_RESOLUTION

protected static final int FIELD_OUTPUT_RESOLUTION

Index of the outputResolution field

See Also:

• Constant Field Values

FIELD_OUTPUT_WRAP

protected static final int FIELD_OUTPUT_WRAP

Index of the axisWrap field

See Also:

• Constant Field Values

FIELD_ENABLED

protected static final int FIELD_ENABLED

Index of the enabled field

See Also:

• Constant Field Values

LAST_HIDSENSOR_INDEX

protected static final int LAST_HIDSENSOR_INDEX

The last field index used by this class

See Also:

• Constant Field Values

vfEnabled

protected boolean vfEnabled

exposedField SFBool enabled

vfName

protected String vfName

field SFString name

vfIsActive

protected boolean vfIsActive

eventOut SFBool isActive

vfAxisValue

protected float[] vfAxisValue

eventOut MFFloat axisValue

vfAxisMinValue

protected float[] vfAxisMinValue

eventOut MFFloat axisMinValue

vfAxisMaxValue

protected float[] vfAxisMaxValue

eventOut MFFloat axisMaxValue

vfAxisName

protected String[] vfAxisName

eventOut MFString axisName

vfAxisResolution

protected float[] vfAxisResolution

eventOut MFFloat axisResolution

vfAxisWrap

protected boolean[] vfAxisWrap

eventOut MFBool axisWrap

vfManufacturerName

protected String vfManufacturerName

eventOut SFString manufacturerName

vfNumAxes

protected int vfNumAxes

eventOut SFInt numAxes

vfNumOutputs

protected int vfNumOutputs

eventOut SFInt numOutputs

vfOutputValue

protected float[] vfOutputValue

eventIn MFFloat outputValue

vfOutputMinValue

protected float[] vfOutputMinValue

eventOut MFFloat outputMinValue

vfOutputMaxValue

protected float[] vfOutputMaxValue

eventOut MFFloat outputMaxValue

vfOutputName

protected String[] vfOutputName

eventOut MFString outputName

vfOutputResolution

protected float[] vfOutputResolution

eventOut MFFloat outputResolution

vfOutputWrap

protected boolean[] vfOutputWrap

eventOut MFBoolean outputWrap

Constructor Details

BaseHIDSensor

public BaseHIDSensor(String nodeName)

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

Parameters:

nodeName -

Method Details

copy

protected void copy(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

getName

public String getName()

Get the name field.

Specified by:

getName in interface VRMLDeviceSensorNodeType

Returns:

The name.

getEnabled

public boolean getEnabled()

Accessor method to get current value of field enabled, default value is true.

Specified by:

getEnabled in interface VRMLSensorNodeType

Returns:

The value of the enabled field

getIsActive

public boolean getIsActive()

Get the current value of the isActive field

Specified by:

getIsActive in interface VRMLSensorNodeType

Returns:

True if currently active, false otherwise

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

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 AbstractNode

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 AbstractNode

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 AbstractNode

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.

setValue

public void setValue(int index,
 String value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a String. This is be used to set SFString field types name.

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

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

setEnabled

public void setEnabled(boolean state)

Set a new state for the enabled field.

Specified by:

setEnabled in interface VRMLSensorNodeType

Parameters:

state - True if this sensor is to be enabled

setName

protected void setName(String name)

Set a new state for the name field.

Parameters:

name - The new name