HAnimPose
Overview
HAnimPose nodes support setting HAnimJoint values in a corresponding HAnimHumanoid skeleton.
The HAnimPose node belongs to the HAnim component and requires at least support level 3, its default container field is children. It is available from X3D version 4.1 or higher.
Info: Please note that this node is still experimental, i.e. the functionality of this node may change in future versions of X_ITE.
Hierarchy
1
2
3
+ X3DNode
+ X3DChildNode
+ HAnimPose
Fields
| Type | Access Type | Name | Default Value |
|---|---|---|---|
| SFNode | [in, out] | metadata | NULL |
| SFString | [in, out] | description | ”” |
| SFString | [in, out] | name | ”” |
| SFInt32 | [in, out] | loa | -1 |
| SFBool | [in, out] | enabled | TRUE |
| SFFloat | [in, out] | transitionDuration | 0 |
| SFBool | [in] | resetAllJoints | |
| SFBool | [in] | commencePose | |
| SFTime | [in] | set_startTime | |
| SFFloat | [in] | set_fraction | |
| SFBool | [out] | isActive | |
| MFNode | [in, out] | children | [ ] |
SFNode [in, out] metadata NULL [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint
SFString [in, out] description “”
Author-provided prose that describes intended purpose of this node.
Hint
- Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for “ quotation-mark character).
SFString [in, out] name “”
Unique name attribute must be defined so that HAnimPose node can be identified at run time for animation purposes.
SFInt32 [in, out] loa -1 [-1,4]
Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid skeletal hierarchy.
Hints
- loa value of -1 indicates that no LOA conformance is provided.
- Humanoid Animation (HAnim) Specification, Part 1 Architecture, 4.8.4 Levels of articulation
SFBool [in, out] enabled TRUE
Enables/disables node operation.
SFFloat [in, out] transitionDuration 0 (0,∞)
Duration in seconds for a pose transition.
SFBool [in] resetAllJoints
resetAllJoints is an input boolean event that zeroes all Joint objects in the skeleton field to their default values, matching the default binding pose (i.e. the I pose).
Warning
- It is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
SFBool [in] commencePose
commencePose is an input boolean event that triggers the animation of Joint values to achieve the pose.
Warning
- It is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
SFTime [in] set_startTime
set_startTime is an input event that commences the animation of Joint objects in the parent Humanoid object.
Warning
- It is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
SFFloat [in] set_fraction
Setting fraction in range [0,1] provides an input event that allows gradual change of each joint in the pose, where 0 indicates no change and 1 indicates fully changed.
Warning
- It is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
SFBool [out] isActive
isActive true/false events are sent when pose animation starts/stops.
Warning
- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
MFNode [in, out] children [ ] [HAnimJoint]
The children field lists all HAnimJoint nodes making up this pose. Contained HAnimJoint nodes provide center, rotation, and scale values which are applied to corresponding HAnimJoint nodes with the same name in the parent HAnimHumanoid skeleton.
Warnings
- These nodes must be independent of HAnimHumanoid skeleton joints, do not re-USE any skeleton HAnimJoint nodes.
- No other node types are allowed in the HAnimPose children field.
Advice
Hints
- HAnim Architecture draft version 2.1, clause 4.10.3 Poses
- HAnim Architecture draft version 2.1, 6.5 Pose