Interface HAnimHumanoid

All Superinterfaces:
X3DBoundedObject, X3DChildNode, X3DNode
All Known Implementing Classes:
HAnimHumanoidObject

public interface HAnimHumanoid
extends X3DChildNode, X3DBoundedObject
The HAnimHumanoid node is used to: (a) store references to the joints, segments, sites, skeleton, optional skin, and fixed viewpoints, (b) serve as a container for the entire humanoid, (c) provide a convenient way of moving the humanoid through its environment, and (d) store human-readable metadata such as name, version, author, copyright, age, gender and other information.

X3D node tooltip: [X3DChildNode,X3DBoundedObject] The HAnimHumanoid node is used to: (a) store references to the joints, segments, sites, skeleton, optional skin, and fixed viewpoints, (b) serve as a container for the entire humanoid, (c) provide a convenient way of moving the humanoid through its environment, and (d) store human-readable metadata such as name, version, author, copyright, age, gender and other information. HAnimHumanoid contains a skeleton consisting of HAnimJoint, HAnimSegment and HAnimSite nodes. HAnimHumanoid can also contain an optional skin consisting of an IndexedFaceSet mesh with corresponding skinCoord Coordinate|CoordinateDouble vertices and skinNormal Normal vectors.
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: HAnimHumanoid, X3D Tooltips: HAnimHumanoid, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    void addJoints​(X3DNode[] newValue)
    Add array of child joints nodes to array of existing nodes (if any).
    void addMotions​(X3DNode[] newValue)
    Add array of child motions nodes to array of existing nodes (if any).
    void addSegments​(X3DNode[] newValue)
    Add array of child segments nodes to array of existing nodes (if any).
    void addSites​(X3DNode[] newValue)
    Add array of child sites nodes to array of existing nodes (if any).
    void addSkeleton​(X3DNode[] newValue)
    Add array of child skeleton nodes to array of existing nodes (if any).
    void addSkin​(X3DNode[] newValue)
    Add array of child skin nodes to array of existing nodes (if any).
    void addSkinBindingCoords​(X3DNode[] newValue)
    Add array of child skinBindingCoords nodes to array of existing nodes (if any).
    void addSkinBindingNormals​(X3DNode[] newValue)
    Add array of child skinBindingNormals nodes to array of existing nodes (if any).
    void addViewpoints​(X3DNode[] newValue)
    Add array of child viewpoints 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[] getCenter()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    java.lang.String[] getInfo()
    Provide array of String results from inputOutput MFString field named info.
    float[] getJointBindingPositions()
    Provide array of 3-tuple float results from inputOutput MFVec3f field named jointBindingPositions.
    float[] getJointBindingRotations()
    Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput MFRotation field named jointBindingRotations.
    float[] getJointBindingScales()
    Provide array of 3-tuple float results from inputOutput MFVec3f field named jointBindingScales.
    X3DNode[] getJoints()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field joints.
    int getLoa()
    Provide int value within allowed range of [-1,4] from inputOutput SFInt32 field named loa.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    X3DNode[] getMotions()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field motions.
    java.lang.String getName()
    Provide String value from inputOutput SFString field named name.
    float[] getRotation()
    Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
    float[] getScale()
    Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named scale.
    float[] getScaleOrientation()
    Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named scaleOrientation.
    X3DNode[] getSegments()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field segments.
    X3DNode[] getSites()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field sites.
    java.lang.String getSkeletalConfiguration()
    Provide String value from inputOutput SFString field named skeletalConfiguration.
    X3DNode[] getSkeleton()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to HAnimJoint|HAnimSite, from inputOutput MFNode field skeleton.
    X3DNode[] getSkin()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to Group|Transform|Shape|IndexedFaceSet, from inputOutput MFNode field skin.
    X3DNode[] getSkinBindingCoords()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field skinBindingCoords.
    X3DNode[] getSkinBindingNormals()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field skinBindingNormals.
    X3DCoordinateNode getSkinCoord()
    Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field skinCoord.
    X3DNormalNode getSkinNormal()
    Provide X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field skinNormal.
    float[] getTranslation()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.
    java.lang.String getVersion()
    Provide String enumeration value ( baseType hanimVersionChoices) ["1.0" | "1.1" | "2.0"] from inputOutput SFString field named version.
    X3DNode[] getViewpoints()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field viewpoints.
    HAnimHumanoid setBboxCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    HAnimHumanoid setBboxSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    HAnimHumanoid setCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.
    HAnimHumanoid setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    HAnimHumanoid setInfo​(java.lang.String[] newValue)
    Accessor method to assign String array to inputOutput MFString field named info.
    HAnimHumanoid setJointBindingPositions​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named jointBindingPositions.
    HAnimHumanoid setJointBindingRotations​(float[] newValue)
    Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput MFRotation field named jointBindingRotations.
    HAnimHumanoid setJointBindingScales​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named jointBindingScales.
    void setJoints​(X3DNode newValue)
    Set single child joints node, replacing prior array of existing nodes (if any).
    HAnimHumanoid setJoints​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field joints.
    HAnimHumanoid setLoa​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named loa.
    HAnimHumanoid setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    void setMotions​(X3DNode newValue)
    Set single child motions node, replacing prior array of existing nodes (if any).
    HAnimHumanoid setMotions​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field motions.
    HAnimHumanoid setName​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named name.
    HAnimHumanoid setRotation​(float[] newValue)
    Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
    HAnimHumanoid setScale​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named scale.
    HAnimHumanoid setScaleOrientation​(float[] newValue)
    Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named scaleOrientation.
    void setSegments​(X3DNode newValue)
    Set single child segments node, replacing prior array of existing nodes (if any).
    HAnimHumanoid setSegments​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field segments.
    void setSites​(X3DNode newValue)
    Set single child sites node, replacing prior array of existing nodes (if any).
    HAnimHumanoid setSites​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field sites.
    HAnimHumanoid setSkeletalConfiguration​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named skeletalConfiguration.
    void setSkeleton​(X3DNode newValue)
    Set single child skeleton node, replacing prior array of existing nodes (if any).
    HAnimHumanoid setSkeleton​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field skeleton. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.HAnim.HAnimJointObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.HAnim.HAnimSiteObject); if (!
    void setSkin​(X3DNode newValue)
    Set single child skin node, replacing prior array of existing nodes (if any).
    HAnimHumanoid setSkin​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field skin. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Grouping.GroupObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Grouping.TransformObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Shape.ShapeObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Geometry3D.IndexedFaceSetObject); if (!
    void setSkinBindingCoords​(X3DNode newValue)
    Set single child skinBindingCoords node, replacing prior array of existing nodes (if any).
    HAnimHumanoid setSkinBindingCoords​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field skinBindingCoords.
    void setSkinBindingNormals​(X3DNode newValue)
    Set single child skinBindingNormals node, replacing prior array of existing nodes (if any).
    HAnimHumanoid setSkinBindingNormals​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field skinBindingNormals.
    HAnimHumanoid setSkinCoord​(X3DCoordinateNode newValue)
    Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field skinCoord.
    HAnimHumanoid setSkinNormal​(X3DNormalNode newValue)
    Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field skinNormal.
    HAnimHumanoid setTranslation​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.
    HAnimHumanoid setVersion​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("1.0" | "1.1" | "2.0") to inputOutput SFString field named version.
    void setViewpoints​(X3DNode newValue)
    Set single child viewpoints node, replacing prior array of existing nodes (if any).
    HAnimHumanoid setViewpoints​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field viewpoints.
  • Method Details

    • 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.
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Returns:
      value of bboxCenter field
    • setBboxCenter

      HAnimHumanoid setBboxCenter​(float[] newValue)
      Accessor method to 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.
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      HAnimHumanoid - 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.
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Returns:
      value of bboxSize field
    • setBboxSize

      HAnimHumanoid setBboxSize​(float[] newValue)
      Accessor method to assign 3-tuple float array 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.
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCenter

      float[] getCenter()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named center.

      Tooltip: Translation offset from origin of local coordinate system. *
      Returns:
      value of center field
    • setCenter

      HAnimHumanoid setCenter​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.

      Tooltip: Translation offset from origin of local coordinate system. *
      Parameters:
      newValue - is new value for the center field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDescription

      java.lang.String getDescription()
      Provide String value from inputOutput SFString field named description.
      Returns:
      value of description field
    • setDescription

      HAnimHumanoid setDescription​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.
      Parameters:
      newValue - is new value for the description field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getInfo

      java.lang.String[] getInfo()
      Provide array of String results from inputOutput MFString field named info.

      Tooltip: Contains metadata keyword=value pairs, where approved keyword terms are humanoidVersion authorName authorEmail copyright creationDate usageRestrictions age gender height and weight.
      • Hint: alternate metadata keywords are also allowed.
      Returns:
      value of info field
    • setInfo

      HAnimHumanoid setInfo​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named info.

      Tooltip: Contains metadata keyword=value pairs, where approved keyword terms are humanoidVersion authorName authorEmail copyright creationDate usageRestrictions age gender height and weight.
      • Hint: alternate metadata keywords are also allowed.
      Parameters:
      newValue - is new value for the info field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getJointBindingPositions

      float[] getJointBindingPositions()
      Provide array of 3-tuple float results from inputOutput MFVec3f field named jointBindingPositions.

      Tooltip: Specifies an array of position values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.
      • Hint: if only one value is provided, it is provided to each Joint equivalently.
      • Warning: not used when skeletalConfiguration='BASIC'.
      Returns:
      value of jointBindingPositions field
    • setJointBindingPositions

      HAnimHumanoid setJointBindingPositions​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named jointBindingPositions.

      Tooltip: Specifies an array of position values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.
      • Hint: if only one value is provided, it is provided to each Joint equivalently.
      • Warning: not used when skeletalConfiguration='BASIC'.
      Parameters:
      newValue - is new value for the jointBindingPositions field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getJointBindingRotations

      float[] getJointBindingRotations()
      Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput MFRotation field named jointBindingRotations.

      Tooltip: Specifies an array of rotation values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.
      • Hint: if only one value is provided, it is provided to each Joint equivalently.
      • Warning: not used when skeletalConfiguration='BASIC'.
      Returns:
      value of jointBindingRotations field
    • setJointBindingRotations

      HAnimHumanoid setJointBindingRotations​(float[] newValue)
      Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput MFRotation field named jointBindingRotations.

      Tooltip: Specifies an array of rotation values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.
      • Hint: if only one value is provided, it is provided to each Joint equivalently.
      • Warning: not used when skeletalConfiguration='BASIC'.
      Parameters:
      newValue - is new value for the jointBindingRotations field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getJointBindingScales

      float[] getJointBindingScales()
      Provide array of 3-tuple float results from inputOutput MFVec3f field named jointBindingScales.

      Tooltip: Specifies an array of scale values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.
      • Hint: if only one value is provided, it is provided to each Joint equivalently.
      • Warning: not used when skeletalConfiguration='BASIC'.
      Returns:
      value of jointBindingScales field
    • setJointBindingScales

      HAnimHumanoid setJointBindingScales​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named jointBindingScales.

      Tooltip: Specifies an array of scale values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.
      • Hint: if only one value is provided, it is provided to each Joint equivalently.
      • Warning: not used when skeletalConfiguration='BASIC'.
      Parameters:
      newValue - is new value for the jointBindingScales field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getJoints

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

      Tooltip: [HAnimJoint] The joints field contains a list of USE references for all HAnimJoint node instances found within the preceding skeleton hierarchy.
      • Hint: order is irrelevant since names are contained in the original DEF objects.
      • Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
      • Warning: the number of contained <HAnimJoint USE='*' containerField='joints'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimJoint node instances found within the preceding skeleton hierarchy.
      • Warning: top-level HAnimJoint USE nodes must include containerField='joints' for proper validation and operation.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint.
      Returns:
      value of joints field
      See Also:
      HAnimJointObject
    • setJoints

      HAnimHumanoid setJoints​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field joints.

      Tooltip: [HAnimJoint] The joints field contains a list of USE references for all HAnimJoint node instances found within the preceding skeleton hierarchy.
      • Hint: order is irrelevant since names are contained in the original DEF objects.
      • Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
      • Warning: the number of contained <HAnimJoint USE='*' containerField='joints'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimJoint node instances found within the preceding skeleton hierarchy.
      • Warning: top-level HAnimJoint USE nodes must include containerField='joints' for proper validation and operation.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint.
      Parameters:
      newValue - is new value for the joints field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addJoints

      void addJoints​(X3DNode[] newValue)
      Add array of child joints nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint.
      Parameters:
      newValue - is new value array to be appended the joints field.
    • setJoints

      void setJoints​(X3DNode newValue)
      Set single child joints node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the joints field
    • getLoa

      int getLoa()
      Provide int value within allowed range of [-1,4] from inputOutput SFInt32 field named loa.

      Tooltip: [-1,4] Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid skeletal hierarchy.
      Returns:
      value of loa field
    • setLoa

      HAnimHumanoid setLoa​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named loa.

      Tooltip: [-1,4] Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid skeletal hierarchy.
      Parameters:
      newValue - is new value for the loa field.
      Returns:
      HAnimHumanoid - 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 X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      HAnimHumanoid setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      HAnimHumanoid - 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
    • getMotions

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

      Tooltip: [HAnimMotion] Contains any HAnimMotion nodes that can animate the HAnimHumanoid. *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimMotion.
      Returns:
      value of motions field
      See Also:
      HAnimMotionObject
    • setMotions

      HAnimHumanoid setMotions​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field motions.

      Tooltip: [HAnimMotion] Contains any HAnimMotion nodes that can animate the HAnimHumanoid. *


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimMotion.
      Parameters:
      newValue - is new value for the motions field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addMotions

      void addMotions​(X3DNode[] newValue)
      Add array of child motions nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimMotion.
      Parameters:
      newValue - is new value array to be appended the motions field.
    • setMotions

      void setMotions​(X3DNode newValue)
      Set single child motions node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the motions field
    • getName

      java.lang.String getName()
      Provide String value from inputOutput SFString field named name.

      Tooltip: Unique name attribute must be defined so that each HAnimHumanoid node in a scene can be identified at run time for animation purposes.
      • Hint: this same name is a required name prefix for all other HAnim nodes within the HAnimHumanoid, if more than one humanoid appears within a scene file.
      • Warning: name is not included if this instance is a USE node.
      • 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

      HAnimHumanoid setName​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named name.

      Tooltip: Unique name attribute must be defined so that each HAnimHumanoid node in a scene can be identified at run time for animation purposes.
      • Hint: this same name is a required name prefix for all other HAnim nodes within the HAnimHumanoid, if more than one humanoid appears within a scene file.
      • Warning: name is not included if this instance is a USE node.
      • 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:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRotation

      float[] getRotation()
      Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.

      Tooltip: Orientation of children relative to local coordinate system.
      • Warning: default pose is typically empty (or an identity rotation) to avoid distorted body animations.
      Returns:
      value of rotation field
    • setRotation

      HAnimHumanoid setRotation​(float[] newValue)
      Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.

      Tooltip: Orientation of children relative to local coordinate system.
      • Warning: default pose is typically empty (or an identity rotation) to avoid distorted body animations.
      Parameters:
      newValue - is new value for the rotation field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getScale

      float[] getScale()
      Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named scale.

      Tooltip: Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation. *
      Returns:
      value of scale field
    • setScale

      HAnimHumanoid setScale​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named scale.

      Tooltip: Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation. *
      Parameters:
      newValue - is new value for the scale field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getScaleOrientation

      float[] getScaleOrientation()
      Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named scaleOrientation.

      Tooltip: Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations). *
      Returns:
      value of scaleOrientation field
    • setScaleOrientation

      HAnimHumanoid setScaleOrientation​(float[] newValue)
      Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named scaleOrientation.

      Tooltip: Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations). *
      Parameters:
      newValue - is new value for the scaleOrientation field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSegments

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

      Tooltip: [HAnimSegment] The segments field contains a list of USE references for all HAnimSegment node instances found within the preceding skeleton hierarchy.
      • Hint: order is irrelevant since names are contained in the original DEF objects.
      • Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
      • Warning: the number of contained <HAnimSegment USE='*' containerField='segments'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSegment node instances found within the preceding skeleton hierarchy.
      • Warning: top-level HAnimSegment USE nodes must include containerField='segments' for proper validation and operation.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSegment.
      Returns:
      value of segments field
      See Also:
      HAnimSegmentObject
    • setSegments

      HAnimHumanoid setSegments​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field segments.

      Tooltip: [HAnimSegment] The segments field contains a list of USE references for all HAnimSegment node instances found within the preceding skeleton hierarchy.
      • Hint: order is irrelevant since names are contained in the original DEF objects.
      • Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
      • Warning: the number of contained <HAnimSegment USE='*' containerField='segments'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSegment node instances found within the preceding skeleton hierarchy.
      • Warning: top-level HAnimSegment USE nodes must include containerField='segments' for proper validation and operation.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSegment.
      Parameters:
      newValue - is new value for the segments field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSegments

      void addSegments​(X3DNode[] newValue)
      Add array of child segments nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSegment.
      Parameters:
      newValue - is new value array to be appended the segments field.
    • setSegments

      void setSegments​(X3DNode newValue)
      Set single child segments node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the segments field
    • getSites

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

      Tooltip: [HAnimSite] sites field contains a list of USE references for all HAnimSite node instances found within the preceding skeleton hierarchy.
      • Hint: order is irrelevant since names are contained in the original DEF objects.
      • Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
      • Warning: the number of contained <HAnimSite USE='*' containerField='sites, skeleton or viewpoints'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSite node instances found within the preceding skeleton hierarchy.
      • Warning: top-level HAnimSite USE nodes must include containerField='sites' for proper validation and operation.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.
      Returns:
      value of sites field
      See Also:
      HAnimSiteObject
    • setSites

      HAnimHumanoid setSites​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field sites.

      Tooltip: [HAnimSite] sites field contains a list of USE references for all HAnimSite node instances found within the preceding skeleton hierarchy.
      • Hint: order is irrelevant since names are contained in the original DEF objects.
      • Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
      • Warning: the number of contained <HAnimSite USE='*' containerField='sites, skeleton or viewpoints'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSite node instances found within the preceding skeleton hierarchy.
      • Warning: top-level HAnimSite USE nodes must include containerField='sites' for proper validation and operation.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.
      Parameters:
      newValue - is new value for the sites field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSites

      void addSites​(X3DNode[] newValue)
      Add array of child sites nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.
      Parameters:
      newValue - is new value array to be appended the sites field.
    • setSites

      void setSites​(X3DNode newValue)
      Set single child sites node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the sites field
    • getSkeletalConfiguration

      java.lang.String getSkeletalConfiguration()
      Provide String value from inputOutput SFString field named skeletalConfiguration.

      Tooltip: Models sharing a common skeletal configuration can share animations and binding poses.
      Returns:
      value of skeletalConfiguration field
    • setSkeletalConfiguration

      HAnimHumanoid setSkeletalConfiguration​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named skeletalConfiguration.

      Tooltip: Models sharing a common skeletal configuration can share animations and binding poses.
      Parameters:
      newValue - is new value for the skeletalConfiguration field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSkeleton

      X3DNode[] getSkeleton()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to HAnimJoint|HAnimSite, from inputOutput MFNode field skeleton.

      Tooltip: [HAnimJoint|HAnimSite] List of top-level HAnimJoint and HAnimSite nodes that create the skeleton model. The skeleton field contains the humanoid_root Joint object, and thus the entire hierarchy of HAnimJoint/HAnimSegment nodes making up the articulated skeleton model.
      • Hint: typically contains HAnimJoint with name='humanoid_root'.
      • Hint: immediate children in the skeleton field can also include top-level HAnimSite node declarations, which are landmarks for the overall humanoid figure that are not affected by HAnimJoint movement.
      • Warning: top-level HAnimJoint and HAnimSite nodes must include containerField='skeleton' for proper validation and operation.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint|HAnimSite.
      Returns:
      value of skeleton field
      See Also:
      HAnimJointObject, HAnimSiteObject
    • setSkeleton

      HAnimHumanoid setSkeleton​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field skeleton. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.HAnim.HAnimJointObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.HAnim.HAnimSiteObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes HAnimJoint|HAnimSite; newValue=" + newValue); }

      Tooltip: [HAnimJoint|HAnimSite] List of top-level HAnimJoint and HAnimSite nodes that create the skeleton model. The skeleton field contains the humanoid_root Joint object, and thus the entire hierarchy of HAnimJoint/HAnimSegment nodes making up the articulated skeleton model.
      • Hint: typically contains HAnimJoint with name='humanoid_root'.
      • Hint: immediate children in the skeleton field can also include top-level HAnimSite node declarations, which are landmarks for the overall humanoid figure that are not affected by HAnimJoint movement.
      • Warning: top-level HAnimJoint and HAnimSite nodes must include containerField='skeleton' for proper validation and operation.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint|HAnimSite.
      Parameters:
      newValue - is new value for the skeleton field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSkeleton

      void addSkeleton​(X3DNode[] newValue)
      Add array of child skeleton nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint|HAnimSite.
      Parameters:
      newValue - is new value array to be appended the skeleton field.
    • setSkeleton

      void setSkeleton​(X3DNode newValue)
      Set single child skeleton node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the skeleton field
    • getSkin

      X3DNode[] getSkin()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to Group|Transform|Shape|IndexedFaceSet, from inputOutput MFNode field skin.

      Tooltip: [IndexedFaceSet|Group|Transform|Shape] List of one or more indexed mesh definitions (such as IndexedFaceSet) that utilize skinCoord point and skinNormal normal data.
      • 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: top-level node must include containerField='skin' for proper validation and operation.
      • Hint: put skin node first and provide DEF label to simplify USE node usage within the skeleton hierarchy.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Group|Transform|Shape|IndexedFaceSet.
      Returns:
      value of skin field
      See Also:
      GroupObject, TransformObject, ShapeObject, IndexedFaceSetObject
    • setSkin

      HAnimHumanoid setSkin​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field skin. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Grouping.GroupObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Grouping.TransformObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Shape.ShapeObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Geometry3D.IndexedFaceSetObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes Group|Transform|Shape|IndexedFaceSet; newValue=" + newValue); }

      Tooltip: [IndexedFaceSet|Group|Transform|Shape] List of one or more indexed mesh definitions (such as IndexedFaceSet) that utilize skinCoord point and skinNormal normal data.
      • 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: top-level node must include containerField='skin' for proper validation and operation.
      • Hint: put skin node first and provide DEF label to simplify USE node usage within the skeleton hierarchy.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Group|Transform|Shape|IndexedFaceSet.
      Parameters:
      newValue - is new value for the skin field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSkin

      void addSkin​(X3DNode[] newValue)
      Add array of child skin nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Group|Transform|Shape|IndexedFaceSet.
      Parameters:
      newValue - is new value array to be appended the skin field.
    • setSkin

      void setSkin​(X3DNode newValue)
      Set single child skin node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the skin field
    • getSkinBindingCoords

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

      Tooltip: [X3DCoordinateNode] Array of Coordinate nodes to handle non-default source pose so that both skin and skeleton can be in same binding pose.
      • 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: top-level Coordinate or CoordinateDouble nodes must include containerField='skinBindingCoords' for proper validation and operation.
      • Hint: a single node is used so that coordIndex references are consistent for all references to these coordinates.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>
      • Warning: not used when skeletalConfiguration='BASIC'.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DCoordinateNode.
      Returns:
      value of skinBindingCoords field
      See Also:
      X3DCoordinateNode
    • setSkinBindingCoords

      HAnimHumanoid setSkinBindingCoords​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field skinBindingCoords.

      Tooltip: [X3DCoordinateNode] Array of Coordinate nodes to handle non-default source pose so that both skin and skeleton can be in same binding pose.
      • 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: top-level Coordinate or CoordinateDouble nodes must include containerField='skinBindingCoords' for proper validation and operation.
      • Hint: a single node is used so that coordIndex references are consistent for all references to these coordinates.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>
      • Warning: not used when skeletalConfiguration='BASIC'.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DCoordinateNode.
      Parameters:
      newValue - is new value for the skinBindingCoords field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSkinBindingCoords

      void addSkinBindingCoords​(X3DNode[] newValue)
      Add array of child skinBindingCoords nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DCoordinateNode.
      Parameters:
      newValue - is new value array to be appended the skinBindingCoords field.
    • setSkinBindingCoords

      void setSkinBindingCoords​(X3DNode newValue)
      Set single child skinBindingCoords node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the skinBindingCoords field
    • getSkinBindingNormals

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

      Tooltip: [X3DNormalNode] Array of Normal nodes to handle non-default source pose so that both skin and skeleton can be in same binding pose.
      • 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: top-level Normal nodes must include containerField='skinBindingNormals' for proper validation and operation.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>
      • Warning: not used when skeletalConfiguration='BASIC'.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNormalNode.
      Returns:
      value of skinBindingNormals field
      See Also:
      X3DNormalNode
    • setSkinBindingNormals

      HAnimHumanoid setSkinBindingNormals​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field skinBindingNormals.

      Tooltip: [X3DNormalNode] Array of Normal nodes to handle non-default source pose so that both skin and skeleton can be in same binding pose.
      • 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: top-level Normal nodes must include containerField='skinBindingNormals' for proper validation and operation.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>
      • Warning: not used when skeletalConfiguration='BASIC'.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNormalNode.
      Parameters:
      newValue - is new value for the skinBindingNormals field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSkinBindingNormals

      void addSkinBindingNormals​(X3DNode[] newValue)
      Add array of child skinBindingNormals nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNormalNode.
      Parameters:
      newValue - is new value array to be appended the skinBindingNormals field.
    • setSkinBindingNormals

      void setSkinBindingNormals​(X3DNode newValue)
      Set single child skinBindingNormals node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the skinBindingNormals field
    • getSkinCoord

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

      Tooltip: [X3DCoordinateNode] Coordinate node utilized by indexed mesh definitions for skin. The skinCoord field contains a single sequence of points, used by internal HAnimHumanoid mechanisms to create appropriate surface deformations as well as by the indexed face set definitions within the skin field that perform the actual rendering of surface geometry.
      • 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: top-level Coordinate or CoordinateDouble node must include containerField='skinCoord' for proper validation and operation.
      • Hint: a single node is used so that coordIndex references are consistent for all references to these coordinates.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>.
      Returns:
      value of skinCoord field
    • setSkinCoord

      HAnimHumanoid setSkinCoord​(X3DCoordinateNode newValue)
      Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field skinCoord.

      Tooltip: [X3DCoordinateNode] Coordinate node utilized by indexed mesh definitions for skin. The skinCoord field contains a single sequence of points, used by internal HAnimHumanoid mechanisms to create appropriate surface deformations as well as by the indexed face set definitions within the skin field that perform the actual rendering of surface geometry.
      • 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: top-level Coordinate or CoordinateDouble node must include containerField='skinCoord' for proper validation and operation.
      • Hint: a single node is used so that coordIndex references are consistent for all references to these coordinates.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>.
      Parameters:
      newValue - is new value for the skinCoord field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSkinNormal

      X3DNormalNode getSkinNormal()
      Provide X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field skinNormal.

      Tooltip: [X3DNormalNode] Single Normal node utilized by indexed mesh definitions for skin. The skinNormal field contains a single sequence of normal values, used by internal HAnimHumanoid mechanisms to create appropriate surface deformations as well as by the indexed face set definitions within the skin field that perform the actual rendering of surface geometry.
      • 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: top-level Normal node must include containerField='skinNormal' for proper validation and operation.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>.
      Returns:
      value of skinNormal field
    • setSkinNormal

      HAnimHumanoid setSkinNormal​(X3DNormalNode newValue)
      Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field skinNormal.

      Tooltip: [X3DNormalNode] Single Normal node utilized by indexed mesh definitions for skin. The skinNormal field contains a single sequence of normal values, used by internal HAnimHumanoid mechanisms to create appropriate surface deformations as well as by the indexed face set definitions within the skin field that perform the actual rendering of surface geometry.
      • 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: top-level Normal node must include containerField='skinNormal' for proper validation and operation.
      • Warning: (X3D version 4.0 draft) requires X3D profile='Full' or else include <component name='H-Anim' level='2'/>.
      Parameters:
      newValue - is new value for the skinNormal field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTranslation

      float[] getTranslation()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.

      Tooltip: Position of children relative to local coordinate system.
      • Hint: since default pose faces along +Z axis, -x values are right side and +x values are left side within HAnimHumanoid.
      Returns:
      value of translation field
    • setTranslation

      HAnimHumanoid setTranslation​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.

      Tooltip: Position of children relative to local coordinate system.
      • Hint: since default pose faces along +Z axis, -x values are right side and +x values are left side within HAnimHumanoid.
      Parameters:
      newValue - is new value for the translation field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getVersion

      java.lang.String getVersion()
      Provide String enumeration value ( baseType hanimVersionChoices) ["1.0" | "1.1" | "2.0"] from inputOutput SFString field named version.

      Tooltip: HAnimHumanoid version, where value is 2.0 for standardized ISO 19774 initial version from 2006, and value is 2.2 for draft ISO 19774 version from 2018.
      • Warning: prior versions of HAnim nodes might not validate correctly due to small changes in the contained-node content model.
      Returns:
      value of version field
    • setVersion

      HAnimHumanoid setVersion​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("1.0" | "1.1" | "2.0") to inputOutput SFString field named version.

      Tooltip: HAnimHumanoid version, where value is 2.0 for standardized ISO 19774 initial version from 2006, and value is 2.2 for draft ISO 19774 version from 2018.
      • Warning: prior versions of HAnim nodes might not validate correctly due to small changes in the contained-node content model.
      Parameters:
      newValue - is new value for the version field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getViewpoints

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

      Tooltip: [HAnimSite] List of HAnimSite nodes containing Viewpoint nodes that appear in the skeleton model, usually as USE node references. The viewpoints field contains zero or more special HAnimSite nodes that are only affected by HAnimHumanoid transformations (and no HAnimJoint transformations). Each HAnimSite can contain a Viewpoint as virtual camera in the HAnimHumanoid reference frame (such as viewing the face or profile of the human figure).
      • Warning: these are actual node declarations, not USE nodes.
      • Hint: the viewpoint field has different functionality than the joints, segments and sites fields.
      • Hint: the viewpoints field connects internal Site nodes that in turn hold relative Viewpoint nodes, such as <HAnimSite USE='ObserveFaceSite_view' containerField='viewpoints'/> which has corresponding counterpart nodes <HAnimSite DEF='ObserveFaceSite_view' name='ObserveFaceSite_view' containerField='children'> <Viewpoint description='look at me!'/> </HAnimSite>.
      • Warning: top-level HAnimSite nodes (in turn containing Viewpoint nodes) must include containerField='viewpoints' for proper validation and operation.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.
      Returns:
      value of viewpoints field
      See Also:
      HAnimSiteObject
    • setViewpoints

      HAnimHumanoid setViewpoints​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field viewpoints.

      Tooltip: [HAnimSite] List of HAnimSite nodes containing Viewpoint nodes that appear in the skeleton model, usually as USE node references. The viewpoints field contains zero or more special HAnimSite nodes that are only affected by HAnimHumanoid transformations (and no HAnimJoint transformations). Each HAnimSite can contain a Viewpoint as virtual camera in the HAnimHumanoid reference frame (such as viewing the face or profile of the human figure).
      • Warning: these are actual node declarations, not USE nodes.
      • Hint: the viewpoint field has different functionality than the joints, segments and sites fields.
      • Hint: the viewpoints field connects internal Site nodes that in turn hold relative Viewpoint nodes, such as <HAnimSite USE='ObserveFaceSite_view' containerField='viewpoints'/> which has corresponding counterpart nodes <HAnimSite DEF='ObserveFaceSite_view' name='ObserveFaceSite_view' containerField='children'> <Viewpoint description='look at me!'/> </HAnimSite>.
      • Warning: top-level HAnimSite nodes (in turn containing Viewpoint nodes) must include containerField='viewpoints' for proper validation and operation.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.
      Parameters:
      newValue - is new value for the viewpoints field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addViewpoints

      void addViewpoints​(X3DNode[] newValue)
      Add array of child viewpoints nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.
      Parameters:
      newValue - is new value array to be appended the viewpoints field.
    • setViewpoints

      void setViewpoints​(X3DNode newValue)
      Set single child viewpoints node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the viewpoints field