org.web3d.x3d.sai.HAnim

Interface HAnimSegment

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DGroupingNode, X3DNode

All Known Implementing Classes:

HAnimSegmentObject

public interface HAnimSegment
extends X3DGroupingNode

Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DGroupingNode] HAnimSegment node contains Shape geometry for each body segment. HAnimSegment contains Coordinate|CoordinateDouble with containerField='coord', HAnimDisplacer with containerField='displacers' and Shape or grouping nodes with containerField='children'.

• Hint: HAnimSegment displays geometry between parent HAnimJoint and sibling HAnimJoint nodes.
• Hint: H-Anim Specification
  http://www.web3d.org/documents/specifications/19774-1/V2.0/HAnim/HAnimArchitecture.html
• Hint: H-Anim Specification, Segment
  http://www.web3d.org/documents/specifications/19774-1/V2.0/HAnim/ObjectInterfaces.html#Segment
• Hint: X3D for Advanced Modeling (X3D4AM) slideset
  http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/HumanoidAnimation.pdf
• Warning: requires X3D profile='Full' or else include <component name='H-Anim' level='1'/>
• Warning: the number of contained <HAnimSegment USE='*' containerField='segments'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimJoint node instances found within the preceding skeleton hierarchy.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: HAnimSegment, X3D Tooltips: HAnimSegment, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method and Description
void	addChildren(X3DNode[] newValue) Add array of children nodes to array of existing nodes (if any).
void	addDisplacers(X3DNode[] newValue) Add array of child displacers nodes to array of existing nodes (if any).
float[]	getBboxCenter() Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
float[]	getBboxSize() Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
float[]	getCenterOfMass() Provide array of 3-tuple float results from inputOutput SFVec3f field named centerOfMass.
X3DNode[]	getChildren() Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
X3DCoordinateNode	getCoord() Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
X3DNode[]	getDisplacers() Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field displacers.
float	getMass() Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named mass.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getMomentsOfInertia() Provide array of float results within allowed range of [0,infinity) from inputOutput MFFloat field named momentsOfInertia.
java.lang.String	getName() Provide String enumeration value ['sacrum'|'pelvis'|'l_thigh'|'l_calf'|'l_hindfoot'|'l_midproximal'|'l_middistal'|'l_forefoot'|'r_thigh'|'r_calf'|'r_hindfoot'|'r_midproximal'|'r_middistal'|'r_forefoot'|'l5'|'l4'|'l3'|'l2'|'l1'|'t12'|'t11'|'t10'|'t9'|'t8'|'t7'|'t6'|'t5'|'t4'|'t3'|'t2'|'t1'|'c7'|'c6'|'c5'|'c4'|'c3'|'c2'|'c1'|'skull'|'l_eyelid'|'r_eyelid'|'l_eyeball'|'r_eyeball'|'l_eyebrow'|'r_eyebrow'|'jaw'|'l_clavicle'|'l_scapula'|'l_upperarm'|'l_forearm'|'l_hand'|'l_thumb_metacarpal'|'l_thumb_proximal'|'l_thumb_distal'|'l_index_metacarpal'|'l_index_proximal'|'l_index_middle'|'l_index_distal'|'l_middle_metacarpal'|'l_middle_proximal'|'l_middle_middle'|'l_middle_distal'|'l_ring_metacarpal'|'l_ring_proximal'|'l_ring_middle'|'l_ring_distal'|'l_pinky_metacarpal'|'l_pinky_proximal'|'l_pinky_middle'|'l_pinky_distal'|'r_clavicle'|'r_scapula'|'r_upperarm'|'r_forearm'|'r_hand'|'r_thumb_metacarpal'|'r_thumb_proximal'|'r_thumb_distal'|'r_index_metacarpal'|'r_index_proximal'|'r_index_middle'|'r_index_distal'|'r_middle_metacarpal'|'r_middle_proximal'|'r_middle_middle'|'r_middle_distal'|'r_ring_metacarpal'|'r_ring_proximal'|'r_ring_middle'|'r_ring_distal'|'r_pinky_metacarpal'|'r_pinky_proximal'|'r_pinky_middle'|'r_pinky_distal'|'l_carpal'|'l_trapezoid'|'l_metacarpal_1'|'l_carpal_proximal_phalanx_1'|'l_carpal_distal_phalanx_1'|'l_metacarpal_2'|'l_carpal_proximal_phalanx_2'|'l_carpal_middle_phalanx_2'|'l_carpal_distal_phalanx_2'|'l_capitate'|'l_metacarpal_3'|'l_carpal_proximal_phalanx_3'|'l_carpal_middle_phalanx_3'|'l_carpal_distal_phalanx_3'|'l_hamate'|'l_metacarpal_4'|'l_carpal_proximal_phalanx_4'|'l_carpal_middle_phalanx_4'|'l_carpal_distal_phalanx_4'|'l_metacarpal_5'|'l_carpal_proximal_phalanx_5'|'l_carpal_middle_phalanx_5'|'l_carpal_distal_phalanx_5'|'r_carpal'|'r_trapezoid'|'r_metacarpal_1'|'r_carpal_proximal_phalanx_1'|'r_carpal_distal_phalanx_1'|'r_metacarpal_2'|'r_carpal_proximal_phalanx_2'|'r_carpal_middle_phalanx_2'|'r_carpal_distal_phalanx_2'|'r_capitate'|'r_metacarpal_3'|'r_carpal_proximal_phalanx_3'|'r_carpal_middle_phalanx_3'|'r_carpal_distal_phalanx_3'|'r_hamate'|'r_metacarpal_4'|'r_carpal_proximal_phalanx_4'|'r_carpal_middle_phalanx_4'|'r_carpal_distal_phalanx_4'|'r_metacarpal_5'|'r_carpal_proximal_phalanx_5'|'r_carpal_middle_phalanx_5'|'r_carpal_distal_phalanx_5'|'l_talus'|'l_metatarsal'|'l_tarsal_proximal_phalanx'|'l_tarsal_distal_phalanx'|'r_talus'|'r_metatarsal'|'r_tarsal_proximal_phalanx'|'r_tarsal_distal_phalanx'] from inputOutput SFString field named name.
HAnimSegment	setBboxCenter(float[] newValue) Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
HAnimSegment	setBboxSize(float[] newValue) Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
HAnimSegment	setCenterOfMass(float[] newValue) Assign 3-tuple float array to inputOutput SFVec3f field named centerOfMass.
void	setChildren(X3DNode newValue) Set single children node, replacing prior array of existing nodes (if any).
HAnimSegment	setChildren(X3DNode[] newValue) Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
HAnimSegment	setCoord(X3DCoordinateNode newValue) Assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
HAnimSegment	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
HAnimSegment	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
void	setDisplacers(X3DNode newValue) Set single child displacers node, replacing prior array of existing nodes (if any).
HAnimSegment	setDisplacers(X3DNode[] newValue) Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field displacers.
HAnimSegment	setMass(float newValue) Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named mass.
HAnimSegment	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
HAnimSegment	setMomentsOfInertia(float[] newValue) Assign float array within allowed range of [0,infinity) to inputOutput MFFloat field named momentsOfInertia.
HAnimSegment	setName(java.lang.String newValue) Assign String enumeration value ("sacrum"|"pelvis"|"l_thigh"|"l_calf"|"l_hindfoot"|"l_midproximal"|"l_middistal"|"l_forefoot"|"r_thigh"|"r_calf"|"r_hindfoot"|"r_midproximal"|"r_middistal"|"r_forefoot"|"l5"|"l4"|"l3"|"l2"|"l1"|"t12"|"t11"|"t10"|"t9"|"t8"|"t7"|"t6"|"t5"|"t4"|"t3"|"t2"|"t1"|"c7"|"c6"|"c5"|"c4"|"c3"|"c2"|"c1"|"skull"|"l_eyelid"|"r_eyelid"|"l_eyeball"|"r_eyeball"|"l_eyebrow"|"r_eyebrow"|"jaw"|"l_clavicle"|"l_scapula"|"l_upperarm"|"l_forearm"|"l_hand"|"l_thumb_metacarpal"|"l_thumb_proximal"|"l_thumb_distal"|"l_index_metacarpal"|"l_index_proximal"|"l_index_middle"|"l_index_distal"|"l_middle_metacarpal"|"l_middle_proximal"|"l_middle_middle"|"l_middle_distal"|"l_ring_metacarpal"|"l_ring_proximal"|"l_ring_middle"|"l_ring_distal"|"l_pinky_metacarpal"|"l_pinky_proximal"|"l_pinky_middle"|"l_pinky_distal"|"r_clavicle"|"r_scapula"|"r_upperarm"|"r_forearm"|"r_hand"|"r_thumb_metacarpal"|"r_thumb_proximal"|"r_thumb_distal"|"r_index_metacarpal"|"r_index_proximal"|"r_index_middle"|"r_index_distal"|"r_middle_metacarpal"|"r_middle_proximal"|"r_middle_middle"|"r_middle_distal"|"r_ring_metacarpal"|"r_ring_proximal"|"r_ring_middle"|"r_ring_distal"|"r_pinky_metacarpal"|"r_pinky_proximal"|"r_pinky_middle"|"r_pinky_distal"|"l_carpal"|"l_trapezoid"|"l_metacarpal_1"|"l_carpal_proximal_phalanx_1"|"l_carpal_distal_phalanx_1"|"l_metacarpal_2"|"l_carpal_proximal_phalanx_2"|"l_carpal_middle_phalanx_2"|"l_carpal_distal_phalanx_2"|"l_capitate"|"l_metacarpal_3"|"l_carpal_proximal_phalanx_3"|"l_carpal_middle_phalanx_3"|"l_carpal_distal_phalanx_3"|"l_hamate"|"l_metacarpal_4"|"l_carpal_proximal_phalanx_4"|"l_carpal_middle_phalanx_4"|"l_carpal_distal_phalanx_4"|"l_metacarpal_5"|"l_carpal_proximal_phalanx_5"|"l_carpal_middle_phalanx_5"|"l_carpal_distal_phalanx_5"|"r_carpal"|"r_trapezoid"|"r_metacarpal_1"|"r_carpal_proximal_phalanx_1"|"r_carpal_distal_phalanx_1"|"r_metacarpal_2"|"r_carpal_proximal_phalanx_2"|"r_carpal_middle_phalanx_2"|"r_carpal_distal_phalanx_2"|"r_capitate"|"r_metacarpal_3"|"r_carpal_proximal_phalanx_3"|"r_carpal_middle_phalanx_3"|"r_carpal_distal_phalanx_3"|"r_hamate"|"r_metacarpal_4"|"r_carpal_proximal_phalanx_4"|"r_carpal_middle_phalanx_4"|"r_carpal_distal_phalanx_4"|"r_metacarpal_5"|"r_carpal_proximal_phalanx_5"|"r_carpal_middle_phalanx_5"|"r_carpal_distal_phalanx_5"|"l_talus"|"l_metatarsal"|"l_tarsal_proximal_phalanx"|"l_tarsal_distal_phalanx"|"r_talus"|"r_metatarsal"|"r_tarsal_proximal_phalanx"|"r_tarsal_distal_phalanx") ['sacrum'|'pelvis'|'l_thigh'|'l_calf'|'l_hindfoot'|'l_midproximal'|'l_middistal'|'l_forefoot'|'r_thigh'|'r_calf'|'r_hindfoot'|'r_midproximal'|'r_middistal'|'r_forefoot'|'l5'|'l4'|'l3'|'l2'|'l1'|'t12'|'t11'|'t10'|'t9'|'t8'|'t7'|'t6'|'t5'|'t4'|'t3'|'t2'|'t1'|'c7'|'c6'|'c5'|'c4'|'c3'|'c2'|'c1'|'skull'|'l_eyelid'|'r_eyelid'|'l_eyeball'|'r_eyeball'|'l_eyebrow'|'r_eyebrow'|'jaw'|'l_clavicle'|'l_scapula'|'l_upperarm'|'l_forearm'|'l_hand'|'l_thumb_metacarpal'|'l_thumb_proximal'|'l_thumb_distal'|'l_index_metacarpal'|'l_index_proximal'|'l_index_middle'|'l_index_distal'|'l_middle_metacarpal'|'l_middle_proximal'|'l_middle_middle'|'l_middle_distal'|'l_ring_metacarpal'|'l_ring_proximal'|'l_ring_middle'|'l_ring_distal'|'l_pinky_metacarpal'|'l_pinky_proximal'|'l_pinky_middle'|'l_pinky_distal'|'r_clavicle'|'r_scapula'|'r_upperarm'|'r_forearm'|'r_hand'|'r_thumb_metacarpal'|'r_thumb_proximal'|'r_thumb_distal'|'r_index_metacarpal'|'r_index_proximal'|'r_index_middle'|'r_index_distal'|'r_middle_metacarpal'|'r_middle_proximal'|'r_middle_middle'|'r_middle_distal'|'r_ring_metacarpal'|'r_ring_proximal'|'r_ring_middle'|'r_ring_distal'|'r_pinky_metacarpal'|'r_pinky_proximal'|'r_pinky_middle'|'r_pinky_distal'|'l_carpal'|'l_trapezoid'|'l_metacarpal_1'|'l_carpal_proximal_phalanx_1'|'l_carpal_distal_phalanx_1'|'l_metacarpal_2'|'l_carpal_proximal_phalanx_2'|'l_carpal_middle_phalanx_2'|'l_carpal_distal_phalanx_2'|'l_capitate'|'l_metacarpal_3'|'l_carpal_proximal_phalanx_3'|'l_carpal_middle_phalanx_3'|'l_carpal_distal_phalanx_3'|'l_hamate'|'l_metacarpal_4'|'l_carpal_proximal_phalanx_4'|'l_carpal_middle_phalanx_4'|'l_carpal_distal_phalanx_4'|'l_metacarpal_5'|'l_carpal_proximal_phalanx_5'|'l_carpal_middle_phalanx_5'|'l_carpal_distal_phalanx_5'|'r_carpal'|'r_trapezoid'|'r_metacarpal_1'|'r_carpal_proximal_phalanx_1'|'r_carpal_distal_phalanx_1'|'r_metacarpal_2'|'r_carpal_proximal_phalanx_2'|'r_carpal_middle_phalanx_2'|'r_carpal_distal_phalanx_2'|'r_capitate'|'r_metacarpal_3'|'r_carpal_proximal_phalanx_3'|'r_carpal_middle_phalanx_3'|'r_carpal_distal_phalanx_3'|'r_hamate'|'r_metacarpal_4'|'r_carpal_proximal_phalanx_4'|'r_carpal_middle_phalanx_4'|'r_carpal_distal_phalanx_4'|'r_metacarpal_5'|'r_carpal_proximal_phalanx_5'|'r_carpal_middle_phalanx_5'|'r_carpal_distal_phalanx_5'|'l_talus'|'l_metatarsal'|'l_tarsal_proximal_phalanx'|'l_tarsal_distal_phalanx'|'r_talus'|'r_metatarsal'|'r_tarsal_proximal_phalanx'|'r_tarsal_distal_phalanx'] to inputOutput SFString field named name.
HAnimSegment	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getBboxCenter

