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

Class BaseCollision

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseGroupingNode

org.web3d.vrml.renderer.common.nodes.navigation.BaseCollision

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLCollidableNodeType, VRMLEnvironmentalSensorNodeType, VRMLGroupingNodeType, VRMLNodeType, VRMLSensorNodeType, VRMLTimeDependentNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRCollision, OGLCollision

public abstract class BaseCollision
extends BaseGroupingNode
implements VRMLEnvironmentalSensorNodeType, VRMLTimeDependentNodeType, VRMLCollidableNodeType

Common base implementation of a Collision node.

Version:

$Revision: 1.16 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_COLLIDE	Index of the collide field
protected static final int	FIELD_COLLIDE_TIME	Index of the collideTime eventOut
protected static final int	FIELD_ENABLED	Index of the enabled field
protected static final int	FIELD_ISACTIVE	Index of the isActive field
protected static final int	FIELD_PROXY	Index of the proxy field
protected static final VRMLFieldDeclaration[]	fieldDecl	Array of VRMLFieldDeclarations
protected static final Map<String,Integer>	fieldMap	Hashmap between a field name and its index
protected static final int	LAST_COLLIDE_INDEX	Last index used by this node
protected VRMLProtoInstance	pProxy	proto version of SFNode proxy
protected static final String	PROXY_NODE_MSG	Message for when the node in setValue() is not a child
protected static final String	PROXY_PROTO_MSG	Message for when the proto is not a child
protected boolean	vfCollide	exposedField SFBool collide
protected double	vfCollideTime	eventOut SFTime collideTime
protected boolean	vfIsActive	eventout SFBool bind
protected VRMLChildNodeType	vfProxy	field SFNode proxy
protected VRMLClock	vrmlClock	The clock used to drive collide time eventOuts

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseGroupingNode

childCount, FIELD_ADDCHILDREN, FIELD_BBOX_CENTER, FIELD_BBOX_DISPLAY, FIELD_BBOX_SIZE, FIELD_CHILDREN, FIELD_REMOVECHILDREN, FIELD_VISIBLE, hasBindables, LAST_GROUP_INDEX, shareCount, USE_BIND_MSG, vfBboxCenter, vfBboxDisplay, vfBboxSize, vfChildren, 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

Modifier	Constructor	Description
protected	BaseCollision()	Construct a default instance of this node.
protected	BaseCollision(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	collisionDetected()	Activate the collision status of this node.
boolean	getEnabled()	Accessor method to get current value of the enabled field, 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()	Accessor method to get current value of the isActive eventOut
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[]	getSecondaryType()	Get the secondary types 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.
protected void	setCollide(boolean state)	Set the value of the collide field.
void	setEnabled(boolean state)	Set the enabled state of the sensor.
protected void	setIsActive(boolean enable)	Set the isActive field of this node.
protected void	setProxy(VRMLNodeType app)	Set node content as replacement for proxy.
void	setValue(int index, boolean value)	Set the value of the field at the given index as a boolean.
void	setValue(int index, double value)	Set the value of the field at the given index as a double.
void	setValue(int index, VRMLNodeType child)	Set the value of the field at the given index as a node.
void	setVRMLClock(VRMLClock clock)	Set the clock that this time dependent node will be running with.

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

addChild, addChildNode, clearChildren, containsBindableNodes, copy, getBboxCenter, getBboxDisplay, getBboxSize, getChildren, getChildrenSize, getPrimaryType, getVisible, isShared, removeChildNode, setBboxCenter, setBboxDisplay, setBboxSize, setChildren, setChildren, setDEF, setShared, setupFinished, setValue, setValue, setVisible, updateRefCount

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

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, 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

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

Field Details

PROXY_PROTO_MSG

protected static final String PROXY_PROTO_MSG

Message for when the proto is not a child

See Also:

• Constant Field Values

PROXY_NODE_MSG

protected static final String PROXY_NODE_MSG

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

See Also:

• Constant Field Values

FIELD_COLLIDE

protected static final int FIELD_COLLIDE

Index of the collide field

See Also:

• Constant Field Values

FIELD_PROXY

protected static final int FIELD_PROXY

Index of the proxy field

See Also:

• Constant Field Values

FIELD_COLLIDE_TIME

protected static final int FIELD_COLLIDE_TIME

Index of the collideTime eventOut

See Also:

• Constant Field Values

FIELD_ISACTIVE

protected static final int FIELD_ISACTIVE

Index of the isActive 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_COLLIDE_INDEX

protected static final int LAST_COLLIDE_INDEX

Last index used by this node

See Also:

• Constant Field Values

fieldDecl

protected static final VRMLFieldDeclaration[] fieldDecl

Array of VRMLFieldDeclarations

fieldMap

protected static final Map<String,Integer> fieldMap

Hashmap between a field name and its index

vfCollide

protected boolean vfCollide

exposedField SFBool collide

vfProxy

protected VRMLChildNodeType vfProxy

field SFNode proxy

pProxy

protected VRMLProtoInstance pProxy

proto version of SFNode proxy

vfCollideTime

protected double vfCollideTime

eventOut SFTime collideTime

vfIsActive

protected boolean vfIsActive

eventout SFBool bind

vrmlClock

protected VRMLClock vrmlClock

The clock used to drive collide time eventOuts

Constructor Details

BaseCollision

protected BaseCollision()

Construct a default instance of this node. The defaults are set by the VRML specification.

BaseCollision

protected BaseCollision(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a group node, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

setVRMLClock

public void setVRMLClock(VRMLClock clock)

Set the clock that this time dependent node will be running with. The clock provides all the information and listeners for keeping track of time. Setting a value of null will ask the node to remove the clock from it's use so that the node may be removed from the scene.

Specified by:

setVRMLClock in interface VRMLTimeDependentNodeType

Parameters:

clock - The clock to use for this node

setEnabled

public void setEnabled(boolean state)

Set the enabled state of the sensor.

Specified by:

setEnabled in interface VRMLSensorNodeType

Parameters:

state - True if the sensor is to be enabled

getEnabled

public boolean getEnabled()

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

Specified by:

getEnabled in interface VRMLSensorNodeType

Returns:

The value of the enabled field

getIsActive

public boolean getIsActive()

Accessor method to get current value of the isActive eventOut

Specified by:

getIsActive in interface VRMLSensorNodeType

Returns:

The current value of isActive

collisionDetected

public void collisionDetected()

Activate the collision status of this node. If the derived node has detected a collision, this will generate an event out with the correct time. It assumes that the derived node is taking into account the enable and collide field settings.

Specified by:

collisionDetected in interface VRMLCollidableNodeType

getSecondaryType

public int[] getSecondaryType()

Get the secondary types of this node. Replaces the instanceof mechanism for use in switch statements. If there are no secondary types, it will return a zero-length array.

Specified by:

getSecondaryType in interface VRMLNode

Overrides:

getSecondaryType in class AbstractNode

Returns:

The secondary 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.

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

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.

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 BaseGroupingNode

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 BaseGroupingNode

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 would be used to set SFBool field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class BaseGroupingNode

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 known

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

setValue

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

Set the value of the field at the given index as a double. This would be used to set SFDouble or SFTime 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 known

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

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 BaseGroupingNode

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

setProxy

protected void setProxy(VRMLNodeType app)
                 throws InvalidFieldValueException

Set node content as replacement for proxy.

Parameters:

app - The new proxy. null will act like delete

Throws:

InvalidFieldValueException - The node does not match the required type.

setCollide

protected void setCollide(boolean state)

Set the value of the collide field. Used to change the collision status. Can be overridden by derived classes, but should be called to make sure all field handling is done correctly.

Parameters:

state - true if the collision is being set

setIsActive

protected void setIsActive(boolean enable)

Set the isActive field of this node. This will cause the node to be the subject of input handling.

Parameters:

enable - True if this node is to be bound