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

Class BaseCollidableOffset

java.lang.Object

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

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLNBodyCollidableNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRCollidableOffset, OGLCollidableOffset

public abstract class BaseCollidableOffset
extends BaseCollidableNode

Implementation of the CollidableOffset node.

The base class provides most of the basic functionality, including interacting with the ODE portions. However, for returning the scene graph object appropriate for the renderer will require the derived class to take care of it.

The X3D definition of CollidableOffset is:

 CollidableOffset : X3DNBodyCollidableNode {
   SFNode  [in,out] metadata       NULL     [X3DMetadataObject]
   SFBool  [in,out] enabled        TRUE
   SFVec3f [in,out] position       0 0 0    (-∞,∞)
   SFVec3f [in,out] rotation       0 0 1 0  [0,1]
   SFVec3f []       bboxCenter     0 0 0    (-∞,∞)
   SFVec3f []       bboxSize       -1 -1 -1 [0,∞) or -1 -1 -1
   SFBool  [in,out] bboxDisplay    FALSE
   SFBool  [in,out] visible        TRUE
   SFNode  []       collidable     NULL     [X3DNBodyCollidableNode]
 }
 

Version:

$Revision: 1.9 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COLLIDABLE_NODE_MSG	Message for when the node in setValue() is not a primitive
protected static final String	COLLIDABLE_PROTO_MSG	Message for when the node in setValue() is not a primitive
protected static final int	FIELD_COLLIDABLE	The field index for shape
protected static final int	LAST_OFFSET_INDEX	Last index used by this base node
protected VRMLProtoInstance	pCollidable	Proto version of the shape node
protected VRMLNBodyCollidableNodeType	vfCollidable	exposedField SFNode shape NULL

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

FIELD_BBOX_CENTER, FIELD_BBOX_DISPLAY, FIELD_BBOX_SIZE, FIELD_ENABLED, FIELD_ROTATION, FIELD_TRANSLATION, FIELD_VISIBLE, LAST_COLLIDABLE_INDEX, odeGeom, tmatrix, vfBboxCenter, vfBboxDisplay, vfBboxSize, vfEnabled, vfRotation, vfTranslation, vfVisible

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
BaseCollidableOffset()	Construct a new Collidable shape node object.
BaseCollidableOffset(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.
protected void	setCollidable(VRMLNodeType col)	Set node content for the collidable field.
void	setupFinished()	Notification that the construction phase of this node has finished.
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.rigidphysics.BaseCollidableNode

allEventsComplete, copy, getBboxCenter, getBboxDisplay, getBboxSize, getODEGeometry, getPrimaryType, getRotation, getTranslation, getVisible, isEnabled, isShared, sendRoute, setBboxCenter, setBboxDisplay, setBboxSize, setEnabled, setRotation, setShared, setTranslation, setValue, setValue, setVisible, updateFromODE, updateMatrix

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

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

Field Details

FIELD_COLLIDABLE

protected static final int FIELD_COLLIDABLE

The field index for shape

See Also:

• Constant Field Values

LAST_OFFSET_INDEX

protected static final int LAST_OFFSET_INDEX

Last index used by this base node

See Also:

• Constant Field Values

COLLIDABLE_PROTO_MSG

protected static final String COLLIDABLE_PROTO_MSG

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

See Also:

• Constant Field Values

COLLIDABLE_NODE_MSG

protected static final String COLLIDABLE_NODE_MSG

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

See Also:

• Constant Field Values

pCollidable

protected VRMLProtoInstance pCollidable

Proto version of the shape node

vfCollidable

protected VRMLNBodyCollidableNodeType vfCollidable

exposedField SFNode shape NULL

Constructor Details

BaseCollidableOffset

public BaseCollidableOffset()

Construct a new Collidable shape node object.

BaseCollidableOffset

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

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 BaseCollidableNode

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 shape of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

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 BaseCollidableNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

setValue

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

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:

InvalidFieldValueException - The node does not match the required type.

InvalidFieldException - The field index is not known

setCollidable

protected void setCollidable(VRMLNodeType col)
                      throws InvalidFieldValueException

Set node content for the collidable field.

Parameters:

col - The new collidable object

Throws:

InvalidFieldValueException - The node does not match the required type.