Class HAnimPose

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.HAnim.HAnimPose
All Implemented Interfaces:
X3DChildNode, X3DNode, HAnimPose
public class HAnimPose extends X3DConcreteNode implements HAnimPose
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 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:

  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: HAnimPose.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the HAnimPose element: HAnim
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D HAnim component level for this element: 2
      See Also:

    • DESCRIPTION_DEFAULT_VALUE

      public static final String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:

    • ENABLED_DEFAULT_VALUE

      public static final boolean ENABLED_DEFAULT_VALUE
      SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
      See Also:

    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

    • LOA_DEFAULT_VALUE

      public static final int LOA_DEFAULT_VALUE
      SFInt32 field named loa has default value -1 (Java syntax) or -1 (XML syntax).
      See Also:

    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

    • NAME_DEFAULT_VALUE

      public static final String NAME_DEFAULT_VALUE
      SFString field named name has default value equal to an empty string.
      See Also:

    • TRANSITIONDURATION_DEFAULT_VALUE

      public static final double TRANSITIONDURATION_DEFAULT_VALUE
      SFTime field named transitionDuration has default value 0.0 (Java syntax) or 0.0 (XML syntax).
      See Also:

    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
      containerField_DEFAULT_VALUE = "children";
      containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN
      See Also:

    • toField_COMMENCEPOSE

      public static final String toField_COMMENCEPOSE
      toField ROUTE name for SFBool field named commencePose.
      See Also:

    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:

    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:

    • fromField_ENABLED

      public static final String fromField_ENABLED
      fromField ROUTE name for SFBool field named enabled.
      See Also:

    • toField_ENABLED

      public static final String toField_ENABLED
      toField ROUTE name for SFBool field named enabled.
      See Also:

    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:

    • fromField_ISACTIVE

      public static final String fromField_ISACTIVE
      fromField ROUTE name for SFBool field named isActive.
      See Also:

    • fromField_LOA

      public static final String fromField_LOA
      fromField ROUTE name for SFInt32 field named loa.
      See Also:

    • toField_LOA

      public static final String toField_LOA
      toField ROUTE name for SFInt32 field named loa.
      See Also:

    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:

    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:

    • fromField_NAME

      public static final String fromField_NAME
      fromField ROUTE name for SFString field named name.
      See Also:

    • toField_NAME

      public static final String toField_NAME
      toField ROUTE name for SFString field named name.
      See Also:

    • toField_RESETALLJOINTS

      public static final String toField_RESETALLJOINTS
      toField ROUTE name for SFBool field named resetAllJoints.
      See Also:

    • toField_SET_FRACTION

      public static final String toField_SET_FRACTION
      toField ROUTE name for SFTime field named set_fraction.
      See Also:

    • toField_SET_STARTTIME

      public static final String toField_SET_STARTTIME
      toField ROUTE name for SFTime field named set_startTime.
      See Also:

    • fromField_TRANSITIONDURATION

      public static final String fromField_TRANSITIONDURATION
      fromField ROUTE name for SFTime field named transitionDuration.
      See Also:

    • toField_TRANSITIONDURATION

      public static final String toField_TRANSITIONDURATION
      toField ROUTE name for SFTime field named transitionDuration.
      See Also:

  • Constructor Details

    • HAnimPose

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

    • HAnimPose

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

    • HAnimPose

      public HAnimPose(String DEFlabel, 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:

  • Method Details

    • getElementName

      public final String getElementName()
      Provides name of this element: HAnimPose
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the HAnimPose 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: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element

    • getDescriptionDefault

      public static final String getDescriptionDefault()
      Public accessor for encapsulated SFString default value, returned as String.
      Returns:
      default value

    • getEnabledDefault

      public static final boolean getEnabledDefault()
      Public accessor for encapsulated SFBool default value true, returned as boolean.
      Returns:
      default value

    • getISDefault

      public static final IS getISDefault()
      Public accessor for encapsulated SFNode default value null, returned as IS.
      Returns:
      default value

    • getLoaDefault

      public static final int getLoaDefault()
      Public accessor for encapsulated SFInt32 default value -1, returned as int.
      Returns:
      default value

    • getMetadataDefault

      public static final X3DMetadataObject getMetadataDefault()
      Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.
      Returns:
      default value

    • getNameDefault

      public static final String getNameDefault()
      Public accessor for encapsulated SFString default value, returned as String.
      Returns:
      default value

    • getTransitionDurationDefault

      public static final double getTransitionDurationDefault()
      Public accessor for encapsulated SFTime default value 0.0, returned as double.
      Returns:
      default value

    • getFieldType

      public String getFieldType(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:

    • getAccessType

      public String getAccessType(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:

    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:

    • initialize

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

    • setCommencePose

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

    • setCommencePose

      public HAnimPose setCommencePose(SFBool newValue)
      Assign typed object value to SFBool commencePose field, similar to setCommencePose(boolean).
      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

      public 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 HAnimPose
      Returns:
      value of description field

    • setDescription

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

    • setDescription

      public HAnimPose 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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getEnabled

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

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface HAnimPose
      Returns:
      value of enabled field

    • setEnabled

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

      Tooltip: Enables/disables node operation. *
      Specified by:
      setEnabled in interface HAnimPose
      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).

    • setEnabled

      public HAnimPose setEnabled(SFBool newValue)
      Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
      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).

    • 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:

    • setIS

      public HAnimPose 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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearIS

      public HAnimPose clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      HAnimPose - 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:

    • getIsActive

      public 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.
      Specified by:
      getIsActive in interface HAnimPose
      Returns:
      value of isActive field

    • 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 HAnimPose
      Returns:
      value of loa field

    • setLoa

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

    • setLoa

      public HAnimPose 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:
      HAnimPose - 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 HAnimPose
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      public 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.
      Specified by:
      setMetadata in interface HAnimPose
      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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearMetadata

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

    • setMetadata

      public HAnimPose 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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • 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:

    • getName

      public 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. *
      Specified by:
      getName in interface HAnimPose
      Overrides:
      getName in class X3DConcreteNode
      Returns:
      value of name field

    • setName

      public final 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
      Specified by:
      setName in interface HAnimPose
      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).

    • setName

      public HAnimPose 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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setResetAllJoints

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

    • setResetAllJoints

      public HAnimPose setResetAllJoints(SFBool newValue)
      Assign typed object value to SFBool resetAllJoints field, similar to setResetAllJoints(boolean).
      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

      public 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. *
      Specified by:
      getTransitionDuration in interface HAnimPose
      Returns:
      value of transitionDuration field

    • setTransitionDuration

      public 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. *
      Specified by:
      setTransitionDuration in interface HAnimPose
      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).

    • setTransitionDuration

      public HAnimPose setTransitionDuration(SFTime newValue)
      Assign typed object value to SFTime transitionDuration field, similar to setTransitionDuration(double).
      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).

    • getDEF

      public 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:

    • setDEF

      public final HAnimPose setDEF(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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

      public HAnimPose 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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUSE

      public 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:

    • setUSE

      public final HAnimPose setUSE(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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public HAnimPose 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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

      public final HAnimPose setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssClass

      public HAnimPose 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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getHtmlId

      public String getHtmlId()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlId in class X3DConcreteElement
      Returns:
      value of id field
      See Also:

    • setHtmlId

      public final HAnimPose setHtmlId(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlId in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setHtmlId

      public HAnimPose setHtmlId(SFString newValue)
      Assign typed object value to SFString HtmlId field, similar to setHtmlId(String).
      Parameters:
      newValue - is new value for the id field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:

    • setCssStyle

      public final HAnimPose setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssStyle

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

    • getAncestorHAnimHumanoid

      public HAnimHumanoid getAncestorHAnimHumanoid()
      Return reference to ancestor HAnimHumanoid
      Returns:
      HAnimHumanoid if found, otherwise null

    • hasAncestorHAnimHumanoid

      public boolean hasAncestorHAnimHumanoid()
      Return whether ancestor HAnimHumanoid is available
      Returns:
      true if ancestor HAnimHumanoid found

    • getHAnimVersion

      public String getHAnimVersion()
      Return version of ancestor HAnimHumanoid
      Returns:
      version if found, otherwise "-1"

    • setUSE

      public HAnimPose setUSE(HAnimPose 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:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addComments

      public HAnimPose addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      HAnimPose - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addComments

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

    • addComments

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

    • toStringX3D

      public 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:

    • toStringClassicVRML

      public 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:

    • toStringVRML97

      public 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:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(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:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, 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:

    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, 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:

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(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:

    • hasNodeByDEF

      public boolean hasNodeByDEF(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:

    • validate

      public 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. TODO document specific validation methods.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)