Class BaseHAnimJoint
java.lang.Object
org.web3d.vrml.renderer.common.nodes.AbstractNode
org.web3d.vrml.renderer.common.nodes.BaseGroupingNode
org.web3d.vrml.renderer.common.nodes.hanim.BaseHAnimJoint
- All Implemented Interfaces:
VRMLNode
,FrameStateListener
,VRMLBoundedNodeType
,VRMLChildNodeType
,VRMLGroupingNodeType
,VRMLHAnimNodeType
,VRMLNodeType
,VRMLWorldRootChildNodeType
- Direct Known Subclasses:
NRHAnimJoint
,OGLHAnimJoint
Common implementation for the field handling of the HAnimJoint node.
The node is defined as follows:
HAnimJoint : X3DGroupingNode { MFNode [in] addChildren [HAnimJoint,HAnimSegment,HAnimSite] MFNode [in] removeChildren [HAnimJoint,HAnimSegment,HAnimSite] SFVec3f [in,out] center 0 0 0 (-inf,inf) MFNode [in,out] children [] [HAnimJoint,HAnimSegment,HAnimSite] SFRotation [in,out] limitOrientation 0 0 1 0 (-inf,inf)|[-1,1] MFFloat [in,out] llimit [] (-inf,inf) 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] MFInt32 [in,out] skinCoordIndex [] MFFloat [in,out] skinCoordWeight [] MFFloat [in,out] stiffness [0 0 0] [0,1] SFVec3f [in,out] translation 0 0 0 (-inf,inf) MFFloat [in,out] ulimit [] (-inf,inf) SFVec3f [] bboxCenter 0 0 0 (-inf,inf) SFVec3f [] bboxSize -1 -1 -1 [0,inf) or -1 -1 -1 SFBool bboxDisplay FALSE }This base class does not automatically update the underlying transform with each set() call. These calls only update the local field values, but not the transform that would be used in the rendering code. To make sure this is updated, call the updateMatrix() method and then use the updated matrix in your rendering code.
- Version:
- $Revision: 2.3 $
- Author:
- Justin Couch
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final int
Field Index for the field: centerprotected static final int
Field Index for the field: limitOrientationprotected static final int
Field Index for the field: limitprotected static final int
Field Index for the field: nameprotected static final int
Field Index for the field: rotationprotected static final int
Field Index for the field: scaleprotected static final int
Field Index for the field: scaleOrientationprotected static final int
Field Index for the field: skinCoordIndexprotected static final int
Field Index for the field: skinCoordWeightprotected static final int
Field Index for the field: stiffnessprotected static final int
Field Index for the field: translationprotected static final int
Field Index for the field: ulimitprotected org.j3d.geom.hanim.HAnimFactory
Factory used to generate the implementation nodeprotected org.j3d.geom.hanim.HAnimJoint
The generic internal representation of the nodeprotected static final int
The last field index used by this classprotected static final int
Number of fields constantprotected int
Number of valid items in vfLlimitprotected int
The number of valid items in vfSkinCoordIndexprotected int
The number of valid items in vfSkinCoordWeightprotected int
The numer of valid items in vfStiffnessprotected int
The number of valid values in vfUlimitprotected float[]
SFVec3f centerprotected float[]
SFRotation limitOrientationprotected float[]
MFFloat limitprotected String
The name of this jointprotected float[]
SFRotation rotationprotected float[]
SFVec3f scaleprotected float[]
SFRotation scaleOrientationprotected int[]
MFInt32 skinCoordIndexprotected float[]
MFFloat skinCoordWeightprotected float[]
MFFloat stiffnessprotected float[]
SFVec3f translationprotected float[]
MFFloat ulimitFields 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
ConstructorsConstructorDescriptionConstruct a default instance of this node.BaseHAnimJoint
(VRMLNodeType node) Construct a new instance of this node based on the details from the given node. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addChildNode
(VRMLNodeType node) Add a single child node to the list of available children.protected void
Clear the child node list of all children - both VRML and OpenGL.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.getFieldValue
(int index) Get the value of a field.org.j3d.geom.hanim.HAnimObject
Get the HAnim implementation node.int[]
Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).int
Get the number of fields.protected void
removeChildNode
(VRMLNodeType node) Remove a single child node to the list of available children.void
sendRoute
(double time, int srcIndex, VRMLNodeType destNode, int destIndex) Send a routed value from this node to the given destination node.protected void
setCenter
(float[] center) Set the center component of the joint.void
setHAnimFactory
(org.j3d.geom.hanim.HAnimFactory fac) Set the current node factory to use.protected void
setLimitOrientation
(float[] lo) Set the limit orientation component of the joint.protected void
setLlimit
(float[] lim, int num) Set the limit component of the joint.protected void
setRotation
(float[] rot) Set the rotation component of the joint.protected void
setScale
(float[] scale) Set the scale component of the joint.protected void
setScaleOrientation
(float[] so) Set the scale orientation component of the joint.protected void
setSkinCoordIndex
(int[] idx, int num) Set the skinCoordIndex component of the joint.protected void
setSkinCoordWeight
(float[] idx, int num) Set the skinCoordWeight component of the joint.protected void
setStiffness
(float[] stiffness, int num) Set the stiffness component of the joint.protected void
setTranslation
(float[] tx) Set the translation component of the joint.protected void
setUlimit
(float[] lim, int num) Set the ulimit component of the joint.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 ints.void
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, containsBindableNodes, copy, getBboxCenter, getBboxDisplay, getBboxSize, getChildren, getChildrenSize, getPrimaryType, getVisible, isShared, 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, 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, updateRefCount
-
Field Details
-
FIELD_CENTER
protected static final int FIELD_CENTERField Index for the field: center- See Also:
-
FIELD_ROTATION
protected static final int FIELD_ROTATIONField Index for the field: rotation- See Also:
-
FIELD_SCALE
protected static final int FIELD_SCALEField Index for the field: scale- See Also:
-
FIELD_SCALE_ORIENTATION
protected static final int FIELD_SCALE_ORIENTATIONField Index for the field: scaleOrientation- See Also:
-
FIELD_TRANSLATION
protected static final int FIELD_TRANSLATIONField Index for the field: translation- See Also:
-
FIELD_NAME
protected static final int FIELD_NAMEField Index for the field: name- See Also:
-
FIELD_LIMIT_ORIENTATION
protected static final int FIELD_LIMIT_ORIENTATIONField Index for the field: limitOrientation- See Also:
-
FIELD_LLIMIT
protected static final int FIELD_LLIMITField Index for the field: limit- See Also:
-
FIELD_SKIN_COORD_INDEX
protected static final int FIELD_SKIN_COORD_INDEXField Index for the field: skinCoordIndex- See Also:
-
FIELD_SKIN_COORD_WEIGHT
protected static final int FIELD_SKIN_COORD_WEIGHTField Index for the field: skinCoordWeight- See Also:
-
FIELD_STIFFNESS
protected static final int FIELD_STIFFNESSField Index for the field: stiffness- See Also:
-
FIELD_ULIMIT
protected static final int FIELD_ULIMITField Index for the field: ulimit- See Also:
-
LAST_JOINT_INDEX
protected static final int LAST_JOINT_INDEXThe last field index used by this class- See Also:
-
NUM_FIELDS
protected static final int NUM_FIELDSNumber of fields constant- See Also:
-
vfCenter
protected float[] vfCenterSFVec3f center -
vfRotation
protected float[] vfRotationSFRotation rotation -
vfScale
protected float[] vfScaleSFVec3f scale -
vfScaleOrientation
protected float[] vfScaleOrientationSFRotation scaleOrientation -
vfTranslation
protected float[] vfTranslationSFVec3f translation -
vfName
The name of this joint -
vfLimitOrientation
protected float[] vfLimitOrientationSFRotation limitOrientation -
vfLlimit
protected float[] vfLlimitMFFloat limit -
numLlimit
protected int numLlimitNumber of valid items in vfLlimit -
vfSkinCoordIndex
protected int[] vfSkinCoordIndexMFInt32 skinCoordIndex -
numSkinCoordIndex
protected int numSkinCoordIndexThe number of valid items in vfSkinCoordIndex -
vfSkinCoordWeight
protected float[] vfSkinCoordWeightMFFloat skinCoordWeight -
numSkinCoordWeight
protected int numSkinCoordWeightThe number of valid items in vfSkinCoordWeight -
vfStiffness
protected float[] vfStiffnessMFFloat stiffness -
numStiffness
protected int numStiffnessThe numer of valid items in vfStiffness -
vfUlimit
protected float[] vfUlimitMFFloat ulimit -
numUlimit
protected int numUlimitThe number of valid values in vfUlimit -
hanimImpl
protected org.j3d.geom.hanim.HAnimJoint hanimImplThe generic internal representation of the node -
hanimFactory
protected org.j3d.geom.hanim.HAnimFactory hanimFactoryFactory used to generate the implementation node
-
-
Constructor Details
-
BaseHAnimJoint
public BaseHAnimJoint()Construct a default instance of this node. The defaults are set by the VRML specification. -
BaseHAnimJoint
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 interfaceVRMLHAnimNodeType
- 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 interfaceVRMLHAnimNodeType
- Returns:
- The HAnimObject instance for this node
-
getFieldIndex
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 interfaceVRMLNode
- 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 interfaceVRMLNode
- Returns:
- The list of field indices that correspond to SF/MFnode fields or null if none
-
getFieldDeclaration
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 interfaceVRMLNode
- 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 interfaceVRMLNode
- Returns:
- The number of fields.
-
getFieldValue
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 interfaceVRMLNodeType
- Overrides:
getFieldValue
in classBaseGroupingNode
- 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
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 interfaceVRMLNodeType
- Overrides:
sendRoute
in classBaseGroupingNode
- 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 fromdestNode
- The node reference that we will be sending the value todestIndex
- 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, InvalidFieldValueException Set the value of the field at the given index as an array of ints. This would be used to set MFInt32, SFImage and MFImage field types.- Specified by:
setValue
in interfaceVRMLNodeType
- Overrides:
setValue
in classAbstractNode
- Parameters:
index
- The index of destination field to setvalue
- The new value to use for the nodenumValid
- The number of valid values to copy from the array- Throws:
InvalidFieldException
- The field index is not knownInvalidFieldValueException
- 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, 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 interfaceVRMLNodeType
- Overrides:
setValue
in classBaseGroupingNode
- Parameters:
index
- The index of destination field to setvalue
- The new value to use for the nodenumValid
- The number of valid values to copy from the array- Throws:
InvalidFieldException
- The field index is not knownInvalidFieldValueException
- 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
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 interfaceVRMLNodeType
- Overrides:
setValue
in classAbstractNode
- Parameters:
index
- The index of destination field to setvalue
- The new value to use for the node- Throws:
InvalidFieldException
- The field index is not knownInvalidFieldValueException
- 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
-
clearChildren
protected void clearChildren()Clear the child node list of all children - both VRML and OpenGL.- Overrides:
clearChildren
in classBaseGroupingNode
-
addChildNode
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. This node has a restriction to only 3 valid node types: HAnimJoint,HAnimSegment,HAnimSite. This overrides the base class method to do this check first.- Overrides:
addChildNode
in classBaseGroupingNode
- Parameters:
node
- The node to add- Throws:
InvalidFieldValueException
- This is a bindable node shared
-
removeChildNode
Remove a single child node to the list of available children. Override to provide.renderer-specific behaviour, but remember to also call this implementation too. This node has a restriction to only 3 valid node types: HAnimJoint,HAnimSegment,HAnimSite. This overrides the base class method to do this check first.- Overrides:
removeChildNode
in classBaseGroupingNode
- Parameters:
node
- The node to add- Throws:
InvalidFieldValueException
- This is a bindable node shared
-
setRotation
Set the rotation component of the joint. Setting a value of null is an error- Parameters:
rot
- The new rotation component- Throws:
InvalidFieldValueException
- The rotation was null
-
setTranslation
Set the translation component of the joint. Setting a value of null is an error- Parameters:
tx
- The new translation component- Throws:
InvalidFieldValueException
- The translation was null
-
setScale
Set the scale component of the joint. Setting a value of null is an error- Parameters:
scale
- The new scale component- Throws:
InvalidFieldValueException
- The scale was null
-
setScaleOrientation
Set the scale orientation component of the joint. Setting a value of null is an error- Parameters:
so
- The new scale orientation component- Throws:
InvalidFieldValueException
- The scale orientation was null
-
setCenter
Set the center component of the joint. Setting a value of null is an error- Parameters:
center
- The new center component- Throws:
InvalidFieldValueException
- The center was null
-
setLimitOrientation
Set the limit orientation component of the joint. Setting a value of null is an error- Parameters:
lo
- The new limit orientation value- Throws:
InvalidFieldValueException
- The scale orientation was null
-
setLlimit
Set the limit component of the joint. Setting a value of null is an error.- Parameters:
lim
- The new limit valuesnum
- The number of valid values to get from the array- Throws:
InvalidFieldValueException
- The scale orientation was null
-
setSkinCoordIndex
Set the skinCoordIndex component of the joint. Setting a value of null is an error.- Parameters:
idx
- The new indexvaluesnum
- The number of valid values to get from the array- Throws:
InvalidFieldValueException
- The scale orientation was null
-
setSkinCoordWeight
Set the skinCoordWeight component of the joint. Setting a value of null is an error.- Parameters:
idx
- The new indexvaluesnum
- The number of valid values to get from the array- Throws:
InvalidFieldValueException
- The scale orientation was null
-
setStiffness
Set the stiffness component of the joint. Setting a value of null is an error. All values must lie [0, 1].- Parameters:
stiffness
- The new stiffness valuesnum
- The number of valid values to get from the array- Throws:
InvalidFieldValueException
- The scale orientation was null
-
setUlimit
Set the ulimit component of the joint. Setting a value of null is an error.- Parameters:
lim
- The new limit valuesnum
- The number of valid values to get from the array- Throws:
InvalidFieldValueException
- The scale orientation was null
-