float[] getBboxCenter()

Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes

Specified by:

getBboxCenter in interface X3DBoundedObject

Specified by:

getBboxCenter in interface X3DGroupingNode

Returns:

value of bboxCenter field

setBboxCenter

HAnimSegment setBboxCenter(float[] newValue)

Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes

Specified by:

setBboxCenter in interface X3DBoundedObject

Specified by:

setBboxCenter in interface X3DGroupingNode

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBboxSize

float[] getBboxSize()

Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.

• Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes

Specified by:

getBboxSize in interface X3DBoundedObject

Specified by:

getBboxSize in interface X3DGroupingNode

Returns:

value of bboxSize field

setBboxSize

HAnimSegment setBboxSize(float[] newValue)

Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.

Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint. Hint: can be useful for collision computations or inverse-kinematics (IK) engines. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes

Specified by:

setBboxSize in interface X3DBoundedObject

Specified by:

setBboxSize in interface X3DGroupingNode

Parameters:

newValue - is new value for the bboxSize field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCenterOfMass

float[] getCenterOfMass()

Provide array of 3-tuple float results from inputOutput SFVec3f field named centerOfMass.

Tooltip: Location within segment of center of mass. *

Returns:

value of centerOfMass field

setCenterOfMass

HAnimSegment setCenterOfMass(float[] newValue)

