Class HAnimMotionObject

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: HAnimMotion.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the HAnimMotion element: H-Anim
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D H-Anim component level for this element: 2
        See Also:
        Constant Field Values
      • CHANNELS_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> CHANNELS_DEFAULT_VALUE
        MFString field named channels has default value equal to an empty list.
      • CHANNELSENABLED_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Boolean> CHANNELSENABLED_DEFAULT_VALUE
        MFBool field named channelsEnabled has default value equal to an empty list.
      • DESCRIPTION_DEFAULT_VALUE

        public static final java.lang.String DESCRIPTION_DEFAULT_VALUE
        SFString field named description has default value equal to an empty string.
        See Also:
        Constant Field Values
      • ENABLED_DEFAULT_VALUE

        public static final boolean ENABLED_DEFAULT_VALUE
        SFBool field named enabled has default value false (Java syntax) or false (XML syntax).
        See Also:
        Constant Field Values
      • ENDFRAME_DEFAULT_VALUE

        public static final int ENDFRAME_DEFAULT_VALUE
        SFInt32 field named endFrame has default value -1 (Java syntax) or -1 (XML syntax).
        See Also:
        Constant Field Values
      • FRAMEDURATION_DEFAULT_VALUE

        public static final double FRAMEDURATION_DEFAULT_VALUE
        SFTime field named frameDuration has default value 0.1 (Java syntax) or 0.1 (XML syntax).
        See Also:
        Constant Field Values
      • FRAMEINCREMENT_DEFAULT_VALUE

        public static final int FRAMEINCREMENT_DEFAULT_VALUE
        SFInt32 field named frameIncrement has default value 1 (Java syntax) or 1 (XML syntax).
        See Also:
        Constant Field Values
      • FRAMEINDEX_DEFAULT_VALUE

        public static final int FRAMEINDEX_DEFAULT_VALUE
        SFInt32 field named frameIndex has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • IS_DEFAULT_VALUE

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

        public static final java.util.ArrayList<java.lang.String> JOINTS_DEFAULT_VALUE
        MFString field named joints has default value equal to an empty list.
      • 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:
        Constant Field Values
      • LOOP_DEFAULT_VALUE

        public static final boolean LOOP_DEFAULT_VALUE
        SFBool field named loop has default value false (Java syntax) or false (XML syntax).
        See Also:
        Constant Field Values
      • METADATA_DEFAULT_VALUE

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

        public static final int STARTFRAME_DEFAULT_VALUE
        SFInt32 field named startFrame has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • VALUES_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.Float> VALUES_DEFAULT_VALUE
        MFFloat field named values has default value equal to an empty list.
      • fromField_CHANNELS

        public static final java.lang.String fromField_CHANNELS
        fromField ROUTE name for MFString field named channels.
        See Also:
        Constant Field Values
      • toField_CHANNELS

        public static final java.lang.String toField_CHANNELS
        toField ROUTE name for MFString field named channels.
        See Also:
        Constant Field Values
      • fromField_CHANNELSENABLED

        public static final java.lang.String fromField_CHANNELSENABLED
        fromField ROUTE name for MFBool field named channelsEnabled.
        See Also:
        Constant Field Values
      • toField_CHANNELSENABLED

        public static final java.lang.String toField_CHANNELSENABLED
        toField ROUTE name for MFBool field named channelsEnabled.
        See Also:
        Constant Field Values
      • fromField_CYCLETIME

        public static final java.lang.String fromField_CYCLETIME
        fromField ROUTE name for SFTime field named cycleTime.
        See Also:
        Constant Field Values
      • fromField_DESCRIPTION

        public static final java.lang.String fromField_DESCRIPTION
        fromField ROUTE name for SFString field named description.
        See Also:
        Constant Field Values
      • toField_DESCRIPTION

        public static final java.lang.String toField_DESCRIPTION
        toField ROUTE name for SFString field named description.
        See Also:
        Constant Field Values
      • fromField_ELAPSEDTIME

        public static final java.lang.String fromField_ELAPSEDTIME
        fromField ROUTE name for SFTime field named elapsedTime.
        See Also:
        Constant Field Values
      • fromField_ENABLED

        public static final java.lang.String fromField_ENABLED
        fromField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • toField_ENABLED

        public static final java.lang.String toField_ENABLED
        toField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • fromField_ENDFRAME

        public static final java.lang.String fromField_ENDFRAME
        fromField ROUTE name for SFInt32 field named endFrame.
        See Also:
        Constant Field Values
      • toField_ENDFRAME

        public static final java.lang.String toField_ENDFRAME
        toField ROUTE name for SFInt32 field named endFrame.
        See Also:
        Constant Field Values
      • fromField_FRAMECOUNT

        public static final java.lang.String fromField_FRAMECOUNT
        fromField ROUTE name for SFInt32 field named frameCount.
        See Also:
        Constant Field Values
      • fromField_FRAMEDURATION

        public static final java.lang.String fromField_FRAMEDURATION
        fromField ROUTE name for SFTime field named frameDuration.
        See Also:
        Constant Field Values
      • toField_FRAMEDURATION

        public static final java.lang.String toField_FRAMEDURATION
        toField ROUTE name for SFTime field named frameDuration.
        See Also:
        Constant Field Values
      • fromField_FRAMEINCREMENT

        public static final java.lang.String fromField_FRAMEINCREMENT
        fromField ROUTE name for SFInt32 field named frameIncrement.
        See Also:
        Constant Field Values
      • toField_FRAMEINCREMENT

        public static final java.lang.String toField_FRAMEINCREMENT
        toField ROUTE name for SFInt32 field named frameIncrement.
        See Also:
        Constant Field Values
      • fromField_FRAMEINDEX

        public static final java.lang.String fromField_FRAMEINDEX
        fromField ROUTE name for SFInt32 field named frameIndex.
        See Also:
        Constant Field Values
      • toField_FRAMEINDEX

        public static final java.lang.String toField_FRAMEINDEX
        toField ROUTE name for SFInt32 field named frameIndex.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_JOINTS

        public static final java.lang.String fromField_JOINTS
        fromField ROUTE name for MFString field named joints.
        See Also:
        Constant Field Values
      • toField_JOINTS

        public static final java.lang.String toField_JOINTS
        toField ROUTE name for MFString field named joints.
        See Also:
        Constant Field Values
      • fromField_LOA

        public static final java.lang.String fromField_LOA
        fromField ROUTE name for SFInt32 field named loa.
        See Also:
        Constant Field Values
      • toField_LOA

        public static final java.lang.String toField_LOA
        toField ROUTE name for SFInt32 field named loa.
        See Also:
        Constant Field Values
      • fromField_LOOP

        public static final java.lang.String fromField_LOOP
        fromField ROUTE name for SFBool field named loop.
        See Also:
        Constant Field Values
      • toField_LOOP

        public static final java.lang.String toField_LOOP
        toField ROUTE name for SFBool field named loop.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_STARTFRAME

        public static final java.lang.String fromField_STARTFRAME
        fromField ROUTE name for SFInt32 field named startFrame.
        See Also:
        Constant Field Values
      • toField_STARTFRAME

        public static final java.lang.String toField_STARTFRAME
        toField ROUTE name for SFInt32 field named startFrame.
        See Also:
        Constant Field Values
      • fromField_VALUES

        public static final java.lang.String fromField_VALUES
        fromField ROUTE name for MFFloat field named values.
        See Also:
        Constant Field Values
      • toField_VALUES

        public static final java.lang.String toField_VALUES
        toField ROUTE name for MFFloat field named values.
        See Also:
        Constant Field Values
    • Constructor Detail

      • HAnimMotionObject

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

        public HAnimMotionObject​(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
    • Method Detail

      • getElementName

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

        public final java.lang.String getComponent()
        Defines X3D component for the HAnimMotion element: H-Anim
        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
      • 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
      • initialize

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

        public java.lang.String[] getChannels()
        Provide array of String results from inputOutput MFString field named channels.

        Tooltip: list of number of channels for transformation, followed by transformation type of each channel of data. Each value is space or comma separated.
        • Hint: channels are enabled by default, unless otherwise indicated by channelsEnabled field.
        Specified by:
        getChannels in interface HAnimMotion
        Returns:
        value of channels field
      • getChannelsList

        public java.util.ArrayList<java.lang.String> getChannelsList()
        Utility method to get ArrayList value of MFString channels field, similar to getChannels().
        Returns:
        value of channels field
      • setChannels

        public HAnimMotionObject setChannels​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named channels.

        Tooltip: list of number of channels for transformation, followed by transformation type of each channel of data. Each value is space or comma separated.
        • Hint: channels are enabled by default, unless otherwise indicated by channelsEnabled field.
        Specified by:
        setChannels in interface HAnimMotion
        Parameters:
        newValue - is new value for the channels field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setChannels

        public HAnimMotionObject setChannels​(MFStringObject newValue)
        Assign typed object value to MFString channels field, similar to setChannels(String[]).
        Parameters:
        newValue - is new value for the channels field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setChannels

        public HAnimMotionObject setChannels​(SFStringObject newValue)
        Assign single SFString object value to MFString channels field, similar to setChannels(String[]).
        Parameters:
        newValue - is new value for the channels field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setChannels

        public HAnimMotionObject setChannels​(java.lang.String newValue)
        Assign singleton String value to MFString channels field, similar to setChannels(String[]).
        Parameters:
        newValue - is new value for the channels field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setChannels

        public HAnimMotionObject setChannels​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString channels field, similar to setChannels(String[]).
        Parameters:
        newValue - is new value for the channels field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearChannels

        public HAnimMotionObject clearChannels()
        Utility method to clear MFString value of channels field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addChannels

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

        public boolean[] getChannelsEnabled()
        Provide array of Boolean results from inputOutput MFBool field named channelsEnabled.

        Tooltip: boolean values for each channels indicating whether enabled. *
        Specified by:
        getChannelsEnabled in interface HAnimMotion
        Returns:
        value of channelsEnabled field
      • getChannelsEnabledList

        public java.util.ArrayList<java.lang.Boolean> getChannelsEnabledList()
        Utility method to get ArrayList value of MFBool channelsEnabled field, similar to getChannelsEnabled().
        Returns:
        value of channelsEnabled field
      • setChannelsEnabled

        public HAnimMotionObject setChannelsEnabled​(boolean[] newValue)
        Accessor method to assign Boolean array to inputOutput MFBool field named channelsEnabled.

        Tooltip: boolean values for each channels indicating whether enabled. *
        Specified by:
        setChannelsEnabled in interface HAnimMotion
        Parameters:
        newValue - is new value for the channelsEnabled field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setChannelsEnabled

        public HAnimMotionObject setChannelsEnabled​(MFBoolObject newValue)
        Assign typed object value to MFBool channelsEnabled field, similar to setChannelsEnabled(boolean[]).
        Parameters:
        newValue - is new value for the channelsEnabled field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setChannelsEnabled

        public HAnimMotionObject setChannelsEnabled​(java.util.ArrayList<java.lang.Boolean> newValue)
        Assign ArrayList value of MFBool channelsEnabled field, similar to setChannelsEnabled(boolean[]).
        Parameters:
        newValue - is new value for the channelsEnabled field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearChannelsEnabled

        public HAnimMotionObject clearChannelsEnabled()
        Utility method to clear MFBool value of channelsEnabled field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addChannelsEnabled

        public HAnimMotionObject addChannelsEnabled​(boolean newValue)
        Add singleton boolean value to MFBool channelsEnabled field.
        Parameters:
        newValue - is new value to add to the channelsEnabled field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChannelsEnabled

        public HAnimMotionObject addChannelsEnabled​(SFBoolObject newValue)
        Add singleton SFBoolObject value to MFBool channelsEnabled field.
        Parameters:
        newValue - is new value to add to the channelsEnabled field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getCycleTime

        public double getCycleTime()
        Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named cycleTime.

        Tooltip: cycleTime sends a time event at initial starting time and at beginning of each new cycle.
        • Hint: this event is useful for synchronization with other time-based animation objects.
        • 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:
        getCycleTime in interface HAnimMotion
        Returns:
        value of cycleTime field
      • getDescription

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

        Tooltip: Author-provided text tooltip that tells users the expected action of this node.
        • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character).
        Specified by:
        getDescription in interface HAnimMotion
        Returns:
        value of description field
      • setDescription

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

        Tooltip: Author-provided text tooltip that tells users the expected action of this node.
        • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character).
        Specified by:
        setDescription in interface HAnimMotion
        Parameters:
        newValue - is new value for the description field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDescription

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

        public double getElapsedTime()
        Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.

        Tooltip: [0,+infinity) elapsedTime is computed elapsed time since the Motion object was activated and running, counting all traversed frames (as if frameIndex equaled 1) and multiplied by frameDuration, cumulative in seconds.
        • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
        • Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.
        Specified by:
        getElapsedTime in interface HAnimMotion
        Returns:
        value of elapsedTime field
      • getEnabled

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

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

        public HAnimMotionObject 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 HAnimMotion
        Parameters:
        newValue - is new value for the enabled field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setEnabled

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

        public int getEndFrame()
        Provide int value within allowed range of [-1,infinity) from inputOutput SFInt32 field named endFrame.
        Specified by:
        getEndFrame in interface HAnimMotion
        Returns:
        value of endFrame field
      • setEndFrame

        public HAnimMotionObject setEndFrame​(int newValue)
        Accessor method to assign int value to inputOutput SFInt32 field named endFrame.
        Specified by:
        setEndFrame in interface HAnimMotion
        Parameters:
        newValue - is new value for the endFrame field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setEndFrame

        public HAnimMotionObject setEndFrame​(SFInt32Object newValue)
        Assign typed object value to SFInt32 endFrame field, similar to setEndFrame(int).
        Parameters:
        newValue - is new value for the endFrame field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getFrameCount

        public int getFrameCount()
        Provide int value within allowed range of [0,infinity) from outputOnly SFInt32 field named frameCount.

        Tooltip: [0,+infinity) frameCount indicates the number of frames present in the animation, equaling the number of sets of channel data present in the values array.
        • 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:
        getFrameCount in interface HAnimMotion
        Returns:
        value of frameCount field
      • getFrameDuration

        public double getFrameDuration()
        Provide double value in seconds within allowed range of (0,infinity) from inputOutput SFTime field named frameDuration.

        Tooltip: (0,+infinity) frameDuration specifies the duration of each frame in seconds. *
        Specified by:
        getFrameDuration in interface HAnimMotion
        Returns:
        value of frameDuration field
      • setFrameDuration

        public HAnimMotionObject setFrameDuration​(double newValue)
        Accessor method to assign double value in seconds to inputOutput SFTime field named frameDuration.

        Tooltip: (0,+infinity) frameDuration specifies the duration of each frame in seconds. *
        Specified by:
        setFrameDuration in interface HAnimMotion
        Parameters:
        newValue - is new value for the frameDuration field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFrameDuration

        public HAnimMotionObject setFrameDuration​(SFTimeObject newValue)
        Assign typed object value to SFTime frameDuration field, similar to setFrameDuration(double).
        Parameters:
        newValue - is new value for the frameDuration field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getFrameIncrement

        public int getFrameIncrement()
        Provide int value from inputOutput SFInt32 field named frameIncrement.

        Tooltip: [-infinity,+infinity) frameIncrement field controls whether playback direction is forwards or backwards, and also whether frames are skipped (e.g. subsampled replay). For a single animation step, the next frameIndex value equals (frameIndex + frameIncrement) modulo frameCount.
        • Hint: note that setting frameIncrement to 0 prevents automatic advancement of frameIndex and pauses animation of HAnimMotion node.
        Specified by:
        getFrameIncrement in interface HAnimMotion
        Returns:
        value of frameIncrement field
      • setFrameIncrement

        public HAnimMotionObject setFrameIncrement​(int newValue)
        Accessor method to assign int value to inputOutput SFInt32 field named frameIncrement.

        Tooltip: [-infinity,+infinity) frameIncrement field controls whether playback direction is forwards or backwards, and also whether frames are skipped (e.g. subsampled replay). For a single animation step, the next frameIndex value equals (frameIndex + frameIncrement) modulo frameCount.
        • Hint: note that setting frameIncrement to 0 prevents automatic advancement of frameIndex and pauses animation of HAnimMotion node.
        Specified by:
        setFrameIncrement in interface HAnimMotion
        Parameters:
        newValue - is new value for the frameIncrement field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFrameIncrement

        public HAnimMotionObject setFrameIncrement​(SFInt32Object newValue)
        Assign typed object value to SFInt32 frameIncrement field, similar to setFrameIncrement(int).
        Parameters:
        newValue - is new value for the frameIncrement field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getFrameIndex

        public int getFrameIndex()
        Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named frameIndex.

        Tooltip: [0,+infinity) frameIndex indicates index of current frame. Note that frameIndex can be modified whether the Motion node is enabled or not, and becomes effective when the next animation cycle occurs. Thus the frameIndex value indicates the frame currently (or next) being processed.
        • Hint: frameIndex starts at 0 and is no greater than (frameCount - 1). Values less than 0 are reset as 0. Values greater or equal to frameCount are stored as (frameCount - 1). Thus the value of frameIndex shall be greater than or equal to zero, and less than frameCount.
        Specified by:
        getFrameIndex in interface HAnimMotion
        Returns:
        value of frameIndex field
      • setFrameIndex

        public HAnimMotionObject setFrameIndex​(int newValue)
        Accessor method to assign int value to inputOutput SFInt32 field named frameIndex.

        Tooltip: [0,+infinity) frameIndex indicates index of current frame. Note that frameIndex can be modified whether the Motion node is enabled or not, and becomes effective when the next animation cycle occurs. Thus the frameIndex value indicates the frame currently (or next) being processed.
        • Hint: frameIndex starts at 0 and is no greater than (frameCount - 1). Values less than 0 are reset as 0. Values greater or equal to frameCount are stored as (frameCount - 1). Thus the value of frameIndex shall be greater than or equal to zero, and less than frameCount.
        Specified by:
        setFrameIndex in interface HAnimMotion
        Parameters:
        newValue - is new value for the frameIndex field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setFrameIndex

        public HAnimMotionObject setFrameIndex​(SFInt32Object newValue)
        Assign typed object value to SFInt32 frameIndex field, similar to setFrameIndex(int).
        Parameters:
        newValue - is new value for the frameIndex field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearIS

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

        public java.lang.String[] getJoints()
        Provide array of String results from inputOutput MFString field named joints.

        Tooltip: joints field lists names of joints that raw motion data is to be applied to. The number and order of the names in the joints field shall match the number and order of the channels field information, and the number and order of the sets of values in the values field for each frame of the animation.
        • Hint: values are space or comma separated.
        • Hint: The joint name IGNORED shall be used for channel of motion data that is not used for any joint.
        Specified by:
        getJoints in interface HAnimMotion
        Returns:
        value of joints field
      • getJointsList

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

        public HAnimMotionObject setJoints​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named joints.

        Tooltip: joints field lists names of joints that raw motion data is to be applied to. The number and order of the names in the joints field shall match the number and order of the channels field information, and the number and order of the sets of values in the values field for each frame of the animation.
        • Hint: values are space or comma separated.
        • Hint: The joint name IGNORED shall be used for channel of motion data that is not used for any joint.
        Specified by:
        setJoints in interface HAnimMotion
        Parameters:
        newValue - is new value for the joints field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setJoints

        public HAnimMotionObject setJoints​(MFStringObject newValue)
        Assign typed object value to MFString joints field, similar to setJoints(String[]).
        Parameters:
        newValue - is new value for the joints field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setJoints

        public HAnimMotionObject setJoints​(SFStringObject newValue)
        Assign single SFString object value to MFString joints field, similar to setJoints(String[]).
        Parameters:
        newValue - is new value for the joints field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setJoints

        public HAnimMotionObject setJoints​(java.lang.String newValue)
        Assign singleton String value to MFString joints field, similar to setJoints(String[]).
        Parameters:
        newValue - is new value for the joints field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setJoints

        public HAnimMotionObject setJoints​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString joints field, similar to setJoints(String[]).
        Parameters:
        newValue - is new value for the joints field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearJoints

        public HAnimMotionObject clearJoints()
        Utility method to clear MFString value of joints field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 HAnimMotion
        Returns:
        value of loa field
      • setLoa

        public HAnimMotionObject 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 HAnimMotion
        Parameters:
        newValue - is new value for the loa field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLoa

        public HAnimMotionObject setLoa​(SFInt32Object newValue)
        Assign typed object value to SFInt32 loa field, similar to setLoa(int).
        Parameters:
        newValue - is new value for the loa field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getLoop

        public boolean getLoop()
        Provide boolean value from inputOutput SFBool field named loop.

        Tooltip: repeat indefinitely when loop=true, repeat only once when loop=false. *
        Specified by:
        getLoop in interface HAnimMotion
        Returns:
        value of loop field
      • setLoop

        public HAnimMotionObject setLoop​(boolean newValue)
        Accessor method to assign boolean value to inputOutput SFBool field named loop.

        Tooltip: repeat indefinitely when loop=true, repeat only once when loop=false. *
        Specified by:
        setLoop in interface HAnimMotion
        Parameters:
        newValue - is new value for the loop field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLoop

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

        public HAnimMotionObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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
      • getStartFrame

        public int getStartFrame()
        Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named startFrame.
        Specified by:
        getStartFrame in interface HAnimMotion
        Returns:
        value of startFrame field
      • setStartFrame

        public HAnimMotionObject setStartFrame​(int newValue)
        Accessor method to assign int value to inputOutput SFInt32 field named startFrame.
        Specified by:
        setStartFrame in interface HAnimMotion
        Parameters:
        newValue - is new value for the startFrame field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setStartFrame

        public HAnimMotionObject setStartFrame​(SFInt32Object newValue)
        Assign typed object value to SFInt32 startFrame field, similar to setStartFrame(int).
        Parameters:
        newValue - is new value for the startFrame field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getValues

        public float[] getValues()
        Provide array of Float results from inputOutput MFFloat field named values.

        Tooltip: values field contains all transformation values, ordered first by frame, then by joint, and then by transformation Sets of floats in the values array matching the order listed in joints and channels fields. *
        Specified by:
        getValues in interface HAnimMotion
        Returns:
        value of values field
      • getValuesList

        public java.util.ArrayList<java.lang.Float> getValuesList()
        Utility method to get ArrayList value of MFFloat values field, similar to getValues().
        Returns:
        value of values field
      • setValues

        public HAnimMotionObject setValues​(float[] newValue)
        Accessor method to assign Float array to inputOutput MFFloat field named values.

        Tooltip: values field contains all transformation values, ordered first by frame, then by joint, and then by transformation Sets of floats in the values array matching the order listed in joints and channels fields. *
        Specified by:
        setValues in interface HAnimMotion
        Parameters:
        newValue - is new value for the values field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setValues

        public HAnimMotionObject setValues​(MFFloatObject newValue)
        Assign typed object value to MFFloat values field, similar to setValues(float[]).
        Parameters:
        newValue - is new value for the values field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setValues

        public HAnimMotionObject setValues​(java.util.ArrayList<java.lang.Float> newValue)
        Assign ArrayList value of MFFloat values field, similar to setValues(float[]).
        Parameters:
        newValue - is new value for the values field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearValues

        public HAnimMotionObject clearValues()
        Utility method to clear MFFloat value of values field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setValues

        public HAnimMotionObject setValues​(int[] newValue)
        Assign floating-point array value of MFFloat values field, similar to setValues(float[]).
        Parameters:
        newValue - is new value for the values field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addValues

        public HAnimMotionObject addValues​(float newValue)
        Add singleton float value to MFFloat values field.
        Parameters:
        newValue - is new value to add to the values field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addValues

        public HAnimMotionObject addValues​(SFFloatObject newValue)
        Add singleton SFFloatObject value to MFFloat values field.
        Parameters:
        newValue - is new value to add to the values field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setValues

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

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

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

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

        public final HAnimMotionObject setUSE​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named USE.

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

        public HAnimMotionObject setUSE​(SFStringObject newValue)
        Assign typed object value to SFString USE field, similar to setUSE(String).
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        HAnimMotionObject - 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 HAnimMotionObject 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:
        HAnimMotionObject - 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 HAnimMotionObject setCssClass​(SFStringObject newValue)
        Assign typed object value to SFString cssClass field, similar to setCssClass(String).
        Parameters:
        newValue - is new value for the class field.
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getAncestorHAnimHumanoid

        public HAnimHumanoidObject getAncestorHAnimHumanoid()
        Return reference to ancestor HAnimHumanoidObject
        Returns:
        HAnimHumanoidObject if found, otherwise null
      • hasAncestorHAnimHumanoid

        public boolean hasAncestorHAnimHumanoid()
        Return whether ancestor HAnimHumanoidObject is available
        Returns:
        true if ancestor HAnimHumanoidObject found
      • getHAnimVersion

        public java.lang.String getHAnimVersion()
        Return version of ancestor HAnimHumanoidObject (if found) or this HAnimMotion node
        Returns:
        ancestor version if found, otherwise 2.0
        See Also:
        HAnimHumanoidObject.VERSION_2_0
      • setUSE

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

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

        public HAnimMotionObject 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:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public HAnimMotionObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        HAnimMotionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • 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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • 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)
      • 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)