EaseInEaseOut (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode

All Known Implementing Classes:

EaseInEaseOutObject
```
public interface EaseInEaseOut
extends X3DChildNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: EaseInEaseOut, X3D Tooltips: EaseInEaseOut, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`float[]`	`getEaseInEaseOut()` Provide array of 2-tuple float results from inputOutput MFVec2f field named easeInEaseOut.
`float[]`	`getKey()` Provide array of float results from inputOutput MFFloat field named key.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`float`	`getModifiedFraction()` Provide float value from outputOnly SFFloat field named modifiedFraction_changed.
`EaseInEaseOut`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`EaseInEaseOut`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`EaseInEaseOut`	`setEaseInEaseOut(float[] newValue)` Assign 2-tuple float array to inputOutput MFVec2f field named easeInEaseOut.
`EaseInEaseOut`	`setKey(float[] newValue)` Assign float array to inputOutput MFFloat field named key.
`EaseInEaseOut`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`EaseInEaseOut`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getEaseInEaseOut
```
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.
    Returns:
    
    value of easeInEaseOut field
  - setEaseInEaseOut
```
EaseInEaseOut setEaseInEaseOut(float[] newValue)
```
    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.
    
    Parameters:
    
    newValue - is new value for the easeInEaseOut field.
    
    Returns:
    
    EaseInEaseOut - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getKey
```
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.
    Returns:
    
    value of key field
  - setKey
```
EaseInEaseOut setKey(float[] newValue)
```
    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.
    
    Parameters:
    
    newValue - is new value for the key field.
    
    Returns:
    
    EaseInEaseOut - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
EaseInEaseOut setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    EaseInEaseOut - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getModifiedFraction
```
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.
    Returns:
    
    value of modifiedFraction_changed field
  - setDEF
```
EaseInEaseOut setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    EaseInEaseOut - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
EaseInEaseOut setUSE(java.lang.String newValue)
```
    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 interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    EaseInEaseOut - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
EaseInEaseOut setCssClass(java.lang.String newValue)
```
    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 interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    EaseInEaseOut - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface EaseInEaseOut

Method Summary

Method Detail

getEaseInEaseOut

setEaseInEaseOut

getKey

setKey

getMetadata

setMetadata

getModifiedFraction

setDEF

setUSE

setCssClass