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

All Implemented Interfaces:: VRMLNode, FrameStateListener, VRMLBoundedNodeType, VRMLChildNodeType, VRMLGroupingNodeType, VRMLHAnimNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:: NRHAnimSegment, OGLHAnimSegment

public abstract class BaseHAnimSegment extends BaseGroupingNode implements VRMLHAnimNodeType

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

The node is defined as follows:

  HAnimSegment : X3DGroupingNode {
    MFNode   [in]     addChildren                          [X3DChildNode]
    MFNode   [in]     removeChildren                       [X3DChildNode]
    SFVec3f  [in,out] centerOfMass     0 0 0               (-inf,inf)
    MFNode   [in,out] children         []                  [X3DChildNode]
    SFNode   [in,out] coord            NULL                [X3DCoordinateNode]
    MFNode   [in,out] displacers       []                  [HAnimDisplacer]
    SFFloat  [in,out] mass             0                   (0,inf)
    SFNode   [in,out] metadata         NULL                [X3DMetadataObject]
    MFFloat  [in,out] momentsOfInertia [0 0 0 0 0 0 0 0 0] [0,inf)
    SFString [in,out] name             ""
    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.4 $
Author:: Justin Couch

Field Summary

Fields

Modifier and Type

Field

Description

protected static final String

COORD_NODE_MSG

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

protected static final String

COORD_PROTO_MSG

Message for when the proto is not a Coordinate

protected static final String

DISPLACEMENT_NODE_MSG

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

protected static final String

DISPLACEMENT_PROTO_MSG

Message for when the proto is not a HAnimDisplacer

protected static final int

FIELD_CENTER_OF_MASS

Index of the field centerOfMass

protected static final int

FIELD_COORD

Index of the field coord

protected static final int

FIELD_DISPLACERS

Index of the field displacers

protected static final int

FIELD_MASS

Index of the field mass

protected static final int

FIELD_MOMENTS_OF_INERTIA

Index of the field momentsOfIntertia

protected static final int

FIELD_NAME

Index of the field name

protected static VRMLFieldDeclaration[]

fieldDecl

Array of VRMLFieldDeclarations

protected static final Map<String,Integer>

fieldMap

Hashmap between a field name and its index

protected org.j3d.geom.hanim.HAnimFactory

hanimFactory

Factory used to generate the implementation node

protected org.j3d.geom.hanim.HAnimSegment

hanimImpl

The generic internal representation of the node

protected static final int

LAST_DISPLACER_INDEX

Last index declared for these fields

protected static final int

NUM_FIELDS

Number of fields constant

protected int

numMomentsOfInertia

Number of valid values in the moments of inertia field

protected VRMLProtoInstance

pCoord

proto version of coord

protected float[]

vfCenterOfMass

exposedField SFVec3f centerOfMass

protected VRMLCoordinateNodeType

vfCoord

exposedField SFNode coord

protected List<VRMLHAnimNodeType>

vfDisplacers

exposedField MFNode displacers

protected float

vfMass

exposedField SFFloat mass

protected float[]

vfMomentsOfInertia

exposedField MFFloat momentsOfIntertia

protected String

vfName

exposedField SFString name

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

BaseHAnimSegment()

Construct a default instance of this node.

BaseHAnimSegment(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

addDisplacerNode(VRMLNodeType node)

Add a single child node to the list of available children.

protected void

clearDisplacers()

Clear the child node list of all children in the VRML node.

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.

protected void

setCenterOfMass(float[] value)

Set the center of mass field value.

protected void

setCoord(VRMLNodeType coord)

Set node content as replacement for the skinCoord field.

void

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

Set the current node factory to use.

protected void

setMomentsOfInertia(float[] value, int numValues)

Set the new values for momentsOfInertia.

void

setupFinished()

Notification that the construction phase of this node has finished.

void

setValue(int index, float value)

Set the value of the field at the given index as a single float.

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 a single string.

void

setValue(int index, VRMLNodeType child)

Set the value of the field at the given index as an array of nodes.

void

setValue(int index, VRMLNodeType[] children, int numValid)

Set the value of the field at the given index as an array of nodes.

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

Field Details
- FIELD_CENTER_OF_MASS
  protected static final int FIELD_CENTER_OF_MASS
  
  Index of the field centerOfMass
  
  See Also:
  
  Constant Field Values
- FIELD_COORD
  protected static final int FIELD_COORD
  
  Index of the field coord
  
  See Also:
  
  Constant Field Values
- FIELD_DISPLACERS
  protected static final int FIELD_DISPLACERS
  
  Index of the field displacers
  
  See Also:
  
  Constant Field Values
- FIELD_MASS
  protected static final int FIELD_MASS
  
  Index of the field mass
  
  See Also:
  
  Constant Field Values
- FIELD_MOMENTS_OF_INERTIA
  protected static final int FIELD_MOMENTS_OF_INERTIA
  
  Index of the field momentsOfIntertia
  
  See Also:
  
  Constant Field Values
- FIELD_NAME
  protected static final int FIELD_NAME
  
  Index of the field name
  
  See Also:
  
  Constant Field Values
- LAST_DISPLACER_INDEX
  protected static final int LAST_DISPLACER_INDEX
  
  Last index declared for these fields
  
  See Also:
  
  Constant Field Values
- NUM_FIELDS
  protected static final int NUM_FIELDS
  
  Number of fields constant
  
  See Also:
  
  Constant Field Values
- COORD_PROTO_MSG
  protected static final String COORD_PROTO_MSG
  
  Message for when the proto is not a Coordinate
  
  See Also:
  
  Constant Field Values
- COORD_NODE_MSG
  protected static final String COORD_NODE_MSG
  
  Message for when the node in setValue() is not a Coordinate
  
  See Also:
  
  Constant Field Values
- DISPLACEMENT_PROTO_MSG
  protected static final String DISPLACEMENT_PROTO_MSG
  
  Message for when the proto is not a HAnimDisplacer
  
  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 HAnimDisplacer
  
  See Also:
  
  Constant Field Values
- fieldDecl
  
  protected static VRMLFieldDeclaration[] fieldDecl
  
  Array of VRMLFieldDeclarations
- fieldMap
  
  protected static final Map<String,Integer> fieldMap
  
  Hashmap between a field name and its index
- vfCenterOfMass
  
  protected float[] vfCenterOfMass
  
  exposedField SFVec3f centerOfMass
- vfCoord
  
  protected VRMLCoordinateNodeType vfCoord
  
  exposedField SFNode coord
- pCoord
  
  protected VRMLProtoInstance pCoord
  
  proto version of coord
- vfDisplacers
  
  protected List<VRMLHAnimNodeType> vfDisplacers
  
  exposedField MFNode displacers
- vfMass
  
  protected float vfMass
  
  exposedField SFFloat mass
- vfMomentsOfInertia
  
  protected float[] vfMomentsOfInertia
  
  exposedField MFFloat momentsOfIntertia
- numMomentsOfInertia
  
  protected int numMomentsOfInertia
  
  Number of valid values in the moments of inertia field
- vfName
  
  protected String vfName
  
  exposedField SFString name
- hanimImpl
  
  protected org.j3d.geom.hanim.HAnimSegment 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
- BaseHAnimSegment
  
  public BaseHAnimSegment()
  
  Construct a default instance of this node. The defaults are set by the VRML specification.
- BaseHAnimSegment
  
  public BaseHAnimSegment(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
- 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
- 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 BaseGroupingNode
- 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) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as a single float. This would be used to set SFFloat 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 is not in the acceptable range for the given field
- 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 is not in the acceptable range for the given field
- setValue
  
  public void setValue(int index, String value) throws InvalidFieldException
  
  Set the value of the field at the given index as a single string. 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
- setValue
  
  public void setValue(int index, VRMLNodeType child) throws InvalidFieldException, InvalidFieldValueException
  
  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 BaseGroupingNode
  
  Parameters:
  
  index - The index of destination field to set
  
  child - The new value to use for the node
  
  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, VRMLNodeType[] children, int numValid) throws InvalidFieldException, InvalidFieldValueException
  
  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 BaseGroupingNode
  
  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.
- setCenterOfMass
  
  protected void setCenterOfMass(float[] value)
  
  Set the center of mass field value.
  
  Parameters:
  
  value - The new value to set
- setMomentsOfInertia
  
  protected void setMomentsOfInertia(float[] value, int numValues) throws InvalidFieldValueException
  
  Set the new values for momentsOfInertia. All values are required to be [0, inf).
  
  Parameters:
  
  value - The new value of the field to use
  
  numValues - The number of valid values to use from the array
  
  Throws:
  
  InvalidFieldValueException - A value was less than zero
- setCoord
  
  protected void setCoord(VRMLNodeType coord) throws InvalidFieldValueException
  
  Set node content as replacement for the skinCoord field.
  
  Parameters:
  
  coord - The new coordinate node. null will act like delete
  
  Throws:
  
  InvalidFieldValueException - The node does not match the required type.
- clearDisplacers
  
  protected void clearDisplacers()
  
  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.
- addDisplacerNode
  
  protected void addDisplacerNode(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

Class BaseHAnimSegment

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

Field Details

FIELD_CENTER_OF_MASS

FIELD_COORD

FIELD_DISPLACERS

FIELD_MASS

FIELD_MOMENTS_OF_INERTIA

FIELD_NAME

LAST_DISPLACER_INDEX

NUM_FIELDS

COORD_PROTO_MSG

COORD_NODE_MSG

DISPLACEMENT_PROTO_MSG

DISPLACEMENT_NODE_MSG

fieldDecl

fieldMap

vfCenterOfMass

vfCoord

pCoord

vfDisplacers

vfMass

vfMomentsOfInertia

numMomentsOfInertia

vfName

hanimImpl

hanimFactory

Constructor Details

BaseHAnimSegment

BaseHAnimSegment

Method Details

setHAnimFactory

getHAnimObject

setupFinished

getFieldIndex

getNodeFieldIndices

getFieldDeclaration

getNumFields

getFieldValue

sendRoute

setValue

setValue

setValue

setValue

setValue

setCenterOfMass

setMomentsOfInertia

setCoord

clearDisplacers

addDisplacerNode