Class EaseInEaseOutObject

  • All Implemented Interfaces:
    X3DChildNode, X3DNode, EaseInEaseOut

    public class EaseInEaseOutObject
    extends X3DConcreteNode
    implements EaseInEaseOut
    X3D node tooltip: (X3D version 3.2 or later) [X3DNode] EaseInEaseOut enables gradual animation transitions by modifying TimeSensor fraction outputs. Output values are modified fractions. Authors can ROUTE value_changed output events to an interpolator, a sequencer, or another SFFloat attribute.
    • Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisEaseInEaseOutDEF.set_fraction
    • Hint: typical output connection is ROUTE thisEaseInEaseOutDEF.modifiedFraction_changed TO someDestinationNodeDEF.set_fraction.
    • Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='3'/>

    Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
    See Also:
    X3D Abstract Specification: EaseInEaseOut, X3D Tooltips: EaseInEaseOut, X3D Scene Authoring Hints
    • Field Detail

      • NAME

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

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the EaseInEaseOut element: Interpolation
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Interpolation component level for this element: 4
        See Also:
        Constant Field Values
      • EASEINEASEOUT_DEFAULT_VALUE

        public static final float[] EASEINEASEOUT_DEFAULT_VALUE
        MFVec2f field named easeInEaseOut has default value equal to an empty list.
      • IS_DEFAULT_VALUE

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

        public static final java.util.ArrayList<java.lang.Float> KEY_DEFAULT_VALUE
        MFFloat field named key has default value equal to an empty list.
      • METADATA_DEFAULT_VALUE

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

        public static final java.lang.String fromField_EASEINEASEOUT
        fromField ROUTE name for MFVec2f field named easeInEaseOut.
        See Also:
        Constant Field Values
      • toField_EASEINEASEOUT

        public static final java.lang.String toField_EASEINEASEOUT
        toField ROUTE name for MFVec2f field named easeInEaseOut.
        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_KEY

        public static final java.lang.String fromField_KEY
        fromField ROUTE name for MFFloat field named key.
        See Also:
        Constant Field Values
      • toField_KEY

        public static final java.lang.String toField_KEY
        toField ROUTE name for MFFloat field named key.
        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_MODIFIEDFRACTION_CHANGED

        public static final java.lang.String fromField_MODIFIEDFRACTION_CHANGED
        fromField ROUTE name for SFFloat field named modifiedFraction_changed.
        See Also:
        Constant Field Values
      • toField_SET_FRACTION

        public static final java.lang.String toField_SET_FRACTION
        toField ROUTE name for SFFloat field named set_fraction.
        See Also:
        Constant Field Values
    • Constructor Detail

      • EaseInEaseOutObject

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

        public EaseInEaseOutObject​(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: EaseInEaseOut
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the EaseInEaseOut element: Interpolation
        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: 4
        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
      • getEaseInEaseOut

        public float[] getEaseInEaseOut()
        Provide array of 2-tuple float results from inputOutput MFVec2f field named easeInEaseOut.

        Tooltip: Array of paired values for easeOut fraction and easeIn fraction within each key interval.
        • Hint: number of easeInEaseOut values must be one less than the number of keys.
        Specified by:
        getEaseInEaseOut in interface EaseInEaseOut
        Returns:
        value of easeInEaseOut field
      • setEaseInEaseOut

        public EaseInEaseOutObject setEaseInEaseOut​(float[] newValue)
        Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named easeInEaseOut.

        Tooltip: Array of paired values for easeOut fraction and easeIn fraction within each key interval.
        • Hint: number of easeInEaseOut values must be one less than the number of keys.
        Specified by:
        setEaseInEaseOut in interface EaseInEaseOut
        Parameters:
        newValue - is new value for the easeInEaseOut field.
        Returns:
        EaseInEaseOutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setEaseInEaseOut

        public EaseInEaseOutObject setEaseInEaseOut​(MFVec2fObject newValue)
        Assign typed object value to MFVec2f easeInEaseOut field, similar to setEaseInEaseOut(float[]).
        Parameters:
        newValue - is new value for the easeInEaseOut field.
        Returns:
        EaseInEaseOutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addEaseInEaseOut

        public EaseInEaseOutObject addEaseInEaseOut​(SFVec2fObject newValue)
        Add singleton SFVec2fObject value to MFVec2f easeInEaseOut field.
        Parameters:
        newValue - is new value to add to the easeInEaseOut field.
        Returns:
        EaseInEaseOutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setEaseInEaseOut

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

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

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

        Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to easeInEaseOut array.
        • Hint: number of keys must be one more than the number of easeInEaseOut values!
        • Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value.
        • Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
        Specified by:
        getKey in interface EaseInEaseOut
        Returns:
        value of key field
      • getKeyList

        public java.util.ArrayList<java.lang.Float> getKeyList()
        Utility method to get ArrayList value of MFFloat key field, similar to getKey().
        Returns:
        value of key field
      • setKey

        public EaseInEaseOutObject setKey​(float[] newValue)
        Accessor method to assign Float array to inputOutput MFFloat field named key.

        Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to easeInEaseOut array.
        • Hint: number of keys must be one more than the number of easeInEaseOut values!
        • Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value.
        • Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
        Specified by:
        setKey in interface EaseInEaseOut
        Parameters:
        newValue - is new value for the key field.
        Returns:
        EaseInEaseOutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setKey

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

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

        public EaseInEaseOutObject clearKey()
        Utility method to clear MFFloat value of key field.
        Returns:
        EaseInEaseOutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setKey

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

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

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

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

        public EaseInEaseOutObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        EaseInEaseOutObject - 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
      • getModifiedFraction

        public float getModifiedFraction()
        Provide float value from outputOnly SFFloat field named modifiedFraction_changed.

        Tooltip: Interpolated output value determined by current key time, corresponding easeInEaseOut smoothing intervals, and corresponding key pair.
        • 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:
        getModifiedFraction in interface EaseInEaseOut
        Returns:
        value of modifiedFraction_changed field
      • setDEF

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

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

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

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

        public java.lang.String getUSE()
        Provide String value from inputOutput SFString field named USE.

        Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
        • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
        • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
        • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
        Overrides:
        getUSE in class X3DConcreteNode
        Returns:
        value of USE field
        See Also:
        X3D Scene Authoring Hints: Naming Conventions
      • setUSE

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

        Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
        • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
        • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
        • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


        Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

        Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

        Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
        Specified by:
        setUSE in class X3DConcreteNode
        Parameters:
        newValue - is new value for the USE field.
        Returns:
        EaseInEaseOutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

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

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

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

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