ValueAnimator

public class ValueAnimator
extends Animator

java.lang.Object
   ↳ androidx.core.animation.Animator
     ↳ androidx.core.animation.ValueAnimator


This class provides a simple timing engine for running animations which calculate animated values and set them on target objects.

There is a single timing pulse that all animations use. It runs in a custom handler to ensure that property changes happen on the UI thread.

By default, ValueAnimator uses non-linear time interpolation, via the AccelerateDecelerateInterpolator class, which accelerates into and decelerates out of an animation. This behavior can be changed by calling setInterpolator(Interpolator).

Animators can be created from either code or resource files. Here is an example of a ValueAnimator resource file:

ValueAnimator also supports the use of a combination of PropertyValuesHolder and Keyframe resource tags to create a multi-step animation. Note that you can specify explicit fractional values (from 0 to 1) for each keyframe to determine when, in the overall duration, the animation should arrive at that value. Alternatively, you can leave the fractions off and the keyframes will be equally distributed within the total duration:

Developer Guides

For more information about animating with ValueAnimator, read the Property Animation developer guide.

Summary

Constants

int INFINITE

This value used used with the setRepeatCount(int) property to repeat the animation indefinitely.

int RESTART

When the animation reaches the end and repeatCount is INFINITE or a positive value, the animation restarts from the beginning.

int REVERSE

When the animation reaches the end and repeatCount is INFINITE or a positive value, the animation reverses direction on every iteration.

Inherited constants

Public constructors

ValueAnimator()

Creates a new ValueAnimator object.

Public methods

static boolean areAnimatorsEnabled()

Returns whether animators are currently enabled, system-wide.

void cancel()

Cancels the animation.

ValueAnimator clone()
void end()

Ends the animation.

float getAnimatedFraction()

Returns the current animation fraction, which is the elapsed/interpolated fraction used in the most recent frame update on the animation.

Object getAnimatedValue()

The most recent value calculated by this ValueAnimator when there is just one property being animated.

Object getAnimatedValue(String propertyName)

The most recent value calculated by this ValueAnimator for propertyName.

long getCurrentPlayTime()

Gets the current position of the animation in time, which is equal to the current time minus the time that the animation started.

long getDuration()

Gets the length of the animation.

static long getFrameDelay()

The amount of time, in milliseconds, between each frame of the animation.

Interpolator getInterpolator()

Returns the timing interpolator that this ValueAnimator uses.

String getNameForTrace()

Returns the name of this animator for debugging purposes.

int getRepeatCount()

Defines how many times the animation should repeat.

int getRepeatMode()

Defines what this animation should do when it reaches the end.

long getStartDelay()

The amount of time, in milliseconds, to delay starting the animation after start() is called.

long getTotalDuration()

Gets the total duration of the animation, accounting for animation sequences, start delay, and repeating.

PropertyValuesHolder[] getValues()

Returns the values that this ValueAnimator animates between.

boolean isRunning()

Returns whether this Animator is currently running (having been started and gone past any initial startDelay period and not yet ended).

boolean isStarted()

Returns whether this Animator has been started and not yet ended.

static ValueAnimator ofArgb(int... values)

Constructs and returns a ValueAnimator that animates between color values.

static ValueAnimator ofFloat(float... values)

Constructs and returns a ValueAnimator that animates between float values.

static ValueAnimator ofInt(int... values)

Constructs and returns a ValueAnimator that animates between int values.

static ValueAnimator ofObject(TypeEvaluator evaluator, Object... values)

Constructs and returns a ValueAnimator that animates between Object values.

static ValueAnimator ofPropertyValuesHolder(PropertyValuesHolder... values)

Constructs and returns