JavaFX 24 · com.sun.scenario.animation.SplineInterpolator

Field Summary

Modifier and Type	Field and Description
private final boolean	isCurveLinear Do the input control points form a line with (0,0) and (1,1), i.e., x1 == y1 and x2 == y2 -- if so, then all x(t) == y(t) for the curve.
private static final double	SAMPLE_INCREMENT Difference in t used to calculate each of the xSamples values -- power of 2 sample size should provide exact representation of this value and its integer multiples (integer in range of [0..SAMPLE_SIZE].
private static final int	SAMPLE_SIZE Power of 2 sample size for lookup table of x values.
private final double	x1 The coordinates of the 2 2D control points for a cubic Bezier curve, with implicit start point (0,0) and end point (1,1) -- each individual coordinate value must be in range [0,1].
private final double	x2 The coordinates of the 2 2D control points for a cubic Bezier curve, with implicit start point (0,0) and end point (1,1) -- each individual coordinate value must be in range [0,1].
private final double[]	xSamples X values for the bezier curve, sampled at increments of 1/SAMPLE_SIZE -- this is used to find the good initial guess for parameter t, given an x.
private final double	y1 The coordinates of the 2 2D control points for a cubic Bezier curve, with implicit start point (0,0) and end point (1,1) -- each individual coordinate value must be in range [0,1].
private final double	y2 The coordinates of the 2 2D control points for a cubic Bezier curve, with implicit start point (0,0) and end point (1,1) -- each individual coordinate value must be in range [0,1].

Inherited from javafx.animation.Interpolator:: DISCRETE EASE_BOTH EASE_IN EASE_OUT LINEAR STEP_END STEP_START

Constructor Summary

Access	Constructor and Description
public	SplineInterpolator(double X coordinate of first control point, in range [0,1] px1, double Y coordinate of first control point, in range [0,1] py1, double X coordinate of second control point, in range [0,1] px2, double Y coordinate of second control point, in range [0,1] py2) Creates a new instance with control points (0,0) (px1,py1) (px2,py2) (1,1) -- px1, py1, px2, py2 all in range [0,1].

Method Summary

Modifier and Type	Method and Description
public double	Returns: corresponding y-value of cubic bezier curve -- in range [0,1] curve(double is x-value of cubic bezier curve, in range [0,1] x) Implements abstract javafx.animation.Interpolator.curve. Returns the y-value of the cubic bezier curve that corresponds to the x input.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
private double	Returns: the value of the Bezier curve at parameter t eval(double is the paramaterized value in range [0,1] t, double is 1st control point coordinate in range [0,1] p1, double is 2nd control point coordinate in range [0,1] p2) Use Bernstein basis to evaluate 1D cubic Bezier curve (quicker and more numerically stable than power basis) -- 1D control coordinates are (0, p1, p2, 1), where p1 and p2 are in range [0,1], and there is no ordering constraint on p1 and p2, i.e., p1 <= p2 does not have to be true.
private double	Returns: the value of the Bezier curve at parameter t evalDerivative(double is the paramaterized value in range [0,1] t, double is 1st control point coordinate in range [0,1] p1, double is 2nd control point coordinate in range [0,1] p2) Evaluates Bernstein basis derivative of 1D cubic Bezier curve, where 1D control points are (0, p1, p2, 1), where p1 and p2 are in range [0,1], and there is no ordering constraint on p1 and p2, i.e., p1 <= p2 does not have to be true.
private double	Returns: the parameter t (in range [0,1]) that produces x findTForX(double is x-value of cubic bezier curve, in range [0,1] x) Finds the parameter t that produces the given x-value for the curve -- uses Newton-Raphson to refine the value as opposed to subdividing until we are within some tolerance.
private double	Returns: a good initial guess for parameter t (in range [0,1]) that gives x getInitialGuessForT(double is x-value of cubic bezier curve, in range [0,1] x) Find an initial good guess for what parameter t might produce the x-value on the Bezier curve -- uses linear interpolation on the x-value sample array that was created on construction.
public double	getX1()
public double	getX2()
public double	getY1()
public double	getY2()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from javafx.animation.Interpolator:: interpolate interpolate interpolate interpolate interpolate SPLINE STEPS TANGENT TANGENT

Field Detail

isCurveLinear	back to summary
private final boolean isCurveLinear Do the input control points form a line with (0,0) and (1,1), i.e., x1 == y1 and x2 == y2 -- if so, then all x(t) == y(t) for the curve.

SAMPLE_INCREMENT	back to summary
private static final double SAMPLE_INCREMENT Difference in t used to calculate each of the xSamples values -- power of 2 sample size should provide exact representation of this value and its integer multiples (integer in range of [0..SAMPLE_SIZE].

SAMPLE_SIZE	back to summary
private static final int SAMPLE_SIZE Power of 2 sample size for lookup table of x values.

x1	back to summary
private final double x1 The coordinates of the 2 2D control points for a cubic Bezier curve, with implicit start point (0,0) and end point (1,1) -- each individual coordinate value must be in range [0,1].

x2	back to summary
private final double x2 The coordinates of the 2 2D control points for a cubic Bezier curve, with implicit start point (0,0) and end point (1,1) -- each individual coordinate value must be in range [0,1].

xSamples	back to summary
private final double[] xSamples X values for the bezier curve, sampled at increments of 1/SAMPLE_SIZE -- this is used to find the good initial guess for parameter t, given an x.

y1	back to summary
private final double y1 The coordinates of the 2 2D control points for a cubic Bezier curve, with implicit start point (0,0) and end point (1,1) -- each individual coordinate value must be in range [0,1].

y2	back to summary
private final double y2 The coordinates of the 2 2D control points for a cubic Bezier curve, with implicit start point (0,0) and end point (1,1) -- each individual coordinate value must be in range [0,1].

Constructor Detail

SplineInterpolator	back to summary
public SplineInterpolator(double px1, double py1, double px2, double py2) Creates a new instance with control points (0,0) (px1,py1) (px2,py2) (1,1) -- px1, py1, px2, py2 all in range [0,1]. Parameters px1:double X coordinate of first control point, in range [0,1] py1:double Y coordinate of first control point, in range [0,1] px2:double X coordinate of second control point, in range [0,1] py2:double Y coordinate of second control point, in range [0,1]

SplineInterpolator

back to summary

public SplineInterpolator(double px1, double py1, double px2, double py2)

Creates a new instance with control points (0,0) (px1,py1) (px2,py2) (1,1) -- px1, py1, px2, py2 all in range [0,1].

Parameters

px1:double: X coordinate of first control point, in range [0,1]
py1:double: Y coordinate of first control point, in range [0,1]
px2:double: X coordinate of second control point, in range [0,1]
py2:double: Y coordinate of second control point, in range [0,1]

Method Detail

curve	back to summary
public double curve(double x) Implements abstract javafx.animation.Interpolator.curve. Returns the y-value of the cubic bezier curve that corresponds to the x input. Parameters x:double is x-value of cubic bezier curve, in range [0,1] Returns:double corresponding y-value of cubic bezier curve -- in range [0,1] Annotations @Override

curve

back to summary

public double curve(double x)

Implements abstract javafx.animation.Interpolator.curve.

Returns the y-value of the cubic bezier curve that corresponds to the x input.

Parameters

x:double: is x-value of cubic bezier curve, in range [0,1]

Returns:double

corresponding y-value of cubic bezier curve -- in range [0,1]

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

eval	back to summary
private double eval(double t, double p1, double p2) Use Bernstein basis to evaluate 1D cubic Bezier curve (quicker and more numerically stable than power basis) -- 1D control coordinates are (0, p1, p2, 1), where p1 and p2 are in range [0,1], and there is no ordering constraint on p1 and p2, i.e., p1 <= p2 does not have to be true. Parameters t:double is the paramaterized value in range [0,1] p1:double is 1st control point coordinate in range [0,1] p2:double is 2nd control point coordinate in range [0,1] Returns:double the value of the Bezier curve at parameter t

eval

back to summary

private double eval(double t, double p1, double p2)

Use Bernstein basis to evaluate 1D cubic Bezier curve (quicker and more numerically stable than power basis) -- 1D control coordinates are (0, p1, p2, 1), where p1 and p2 are in range [0,1], and there is no ordering constraint on p1 and p2, i.e., p1 <= p2 does not have to be true.

Parameters

t:double: is the paramaterized value in range [0,1]
p1:double: is 1st control point coordinate in range [0,1]
p2:double: is 2nd control point coordinate in range [0,1]

Returns:double

the value of the Bezier curve at parameter t

evalDerivative	back to summary
private double evalDerivative(double t, double p1, double p2) Evaluates Bernstein basis derivative of 1D cubic Bezier curve, where 1D control points are (0, p1, p2, 1), where p1 and p2 are in range [0,1], and there is no ordering constraint on p1 and p2, i.e., p1 <= p2 does not have to be true. Parameters t:double is the paramaterized value in range [0,1] p1:double is 1st control point coordinate in range [0,1] p2:double is 2nd control point coordinate in range [0,1] Returns:double the value of the Bezier curve at parameter t

evalDerivative

back to summary

private double evalDerivative(double t, double p1, double p2)

Evaluates Bernstein basis derivative of 1D cubic Bezier curve, where 1D control points are (0, p1, p2, 1), where p1 and p2 are in range [0,1], and there is no ordering constraint on p1 and p2, i.e., p1 <= p2 does not have to be true.

Parameters

t:double: is the paramaterized value in range [0,1]
p1:double: is 1st control point coordinate in range [0,1]
p2:double: is 2nd control point coordinate in range [0,1]

Returns:double

the value of the Bezier curve at parameter t

findTForX	back to summary
private double findTForX(double x) Finds the parameter t that produces the given x-value for the curve -- uses Newton-Raphson to refine the value as opposed to subdividing until we are within some tolerance. Parameters x:double is x-value of cubic bezier curve, in range [0,1] Returns:double the parameter t (in range [0,1]) that produces x

findTForX

back to summary

private double findTForX(double x)

Finds the parameter t that produces the given x-value for the curve -- uses Newton-Raphson to refine the value as opposed to subdividing until we are within some tolerance.

Parameters

x:double: is x-value of cubic bezier curve, in range [0,1]

Returns:double

the parameter t (in range [0,1]) that produces x

getInitialGuessForT	back to summary
private double getInitialGuessForT(double x) Find an initial good guess for what parameter t might produce the x-value on the Bezier curve -- uses linear interpolation on the x-value sample array that was created on construction. Parameters x:double is x-value of cubic bezier curve, in range [0,1] Returns:double a good initial guess for parameter t (in range [0,1]) that gives x

getInitialGuessForT

back to summary

private double getInitialGuessForT(double x)

Find an initial good guess for what parameter t might produce the x-value on the Bezier curve -- uses linear interpolation on the x-value sample array that was created on construction.

Parameters

x:double: is x-value of cubic bezier curve, in range [0,1]

Returns:double

a good initial guess for parameter t (in range [0,1]) that gives x

getX1	back to summary
public double getX1()

getX2	back to summary
public double getX2()

getY1	back to summary
public double getY1()

getY2	back to summary
public double getY2()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class SplineInterpolator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail