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

Class BaseUniversalJoint

java.lang.Object

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

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLRigidJointNodeType

Direct Known Subclasses:

NRUniversalJoint, OGLUniversalJoint

public abstract class BaseUniversalJoint
extends BaseJointNode

Implementation of the UniversalJoint node.

Version:

$Revision: 1.7 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BOUNCE1_RANGE_MSG	Message when the stopBounce value is out of range
protected static final String	BOUNCE2_RANGE_MSG	Message when the stop2Bounce value is out of range
protected static final int	FIELD_ANCHOR_POINT	The field index for anchorPoint
protected static final int	FIELD_AXIS1	The field index for axis1
protected static final int	FIELD_AXIS2	The field index for axis2
protected static final int	FIELD_BODY1_ANCHOR_POINT	The field index for body1AnchorPoint
protected static final int	FIELD_BODY1_AXIS	The field index for body1Axis
protected static final int	FIELD_BODY2_ANCHOR_POINT	The field index for body2AnchorPoint
protected static final int	FIELD_BODY2_AXIS	The field index for body2Axis
protected static final int	FIELD_STOP1_BOUNCE	The field index for stop1Bounce
protected static final int	FIELD_STOP1_ERROR_CORRECTION	The field index for stop1ErrorCorrection
protected static final int	FIELD_STOP2_BOUNCE	The field index for stop2Bounce
protected static final int	FIELD_STOP2_ERROR_CORRECTION	The field index for stop2ErrorCorrection
protected static final int	LAST_INDEX	Last index used by this base node
protected org.odejava.JointUniversal	odeJoint	The ODE representation of the joint
protected static final String	STOP_ERROR1_RANGE_MSG	Message when the stop1ErrorCorrection value is out of range
protected static final String	STOP_ERROR2_RANGE_MSG	Message when the stop2ErrorCorrection value is out of range
protected float[]	vfAnchorPoint	The value of the anchorPoint field
protected float[]	vfAxis1	The value of the axis1 field
protected float[]	vfAxis2	The value of the axis2 field
protected float[]	vfBody1AnchorPoint	The value of the body1AnchorPoint field
protected float[]	vfBody1Axis	The value of the body1Axis field
protected float[]	vfBody2AnchorPoint	The value of the body1AnchorPoint field
protected float[]	vfBody2Axis	The value of the body1Axis field
protected float	vfStop1Bounce	The value of the stop1Bounce field
protected float	vfStop1ErrorCorrection	The value of the stop1ErrorCorrection field
protected float	vfStop2Bounce	The value of the stop2Bounce field
protected float	vfStop2ErrorCorrection	The value of the stop2ErrorCorrection field

Fields inherited from class org.web3d.vrml.renderer.common.nodes.rigidphysics.BaseJointNode

BODY_NODE_MSG, BODY_PROTO_MSG, FIELD_BODY1, FIELD_BODY2, FIELD_MUST_OUTPUT, LAST_JOINT_INDEX, numMustOutput, numOutputIndices, outputIndices, pBody1, pBody2, vfBody1, vfBody2, vfMustOutput

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
BaseUniversalJoint()	Construct a new default universal joint node object.
BaseUniversalJoint(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
void	delete()	This node is about to be deleted due to a change in loaded world.
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	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	setODEWorld(org.odejava.World wld, org.odejava.JointGroup grp)	Set the parent world that this body belongs to.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, float value)	Set the value of the field at the given index as a single float.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as a single float.
void	updateRequestedOutputs()	Instruction to the node to fetch the appropriate field values' output from the physics model and update the outputOnly field with the values.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.rigidphysics.BaseJointNode

getBody1, getBody2, getOutputFields, numOutputs, 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, setUserData, 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, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_ANCHOR_POINT

protected static final int FIELD_ANCHOR_POINT

The field index for anchorPoint

See Also:

• Constant Field Values

FIELD_AXIS1

protected static final int FIELD_AXIS1

The field index for axis1

See Also:

• Constant Field Values

FIELD_AXIS2

protected static final int FIELD_AXIS2

The field index for axis2

See Also:

• Constant Field Values

FIELD_BODY1_ANCHOR_POINT

protected static final int FIELD_BODY1_ANCHOR_POINT

The field index for body1AnchorPoint

See Also:

• Constant Field Values

FIELD_BODY2_ANCHOR_POINT

protected static final int FIELD_BODY2_ANCHOR_POINT

The field index for body2AnchorPoint

