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

Class BaseJointNode

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.rigidphysics.BaseJointNode

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLRigidJointNodeType

Direct Known Subclasses:

BaseBallJoint, BaseDoubleAxisHingeJoint, BaseMotorJoint, BaseSingleAxisHingeJoint, BaseSliderJoint, BaseUniversalJoint

public abstract class BaseJointNode
extends AbstractNode
implements VRMLRigidJointNodeType

Implementation of the abstract X3DRigidJointNode type.

Version:

$Revision: 1.3 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BODY_NODE_MSG	Message for when the node in setValue() is not a Body
protected static final String	BODY_PROTO_MSG	Message for when the proto is not a Body
protected static final int	FIELD_BODY1	The field index for body1
protected static final int	FIELD_BODY2	The field index for body2
protected static final int	FIELD_MUST_OUTPUT	The field index for mustOutput
protected static final int	LAST_JOINT_INDEX	Last index used by this base node
protected int	numMustOutput	The number of valid values in vfMustOutput
protected int	numOutputIndices	The number of valid values in the output list
protected int[]	outputIndices	Converted version of the output index list
protected VRMLProtoInstance	pBody1	The proto version of the body1
protected VRMLProtoInstance	pBody2	The proto version of the body2
protected VRMLRigidBodyNodeType	vfBody1	The value of the body1 field
protected VRMLRigidBodyNodeType	vfBody2	The value of the body2 field
protected String[]	vfMustOutput	The value of the mustOutput list

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
BaseJointNode(String name)	Construct a new generalised joint node object.

Method Summary

Modifier and Type	Method	Description
VRMLNodeType	getBody1()	Fetch the node that is being used to pick the geometry
VRMLNodeType	getBody2()	Fetch the node that is being used to pick the geometry
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int[]	getOutputFields()	Get the array of output field indices for this joint.
int	getPrimaryType()	Get the primary type of this node.
int	numOutputs()	Get the number of valid fields that the user has requested updates for.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setBody1(VRMLNodeType body)	Set node content as replacement for the body1 field.
void	setBody2(VRMLNodeType body)	Set node content as replacement for the body1 field.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, String[] value, int numValid)	Set the value of the field at the given index as a single float.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.

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

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, 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, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

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

delete, setODEWorld, updateRequestedOutputs

Field Details

FIELD_BODY1

protected static final int FIELD_BODY1

The field index for body1

See Also:

• Constant Field Values

FIELD_BODY2

protected static final int FIELD_BODY2

The field index for body2

See Also:

• Constant Field Values

FIELD_MUST_OUTPUT

protected static final int FIELD_MUST_OUTPUT

The field index for mustOutput

See Also:

• Constant Field Values

LAST_JOINT_INDEX

protected static final int LAST_JOINT_INDEX

Last index used by this base node

See Also:

• Constant Field Values

BODY_PROTO_MSG

protected static final String BODY_PROTO_MSG

Message for when the proto is not a Body

See Also:

• Constant Field Values

BODY_NODE_MSG

protected static final String BODY_NODE_MSG

Message for when the node in setValue() is not a Body

See Also:

• Constant Field Values

vfBody1

protected VRMLRigidBodyNodeType vfBody1

The value of the body1 field

pBody1

protected VRMLProtoInstance pBody1

The proto version of the body1

vfBody2

protected VRMLRigidBodyNodeType vfBody2

The value of the body2 field

pBody2

protected VRMLProtoInstance pBody2

The proto version of the body2

vfMustOutput

protected String[] vfMustOutput

The value of the mustOutput list

numMustOutput

protected int numMustOutput

The number of valid values in vfMustOutput

outputIndices

protected int[] outputIndices

Converted version of the output index list

numOutputIndices

protected int numOutputIndices

The number of valid values in the output list

Constructor Details

BaseJointNode

public BaseJointNode(String name)

Construct a new generalised joint node object.

Parameters:

name - The VRML name of this node

Method Details

numOutputs

public int numOutputs()

Get the number of valid fields that the user has requested updates for.

Specified by:

numOutputs in interface VRMLRigidJointNodeType

Returns:

a value greater than or equal to zero

getOutputFields

public int[] getOutputFields()

Get the array of output field indices for this joint. These are previously mapped internally from the output listing to the field index values corresponding to the user-supplied field names, as well as processing for the special NONE and ALL types.

Specified by:

getOutputFields in interface VRMLRigidJointNodeType

Returns:

an array of field indices that are to be used

setBody1

public void setBody1(VRMLNodeType body)
              throws InvalidFieldValueException

Set node content as replacement for the body1 field. This checks only for basic node representation. If a concrete node needs a specific set of nodes, it should override this method to check.

Specified by:

setBody1 in interface VRMLRigidJointNodeType

Parameters:

body - The new body representation. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

getBody1

public VRMLNodeType getBody1()

Fetch the node that is being used to pick the geometry

Returns:

The valid geometry node or null if not set

setBody2

public void setBody2(VRMLNodeType body)
              throws InvalidFieldValueException

Set node content as replacement for the body1 field. This checks only for basic node representation. If a concrete node needs a specific set of nodes, it should override this method to check.

Specified by:

setBody2 in interface VRMLRigidJointNodeType

Parameters:

body - The new body representation. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

getBody2

public VRMLNodeType getBody2()

Fetch the node that is being used to pick the geometry

Specified by:

getBody2 in interface VRMLRigidJointNodeType

Returns:

The valid geometry node or null if not set

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

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

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,
 String[] value,
 int numValid)
              throws InvalidFieldValueException,
InvalidFieldException

Set the value of the field at the given index as a single float. This would be used to set MFString field types.

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

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not know

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

setValue

public void setValue(int index,
 VRMLNodeType child)
              throws InvalidFieldValueException,
InvalidFieldException

Set the value of the field at the given index as a node. This would be used to set SFNode field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

child - The new value to use for the node

Throws:

InvalidFieldException - The field index is not know

InvalidFieldValueException - The value provided does not fit this type of node