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

Class BaseCollisionSpace

java.lang.Object

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLNBodySpaceNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRCollisionSpace, OGLCollisionSpace

public abstract class BaseCollisionSpace
extends AbstractNode
implements VRMLNBodySpaceNodeType

Implementation of the CollidableSpace node. The X3D definition of CollisionSpace is:

 CollisionSpace : X3DNode {
   MFNode  [in,out] collidables NULL      [X3DNBodyCollisionSpaceNode, X3DNBodyCollidableNode]
   SFBool  [in,out] enabled     TRUE
   SFNode  [in,out] metadata    NULL      [X3DMetadataObject]
   SFBool  [in,out] useGeometry FALSE
   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
 }
 

Version:

$Revision: 1.6 $

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_BBOX_CENTER	The field index for bboxCenter
protected static final int	FIELD_BBOX_DISPLAY	The field index for bboxDisplay
protected static final int	FIELD_BBOX_SIZE	The field index for bboxSize
protected static final int	FIELD_COLLIDABLES	The field index for collidables
protected static final int	FIELD_ENABLED	The field index for enabled
protected static final int	FIELD_USE_GEOMETRY	The field index for useGeometry
protected static final int	FIELD_VISIBLE	The field index for visible
protected static final int	LAST_SPACE_INDEX	Last index used by this base node
protected float[]	vfBboxCenter	value of the field bboxCenter 0, 0, 0
protected boolean	vfBboxDisplay	value of the field bboxDisplay false
protected float[]	vfBboxSize	value of the field bboxSize [-1, -1, -1]
protected boolean	vfEnabled	The value of the enabled field
protected boolean	vfUseGeometry	Value of the useGeometry field
protected boolean	vfVisible	value of the field visible true

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

Method Summary

Modifier and Type	Method	Description
protected void	addCollidable(VRMLNodeType node)	Add a single child node to the list of available children.
protected void	clearCollidables()	Clear the child node list of all children in the VRML node.
float[]	getBboxCenter()	Get the current value of field the bboxCenter field.
boolean	getBboxDisplay()	Get the current value of the bboxDisplay field.
float[]	getBboxSize()	Get the current value of the bboxSize field.
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.
org.odejava.Space	getODESpace()	Get the ODE object that represents the body to evaluate.
int	getPrimaryType()	Get the primary type of this node.
boolean	getVisible()	Get the current value of the visible field.
boolean	isEnabled()	Is this group enabled for use right now?
boolean	isShared()	Check to see if this node has been used more than once.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setBboxCenter(float[] val)	Set the bounding box for this node.
void	setBboxDisplay(boolean val)	Set the bounding box display for this node.
void	setBboxSize(float[] val)	Set the bounding box for this node.
void	setParentODESpace(org.odejava.Space parent)	Set the parent space that this space belongs to.
void	setShared(boolean used)	Adjust the sharing count up or down one increment depending on the flag.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, boolean value)	Set the value of the field at the given index as a single boolean.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.
void	setValue(int index, VRMLNodeType[] children, int numValid)	Set the value of the field at the given index as an array of nodes.
void	setVisible(boolean val)	Set the bounding box display for this 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, 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_BBOX_SIZE

protected static final int FIELD_BBOX_SIZE

The field index for bboxSize

See Also:

• Constant Field Values

FIELD_BBOX_CENTER

protected static final int FIELD_BBOX_CENTER

The field index for bboxCenter

See Also:

• Constant Field Values

FIELD_BBOX_DISPLAY

protected static final int FIELD_BBOX_DISPLAY

The field index for bboxDisplay

See Also:

• Constant Field Values

FIELD_VISIBLE

protected static final int FIELD_VISIBLE

The field index for visible

See Also:

• Constant Field Values

FIELD_COLLIDABLES

protected static final int FIELD_COLLIDABLES

The field index for collidables

See Also:

• Constant Field Values

FIELD_USE_GEOMETRY

protected static final int FIELD_USE_GEOMETRY

The field index for useGeometry

See Also:

• Constant Field Values

FIELD_ENABLED

protected static final int FIELD_ENABLED

The field index for enabled

See Also:

• Constant Field Values

LAST_SPACE_INDEX

protected static final int LAST_SPACE_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

vfEnabled

protected boolean vfEnabled

The value of the enabled field

vfBboxCenter

protected float[] vfBboxCenter

value of the field bboxCenter 0, 0, 0

vfBboxSize

protected float[] vfBboxSize

value of the field bboxSize [-1, -1, -1]

vfBboxDisplay

protected boolean vfBboxDisplay

