androidx.core.animation

---

Kotlin |Java

Interfaces

Animator.AnimatorListener	An animation listener receives notifications from an animation.
Animator.AnimatorPauseListener	A pause listener receives notifications from an animation when the animation is paused or resumed.
Animator.AnimatorUpdateListener	Implementors of this interface can add themselves as update listeners to an ValueAnimator instance to receive callbacks on every animation frame, after the current frame's values have been calculated for that ValueAnimator.
Interpolator	An interpolator defines the rate of change of an animation.
TimeAnimator.TimeListener	Implementors of this interface can set themselves as update listeners to a TimeAnimator instance to receive callbacks on every animation frame to receive the total time since the animator started and the delta time since the last frame.
TypeEvaluator	Interface for use with the setEvaluator function.

Classes

AccelerateDecelerateInterpolator	An interpolator where the rate of change starts and ends slowly but accelerates through the middle.
AccelerateInterpolator	An interpolator where the rate of change starts out slowly and then accelerates.
Animator	This is the superclass for classes which provide basic support for animations which can be started, ended, and have AnimatorListeners added to them.
AnimatorInflater	This class is used to instantiate animator XML files into Animator objects.
AnimatorListenerAdapter	This adapter class provides empty implementations of the methods from Animator.AnimatorListener.
AnimatorSet	This class plays a set of Animator objects in the specified order.
AnimatorSet.Builder	The Builder object is a utility class to facilitate adding animations to a AnimatorSet along with the relationships between the various animations.
AnimatorTestRule	JUnit TestRule that can be used to run Animators without actually waiting for the duration of the animation.
AnticipateInterpolator	An interpolator where the change starts backward then flings forward.
AnticipateOvershootInterpolator	An interpolator where the change starts backward then flings forward and overshoots the target value and finally goes back to the final value.
ArgbEvaluator	This evaluator can be used to perform type interpolation between integer values that represent ARGB colors.
BidirectionalTypeConverter	Abstract base class used convert type T to another type V and back again.
BounceInterpolator	An interpolator where the change bounces at the end.
CycleInterpolator	Repeats the animation for a specified number of cycles.
DecelerateInterpolator	An interpolator where the rate of change starts out quickly and then decelerates.
FloatArrayEvaluator	This evaluator can be used to perform type interpolation between float[] values.
FloatEvaluator	This evaluator can be used to perform type interpolation between float values.
FloatProperty	An implementation of android.util.Property to be used specifically with fields of type float.
IntArrayEvaluator	This evaluator can be used to perform type interpolation between int[] values.
IntEvaluator	This evaluator can be used to perform type interpolation between int values.
IntProperty	An implementation of android.util.Property to be used specifically with fields of type int.
Keyframe	This class holds a time/value pair for an animation.
LinearInterpolator	An interpolator where the rate of change is constant
ObjectAnimator	This subclass of ValueAnimator provides support for animating properties on target objects.
OvershootInterpolator	An interpolator where the change flings forward and overshoots the last value then comes back.
PathInterpolator	An interpolator that can traverse a Path that extends from Point(0, 0) to (1, 1).
PointFEvaluator	This evaluator can be used to perform type interpolation between PointF values.
PropertyValuesHolder	This class holds information about a property and the values that that property should take on during an animation.
RectEvaluator	This evaluator can be used to perform type interpolation between Rect values.
TimeAnimator	This class provides a simple callback mechanism to listeners that is synchronized with all other animators in the system.
TypeConverter	Abstract base class used convert type T to another type V.
ValueAnimator	This class provides a simple timing engine for running animations which calculate animated values and set them on target objects.

Extension functions summary

inline Animator.AnimatorListener	Animator.addListener(     crossinline onEnd: (animator: Animator) -> Unit,     crossinline onStart: (animator: Animator) -> Unit,     crossinline onCancel: (animator: Animator) -> Unit,     crossinline onRepeat: (animator: Animator) -> Unit ) Add a listener to this Animator using the provided actions.
Animator.AnimatorPauseListener	Animator.addPauseListener(     onResume: (animator: Animator) -> Unit,     onPause: (animator: Animator) -> Unit ) Add a pause and resume listener to this Animator using the provided actions.
inline Animator.AnimatorListener	Animator.doOnCancel(crossinline action: (animator: Animator) -> Unit) Add an action which will be invoked when the animation has been cancelled.
inline Animator.AnimatorListener	Animator.doOnEnd(crossinline action: (animator: Animator) -> Unit) Add an action which will be invoked when the animation has ended.
Animator.AnimatorPauseListener	Animator.doOnPause(action: (animator: Animator) -> Unit) Add an action which will be invoked when the animation has been paused.
inline Animator.AnimatorListener	Animator.doOnRepeat(crossinline action: (animator: Animator) -> Unit) Add an action which will be invoked when the animation has repeated.
Animator.AnimatorPauseListener	Animator.doOnResume(action: (animator: Animator) -> Unit) Add an action which will be invoked when the animation has resumed after a pause.
inline Animator.AnimatorListener	Animator.doOnStart(crossinline action: (animator: Animator) -> Unit) Add an action which will be invoked when the animation has started.

Extension functions

addListener

Artifact: androidx.core:core-ktx

View Source

Added in 1.1.0

inline fun Animator.addListener(
    crossinline onEnd: (animator: Animator) -> Unit = {},
    crossinline onStart: (animator: Animator) -> Unit = {},
    crossinline onCancel: (animator: Animator) -> Unit = {},
    crossinline onRepeat: (animator: Animator) -> Unit = {}
): Animator.AnimatorListener

Add a listener to this Animator using the provided actions.

Returns
Animator.AnimatorListener	the Animator.AnimatorListener added to the Animator

addPauseListener

Artifact: androidx.core:core-ktx

View Source

Added in 1.1.0

fun Animator.addPauseListener(
    onResume: (animator: Animator) -> Unit = {},
    onPause: (animator: Animator) -> Unit = {}
): Animator.AnimatorPauseListener

Add a pause and resume listener to this Animator using the provided actions.

Returns
Animator.AnimatorPauseListener	the Animator.AnimatorPauseListener added to the Animator

doOnCancel

Artifact: androidx.core:core-ktx

View Source

Added in 1.1.0

inline fun Animator.doOnCancel(crossinline action: (animator: Animator) -> Unit): Animator.AnimatorListener

Add an action which will be invoked when the animation has been cancelled.

Returns
Animator.AnimatorListener	the Animator.AnimatorListener added to the Animator

See also
cancel

doOnEnd

Artifact: androidx.core:core-ktx

View Source

Added in 1.1.0

inline fun Animator.doOnEnd(crossinline action: (animator: Animator) -> Unit): Animator.AnimatorListener

Add an action which will be invoked when the animation has ended.

Returns
Animator.AnimatorListener	the Animator.AnimatorListener added to the Animator

See also
end

doOnPause

Artifact: androidx.core:core-ktx

View Source

Added in 1.1.0

fun Animator.doOnPause(action: (animator: Animator) -> Unit): Animator.AnimatorPauseListener

Add an action which will be invoked when the animation has been paused.

Returns
Animator.AnimatorPauseListener	the Animator.AnimatorPauseListener added to the Animator

See also
pause

doOnRepeat

Artifact: androidx.core:core-ktx

View Source

Added in 1.1.0

inline fun Animator.doOnRepeat(crossinline action: (animator: Animator) -> Unit): Animator.AnimatorListener

Add an action which will be invoked when the animation has repeated.

Returns
Animator.AnimatorListener	the Animator.AnimatorListener added to the Animator

doOnResume

Artifact: androidx.core:core-ktx

View Source

Added in 1.1.0

fun Animator.doOnResume(action: (animator: Animator) -> Unit): Animator.AnimatorPauseListener

Add an action which will be invoked when the animation has resumed after a pause.

Returns
Animator.AnimatorPauseListener	the Animator.AnimatorPauseListener added to the Animator

See also
resume

doOnStart

Artifact: androidx.core:core-ktx

View Source

Added in 1.1.0

inline fun Animator.doOnStart(crossinline action: (animator: Animator) -> Unit): Animator.AnimatorListener

Add an action which will be invoked when the animation has started.

Returns
Animator.AnimatorListener	the Animator.AnimatorListener added to the Animator

See also
start