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

Class BaseHAnimSite

java.lang.Object

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

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

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

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLGroupingNodeType, VRMLHAnimNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRHAnimSite, OGLHAnimSite

public abstract class BaseHAnimSite
extends BaseGroupingNode
implements VRMLHAnimNodeType

Common implementation for the field handling of a HAnimSite node.

The node is defined as follows:

  HAnimSite : X3DGroupingNode {
    MFNode     [in]     addChildren               [X3DChildNode]
    MFNode     [in]     removeChildren            [X3DChildNode]
    SFVec3f    [in,out] center           0 0 0    (-inf,inf)
    MFNode     [in,out] children         []       [X3DChildNode]
    SFNode     [in,out] metadata         NULL     [X3DMetadataObject]
    SFString   [in,out] name             ""
    SFRotation [in,out] rotation         0 0 1 0  (-inf,inf)|[-1,1]
    SFVec3f    [in,out] scale            1 1 1    (0,inf)
    SFRotation [in,out] scaleOrientation 0 0 1 0  (-inf,inf)|[-1,1]
    SFVec3f    [in,out] translation      0 0 0    (-inf,inf)|[-1,1]
    SFVec3f    []       bboxCenter       0 0 0    (-inf,inf)
    SFVec3f    []       bboxSize         -1 -1 -1 [0,inf) or -1 -1 -1
    SFBool              bboxDisplay      FALSE
  }
 

This class does not pass the children field values along to the render implementation node because that needs to be a renderer-specific object. Derived classes need to handle this in the setHAnimFactory() call and any time the children are set.

Version:

$Revision: 2.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_CENTER	Field Index for the field: center
protected static final int	FIELD_NAME	Field Index for the field: name
protected static final int	FIELD_ROTATION	Field Index for the field: rotation
protected static final int	FIELD_SCALE	Field Index for the field: scale
protected static final int	FIELD_SCALE_ORIENTATION	Field Index for the field: scale orientation
protected static final int	FIELD_TRANSLATION	Field Index for the field: translation
protected org.j3d.geom.hanim.HAnimFactory	hanimFactory	Factory used to generate the implementation node
protected org.j3d.geom.hanim.HAnimSite	hanimImpl	The generic internal representation of the node
protected static final int	LAST_SITE_INDEX	The last field index used by this class
protected static final int	NUM_FIELDS	Number of fields constant
protected float[]	vfCenter	SFVec3f center
protected String	vfName	The name of this displacer
protected float[]	vfRotation	SFRotation rotation
protected float[]	vfScale	SFVec3f scale
protected float[]	vfScaleOrientation	SFRotation scaleOrientation
protected float[]	vfTranslation	SFVec3f translation

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

Constructor	Description
BaseHAnimSite()	Construct a default instance of this node.
BaseHAnimSite(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.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setCenter(float[] center)	Set the center component of the of transform.
void	setHAnimFactory(org.j3d.geom.hanim.HAnimFactory fac)	Set the current node factory to use.
void	setRotation(float[] rot)	Set the rotation component of the of transform.
void	setScale(float[] scale)	Set the scale component of the of transform.
void	setScaleOrientation(float[] so)	Set the scale orientation component of the of transform.
void	setTranslation(float[] tx)	Set the translation component of the of transform.
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, 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.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, 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, getSecondaryType, 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, 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, setValue, updateRefCount

Field Details

FIELD_CENTER

protected static final int FIELD_CENTER

Field Index for the field: center

See Also:

• Constant Field Values

FIELD_ROTATION

protected static final int FIELD_ROTATION

Field Index for the field: rotation

See Also:

• Constant Field Values

FIELD_SCALE

protected static final int FIELD_SCALE

Field Index for the field: scale

See Also:

• Constant Field Values

FIELD_SCALE_ORIENTATION

protected static final int FIELD_SCALE_ORIENTATION

Field Index for the field: scale orientation

See Also:

• Constant Field Values

FIELD_TRANSLATION

protected static final int FIELD_TRANSLATION

Field Index for the field: translation

See Also:

• Constant Field Values

FIELD_NAME

protected static final int FIELD_NAME

Field Index for the field: name

See Also:

• Constant Field Values

LAST_SITE_INDEX

protected static final int LAST_SITE_INDEX

The last field index used by this class

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

vfCenter

protected float[] vfCenter

SFVec3f center

vfRotation

protected float[] vfRotation

SFRotation rotation

vfScale

protected float[] vfScale

SFVec3f scale

vfScaleOrientation

protected float[] vfScaleOrientation

SFRotation scaleOrientation

vfTranslation

protected float[] vfTranslation

SFVec3f translation

vfName

protected String vfName

The name of this displacer

hanimImpl

protected org.j3d.geom.hanim.HAnimSite 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

BaseHAnimSite

public BaseHAnimSite()

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

BaseHAnimSite

public BaseHAnimSite(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. It does not copy the children nodes, just this node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

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.

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

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 BaseGroupingNode

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.

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

setRotation

public void setRotation(float[] rot)
                 throws InvalidFieldValueException

Set the rotation component of the of transform. Setting a value of null is an error

Parameters:

rot - The new rotation component

Throws:

InvalidFieldValueException - The rotation was null

setTranslation

public void setTranslation(float[] tx)
                    throws InvalidFieldValueException

Set the translation component of the of transform. Setting a value of null is an error

Parameters:

tx - The new translation component

Throws:

InvalidFieldValueException - The translation was null

setScale

public void setScale(float[] scale)
              throws InvalidFieldValueException

Set the scale component of the of transform. Setting a value of null is an error

Parameters:

scale - The new scale component

Throws:

InvalidFieldValueException - The scale was null

setScaleOrientation

public void setScaleOrientation(float[] so)
                         throws InvalidFieldValueException

Set the scale orientation component of the of transform. Setting a value of null is an error

Parameters:

so - The new scale orientation component

Throws:

InvalidFieldValueException - The scale orientation was null

setCenter

public void setCenter(float[] center)
               throws InvalidFieldValueException

Set the center component of the of transform. Setting a value of null is an error

Parameters:

center - The new center component

Throws:

InvalidFieldValueException - The center was null