Assign 3-tuple float array to inputOutput SFVec3f field named centerOfMass.

Tooltip: Location within segment of center of mass.

Parameters:

newValue - is new value for the centerOfMass field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getChildren

X3DNode[] getChildren()

Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.

Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.

• Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
• Hint: place any geometry for parent HAnimJoint within a child Transform having the same translation value as the parent HAnimJoint center value.
• Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
• Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
• Hint: X3D Architecture 10.2.1 Grouping and children node types,
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.

Specified by:

getChildren in interface X3DGroupingNode

Returns:

value of children field

See Also:

X3DChildNode

setChildren

HAnimSegment setChildren(X3DNode[] newValue)

Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.

Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes. Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy. Hint: place any geometry for parent HAnimJoint within a child Transform having the same translation value as the parent HAnimJoint center value. Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored. Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored. Hint: X3D Architecture 10.2.1 Grouping and children node types, http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.

Specified by:

setChildren in interface X3DGroupingNode

Parameters:

newValue - is new value for the children field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addChildren

void addChildren(X3DNode[] newValue)

Add array of children nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.

Specified by:

addChildren in interface X3DGroupingNode

Parameters:

newValue - is new value array to be appended the children field.

setChildren

void setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

Specified by:

setChildren in interface X3DGroupingNode

Parameters:

newValue - is new node for the children field

