All Superinterfaces:: X3DChildNode, X3DInterpolatorNode, X3DNode

All Known Implementing Classes:: SplineScalarInterpolator

public interface SplineScalarInterpolator extends X3DInterpolatorNode

SplineScalarInterpolator performs non-linear interpolation among paired lists of float values and velocities to produce an SFFloat value_changed output event.

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. X3D node tooltip: (X3D version 3.2 or later) [X3DInterpolatorNode] SplineScalarInterpolator performs non-linear interpolation among paired lists of float values and velocities to produce an SFFloat value_changed output event. Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute. Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='4'/> *

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

boolean

getClosed()

Provide boolean value from inputOutput SFBool field named closed.

float[]

getKey()

Provide array of float results from inputOutput MFFloat field named key.

float[]

getKeyValue()

Provide array of float results from inputOutput MFFloat field named keyValue.

float[]

getKeyVelocity()

Provide array of float results from inputOutput MFFloat field named keyVelocity.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

boolean

getNormalizeVelocity()

Provide boolean value from inputOutput SFBool field named normalizeVelocity.

float

getValue()

Provide float value from outputOnly SFFloat field named value_changed.

SplineScalarInterpolator

setClosed(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named closed.

SplineScalarInterpolator

setKey(float[] newValue)

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

SplineScalarInterpolator

setKeyValue(float[] newValue)

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

SplineScalarInterpolator

setKeyVelocity(float[] newValue)

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

SplineScalarInterpolator

setMetadata(X3DMetadataObject newValue)

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

SplineScalarInterpolator

setNormalizeVelocity(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named normalizeVelocity.

Method Details
- getClosed
  
  boolean getClosed()
  
  Provide boolean value from inputOutput SFBool field named closed.
  
  Tooltip: Whether or not the curve is closed (i.e. matching end values), with continuous velocity vectors as the interpolator transitions from the last key to the first key. Warning: if velocity vectors at first and last keys are specified, the closed field is ignored. Warning: if keyValues at first and last key are not identical, the closed field is ignored. *
  
  Returns:
  
  value of closed field
- setClosed
  
  SplineScalarInterpolator setClosed(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named closed.
  
  Tooltip: Whether or not the curve is closed (i.e. matching end values), with continuous velocity vectors as the interpolator transitions from the last key to the first key. Warning: if velocity vectors at first and last keys are specified, the closed field is ignored. Warning: if keyValues at first and last key are not identical, the closed field is ignored. *
  
  Parameters:
  
  newValue - is new value for the closed field.
  
  Returns:
  
  SplineScalarInterpolator - 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 parameters for nonlinear-interpolation function time intervals, listed in non-decreasing order and corresponding to keyValue, keyVelocity array values. Warning: number of keys must match number of keyValues! 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 X3DInterpolatorNode
  
  Returns:
  
  value of key field
- setKey
  
  SplineScalarInterpolator setKey(float[] newValue)
  
  Accessor method to assign float array to inputOutput MFFloat field named key.
  
  Tooltip: Definition parameters for nonlinear-interpolation function time intervals, listed in non-decreasing order and corresponding to keyValue, keyVelocity array values. Warning: number of keys must match number of keyValues! 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 X3DInterpolatorNode
  
  Parameters:
  
  newValue - is new value for the key field.
  
  Returns:
  
  SplineScalarInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getKeyValue
  
  float[] getKeyValue()
  
  Provide array of float results from inputOutput MFFloat field named keyValue.
  
  Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array. Warning: number of keys must match number of keyValues!. *
  
  Returns:
  
  value of keyValue field
- setKeyValue
  
  SplineScalarInterpolator setKeyValue(float[] newValue)
  
  Accessor method to assign float array to inputOutput MFFloat field named keyValue.
  
  Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array. Warning: number of keys must match number of keyValues!. *
  
  Parameters:
  
  newValue - is new value for the keyValue field.
  
  Returns:
  
  SplineScalarInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getKeyVelocity
  
  float[] getKeyVelocity()
  
  Provide array of float results from inputOutput MFFloat field named keyVelocity.
  
  Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array. Warning: number of keys must match number of keyVelocity values!. *
  
  Returns:
  
  value of keyVelocity field
- setKeyVelocity
  
  SplineScalarInterpolator setKeyVelocity(float[] newValue)
  
  Accessor method to assign float array to inputOutput MFFloat field named keyVelocity.
  
  Tooltip: Output values for nonlinear interpolation, each corresponding to an input-fraction value in the key array. Warning: number of keys must match number of keyVelocity values!. *
  
  Parameters:
  
  newValue - is new value for the keyVelocity field.
  
  Returns:
  
  SplineScalarInterpolator - 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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DInterpolatorNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  SplineScalarInterpolator 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 <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DInterpolatorNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  SplineScalarInterpolator - 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
- getNormalizeVelocity
  
  boolean getNormalizeVelocity()
  
  Provide boolean value from inputOutput SFBool field named normalizeVelocity.
  
  Tooltip: normalizeVelocity field specifies whether the velocity vectors are normalized to produce smooth speed transitions, or transformed into tangency vectors. Hint: X3D 19.2.3 Non-linear interpolation <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/interpolators.html#NonlinearInterpolation" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/interpolators.html#NonlinearInterpolation</a> *
  
  Returns:
  
  value of normalizeVelocity field
- setNormalizeVelocity
  
  SplineScalarInterpolator setNormalizeVelocity(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named normalizeVelocity.
  
  Tooltip: normalizeVelocity field specifies whether the velocity vectors are normalized to produce smooth speed transitions, or transformed into tangency vectors. Hint: X3D 19.2.3 Non-linear interpolation <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/interpolators.html#NonlinearInterpolation" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/interpolators.html#NonlinearInterpolation</a> *
  
  Parameters:
  
  newValue - is new value for the normalizeVelocity field.
  
  Returns:
  
  SplineScalarInterpolator - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getValue
  
  float getValue()
  
  Provide float value from outputOnly SFFloat field named value_changed.
  
  Tooltip: Nonlinearly interpolated output value computed by using current time fraction along with corresponding key, keyValue and keyVelocity values. 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 value_changed field

Interface SplineScalarInterpolator

Method Summary

Method Details

getClosed

setClosed

getKey

setKey

getKeyValue

setKeyValue

getKeyVelocity

setKeyVelocity

getMetadata

setMetadata

getNormalizeVelocity

setNormalizeVelocity

getValue