PathInterpolatorCompat

Added in 1.1.0

public final class PathInterpolatorCompat

Helper for creating path-based Interpolator instances. On API 21 or newer, the platform implementation will be used and on older platforms a compatible alternative implementation will be used.

Summary

Public methods
static @NonNull Interpolator

Create an Interpolator for an arbitrary Path.
static @NonNull Interpolator
create(float controlX, float controlY)

Create an Interpolator for a quadratic Bezier curve.
static @NonNull Interpolator
create(
    float controlX1,
    float controlY1,
    float controlX2,
    float controlY2
)

Create an Interpolator for a cubic Bezier curve.

Public methods

create

Added in 1.1.0
public static @NonNull Interpolator create(@NonNull Path path)

Create an Interpolator for an arbitrary Path. The Path must begin at (0, 0) and end at (1, 1). The x-coordinate along the Path is the input value and the output is the y coordinate of the line at that point. This means that the Path must conform to a function y = f(x).

The Path must not have gaps in the x direction and must not loop back on itself such that there can be two points sharing the same x coordinate.
Parameters
@NonNull Path path

the Path to use to make the line representing the Interpolator
Returns
@NonNull Interpolator

the Interpolator representing the Path

create

Added in 1.1.0
public static @NonNull Interpolator create(float controlX, float controlY)

Create an Interpolator for a quadratic Bezier curve. The end points (0, 0) and (1, 1) are assumed.

Parameters
float controlX

the x coordinate of the quadratic Bezier control point
float controlY

the y coordinate of the quadratic Bezier control point
Returns
@NonNull Interpolator

the Interpolator representing the quadratic Bezier curve

create

Added in 1.1.0
public static @NonNull Interpolator create(
    float controlX1,
    float controlY1,
    float controlX2,
    float controlY2
)

Create an Interpolator for a cubic Bezier curve. The end points (0, 0) and (1, 1) are assumed.

Parameters
float controlX1

the x coordinate of the first control point of the cubic Bezier
float controlY1

the y coordinate of the first control point of the cubic Bezier
float controlX2

the x coordinate of the second control point of the cubic Bezier
float controlY2

the y coordinate of the second control point of the cubic Bezier
Returns
@NonNull Interpolator

the Interpolator representing the cubic Bezier curve