getCoord

X3DCoordinateNode getCoord()

Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.

Tooltip: [X3DCoordinateNode] the coord field is used for HAnimSegment objects that have deformable meshes and shall contain coordinates referenced from the IndexedFaceSet for the paarent HAnimSegment object. The coordinates are given the same name as the HAnim Segment object, but with "_coords" appended to the name (e.g., "skull_coords").

• Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer nodes for proper skin animation.

Returns:

value of coord field

setCoord

HAnimSegment setCoord(X3DCoordinateNode newValue)

Assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.

Tooltip: [X3DCoordinateNode] the coord field is used for HAnimSegment objects that have deformable meshes and shall contain coordinates referenced from the IndexedFaceSet for the paarent HAnimSegment object. The coordinates are given the same name as the HAnim Segment object, but with "_coords" appended to the name (e.g., "skull_coords"). Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer nodes for proper skin animation.

Parameters:

newValue - is new value for the coord field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDisplacers

X3DNode[] getDisplacers()

Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field displacers.

Tooltip: [HAnimDisplacer] the displacers field stores HAnimDisplacer objects for a particular HAnimSegment object.

• Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer nodes for proper skin animation.

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimDisplacer.

Returns:

value of displacers field

See Also:

HAnimDisplacerObject

setDisplacers

HAnimSegment setDisplacers(X3DNode[] newValue)

Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field displacers.

Tooltip: [HAnimDisplacer] the displacers field stores HAnimDisplacer objects for a particular HAnimSegment object. Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer nodes for proper skin animation.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimDisplacer.

Parameters:

newValue - is new value for the displacers field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addDisplacers

void addDisplacers(X3DNode[] newValue)

Add array of child displacers nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimDisplacer.

Parameters:

newValue - is new value array to be appended the displacers field.

setDisplacers

void setDisplacers(X3DNode newValue)

Set single child displacers node, replacing prior array of existing nodes (if any).

Parameters:

newValue - is new node for the displacers field

getMass

float getMass()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named mass.

Tooltip: Total mass of the segment, 0 if not available, defined in mass base units (default is kilograms).

• Hint:
  https://en.wikipedia.org/wiki/Kilogram
• Hint: X3D Architecture 4.3.6 Standard units and coordinate system
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#Standardunitscoordinates

Returns:

value of mass field

setMass

HAnimSegment setMass(float newValue)

Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named mass.

Tooltip: Total mass of the segment, 0 if not available, defined in mass base units (default is kilograms). Hint: https://en.wikipedia.org/wiki/Kilogram Hint: X3D Architecture 4.3.6 Standard units and coordinate system http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/concepts.html#Standardunitscoordinates

Parameters:

newValue - is new value for the mass field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMetadata

X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DGroupingNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

HAnimSegment setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DGroupingNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

X3D Scene Authoring Hints: Metadata Nodes

getMomentsOfInertia

float[] getMomentsOfInertia()

Provide array of float results within allowed range of [0,infinity) from inputOutput MFFloat field named momentsOfInertia.

Tooltip: 3x3 moments of inertia matrix. default: 0 0 0 0 0 0 0 0 0. *

Returns:

value of momentsOfInertia field

setMomentsOfInertia

HAnimSegment setMomentsOfInertia(float[] newValue)

Assign float array within allowed range of [0,infinity) to inputOutput MFFloat field named momentsOfInertia.

Tooltip: 3x3 moments of inertia matrix. default: 0 0 0 0 0 0 0 0 0.

Parameters:

newValue - is new value for the momentsOfInertia field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getName

java.lang.String getName()

