Interface HAnimPose

All Superinterfaces:
X3DChildNode, X3DNode
All Known Implementing Classes:
HAnimPose
public interface HAnimPose extends X3DChildNode
An HAnimPose node supports setting HAnimJoint values in a corresponding HAnimHumanoid skeleton.

HAnimPose node tooltip: (X3D version 4.1 draft) [X3DChildNode] An HAnimPose node supports setting HAnimJoint values in a corresponding HAnimHumanoid skeleton.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Provide String value from inputOutput SFString field named description.
    boolean
    getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    boolean
    getIsActive()
    Provide boolean value from outputOnly SFBool field named isActive.
    int
    getLoa()
    Provide int value within allowed range of [-1,4] from inputOutput SFInt32 field named loa.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    String
    getName()
    Provide String value from inputOutput SFString field named name.
    double
    getTransitionDuration()
    Provide double value in seconds within allowed range of [0.0,infinity) from inputOutput SFTime field named transitionDuration.
    HAnimPose
    setCommencePose(boolean newValue)
    Accessor method to assign boolean value to inputOnly SFBool field named commencePose.
    HAnimPose
    setDescription(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    HAnimPose
    setEnabled(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    HAnimPose
    setLoa(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named loa.
    HAnimPose
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    HAnimPose
    setName(String newValue)
    Accessor method to assign String value to inputOutput SFString field named name.
    HAnimPose
    setResetAllJoints(boolean newValue)
    Accessor method to assign boolean value to inputOnly SFBool field named resetAllJoints.
    HAnimPose
    setTransitionDuration(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named transitionDuration.

  • Method Details

    • setCommencePose

      HAnimPose setCommencePose(boolean newValue)
      Accessor method to assign boolean value to inputOnly SFBool field named commencePose.

      Tooltip: commencePose is an input boolean event that triggers the animation of Joint values to achieve the pose.
      • Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
      Parameters:
      newValue - is new value for the commencePose field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

      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).
      Returns:
      value of description field

    • setDescription

      HAnimPose setDescription(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).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getEnabled

      boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Returns:
      value of enabled field

    • setEnabled

      HAnimPose setEnabled(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIsActive

      boolean getIsActive()
      Provide boolean value from outputOnly SFBool field named isActive.

      Tooltip: isActive true/false events are sent when pose animation starts/stops.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Returns:
      value of isActive field

    • getLoa

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

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

    • setLoa

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

      Tooltip: [-1,4] Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid skeletal hierarchy.
      Parameters:
      newValue - is new value for the loa field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      HAnimPose setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getName

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

      Tooltip: Unique name attribute must be defined so that HAnimPose node can be identified at run time for animation purposes. *
      Returns:
      value of name field

    • setName

      HAnimPose setName(String newValue)
      Accessor method to assign String value to inputOutput SFString field named name.

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


      @see X3D Scene Authoring Hints: Naming Conventions
      Parameters:
      newValue - is new value for the name field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setResetAllJoints

      HAnimPose setResetAllJoints(boolean newValue)
      Accessor method to assign boolean value to inputOnly SFBool field named resetAllJoints.

      Tooltip: resetAllJoints is an input boolean event that zeroes all Joint objects in the skeleton field to their default values, matching the default binding pose (i.e. the I pose).
      • Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events.
      Parameters:
      newValue - is new value for the resetAllJoints field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTransitionDuration

      double getTransitionDuration()
      Provide double value in seconds within allowed range of [0.0,infinity) from inputOutput SFTime field named transitionDuration.

      Tooltip: Duration in seconds for a pose transition. *
      Returns:
      value of transitionDuration field

    • setTransitionDuration

      HAnimPose setTransitionDuration(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named transitionDuration.

      Tooltip: Duration in seconds for a pose transition. *
      Parameters:
      newValue - is new value for the transitionDuration field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).