JavaFX 21.0.2 · javafx.animation.Interpolator · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final Interpolator	DISCRETE Built-in interpolator that provides discrete time interpolation.
public static final Interpolator	EASE_BOTH Built-in interpolator instance that provides ease in/out behavior.
public static final Interpolator	EASE_IN Built-in interpolator instance that provides ease in behavior.
public static final Interpolator	EASE_OUT Built-in interpolator instance that provides ease out behavior.
private static final double	EPSILON
public static final Interpolator	LINEAR Built-in interpolator that provides linear time interpolation.

Access	Constructor and Description
protected	Interpolator() The constructor of `Interpolator`.

Method Summary

Modifier and Type	Method and Description
private static double	clamp(double t)
protected abstract double	Returns: the curved value curve(double time, but normalized to the range [0.0..1.0], where 0.0 is the start of the current interval, while 1.0 is the end of the current interval. Usually a function that increases monotonically. t) Mapping from [0.0..1.0] to itself.
public Object	Returns: interpolated value interpolate(Object start value startValue, Object end value endValue, double a value between 0.0 and 1.0 fraction) This method takes two `Objects` along with a `fraction` between `0.0` and `1.0` and returns the interpolated value.
public boolean	Returns: the interpolated value interpolate(boolean the first data point startValue, boolean the second data point endValue, double the fraction in `[0.0...1.0]` fraction) This method takes two `boolean` values along with a `fraction` between `0.0` and `1.0` and returns the interpolated value.
public double	Returns: the interpolated value interpolate(double the first data point startValue, double the second data point endValue, double the fraction in `[0.0...1.0]` fraction) This method takes two `double` values along with a `fraction` between `0.0` and `1.0` and returns the interpolated value.
public int	Returns: the interpolated value interpolate(int the first data point startValue, int the second data point endValue, double the fraction in `[0.0...1.0]` fraction) This method takes two `int` values along with a `fraction` between `0.0` and `1.0` and returns the interpolated value.
public long	Returns: the interpolated value interpolate(long the first data point startValue, long the second data point endValue, double the fraction in `[0.0...1.0]` fraction) This method takes two `int` values along with a `fraction` between `0.0` and `1.0` and returns the interpolated value.
public static Interpolator	Returns: A spline interpolator SPLINE(double x coordinate of the first control point x1, double y coordinate of the first control point y1, double x coordinate of the second control point x2, double y coordinate of the second control point y2) Creates an `Interpolator`, which `curve()` is shaped using the spline control points defined by (`x1`, `y1` ) and (`x2`, `y2`).
public static Interpolator	Returns: the new tangent interpolator TANGENT(Duration The delta time of the in-tangent, relative to the KeyFrame t1, double The value of the in-tangent v1, Duration The delta time of the out-tangent, relative to the KeyFrame t2, double The value of the out-tangent v2) Create a tangent interpolator.
public static Interpolator	Returns: the new Tangent interpolator TANGENT(Duration The delta time of the tangent t, double The value of the tangent v) Creates a tangent interpolator, for which in-tangent and out-tangent are identical.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DISCRETE	back to summary
public static final Interpolator DISCRETE Built-in interpolator that provides discrete time interpolation. The return value of `interpolate()` is `endValue` only when the input `fraction` is 1.0, and `startValue` otherwise.

EASE_BOTH	back to summary
public static final Interpolator EASE_BOTH Built-in interpolator instance that provides ease in/out behavior. An ease-both interpolator will make an animation start slow, then accelerate and slow down again towards the end, all in a smooth manner. The implementation uses the algorithm for easing defined in SMIL 3.0 with an acceleration and deceleration factor of 0.2, respectively.

EASE_BOTH

back to summary

public static final Interpolator EASE_BOTH

Built-in interpolator instance that provides ease in/out behavior.

An ease-both interpolator will make an animation start slow, then accelerate and slow down again towards the end, all in a smooth manner.

The implementation uses the algorithm for easing defined in SMIL 3.0 with an acceleration and deceleration factor of 0.2, respectively.

EASE_IN	back to summary
public static final Interpolator EASE_IN Built-in interpolator instance that provides ease in behavior. An ease-in interpolator will make an animation start slow and then accelerate smoothly. The implementation uses the algorithm for easing defined in SMIL 3.0 with an acceleration factor of 0.2.

EASE_IN

back to summary

public static final Interpolator EASE_IN

Built-in interpolator instance that provides ease in behavior.

An ease-in interpolator will make an animation start slow and then accelerate smoothly.

The implementation uses the algorithm for easing defined in SMIL 3.0 with an acceleration factor of 0.2.

EASE_OUT	back to summary
public static final Interpolator EASE_OUT Built-in interpolator instance that provides ease out behavior. An ease-out interpolator will make an animation slow down toward the end smoothly. The implementation uses the algorithm for easing defined in SMIL 3.0 with an deceleration factor of 0.2.

EASE_OUT

back to summary

public static final Interpolator EASE_OUT

Built-in interpolator instance that provides ease out behavior.

An ease-out interpolator will make an animation slow down toward the end smoothly.

The implementation uses the algorithm for easing defined in SMIL 3.0 with an deceleration factor of 0.2.

EPSILON	back to summary
private static final double EPSILON

LINEAR	back to summary
public static final Interpolator LINEAR Built-in interpolator that provides linear time interpolation. The return value of `interpolate()` is `startValue` + (`endValue` - `startValue`) * `fraction`.

Constructor Detail

Interpolator	back to summary
protected Interpolator() The constructor of `Interpolator`.

Method Detail

clamp	back to summary
private static double clamp(double t)

curve	back to summary
protected abstract double curve(double t) Mapping from [0.0..1.0] to itself. Parameters t:double time, but normalized to the range [0.0..1.0], where 0.0 is the start of the current interval, while 1.0 is the end of the current interval. Usually a function that increases monotonically. Returns:double the curved value

curve

back to summary

protected abstract double curve(double t)

Mapping from [0.0..1.0] to itself.

Parameters

t:double: time, but normalized to the range [0.0..1.0], where 0.0 is the start of the current interval, while 1.0 is the end of the current interval. Usually a function that increases monotonically.

Returns:double

the curved value

interpolate back to summary

interpolate	back to summary
public Object interpolate(Object startValue, Object endValue, double fraction) This method takes two `Objects` along with a `fraction` between `0.0` and `1.0` and returns the interpolated value. If both `Objects` implement `Number`, their values are interpolated. If `startValue` implements `Interpolatable` the calculation defined in `interpolate()` is used. If neither of these conditions are met, a discrete interpolation is used, i.e. `endValue` is returned if and only if `fraction` is `1.0`, otherwise `startValue` is returned. Before calculating the interpolated value, the fraction is altered according to the function defined in `curve()`. Parameters startValue:Object start value endValue:Object end value fraction:double a value between 0.0 and 1.0 Returns:Object interpolated value Annotations @SuppressWarnings:unchecked, rawtypes

public Object interpolate(Object startValue, Object endValue, double fraction)

This method takes two Objects along with a fraction between 0.0 and 1.0 and returns the interpolated value.

If both Objects implement Number, their values are interpolated. If startValue implements Interpolatable the calculation defined in interpolate() is used. If neither of these conditions are met, a discrete interpolation is used, i.e. endValue is returned if and only if fraction is 1.0, otherwise startValue is returned.

Before calculating the interpolated value, the fraction is altered according to the function defined in curve().

Parameters

startValue:Object: start value
endValue:Object: end value
fraction:double: a value between 0.0 and 1.0

Returns:Object

interpolated value

Annotations

@SuppressWarnings:unchecked, rawtypes

interpolate back to summary

interpolate	back to summary
public boolean interpolate(boolean startValue, boolean endValue, double fraction) This method takes two `boolean` values along with a `fraction` between `0.0` and `1.0` and returns the interpolated value. Before calculating the interpolated value, the fraction is altered according to the function defined in `curve()`. Parameters startValue:boolean the first data point endValue:boolean the second data point fraction:double the fraction in `[0.0...1.0]` Returns:boolean the interpolated value

public boolean interpolate(boolean startValue, boolean endValue, double fraction)

This method takes two boolean values along with a fraction between 0.0 and 1.0 and returns the interpolated value.

Before calculating the interpolated value, the fraction is altered according to the function defined in curve().

Parameters

startValue:boolean: the first data point
endValue:boolean: the second data point
fraction:double: the fraction in [0.0...1.0]

Returns:boolean

the interpolated value

interpolate back to summary

interpolate	back to summary
public double interpolate(double startValue, double endValue, double fraction) This method takes two `double` values along with a `fraction` between `0.0` and `1.0` and returns the interpolated value. Before calculating the interpolated value, the fraction is altered according to the function defined in `curve()`. Parameters startValue:double the first data point endValue:double the second data point fraction:double the fraction in `[0.0...1.0]` Returns:double the interpolated value

public double interpolate(double startValue, double endValue, double fraction)

This method takes two double values along with a fraction between 0.0 and 1.0 and returns the interpolated value.

Before calculating the interpolated value, the fraction is altered according to the function defined in curve().

Parameters

startValue:double: the first data point
endValue:double: the second data point
fraction:double: the fraction in [0.0...1.0]

Returns:double

the interpolated value

interpolate back to summary

interpolate	back to summary
public int interpolate(int startValue, int endValue, double fraction) This method takes two `int` values along with a `fraction` between `0.0` and `1.0` and returns the interpolated value. Before calculating the interpolated value, the fraction is altered according to the function defined in `curve()`. Parameters startValue:int the first data point endValue:int the second data point fraction:double the fraction in `[0.0...1.0]` Returns:int the interpolated value

public int interpolate(int startValue, int endValue, double fraction)

This method takes two int values along with a fraction between 0.0 and 1.0 and returns the interpolated value.

Before calculating the interpolated value, the fraction is altered according to the function defined in curve().

Parameters

startValue:int: the first data point
endValue:int: the second data point
fraction:double: the fraction in [0.0...1.0]

Returns:int

the interpolated value

interpolate back to summary