Provide String enumeration value ['sacrum'|'pelvis'|'l_thigh'|'l_calf'|'l_hindfoot'|'l_midproximal'|'l_middistal'|'l_forefoot'|'r_thigh'|'r_calf'|'r_hindfoot'|'r_midproximal'|'r_middistal'|'r_forefoot'|'l5'|'l4'|'l3'|'l2'|'l1'|'t12'|'t11'|'t10'|'t9'|'t8'|'t7'|'t6'|'t5'|'t4'|'t3'|'t2'|'t1'|'c7'|'c6'|'c5'|'c4'|'c3'|'c2'|'c1'|'skull'|'l_eyelid'|'r_eyelid'|'l_eyeball'|'r_eyeball'|'l_eyebrow'|'r_eyebrow'|'jaw'|'l_clavicle'|'l_scapula'|'l_upperarm'|'l_forearm'|'l_hand'|'l_thumb_metacarpal'|'l_thumb_proximal'|'l_thumb_distal'|'l_index_metacarpal'|'l_index_proximal'|'l_index_middle'|'l_index_distal'|'l_middle_metacarpal'|'l_middle_proximal'|'l_middle_middle'|'l_middle_distal'|'l_ring_metacarpal'|'l_ring_proximal'|'l_ring_middle'|'l_ring_distal'|'l_pinky_metacarpal'|'l_pinky_proximal'|'l_pinky_middle'|'l_pinky_distal'|'r_clavicle'|'r_scapula'|'r_upperarm'|'r_forearm'|'r_hand'|'r_thumb_metacarpal'|'r_thumb_proximal'|'r_thumb_distal'|'r_index_metacarpal'|'r_index_proximal'|'r_index_middle'|'r_index_distal'|'r_middle_metacarpal'|'r_middle_proximal'|'r_middle_middle'|'r_middle_distal'|'r_ring_metacarpal'|'r_ring_proximal'|'r_ring_middle'|'r_ring_distal'|'r_pinky_metacarpal'|'r_pinky_proximal'|'r_pinky_middle'|'r_pinky_distal'|'l_carpal'|'l_trapezoid'|'l_metacarpal_1'|'l_carpal_proximal_phalanx_1'|'l_carpal_distal_phalanx_1'|'l_metacarpal_2'|'l_carpal_proximal_phalanx_2'|'l_carpal_middle_phalanx_2'|'l_carpal_distal_phalanx_2'|'l_capitate'|'l_metacarpal_3'|'l_carpal_proximal_phalanx_3'|'l_carpal_middle_phalanx_3'|'l_carpal_distal_phalanx_3'|'l_hamate'|'l_metacarpal_4'|'l_carpal_proximal_phalanx_4'|'l_carpal_middle_phalanx_4'|'l_carpal_distal_phalanx_4'|'l_metacarpal_5'|'l_carpal_proximal_phalanx_5'|'l_carpal_middle_phalanx_5'|'l_carpal_distal_phalanx_5'|'r_carpal'|'r_trapezoid'|'r_metacarpal_1'|'r_carpal_proximal_phalanx_1'|'r_carpal_distal_phalanx_1'|'r_metacarpal_2'|'r_carpal_proximal_phalanx_2'|'r_carpal_middle_phalanx_2'|'r_carpal_distal_phalanx_2'|'r_capitate'|'r_metacarpal_3'|'r_carpal_proximal_phalanx_3'|'r_carpal_middle_phalanx_3'|'r_carpal_distal_phalanx_3'|'r_hamate'|'r_metacarpal_4'|'r_carpal_proximal_phalanx_4'|'r_carpal_middle_phalanx_4'|'r_carpal_distal_phalanx_4'|'r_metacarpal_5'|'r_carpal_proximal_phalanx_5'|'r_carpal_middle_phalanx_5'|'r_carpal_distal_phalanx_5'|'l_talus'|'l_metatarsal'|'l_tarsal_proximal_phalanx'|'l_tarsal_distal_phalanx'|'r_talus'|'r_metatarsal'|'r_tarsal_proximal_phalanx'|'r_tarsal_distal_phalanx'] from inputOutput SFString field named name.

Tooltip: Unique name attribute must be defined so that HAnimSegment node can be identified at run time for animation purposes.

• Warning: name prefix must match ancestor HAnimHumanoid name followed by underscore character, for example 'Nancy_' prepended before location name.
• Warning: name is not included if this instance is a USE node. Examples: sacrum pelvis l_thigh l_calf etc. as listed in H-Anim Specification.
• Hint: for abitrary humanoids, HAnimSegment name can describe geometry between parent HAnimJoint and sibling HAnimJoint nodes (for example LeftHip_to_LeftKnee).
• Hint: H-Anim Humanoid Segment Names H-Anim Specification, Humanoid Joint-Segment Hierarchy
  http://www.web3d.org/x3d/content/examples/Basic/HumanoidAnimation/tables/HAnimSegmentNames19774V1.0.txt
• Hint: H-Anim Specification, Humanoid Joint-Segment Hierarchy
  http://www.web3d.org/documents/specifications/19774-1/V2.0/HAnim/concepts.html#Hierarchy
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Returns:

value of name field

setName

HAnimSegment setName(java.lang.String newValue)

