Class HAnimHumanoid

java.lang.Object
All Implemented Interfaces:
X3DChildNode, X3DNode, X3DBoundedObject, HAnimHumanoid

public class HAnimHumanoid
extends X3DConcreteNode
implements HAnimHumanoid
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,X3DVisibleObject] 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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: HAnimHumanoid, X3D Tooltips: HAnimHumanoid, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • HAnimHumanoid

      public HAnimHumanoid()
      Constructor for HAnimHumanoid to initialize member variables with default values.
    • HAnimHumanoid

      public HAnimHumanoid​(java.lang.String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
    • HAnimHumanoid

      public HAnimHumanoid​(java.lang.String DEFlabel, java.lang.String newName)
      Utility constructor that assigns both DEF label and name, after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
      newName - name for this meta element
      See Also:
      X3D Tooltips: HAnimHumanoid
  • Method Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: HAnimHumanoid
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the HAnimHumanoid element: HAnim
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • getBboxCenter

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

      public 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 HAnimHumanoid
      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).
    • setBboxCenter

      public HAnimHumanoid setBboxCenter​(SFVec3f newValue)
      Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
      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).
    • setBboxCenter

      public HAnimHumanoid setBboxCenter​(float x, float y, float z)
      Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public HAnimHumanoid setBboxCenter​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public HAnimHumanoid setBboxCenter​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBboxDisplay

      public boolean getBboxDisplay()
      Provide boolean value from inputOutput SFBool field named bboxDisplay.

      Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
      • Hint: the bounding box is displayed regardless of whether contained content is visible.
      Specified by:
      getBboxDisplay in interface HAnimHumanoid
      Specified by:
      getBboxDisplay in interface X3DBoundedObject
      Returns:
      value of bboxDisplay field
    • setBboxDisplay

      public HAnimHumanoid setBboxDisplay​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.

      Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
      • Hint: the bounding box is displayed regardless of whether contained content is visible.
      Specified by:
      setBboxDisplay in interface HAnimHumanoid
      Specified by:
      setBboxDisplay in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxDisplay field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxDisplay

      public HAnimHumanoid setBboxDisplay​(SFBool newValue)
      Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
      Parameters:
      newValue - is new value for the bboxDisplay field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBboxSize

      public 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 HAnimHumanoid
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Returns:
      value of bboxSize field
    • setBboxSize

      public 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 HAnimHumanoid
      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).
    • setBboxSize

      public HAnimHumanoid setBboxSize​(SFVec3f newValue)
      Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
      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).
    • setBboxSize

      public HAnimHumanoid setBboxSize​(float x, float y, float z)
      Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public HAnimHumanoid setBboxSize​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public HAnimHumanoid setBboxSize​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCenter

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

      Tooltip: Translation offset from origin of local coordinate system. *
      Specified by:
      getCenter in interface HAnimHumanoid
      Returns:
      value of center field
    • setCenter

      public 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. *
      Specified by:
      setCenter in interface HAnimHumanoid
      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).
    • setCenter

      public HAnimHumanoid setCenter​(SFVec3f newValue)
      Assign typed object value to SFVec3f center field, similar to setCenter(float[]).
      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).
    • setCenter

      public HAnimHumanoid setCenter​(float x, float y, float z)
      Assign values to SFVec3f center field, similar to setCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public HAnimHumanoid setCenter​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public HAnimHumanoid setCenter​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenter(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDescription

      public java.lang.String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of this node.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      getDescription in interface HAnimHumanoid
      Returns:
      value of description field
    • setDescription

      public HAnimHumanoid setDescription​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of this node.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      setDescription in interface HAnimHumanoid
      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).
    • setDescription

      public HAnimHumanoid setDescription​(SFString newValue)
      Assign typed object value to SFString description field, similar to setDescription(String).
      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

      public 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.
      Specified by:
      getInfo in interface HAnimHumanoid
      Returns:
      value of info field
    • getInfoList

      public java.util.ArrayList<java.lang.String> getInfoList()
      Utility method to get ArrayList value of MFString info field, similar to getInfo().
      Returns:
      value of info field
    • getInfoString

      public java.lang.String getInfoString()
      Utility method to get String value of MFString info field, similar to getInfo().
      Returns:
      value of info field
    • setInfo

      public 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.
      Specified by:
      setInfo in interface HAnimHumanoid
      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).
    • setInfo

      public HAnimHumanoid setInfo​(MFString newValue)
      Assign typed object value to MFString info field, similar to setInfo(String[]).
      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).
    • setInfo

      public HAnimHumanoid setInfo​(SFString newValue)
      Assign single SFString object value to MFString info field, similar to setInfo(String[]).
      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).
    • setInfo

      public HAnimHumanoid setInfo​(java.lang.String newValue)
      Assign singleton String value to MFString info field, similar to setInfo(String[]).
      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).
    • setInfo

      public HAnimHumanoid setInfo​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString info field, similar to setInfo(String[]).
      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).
    • clearInfo

      public HAnimHumanoid clearInfo()
      Utility method to clear MFString value of info field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addInfo

      public HAnimHumanoid addInfo​(java.lang.String newValue)
      Add singleton String value to MFString info field.
      Parameters:
      newValue - is new value to add to the info field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFString.cleanupEnumerationValues(String)
    • addInfo

      public HAnimHumanoid addInfo​(SFString newValue)
      Add singleton SFString value to MFString info field.
      Parameters:
      newValue - is new value to add to the info field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFString.cleanupEnumerationValues(String)
    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public HAnimHumanoid setIS​(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public HAnimHumanoid clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()
    • getJointBindingPositions

      public 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'.
      Specified by:
      getJointBindingPositions in interface HAnimHumanoid
      Returns:
      value of jointBindingPositions field
    • setJointBindingPositions

      public 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'.
      Specified by:
      setJointBindingPositions in interface HAnimHumanoid
      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).
    • setJointBindingPositions

      public HAnimHumanoid setJointBindingPositions​(MFVec3f newValue)
      Assign typed object value to MFVec3f jointBindingPositions field, similar to setJointBindingPositions(float[]).
      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).
    • addJointBindingPositions

      public HAnimHumanoid addJointBindingPositions​(SFVec3f newValue)
      Add singleton SFVec3f value to MFVec3f jointBindingPositions field.
      Parameters:
      newValue - is new value to add to the jointBindingPositions field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setJointBindingPositions

      public HAnimHumanoid setJointBindingPositions​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setJointBindingPositions(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getJointBindingRotations

      public 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'.
      Specified by:
      getJointBindingRotations in interface HAnimHumanoid
      Returns:
      value of jointBindingRotations field
    • setJointBindingRotations

      public 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'.
      Specified by:
      setJointBindingRotations in interface HAnimHumanoid
      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).
    • setJointBindingRotations

      public HAnimHumanoid setJointBindingRotations​(MFRotation newValue)
      Assign typed object value to MFRotation jointBindingRotations field, similar to setJointBindingRotations(float[]).
      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).
    • addJointBindingRotations

      public HAnimHumanoid addJointBindingRotations​(SFRotation newValue)
      Add singleton SFRotation value to MFRotation jointBindingRotations field.
      Parameters:
      newValue - is new value to add to the jointBindingRotations field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getJointBindingScales

      public 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'.
      Specified by:
      getJointBindingScales in interface HAnimHumanoid
      Returns:
      value of jointBindingScales field
    • setJointBindingScales

      public 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'.
      Specified by:
      setJointBindingScales in interface HAnimHumanoid
      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).
    • setJointBindingScales

      public HAnimHumanoid setJointBindingScales​(MFVec3f newValue)
      Assign typed object value to MFVec3f jointBindingScales field, similar to setJointBindingScales(float[]).
      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).
    • addJointBindingScales

      public HAnimHumanoid addJointBindingScales​(SFVec3f newValue)
      Add singleton SFVec3f value to MFVec3f jointBindingScales field.
      Parameters:
      newValue - is new value to add to the jointBindingScales field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setJointBindingScales

      public HAnimHumanoid setJointBindingScales​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setJointBindingScales(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getJoints

      public X3DNode[] getJoints()
      Provide array of HAnimJoint results (using an array consisting of properly typed nodes or ProtoInstances) 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 &lt;HAnimJoint USE='*' containerField='joints'/&gt; 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.
      Specified by:
      getJoints in interface HAnimHumanoid
      Returns:
      value of joints field
      See Also:
      HAnimJoint
    • getJointsList

      public java.util.ArrayList<X3DNode> getJointsList()
      Utility method to get ArrayList value of MFNode joints field, similar to getJoints().
      Returns:
      value of joints field
    • setJoints

      public HAnimHumanoid setJoints​(X3DNode[] newValue)
      Accessor method to assign HAnimJoint array (using an array consisting of properly typed nodes or ProtoInstances) 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 &lt;HAnimJoint USE='*' containerField='joints'/&gt; 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.
      Specified by:
      setJoints in interface HAnimHumanoid
      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).
    • setJoints

      public HAnimHumanoid setJoints​(java.util.ArrayList<HAnimJoint> newValue)
      Assign ArrayList value of MFNode joints field, similar to setJoints(org.web3d.x3d.sai.Core.X3DNode[]).
      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

      public HAnimHumanoid addJoints​(HAnimJoint newValue)
      Add single child node to existing array of joints nodes (if any).

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

      public HAnimHumanoid addJoints​(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for joints field.

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

      public 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.
      Specified by:
      addJoints in interface HAnimHumanoid
      Parameters:
      newValue - is new value array to be appended the joints field.
    • setJoints

      public void setJoints​(X3DNode newValue)
      Set single child joints node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimJoint.
      Specified by:
      setJoints in interface HAnimHumanoid
      Parameters:
      newValue - is new node for the joints field (restricted to HAnimJoint)
    • clearJoints

      public HAnimHumanoid clearJoints()
      Utility method to clear MFNode value of joints field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasJoints

      public boolean hasJoints()
      Indicate whether an object is available for inputOutput MFNode field joints.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getJoints()
    • getLoa

      public 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.
      Specified by:
      getLoa in interface HAnimHumanoid
      Returns:
      value of loa field
    • setLoa

      public 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.
      Specified by:
      setLoa in interface HAnimHumanoid
      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).
    • setLoa

      public HAnimHumanoid setLoa​(SFInt32 newValue)
      Assign typed object value to SFInt32 loa field, similar to setLoa(int).
      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

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface HAnimHumanoid
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public HAnimHumanoid setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface HAnimHumanoid
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      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:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

      public HAnimHumanoid clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public HAnimHumanoid setMetadata​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      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:
      setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getMotions

      public X3DNode[] getMotions()
      Provide array of HAnimMotion results (using an array consisting of properly typed nodes or ProtoInstances) 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.
      Specified by:
      getMotions in interface HAnimHumanoid
      Returns:
      value of motions field
      See Also:
      HAnimMotion
    • getMotionsList

      public java.util.ArrayList<X3DNode> getMotionsList()
      Utility method to get ArrayList value of MFNode motions field, similar to getMotions().
      Returns:
      value of motions field
    • setMotions

      public HAnimHumanoid setMotions​(X3DNode[] newValue)
      Accessor method to assign HAnimMotion array (using an array consisting of properly typed nodes or ProtoInstances) 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.
      Specified by:
      setMotions in interface HAnimHumanoid
      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).
    • setMotions

      public HAnimHumanoid setMotions​(java.util.ArrayList<HAnimMotion> newValue)
      Assign ArrayList value of MFNode motions field, similar to setMotions(org.web3d.x3d.sai.Core.X3DNode[]).
      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

      public HAnimHumanoid addMotions​(HAnimMotion newValue)
      Add single child node to existing array of motions nodes (if any).

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

      public HAnimHumanoid addMotions​(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for motions field.

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

      public 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.
      Specified by:
      addMotions in interface HAnimHumanoid
      Parameters:
      newValue - is new value array to be appended the motions field.
    • setMotions

      public void setMotions​(X3DNode newValue)
      Set single child motions node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimMotion.
      Specified by:
      setMotions in interface HAnimHumanoid
      Parameters:
      newValue - is new node for the motions field (restricted to HAnimMotion)
    • clearMotions

      public HAnimHumanoid clearMotions()
      Utility method to clear MFNode value of motions field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasMotions

      public boolean hasMotions()
      Indicate whether an object is available for inputOutput MFNode field motions.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getMotions()
    • getName

      public 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
      Specified by:
      getName in interface HAnimHumanoid
      Returns:
      value of name field
    • setName

      public final 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions


      @see X3D Scene Authoring Hints: Naming Conventions
      Specified by:
      setName in interface HAnimHumanoid
      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).
    • setName

      public HAnimHumanoid setName​(SFString newValue)
      Assign typed object value to SFString name field, similar to setName(String).
      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

      public 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.
      Specified by:
      getRotation in interface HAnimHumanoid
      Returns:
      value of rotation field
    • setRotation

      public 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.
      Specified by:
      setRotation in interface HAnimHumanoid
      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).
    • setRotation

      public HAnimHumanoid setRotation​(SFRotation newValue)
      Assign typed object value to SFRotation rotation field, similar to setRotation(float[]).
      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).
    • setRotation

      public HAnimHumanoid setRotation​(float x, float y, float z, float angleRadians)
      Assign values to SFRotation rotation field, similar to setRotation(float[]).
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRotation

      public HAnimHumanoid setRotation​(double x, double y, double z, double angleRadians)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setRotation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      angleRadians - fourth component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRotation

      public HAnimHumanoid setRotation​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setRotation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getScale

      public 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. *
      Specified by:
      getScale in interface HAnimHumanoid
      Returns:
      value of scale field
    • setScale

      public 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. *
      Specified by:
      setScale in interface HAnimHumanoid
      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).
    • setScale

      public HAnimHumanoid setScale​(SFVec3f newValue)
      Assign typed object value to SFVec3f scale field, similar to setScale(float[]).
      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).
    • setScale

      public HAnimHumanoid setScale​(float x, float y, float z)
      Assign values to SFVec3f scale field, similar to setScale(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public HAnimHumanoid setScale​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setScale(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public HAnimHumanoid setScale​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setScale(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getScaleOrientation

      public 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). *
      Specified by:
      getScaleOrientation in interface HAnimHumanoid
      Returns:
      value of scaleOrientation field
    • setScaleOrientation

      public 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). *
      Specified by:
      setScaleOrientation in interface HAnimHumanoid
      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).
    • setScaleOrientation

      public HAnimHumanoid setScaleOrientation​(SFRotation newValue)
      Assign typed object value to SFRotation scaleOrientation field, similar to setScaleOrientation(float[]).
      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).
    • setScaleOrientation

      public HAnimHumanoid setScaleOrientation​(float x, float y, float z, float angleRadians)
      Assign values to SFRotation scaleOrientation field, similar to setScaleOrientation(float[]).
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScaleOrientation

      public HAnimHumanoid setScaleOrientation​(double x, double y, double z, double angleRadians)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setScaleOrientation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      angleRadians - fourth component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScaleOrientation

      public HAnimHumanoid setScaleOrientation​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setScaleOrientation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSegments

      public X3DNode[] getSegments()
      Provide array of HAnimSegment results (using an array consisting of properly typed nodes or ProtoInstances) 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 &lt;HAnimSegment USE='*' containerField='segments'/&gt; 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.
      Specified by:
      getSegments in interface HAnimHumanoid
      Returns:
      value of segments field
      See Also:
      HAnimSegment
    • getSegmentsList

      public java.util.ArrayList<X3DNode> getSegmentsList()
      Utility method to get ArrayList value of MFNode segments field, similar to getSegments().
      Returns:
      value of segments field
    • setSegments

      public HAnimHumanoid setSegments​(X3DNode[] newValue)
      Accessor method to assign HAnimSegment array (using an array consisting of properly typed nodes or ProtoInstances) 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 &lt;HAnimSegment USE='*' containerField='segments'/&gt; 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.
      Specified by:
      setSegments in interface HAnimHumanoid
      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).
    • setSegments

      public HAnimHumanoid setSegments​(java.util.ArrayList<HAnimSegment> newValue)
      Assign ArrayList value of MFNode segments field, similar to setSegments(org.web3d.x3d.sai.Core.X3DNode[]).
      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

      public HAnimHumanoid addSegments​(HAnimSegment newValue)
      Add single child node to existing array of segments nodes (if any).

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

      public HAnimHumanoid addSegments​(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for segments field.

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

      public 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.
      Specified by:
      addSegments in interface HAnimHumanoid
      Parameters:
      newValue - is new value array to be appended the segments field.
    • setSegments

      public void setSegments​(X3DNode newValue)
      Set single child segments node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimSegment.
      Specified by:
      setSegments in interface HAnimHumanoid
      Parameters:
      newValue - is new node for the segments field (restricted to HAnimSegment)
    • clearSegments

      public HAnimHumanoid clearSegments()
      Utility method to clear MFNode value of segments field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasSegments

      public boolean hasSegments()
      Indicate whether an object is available for inputOutput MFNode field segments.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getSegments()
    • getSites

      public X3DNode[] getSites()
      Provide array of HAnimSite results (using an array consisting of properly typed nodes or ProtoInstances) 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 &lt;HAnimSite USE='*' containerField='sites, skeleton or viewpoints'/&gt; 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.
      Specified by:
      getSites in interface HAnimHumanoid
      Returns:
      value of sites field
      See Also:
      HAnimSite
    • getSitesList

      public java.util.ArrayList<X3DNode> getSitesList()
      Utility method to get ArrayList value of MFNode sites field, similar to getSites().
      Returns:
      value of sites field
    • setSites

      public HAnimHumanoid setSites​(X3DNode[] newValue)
      Accessor method to assign HAnimSite array (using an array consisting of properly typed nodes or ProtoInstances) 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 &lt;HAnimSite USE='*' containerField='sites, skeleton or viewpoints'/&gt; 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.
      Specified by:
      setSites in interface HAnimHumanoid
      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).
    • setSites

      public HAnimHumanoid setSites​(java.util.ArrayList<HAnimSite> newValue)
      Assign ArrayList value of MFNode sites field, similar to setSites(org.web3d.x3d.sai.Core.X3DNode[]).
      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

      public HAnimHumanoid addSites​(HAnimSite newValue)
      Add single child node to existing array of sites nodes (if any).

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

      public HAnimHumanoid addSites​(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for sites field.

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

      public 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.
      Specified by:
      addSites in interface HAnimHumanoid
      Parameters:
      newValue - is new value array to be appended the sites field.
    • setSites

      public void setSites​(X3DNode newValue)
      Set single child sites node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimSite.
      Specified by:
      setSites in interface HAnimHumanoid
      Parameters:
      newValue - is new node for the sites field (restricted to HAnimSite)
    • clearSites

      public HAnimHumanoid clearSites()
      Utility method to clear MFNode value of sites field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasSites

      public boolean hasSites()
      Indicate whether an object is available for inputOutput MFNode field sites.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getSites()
    • getSkeletalConfiguration

      public 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.
      Specified by:
      getSkeletalConfiguration in interface HAnimHumanoid
      Returns:
      value of skeletalConfiguration field
    • setSkeletalConfiguration

      public 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.
      Specified by:
      setSkeletalConfiguration in interface HAnimHumanoid
      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).
    • setSkeletalConfiguration

      public HAnimHumanoid setSkeletalConfiguration​(SFString newValue)
      Assign typed object value to SFString skeletalConfiguration field, similar to setSkeletalConfiguration(String).
      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

      public X3DNode[] getSkeleton()
      Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) 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.
      Specified by:
      getSkeleton in interface HAnimHumanoid
      Returns:
      value of skeleton field
      See Also:
      HAnimJoint, HAnimSite
    • getSkeletonList

      public java.util.ArrayList<X3DNode> getSkeletonList()
      Utility method to get ArrayList value of MFNode skeleton field, similar to getSkeleton().
      Returns:
      value of skeleton field
    • setSkeleton

      public HAnimHumanoid setSkeleton​(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to 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.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint|HAnimSite.
      Specified by:
      setSkeleton in interface HAnimHumanoid
      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).
    • setSkeleton

      public HAnimHumanoid setSkeleton​(java.util.ArrayList<X3DNode> newValue)
      Assign ArrayList value of MFNode skeleton field, similar to setSkeleton(org.web3d.x3d.sai.Core.X3DNode[]).
      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

      public HAnimHumanoid addSkeleton​(X3DNode newValue)
      Add single child node to existing array of skeleton nodes (if any).

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

      public HAnimHumanoid addSkeleton​(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for skeleton field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the parts field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSkeleton

      public 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.
      Specified by:
      addSkeleton in interface HAnimHumanoid
      Parameters:
      newValue - is new value array to be appended the skeleton field.
    • setSkeleton

      public void setSkeleton​(X3DNode newValue)
      Set single child skeleton node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimJoint|HAnimSite.
      Specified by:
      setSkeleton in interface HAnimHumanoid
      Parameters:
      newValue - is new node for the skeleton field (restricted to HAnimJoint|HAnimSite)
    • clearSkeleton

      public HAnimHumanoid clearSkeleton()
      Utility method to clear MFNode value of skeleton field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasSkeleton

      public boolean hasSkeleton()
      Indicate whether an object is available for inputOutput MFNode field skeleton.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getSkeleton()
    • getSkin

      public X3DNode[] getSkin()
      Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) 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 &lt;component name='H-Anim' level='2'/&gt;.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Group|Transform|Shape|IndexedFaceSet.
      Specified by:
      getSkin in interface HAnimHumanoid
      Returns:
      value of skin field
      See Also:
      Group, Transform, Shape, IndexedFaceSet
    • getSkinList

      public java.util.ArrayList<X3DNode> getSkinList()
      Utility method to get ArrayList value of MFNode skin field, similar to getSkin().
      Returns:
      value of skin field
    • setSkin

      public HAnimHumanoid setSkin​(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to 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 &lt;component name='H-Anim' level='2'/&gt;.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Group|Transform|Shape|IndexedFaceSet.
      Specified by:
      setSkin in interface HAnimHumanoid
      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).
    • setSkin

      public HAnimHumanoid setSkin​(java.util.ArrayList<X3DNode> newValue)
      Assign ArrayList value of MFNode skin field, similar to setSkin(org.web3d.x3d.sai.Core.X3DNode[]).
      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

      public HAnimHumanoid addSkin​(X3DNode newValue)
      Add single child node to existing array of skin nodes (if any).

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

      public HAnimHumanoid addSkin​(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for skin field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the parts field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSkin

      public 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.
      Specified by:
      addSkin in interface HAnimHumanoid
      Parameters:
      newValue - is new value array to be appended the skin field.
    • setSkin

      public void setSkin​(X3DNode newValue)
      Set single child skin node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to Group|Transform|Shape|IndexedFaceSet.
      Specified by:
      setSkin in interface HAnimHumanoid
      Parameters:
      newValue - is new node for the skin field (restricted to Group|Transform|Shape|IndexedFaceSet)
    • clearSkin

      public HAnimHumanoid clearSkin()
      Utility method to clear MFNode value of skin field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasSkin

      public boolean hasSkin()
      Indicate whether an object is available for inputOutput MFNode field skin.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getSkin()
    • getSkinBindingCoords

      public X3DCoordinateNode getSkinBindingCoords()
      Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field skinBindingCoords.
      Specified by:
      getSkinBindingCoords in interface HAnimHumanoid
      Returns:
      value of skinBindingCoords field
      See Also:
      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 lt;component name='H-Anim' level='2'/gt; Warning: not used when skeletalConfiguration='BASIC'.
    • setSkinBindingCoords

      public HAnimHumanoid setSkinBindingCoords​(X3DCoordinateNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field skinBindingCoords.
      Specified by:
      setSkinBindingCoords in interface HAnimHumanoid
      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).
      See Also:
      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 lt;component name='H-Anim' level='2'/gt; Warning: not used when skeletalConfiguration='BASIC'.
    • clearSkinBindingCoords

      public HAnimHumanoid clearSkinBindingCoords()
      Utility method to clear SFNode value of skinBindingCoords field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setSkinBindingCoords

      public HAnimHumanoid setSkinBindingCoords​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinBindingCoords.
      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).
      See Also:
      setSkinBindingCoords( org.web3d.x3d.sai.Rendering.X3DCoordinateNode)
    • hasSkinBindingCoords

      public boolean hasSkinBindingCoords()
      Indicate whether an object is available for inputOutput SFNode field skinBindingCoords.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getSkinBindingCoords(), getSkinBindingCoordsProtoInstance()
    • getSkinBindingNormals

      public X3DNormalNode getSkinBindingNormals()
      Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field skinBindingNormals.
      Specified by:
      getSkinBindingNormals in interface HAnimHumanoid
      Returns:
      value of skinBindingNormals field
      See Also:
      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 lt;component name='H-Anim' level='2'/gt; Warning: not used when skeletalConfiguration='BASIC'.
    • setSkinBindingNormals

      public HAnimHumanoid setSkinBindingNormals​(X3DNormalNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field skinBindingNormals.
      Specified by:
      setSkinBindingNormals in interface HAnimHumanoid
      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).
      See Also:
      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 lt;component name='H-Anim' level='2'/gt; Warning: not used when skeletalConfiguration='BASIC'.
    • clearSkinBindingNormals

      public HAnimHumanoid clearSkinBindingNormals()
      Utility method to clear SFNode value of skinBindingNormals field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setSkinBindingNormals

      public HAnimHumanoid setSkinBindingNormals​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinBindingNormals.
      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).
      See Also:
      setSkinBindingNormals( org.web3d.x3d.sai.Rendering.X3DNormalNode)
    • hasSkinBindingNormals

      public boolean hasSkinBindingNormals()
      Indicate whether an object is available for inputOutput SFNode field skinBindingNormals.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getSkinBindingNormals(), getSkinBindingNormalsProtoInstance()
    • getSkinCoord

      public X3DCoordinateNode getSkinCoord()
      Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field skinCoord.
      Specified by:
      getSkinCoord in interface HAnimHumanoid
      Returns:
      value of skinCoord field
      See Also:
      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 lt;component name='H-Anim' level='2'/gt;.
    • setSkinCoord

      public HAnimHumanoid setSkinCoord​(X3DCoordinateNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field skinCoord.
      Specified by:
      setSkinCoord in interface HAnimHumanoid
      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).
      See Also:
      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 lt;component name='H-Anim' level='2'/gt;.
    • clearSkinCoord

      public HAnimHumanoid clearSkinCoord()
      Utility method to clear SFNode value of skinCoord field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setSkinCoord

      public HAnimHumanoid setSkinCoord​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinCoord.
      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).
      See Also:
      setSkinCoord( org.web3d.x3d.sai.Rendering.X3DCoordinateNode)
    • hasSkinCoord

      public boolean hasSkinCoord()
      Indicate whether an object is available for inputOutput SFNode field skinCoord.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getSkinCoord(), getSkinCoordProtoInstance()
    • getSkinNormal

      public X3DNormalNode getSkinNormal()
      Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field skinNormal.
      Specified by:
      getSkinNormal in interface HAnimHumanoid
      Returns:
      value of skinNormal field
      See Also:
      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 lt;component name='H-Anim' level='2'/gt;.
    • setSkinNormal

      public HAnimHumanoid setSkinNormal​(X3DNormalNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field skinNormal.
      Specified by:
      setSkinNormal in interface HAnimHumanoid
      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).
      See Also:
      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 lt;component name='H-Anim' level='2'/gt;.
    • clearSkinNormal

      public HAnimHumanoid clearSkinNormal()
      Utility method to clear SFNode value of skinNormal field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setSkinNormal

      public HAnimHumanoid setSkinNormal​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinNormal.
      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).
      See Also:
      setSkinNormal( org.web3d.x3d.sai.Rendering.X3DNormalNode)
    • hasSkinNormal

      public boolean hasSkinNormal()
      Indicate whether an object is available for inputOutput SFNode field skinNormal.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getSkinNormal(), getSkinNormalProtoInstance()
    • getTranslation

      public 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.
      Specified by:
      getTranslation in interface HAnimHumanoid
      Returns:
      value of translation field
    • setTranslation

      public 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.
      Specified by:
      setTranslation in interface 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).
    • setTranslation

      public HAnimHumanoid setTranslation​(SFVec3f newValue)
      Assign typed object value to SFVec3f translation field, similar to setTranslation(float[]).
      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).
    • setTranslation

      public HAnimHumanoid setTranslation​(float x, float y, float z)
      Assign values to SFVec3f translation field, similar to setTranslation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public HAnimHumanoid setTranslation​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setTranslation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public HAnimHumanoid setTranslation​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setTranslation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getVersion

      public java.lang.String getVersion()
      Provide String enumeration value (baseType xs:NMTOKEN) ["1.0" | "2.0"] from inputOutput SFString field named version.

      Tooltip: HAnimHumanoid version, where value is 1.0 for standardized ISO 19774 version 2006, and value is 2.0 for final ISO 19774 version 2019.
      • Hint: default HAnimHumanoid version is 1.0 for X3D version 3, and HAnimHumanoid default version is 2.0 for X3D version 4.
      • Warning: no other values are allowed for strict validation.
      • Warning: prior developmental versions of HAnim nodes might not validate correctly due to small changes in the contained-node content model.


      Available enumeration values for string comparison: 1_0, 2_0.
      Specified by:
      getVersion in interface HAnimHumanoid
      Returns:
      value of version field
    • setVersion

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

      Warning: authors can only choose from a strict list of enumeration values (1_0, 2_0).

      Tooltip: HAnimHumanoid version, where value is 1.0 for standardized ISO 19774 version 2006, and value is 2.0 for final ISO 19774 version 2019.
      • Hint: default HAnimHumanoid version is 1.0 for X3D version 3, and HAnimHumanoid default version is 2.0 for X3D version 4.
      • Warning: no other values are allowed for strict validation.
      • Warning: prior developmental versions of HAnim nodes might not validate correctly due to small changes in the contained-node content model.
      Specified by:
      setVersion in interface HAnimHumanoid
      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).
    • setVersion

      public HAnimHumanoid setVersion​(SFString newValue)
      Assign typed object value to SFString version field, similar to setVersion(String).
      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

      public X3DNode[] getViewpoints()
      Provide array of HAnimSite results (using an array consisting of properly typed nodes or ProtoInstances) 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 &lt;HAnimSite USE='ObserveFaceSite_view' containerField='viewpoints'/&gt; which has corresponding counterpart nodes &lt;HAnimSite DEF='ObserveFaceSite_view' name='ObserveFaceSite_view' containerField='children'&gt; &lt;Viewpoint description='look at me!'/&gt; &lt;/HAnimSite&gt;.
      • 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.
      Specified by:
      getViewpoints in interface HAnimHumanoid
      Returns:
      value of viewpoints field
      See Also:
      HAnimSite
    • getViewpointsList

      public java.util.ArrayList<X3DNode> getViewpointsList()
      Utility method to get ArrayList value of MFNode viewpoints field, similar to getViewpoints().
      Returns:
      value of viewpoints field
    • setViewpoints

      public HAnimHumanoid setViewpoints​(X3DNode[] newValue)
      Accessor method to assign HAnimSite array (using an array consisting of properly typed nodes or ProtoInstances) 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 &lt;HAnimSite USE='ObserveFaceSite_view' containerField='viewpoints'/&gt; which has corresponding counterpart nodes &lt;HAnimSite DEF='ObserveFaceSite_view' name='ObserveFaceSite_view' containerField='children'&gt; &lt;Viewpoint description='look at me!'/&gt; &lt;/HAnimSite&gt;.
      • 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.
      Specified by:
      setViewpoints in interface HAnimHumanoid
      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).
    • setViewpoints

      public HAnimHumanoid setViewpoints​(java.util.ArrayList<HAnimSite> newValue)
      Assign ArrayList value of MFNode viewpoints field, similar to setViewpoints(org.web3d.x3d.sai.Core.X3DNode[]).
      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

      public HAnimHumanoid addViewpoints​(HAnimSite newValue)
      Add single child node to existing array of viewpoints nodes (if any).

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

      public HAnimHumanoid addViewpoints​(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for viewpoints field.

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

      public 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.
      Specified by:
      addViewpoints in interface HAnimHumanoid
      Parameters:
      newValue - is new value array to be appended the viewpoints field.
    • setViewpoints

      public void setViewpoints​(X3DNode newValue)
      Set single child viewpoints node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimSite.
      Specified by:
      setViewpoints in interface HAnimHumanoid
      Parameters:
      newValue - is new node for the viewpoints field (restricted to HAnimSite)
    • clearViewpoints

      public HAnimHumanoid clearViewpoints()
      Utility method to clear MFNode value of viewpoints field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasViewpoints

      public boolean hasViewpoints()
      Indicate whether an object is available for inputOutput MFNode field viewpoints.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getViewpoints()
    • getVisible

      public boolean getVisible()
      Provide boolean value from inputOutput SFBool field named visible.

      Tooltip: Whether or not renderable content within this node is visually displayed.
      • Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
      • Hint: content must be visible to be collidable and to be pickable.
      Specified by:
      getVisible in interface HAnimHumanoid
      Specified by:
      getVisible in interface X3DBoundedObject
      Returns:
      value of visible field
    • setVisible

      public HAnimHumanoid setVisible​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named visible.

      Tooltip: Whether or not renderable content within this node is visually displayed.
      • Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
      • Hint: content must be visible to be collidable and to be pickable.
      Specified by:
      setVisible in interface HAnimHumanoid
      Specified by:
      setVisible in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the visible field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setVisible

      public HAnimHumanoid setVisible​(SFBool newValue)
      Assign typed object value to SFBool visible field, similar to setVisible(boolean).
      Parameters:
      newValue - is new value for the visible field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final HAnimHumanoid setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public HAnimHumanoid setDEF​(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public java.lang.String getUSE()
      Provide String value from 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.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final HAnimHumanoid setUSE​(java.lang.String newValue)
      Accessor method to 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public HAnimHumanoid setUSE​(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from 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
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final HAnimHumanoid setCssClass​(java.lang.String newValue)
      Accessor method to 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public HAnimHumanoid setCssClass​(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getHAnimVersion

      public java.lang.String getHAnimVersion()
      Return version of this HAnimHumanoid
      Returns:
      HAnim version
    • setUSE

      public HAnimHumanoid setUSE​(HAnimHumanoid DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that 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.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public HAnimHumanoid addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public HAnimHumanoid addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public HAnimHumanoid addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      HAnimHumanoid - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)
    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)