See Also:

• Constant Field Values

FIELD_BODY1_AXIS

protected static final int FIELD_BODY1_AXIS

The field index for body1Axis

See Also:

• Constant Field Values

FIELD_BODY2_AXIS

protected static final int FIELD_BODY2_AXIS

The field index for body2Axis

See Also:

• Constant Field Values

FIELD_STOP1_BOUNCE

protected static final int FIELD_STOP1_BOUNCE

The field index for stop1Bounce

See Also:

• Constant Field Values

FIELD_STOP2_BOUNCE

protected static final int FIELD_STOP2_BOUNCE

The field index for stop2Bounce

See Also:

• Constant Field Values

FIELD_STOP1_ERROR_CORRECTION

protected static final int FIELD_STOP1_ERROR_CORRECTION

The field index for stop1ErrorCorrection

See Also:

• Constant Field Values

FIELD_STOP2_ERROR_CORRECTION

protected static final int FIELD_STOP2_ERROR_CORRECTION

The field index for stop2ErrorCorrection

See Also:

• Constant Field Values

LAST_INDEX

protected static final int LAST_INDEX

Last index used by this base node

See Also:

• Constant Field Values

BOUNCE1_RANGE_MSG

protected static final String BOUNCE1_RANGE_MSG

Message when the stopBounce value is out of range

See Also:

• Constant Field Values

BOUNCE2_RANGE_MSG

protected static final String BOUNCE2_RANGE_MSG

Message when the stop2Bounce value is out of range

See Also:

• Constant Field Values

STOP_ERROR1_RANGE_MSG

protected static final String STOP_ERROR1_RANGE_MSG

Message when the stop1ErrorCorrection value is out of range

See Also:

• Constant Field Values

STOP_ERROR2_RANGE_MSG

protected static final String STOP_ERROR2_RANGE_MSG

Message when the stop2ErrorCorrection value is out of range

See Also:

• Constant Field Values

vfAnchorPoint

protected float[] vfAnchorPoint

The value of the anchorPoint field

vfAxis1

protected float[] vfAxis1

The value of the axis1 field

vfAxis2

protected float[] vfAxis2

The value of the axis2 field

vfBody1AnchorPoint

protected float[] vfBody1AnchorPoint

The value of the body1AnchorPoint field

vfBody2AnchorPoint

protected float[] vfBody2AnchorPoint

The value of the body1AnchorPoint field

vfBody1Axis

protected float[] vfBody1Axis

The value of the body1Axis field

vfBody2Axis

protected float[] vfBody2Axis

The value of the body1Axis field

vfStop1Bounce

protected float vfStop1Bounce

The value of the stop1Bounce field

vfStop2Bounce

protected float vfStop2Bounce

The value of the stop2Bounce field

vfStop1ErrorCorrection

protected float vfStop1ErrorCorrection

The value of the stop1ErrorCorrection field

vfStop2ErrorCorrection

protected float vfStop2ErrorCorrection

The value of the stop2ErrorCorrection field

odeJoint

protected org.odejava.JointUniversal odeJoint

The ODE representation of the joint

Constructor Details

BaseUniversalJoint

public BaseUniversalJoint()

Construct a new default universal joint node object.

BaseUniversalJoint

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

delete

public void delete()

This node is about to be deleted due to a change in loaded world. Clear up the ODE resources in use.

updateRequestedOutputs

public void updateRequestedOutputs()

Instruction to the node to fetch the appropriate field values' output from the physics model and update the outputOnly field with the values.

setODEWorld

public void setODEWorld(org.odejava.World wld,
 org.odejava.JointGroup grp)

Set the parent world that this body belongs to. A null value clears the world and indicates the physics model or body is no longer in use by this world (eg deletes it).

Parameters:

wld -

grp - The group that this joint should belong to

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

Overrides:

setBody1 in class BaseJointNode

Parameters:

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

Throws:

InvalidFieldValueException - The node does not match the required type.

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

Overrides:

setBody2 in class BaseJointNode

Parameters:

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

Throws:

InvalidFieldValueException - The node does not match the required type.

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.

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.

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.

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

Overrides:

getPrimaryType in class BaseJointNode

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 BaseJointNode

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 BaseJointNode

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 BaseJointNode

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,
 float value)
              throws InvalidFieldValueException,
InvalidFieldException

Set the value of the field at the given index as a single float. This would be used to set SFFloat 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

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,
 float[] 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 SFFloat 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