Assign String enumeration value ("sacrum"|"pelvis"|"l_thigh"|"l_calf"|"l_hindfoot"|"l_midproximal"|"l_middistal"|"l_forefoot"|"r_thigh"|"r_calf"|"r_hindfoot"|"r_midproximal"|"r_middistal"|"r_forefoot"|"l5"|"l4"|"l3"|"l2"|"l1"|"t12"|"t11"|"t10"|"t9"|"t8"|"t7"|"t6"|"t5"|"t4"|"t3"|"t2"|"t1"|"c7"|"c6"|"c5"|"c4"|"c3"|"c2"|"c1"|"skull"|"l_eyelid"|"r_eyelid"|"l_eyeball"|"r_eyeball"|"l_eyebrow"|"r_eyebrow"|"jaw"|"l_clavicle"|"l_scapula"|"l_upperarm"|"l_forearm"|"l_hand"|"l_thumb_metacarpal"|"l_thumb_proximal"|"l_thumb_distal"|"l_index_metacarpal"|"l_index_proximal"|"l_index_middle"|"l_index_distal"|"l_middle_metacarpal"|"l_middle_proximal"|"l_middle_middle"|"l_middle_distal"|"l_ring_metacarpal"|"l_ring_proximal"|"l_ring_middle"|"l_ring_distal"|"l_pinky_metacarpal"|"l_pinky_proximal"|"l_pinky_middle"|"l_pinky_distal"|"r_clavicle"|"r_scapula"|"r_upperarm"|"r_forearm"|"r_hand"|"r_thumb_metacarpal"|"r_thumb_proximal"|"r_thumb_distal"|"r_index_metacarpal"|"r_index_proximal"|"r_index_middle"|"r_index_distal"|"r_middle_metacarpal"|"r_middle_proximal"|"r_middle_middle"|"r_middle_distal"|"r_ring_metacarpal"|"r_ring_proximal"|"r_ring_middle"|"r_ring_distal"|"r_pinky_metacarpal"|"r_pinky_proximal"|"r_pinky_middle"|"r_pinky_distal"|"l_carpal"|"l_trapezoid"|"l_metacarpal_1"|"l_carpal_proximal_phalanx_1"|"l_carpal_distal_phalanx_1"|"l_metacarpal_2"|"l_carpal_proximal_phalanx_2"|"l_carpal_middle_phalanx_2"|"l_carpal_distal_phalanx_2"|"l_capitate"|"l_metacarpal_3"|"l_carpal_proximal_phalanx_3"|"l_carpal_middle_phalanx_3"|"l_carpal_distal_phalanx_3"|"l_hamate"|"l_metacarpal_4"|"l_carpal_proximal_phalanx_4"|"l_carpal_middle_phalanx_4"|"l_carpal_distal_phalanx_4"|"l_metacarpal_5"|"l_carpal_proximal_phalanx_5"|"l_carpal_middle_phalanx_5"|"l_carpal_distal_phalanx_5"|"r_carpal"|"r_trapezoid"|"r_metacarpal_1"|"r_carpal_proximal_phalanx_1"|"r_carpal_distal_phalanx_1"|"r_metacarpal_2"|"r_carpal_proximal_phalanx_2"|"r_carpal_middle_phalanx_2"|"r_carpal_distal_phalanx_2"|"r_capitate"|"r_metacarpal_3"|"r_carpal_proximal_phalanx_3"|"r_carpal_middle_phalanx_3"|"r_carpal_distal_phalanx_3"|"r_hamate"|"r_metacarpal_4"|"r_carpal_proximal_phalanx_4"|"r_carpal_middle_phalanx_4"|"r_carpal_distal_phalanx_4"|"r_metacarpal_5"|"r_carpal_proximal_phalanx_5"|"r_carpal_middle_phalanx_5"|"r_carpal_distal_phalanx_5"|"l_talus"|"l_metatarsal"|"l_tarsal_proximal_phalanx"|"l_tarsal_distal_phalanx"|"r_talus"|"r_metatarsal"|"r_tarsal_proximal_phalanx"|"r_tarsal_distal_phalanx") ['sacrum'|'pelvis'|'l_thigh'|'l_calf'|'l_hindfoot'|'l_midproximal'|'l_middistal'|'l_forefoot'|'r_thigh'|'r_calf'|'r_hindfoot'|'r_midproximal'|'r_middistal'|'r_forefoot'|'l5'|'l4'|'l3'|'l2'|'l1'|'t12'|'t11'|'t10'|'t9'|'t8'|'t7'|'t6'|'t5'|'t4'|'t3'|'t2'|'t1'|'c7'|'c6'|'c5'|'c4'|'c3'|'c2'|'c1'|'skull'|'l_eyelid'|'r_eyelid'|'l_eyeball'|'r_eyeball'|'l_eyebrow'|'r_eyebrow'|'jaw'|'l_clavicle'|'l_scapula'|'l_upperarm'|'l_forearm'|'l_hand'|'l_thumb_metacarpal'|'l_thumb_proximal'|'l_thumb_distal'|'l_index_metacarpal'|'l_index_proximal'|'l_index_middle'|'l_index_distal'|'l_middle_metacarpal'|'l_middle_proximal'|'l_middle_middle'|'l_middle_distal'|'l_ring_metacarpal'|'l_ring_proximal'|'l_ring_middle'|'l_ring_distal'|'l_pinky_metacarpal'|'l_pinky_proximal'|'l_pinky_middle'|'l_pinky_distal'|'r_clavicle'|'r_scapula'|'r_upperarm'|'r_forearm'|'r_hand'|'r_thumb_metacarpal'|'r_thumb_proximal'|'r_thumb_distal'|'r_index_metacarpal'|'r_index_proximal'|'r_index_middle'|'r_index_distal'|'r_middle_metacarpal'|'r_middle_proximal'|'r_middle_middle'|'r_middle_distal'|'r_ring_metacarpal'|'r_ring_proximal'|'r_ring_middle'|'r_ring_distal'|'r_pinky_metacarpal'|'r_pinky_proximal'|'r_pinky_middle'|'r_pinky_distal'|'l_carpal'|'l_trapezoid'|'l_metacarpal_1'|'l_carpal_proximal_phalanx_1'|'l_carpal_distal_phalanx_1'|'l_metacarpal_2'|'l_carpal_proximal_phalanx_2'|'l_carpal_middle_phalanx_2'|'l_carpal_distal_phalanx_2'|'l_capitate'|'l_metacarpal_3'|'l_carpal_proximal_phalanx_3'|'l_carpal_middle_phalanx_3'|'l_carpal_distal_phalanx_3'|'l_hamate'|'l_metacarpal_4'|'l_carpal_proximal_phalanx_4'|'l_carpal_middle_phalanx_4'|'l_carpal_distal_phalanx_4'|'l_metacarpal_5'|'l_carpal_proximal_phalanx_5'|'l_carpal_middle_phalanx_5'|'l_carpal_distal_phalanx_5'|'r_carpal'|'r_trapezoid'|'r_metacarpal_1'|'r_carpal_proximal_phalanx_1'|'r_carpal_distal_phalanx_1'|'r_metacarpal_2'|'r_carpal_proximal_phalanx_2'|'r_carpal_middle_phalanx_2'|'r_carpal_distal_phalanx_2'|'r_capitate'|'r_metacarpal_3'|'r_carpal_proximal_phalanx_3'|'r_carpal_middle_phalanx_3'|'r_carpal_distal_phalanx_3'|'r_hamate'|'r_metacarpal_4'|'r_carpal_proximal_phalanx_4'|'r_carpal_middle_phalanx_4'|'r_carpal_distal_phalanx_4'|'r_metacarpal_5'|'r_carpal_proximal_phalanx_5'|'r_carpal_middle_phalanx_5'|'r_carpal_distal_phalanx_5'|'l_talus'|'l_metatarsal'|'l_tarsal_proximal_phalanx'|'l_tarsal_distal_phalanx'|'r_talus'|'r_metatarsal'|'r_tarsal_proximal_phalanx'|'r_tarsal_distal_phalanx'] to inputOutput SFString field named name.

Tooltip: Unique name attribute must be defined so that HAnimSegment node can be identified at run time for animation purposes. Warning: name prefix must match ancestor HAnimHumanoid name followed by underscore character, for example 'Nancy_' prepended before location name. Warning: name is not included if this instance is a USE node. Examples: sacrum pelvis l_thigh l_calf etc. as listed in H-Anim Specification. Hint: for abitrary humanoids, HAnimSegment name can describe geometry between parent HAnimJoint and sibling HAnimJoint nodes (for example LeftHip_to_LeftKnee). Hint: H-Anim Humanoid Segment Names H-Anim Specification, Humanoid Joint-Segment Hierarchy http://www.web3d.org/x3d/content/examples/Basic/HumanoidAnimation/tables/HAnimSegmentNames19774V1.0.txt Hint: H-Anim Specification, Humanoid Joint-Segment Hierarchy http://www.web3d.org/documents/specifications/19774-1/V2.0/HAnim/concepts.html#Hierarchy Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

@see X3D Scene Authoring Hints: Naming Conventions

Parameters:

newValue - is new value for the name field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

HAnimSegment setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DChildNode

Specified by:

setDEF in interface X3DGroupingNode

Specified by:

setDEF in interface X3DNode

Parameters:

newValue - is new value for the DEF field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

HAnimSegment setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Specified by:

setUSE in interface X3DChildNode

Specified by:

setUSE in interface X3DGroupingNode

Specified by:

setUSE in interface X3DNode

Parameters:

newValue - is new value for the USE field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCssClass

HAnimSegment setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DChildNode

Specified by:

setCssClass in interface X3DGroupingNode

Specified by:

setCssClass in interface X3DNode

Parameters:

newValue - is new value for the class field.

Returns:

HAnimSegment - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).