value of the field bboxDisplay false

vfVisible

protected boolean vfVisible

value of the field visible true

vfUseGeometry

protected boolean vfUseGeometry

Value of the useGeometry field

Constructor Details

BaseCollisionSpace

public BaseCollisionSpace()

Construct a new default CollisionSpace node object.

BaseCollisionSpace

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

getODESpace

public org.odejava.Space getODESpace()

Get the ODE object that represents the body to evaluate.

Specified by:

getODESpace in interface VRMLNBodySpaceNodeType

Returns:

The body object representing this node

setParentODESpace

public void setParentODESpace(org.odejava.Space parent)

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

Specified by:

setParentODESpace in interface VRMLNBodySpaceNodeType

Parameters:

parent - The new parent of this object, or null

isEnabled

public boolean isEnabled()

Is this group enabled for use right now?

Specified by:

isEnabled in interface VRMLNBodySpaceNodeType

Returns:

true if this is enabled

getBboxCenter

public float[] getBboxCenter()

Description copied from interface: VRMLBoundedNodeType

Get the current value of field the bboxCenter field. The default value is 0 0 0.

Specified by:

getBboxCenter in interface VRMLBoundedNodeType

Returns:

The value of bboxCenter(SFVec3f)

getBboxSize

public float[] getBboxSize()

Description copied from interface: VRMLBoundedNodeType

Get the current value of the bboxSize field. The default value is -1 -1 -1.

Specified by:

getBboxSize in interface VRMLBoundedNodeType

Returns:

The size of the bboxSize(SFVec3f)

getBboxDisplay

public boolean getBboxDisplay()

Description copied from interface: VRMLBoundedNodeType

Get the current value of the bboxDisplay field. The default value is false.

Specified by:

getBboxDisplay in interface VRMLBoundedNodeType

Returns:

the value of the bboxDisplay(SFBool)

getVisible

public boolean getVisible()

Description copied from interface: VRMLBoundedNodeType

Get the current value of the visible field. The default value is true.

Specified by:

getVisible in interface VRMLBoundedNodeType

Returns:

the value of the visible(SFBool)

isShared

public boolean isShared()

Check to see if this node has been used more than once. If it has then return true.

Specified by:

isShared in interface VRMLBoundedNodeType

Returns:

true if this node is shared

setShared

public void setShared(boolean used)

Adjust the sharing count up or down one increment depending on the flag.

Specified by:

setShared in interface VRMLBoundedNodeType

Parameters:

used - true if this is about to have another reference added

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

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

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.

Specified by:

getNodeFieldIndices in interface VRMLNode

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

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

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 shape 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.

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

Set the value of the field at the given index as a single boolean. This would be used to set SFBool 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 InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of floats. This would be used to set MFFloat, SFVec2f, SFVec3f and SFRotation 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 known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

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

setValue

public void setValue(int index,
 VRMLNodeType[] children,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException,
InvalidFieldAccessException

Set the value of the field at the given index as an array of nodes. This would be used to set MFNode field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

children - 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 known

InvalidFieldValueException - The value provided is out of range for the field type.

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now

setBboxCenter

public void setBboxCenter(float[] val)

Set the bounding box for this node. Only used by the field parser at setup.

Specified by:

setBboxCenter in interface VRMLBoundedNodeType

Parameters:

val - The box center to set

setBboxSize

public void setBboxSize(float[] val)
                 throws InvalidFieldValueException

Set the bounding box for this node. Only used by the field parser at setup.

Specified by:

setBboxSize in interface VRMLBoundedNodeType

Parameters:

val - The box size to set

Throws:

InvalidFieldValueException - The bounds is not valid

setBboxDisplay

public void setBboxDisplay(boolean val)

Set the bounding box display for this node. Only used by the field parser at setup.

Specified by:

setBboxDisplay in interface VRMLBoundedNodeType

Parameters:

val - the box display value to set

setVisible

public void setVisible(boolean val)

Set the bounding box display for this node. Only used by the field parser at setup.

Specified by:

setVisible in interface VRMLBoundedNodeType

Parameters:

val - the box display value to set

clearCollidables

protected void clearCollidables()

Clear the child node list of all children in the VRML node. Override to provide.renderer-specific behaviour, but remember to also call this implementation too.

addCollidable

protected void addCollidable(VRMLNodeType node)
                      throws InvalidFieldValueException

Add a single child node to the list of available children. Override to provide.renderer-specific behaviour, but remember to also call this implementation too.

Parameters:

node - The node to add

Throws:

InvalidFieldValueException - This is a bindable node shared