All Superinterfaces:: X3DChildNode, X3DNode

All Known Implementing Classes:: EaseInEaseOut

public interface EaseInEaseOut extends X3DChildNode

EaseInEaseOut enables gradual animation transitions by modifying TimeSensor fraction outputs.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. EaseInEaseOut 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:

Method Summary

Modifier and Type

Method

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 org.web3d.x3d.sai.Core.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

setEaseInEaseOut(float[] newValue)

Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named easeInEaseOut.

EaseInEaseOut

setKey(float[] newValue)

Accessor method to assign float array to inputOutput MFFloat field named key.

EaseInEaseOut

setMetadata(X3DMetadataObject newValue)

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

Method Details
- 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)
  
  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.
  
  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)
  
  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.
  
  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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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, instead only use it a source for ROUTE events.
  
  Returns:
  
  value of modifiedFraction_changed field

Interface EaseInEaseOut

Method Summary

Method Details

getEaseInEaseOut

setEaseInEaseOut

getKey

setKey

getMetadata

setMetadata

getModifiedFraction