interpolate	back to summary
public long interpolate(long startValue, long endValue, double fraction) This method takes two `int` values along with a `fraction` between `0.0` and `1.0` and returns the interpolated value. Before calculating the interpolated value, the fraction is altered according to the function defined in `curve()`. Parameters startValue:long the first data point endValue:long the second data point fraction:double the fraction in `[0.0...1.0]` Returns:long the interpolated value

public long interpolate(long startValue, long endValue, double fraction)

This method takes two int values along with a fraction between 0.0 and 1.0 and returns the interpolated value.

Before calculating the interpolated value, the fraction is altered according to the function defined in curve().

Parameters

startValue:long: the first data point
endValue:long: the second data point
fraction:double: the fraction in [0.0...1.0]

Returns:long

the interpolated value

SPLINE back to summary

SPLINE	back to summary
public static Interpolator SPLINE(double x1, double y1, double x2, double y2) Creates an `Interpolator`, which `curve()` is shaped using the spline control points defined by (`x1`, `y1` ) and (`x2`, `y2`). The anchor points of the spline are implicitly defined as (`0.0`, `0.0`) and (`1.0`, `1.0`). Parameters x1:double x coordinate of the first control point y1:double y coordinate of the first control point x2:double x coordinate of the second control point y2:double y coordinate of the second control point Returns:Interpolator A spline interpolator

public static Interpolator SPLINE(double x1, double y1, double x2, double y2)

Creates an Interpolator, which curve() is shaped using the spline control points defined by (x1, y1 ) and (x2, y2). The anchor points of the spline are implicitly defined as (0.0, 0.0) and (1.0, 1.0).

Parameters

x1:double: x coordinate of the first control point
y1:double: y coordinate of the first control point
x2:double: x coordinate of the second control point
y2:double: y coordinate of the second control point

Returns:Interpolator

A spline interpolator

TANGENT back to summary

TANGENT	back to summary
public static Interpolator TANGENT(Duration t1, double v1, Duration t2, double v2) Create a tangent interpolator. A tangent interpolator allows to define the behavior of an animation curve very precisely by defining the tangents close to a key frame. A tangent interpolator defines the behavior to the left and to the right of a key frame, therefore it is only useful within a `Timeline`. If used in a `KeyFrame` after a KeyFrame that has different interpolator, it's treated as if the out-tangent of that KeyFrame was equal to the value in the KeyFrame. The parameters define the tangent of the animation curve for the in tangent (before a key frame) and out tangent (after a key frame). Each tangent is specified with a pair, the distance to the key frame and the value of the tangent at this moment. The interpolation then follows a bezier curve, with 2 control points defined by the specified tangent and positioned at 1/3 of the duration before the second KeyFrame or after the first KeyFrame. See the picture above. Parameters t1:Duration The delta time of the in-tangent, relative to the KeyFrame v1:double The value of the in-tangent t2:Duration The delta time of the out-tangent, relative to the KeyFrame v2:double The value of the out-tangent Returns:Interpolator the new tangent interpolator

public static Interpolator TANGENT(Duration t1, double v1, Duration t2, double v2)

Create a tangent interpolator. A tangent interpolator allows to define the behavior of an animation curve very precisely by defining the tangents close to a key frame. A tangent interpolator defines the behavior to the left and to the right of a key frame, therefore it is only useful within a Timeline. If used in a KeyFrame after a KeyFrame that has different interpolator, it's treated as if the out-tangent of that KeyFrame was equal to the value in the KeyFrame.

A tangent interpolator
defines the behavior to the left and to the right of a key frame,
therefore it is only useful within a Timeline

The parameters define the tangent of the animation curve for the in tangent (before a key frame) and out tangent (after a key frame). Each tangent is specified with a pair, the distance to the key frame and the value of the tangent at this moment.

The interpolation then follows a bezier curve, with 2 control points defined by the specified tangent and positioned at 1/3 of the duration before the second KeyFrame or after the first KeyFrame. See the picture above.

Parameters

t1:Duration: The delta time of the in-tangent, relative to the KeyFrame
v1:double: The value of the in-tangent
t2:Duration: The delta time of the out-tangent, relative to the KeyFrame
v2:double: The value of the out-tangent

Returns:Interpolator

the new tangent interpolator

TANGENT back to summary

TANGENT	back to summary
public static Interpolator TANGENT(Duration t, double v) Creates a tangent interpolator, for which in-tangent and out-tangent are identical. This is especially useful for the first and the last key frame of a `Timeline`, because for these key frames only one tangent is used. Parameters t:Duration The delta time of the tangent v:double The value of the tangent Returns:Interpolator the new Tangent interpolator See Also `TANGENT(Duration, double, Duration, double)`

public static Interpolator TANGENT(Duration t, double v)

Creates a tangent interpolator, for which in-tangent and out-tangent are identical. This is especially useful for the first and the last key frame of a Timeline, because for these key frames only one tangent is used.

Parameters

t:Duration: The delta time of the tangent
v:double: The value of the tangent

Returns:Interpolator

the new Tangent interpolator

public abstract Class Interpolator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail