CycleInterpolator

public class CycleInterpolator
extends Object implements Interpolator

java.lang.Object
   ↳ androidx.core.animation.CycleInterpolator


Repeats the animation for a specified number of cycles. The rate of change follows a sinusoidal pattern.

Summary

Public constructors

CycleInterpolator(float cycles)

Creates a new instance of CycleInterpolator.

CycleInterpolator(Context context, AttributeSet attrs)

Creates a new instance of CycleInterpolator from XML.

Public methods

float getInterpolation(float input)

Maps a value representing the elapsed fraction of an animation to a value that represents the interpolated fraction.

Inherited methods

Public constructors

CycleInterpolator

public CycleInterpolator (float cycles)

Creates a new instance of CycleInterpolator.

Parameters
cycles float: The cycles to repeat.

CycleInterpolator

public CycleInterpolator (Context context, 
                AttributeSet attrs)

Creates a new instance of CycleInterpolator from XML.

Parameters
context Context: The context.

attrs AttributeSet: The AttributeSet from XML.

Public methods

getInterpolation

public float getInterpolation (float input)

Maps a value representing the elapsed fraction of an animation to a value that represents the interpolated fraction. This interpolated value is then multiplied by the change in value of an animation to derive the animated value at the current elapsed animation time.

Parameters
input float: A value between 0 and 1.0 indicating our current point in the animation where 0 represents the start and 1.0 represents the end

Value is between 0.0 and 1.0 inclusive.

Returns
float The interpolation value. This value can be more than 1.0 for interpolators which overshoot their targets, or less than 0 for interpolators that undershoot their targets.

Value is between 0.0 and 1.0 inclusive.