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

Class BaseHAnimDisplacer

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.BaseGeometricPropertyNode

org.web3d.vrml.renderer.common.nodes.hanim.BaseHAnimDisplacer

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLGeometricPropertyNodeType, VRMLHAnimNodeType, VRMLNodeType

Direct Known Subclasses:

NRHAnimDisplacer, OGLHAnimDisplacer

public abstract class BaseHAnimDisplacer
extends BaseGeometricPropertyNode
implements VRMLHAnimNodeType

Common base implementation for the field handling of a HAnimDisplacer node.

The node is defined as follows:

  HAnimDisplacer : X3DGeometricPropertyNode {
    MFInt32  [in,out] coordIndex    []   [0,inf) or -1
    MFVec3f  [in,out] displacements []   [X3DCoordinateNode]
    SFNode   [in,out] metadata      NULL [X3DMetadataObject]
    SFString [in,out] name          ""
  }
 

Version:

$Revision: 2.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DISPLACEMENT_NODE_MSG	Message for when the node in setValue() is not a Appearance
protected static final String	DISPLACEMENT_PROTO_MSG	Message for when the proto is not a Appearance
protected static final int	FIELD_COORD_INDEX	Field Index for coordIndex
protected static final int	FIELD_DISPLACEMENTS	Field Index for displacements
protected static final int	FIELD_NAME	Field Index for name
protected org.j3d.geom.hanim.HAnimFactory	hanimFactory	Factory used to generate the implementation node
protected org.j3d.geom.hanim.HAnimDisplacer	hanimImpl	The generic internal representation of the node
protected static final int	LAST_DISPLACER_INDEX	The last field index used by this class
protected int	numCoordIndex	actual length of vfCoordIndex
protected int	numDisplacements	actual length of vfDisplacements
protected int[]	vfCoordIndex	exposedField MFInt32 coordIndex
protected float[]	vfDisplacements	List of coordinate nodes this displacer manages
protected String	vfName	The name of this displacer

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
BaseHAnimDisplacer()	Constructor to create a default instance of this node.
BaseHAnimDisplacer(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.
org.j3d.geom.hanim.HAnimObject	getHAnimObject()	Get the HAnim implementation node.
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.
protected void	setCoordIndex(int[] indices, int num)	Set a new value for the coordIndex field.
protected void	setDisplacements(float[] disp, int num)	Set a new value for the displacements field.
void	setHAnimFactory(org.j3d.geom.hanim.HAnimFactory fac)	Set the current node factory to use.
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, int[] value, int numValid)	Set the value of the field at the given index as an array of floats.
void	setValue(int index, String value)	Set the value of the field at the given index as an array of floats.

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

addComponentListener, fireComponentChanged, removeComponentListener

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

Field Details

FIELD_COORD_INDEX

protected static final int FIELD_COORD_INDEX

Field Index for coordIndex

See Also:

• Constant Field Values

FIELD_DISPLACEMENTS

protected static final int FIELD_DISPLACEMENTS

Field Index for displacements

See Also:

• Constant Field Values

FIELD_NAME

protected static final int FIELD_NAME

Field Index for name

See Also:

• Constant Field Values

LAST_DISPLACER_INDEX

protected static final int LAST_DISPLACER_INDEX

The last field index used by this class

See Also:

• Constant Field Values

DISPLACEMENT_PROTO_MSG

protected static final String DISPLACEMENT_PROTO_MSG

Message for when the proto is not a Appearance

See Also:

• Constant Field Values

DISPLACEMENT_NODE_MSG

protected static final String DISPLACEMENT_NODE_MSG

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

See Also:

• Constant Field Values

vfCoordIndex

protected int[] vfCoordIndex

exposedField MFInt32 coordIndex

numCoordIndex

protected int numCoordIndex

actual length of vfCoordIndex

vfDisplacements

protected float[] vfDisplacements

List of coordinate nodes this displacer manages

numDisplacements

protected int numDisplacements

actual length of vfDisplacements

vfName

protected String vfName

The name of this displacer

hanimImpl

protected org.j3d.geom.hanim.HAnimDisplacer hanimImpl

The generic internal representation of the node

hanimFactory

protected org.j3d.geom.hanim.HAnimFactory hanimFactory

Factory used to generate the implementation node

Constructor Details

BaseHAnimDisplacer

public BaseHAnimDisplacer()

Constructor to create a default instance of this node.

BaseHAnimDisplacer

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

setHAnimFactory

public void setHAnimFactory(org.j3d.geom.hanim.HAnimFactory fac)

Set the current node factory to use. If this is set again, replace the current implementation node with a new one from this new instance. This may be needed at times when the user makes a change that forces the old way to be incompatible and thus needing a different implementation.

Specified by:

setHAnimFactory in interface VRMLHAnimNodeType

Parameters:

fac - The new factory instance to use

getHAnimObject

public org.j3d.geom.hanim.HAnimObject getHAnimObject()

Get the HAnim implementation node. Since the HAnim class instance is not the same as the basic geometry instance of the particular rendering API, we need to fetch this higher-level construct so that the scene graph can be constructed.

Specified by:

getHAnimObject in interface VRMLHAnimNodeType

Returns:

The HAnimObject instance for this node

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.

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

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

Set the value of the field at the given index as an array of floats. This would be used to set MFInt32, SFImage, and MFImage 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

setValue

public void setValue(int index,
 float[] value,
 int numValid)
              throws InvalidFieldException

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

setValue

public void setValue(int index,
 String value)
              throws InvalidFieldException

Set the value of the field at the given index as an array of floats. This would be used to set SFString 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

setDisplacements

protected void setDisplacements(float[] disp,
 int num)
                         throws InvalidFieldValueException

Set a new value for the displacements field. Derived classes may override as needed, but should call this one as well.

Parameters:

disp - New value for the field

num - The number of valid values to use from the array

Throws:

InvalidFieldValueException - An index value was < -1

setCoordIndex

protected void setCoordIndex(int[] indices,
 int num)
                      throws InvalidFieldValueException

Set a new value for the coordIndex field. Derived classes may override as needed, but should call this one as well.

Parameters:

indices - New value for the field

num - The number of valid values to use from the array

Throws:

InvalidFieldValueException - An index value was < -1