ValueAnimator

const val INFINITE = -1: Int

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

const val RESTART = 1: Int

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

const val REVERSE = 2: Int

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

ValueAnimator()

Creates a new ValueAnimator object. This default constructor is primarily for use internally; the factory methods which take parameters are more generally useful.

java-static fun areAnimatorsEnabled(): Boolean

Returns whether animators are currently enabled, system-wide. By default, all animators are enabled. This can change if either the user sets a Developer Option to set the animator duration scale to 0 or by Battery Savery mode being enabled (which disables all animations).

Developers should not typically need to call this method, but should an app wish to show a different experience when animators are disabled, this return value can be used as a decider of which experience to offer.

fun cancel(): Unit

Cancels the animation. Unlike end, cancel() causes the animation to stop in its tracks, sending an onAnimationCancel to its listeners, followed by an onAnimationEnd message.

This method must be called on the thread that is running the animation.

fun end(): Unit

Ends the animation. This causes the animation to assign the end value of the property being animated, then calling the onAnimationEnd method on its listeners.

This method must be called on the thread that is running the animation.

fun getAnimatedFraction(): Float

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

fun getAnimatedValue(): Any

The most recent value calculated by this ValueAnimator when there is just one property being animated. This value is only sensible while the animation is running. The main purpose for this read-only property is to retrieve the value from the ValueAnimator during a call to onAnimationUpdate, which is called during each animation frame, immediately after the value is calculated.

fun getAnimatedValue(propertyName: String): Any?

The most recent value calculated by this ValueAnimator for propertyName. The main purpose for this read-only property is to retrieve the value from the ValueAnimator during a call to onAnimationUpdate, which is called during each animation frame, immediately after the value is calculated.

fun getCurrentPlayTime(): Long

Gets the current position of the animation in time, which is equal to the current time minus the time that the animation started. An animation that is not yet started will return a value of zero, unless the animation has has its play time set via setCurrentPlayTime or setCurrentFraction, in which case it will return the time that was set.

fun getDuration(): Long

Gets the length of the animation. The default duration is 300 milliseconds.

java-static fun getFrameDelay(): Long

The amount of time, in milliseconds, between each frame of the animation. This is a requested time that the animation will attempt to honor, but the actual delay between frames may be different, depending on system load and capabilities. This is a static function because the same delay will be applied to all animations, since they are all run off of a single timing loop. The frame delay may be ignored when the animation system uses an external timing source, such as the display refresh rate (vsync), to govern animations. Note that this method should be called from the same thread that start is called in order to check the frame delay for that animation. A runtime exception will be thrown if the calling thread does not have a Looper.

fun getInterpolator(): Interpolator?

Returns the timing interpolator that this ValueAnimator uses.

fun getNameForTrace(): String

Returns the name of this animator for debugging purposes.

fun getRepeatCount(): Int

Defines how many times the animation should repeat. The default value is 0.

fun getRepeatMode(): Int

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

fun getStartDelay(): Long

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

fun getTotalDuration(): Long

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

When the animation repeats infinite times, or when any of the child animators does (via setRepeatCount} to INFINITE), the total duration will be DURATION_INFINITE. Otherwise, the total duration is the sum of start delay and animation running time (i.e. duration of one iteration multiplied by the number of iterations).

fun getValues(): Array<PropertyValuesHolder!>

Returns the values that this ValueAnimator animates between. These values are stored in PropertyValuesHolder objects, even if the ValueAnimator was created with a simple list of value objects instead.

fun isRunning(): Boolean

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

fun isStarted(): Boolean

Returns whether this Animator has been started and not yet ended. For reusable Animators (which most Animators are, apart from the one-shot animator produced by createCircularReveal()), this state is a superset of isRunning, because an Animator with a nonzero startDelay will return true for isStarted during the delay phase, whereas isRunning will return true only after the delay phase is complete. Non-reusable animators will always return true after they have been started, because they cannot return to a non-started state.

java-static fun ofArgb(values: IntArray<Int>): ValueAnimator

Constructs and returns a ValueAnimator that animates between color values. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

java-static fun ofFloat(values: FloatArray<Float>): ValueAnimator

Constructs and returns a ValueAnimator that animates between float values. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

java-static fun ofInt(values: IntArray<Int>): ValueAnimator

Constructs and returns a ValueAnimator that animates between int values. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

java-static fun ofObject(evaluator: TypeEvaluator, values: Array<Any!>): ValueAnimator

Constructs and returns a ValueAnimator that animates between Object values. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

Note: The Object values are stored as references to the original objects, which means that changes to those objects after this method is called will affect the values on the animator. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

Since ValueAnimator does not know how to animate between arbitrary Objects, this factory method also takes a TypeEvaluator object that the ValueAnimator will use to perform that interpolation.

java-static fun ofPropertyValuesHolder(values: Array<PropertyValuesHolder!>): ValueAnimator

Constructs and returns a ValueAnimator that animates between the values specified in the PropertyValuesHolder objects.

fun pause(): Unit

Pauses a running animation. This method should only be called on the same thread on which the animation was started. If the animation has not yet been started or has since ended, then the call is ignored. Paused animations can be resumed by calling resume.

fun resume(): Unit

Resumes a paused animation, causing the animator to pick up where it left off when it was paused. This method should only be called on the same thread on which the animation was started. Calls to resume() on an animator that is not currently paused will be ignored.

fun reverse(): Unit

Plays the ValueAnimator in reverse. If the animation is already running, it will stop itself and play backwards from the point reached when reverse was called. If the animation is not currently running, then it will start from the end and play backwards. This behavior is only set for the current animation; future playing of the animation will use the default behavior of playing forward.

fun setCurrentFraction(fraction: Float): Unit

Sets the position of the animation to the specified fraction. This fraction should be between 0 and the total fraction of the animation, including any repetition. That is, a fraction of 0 will position the animation at the beginning, a value of 1 at the end, and a value of 2 at the end of a reversing animator that repeats once. If the animation has not yet been started, then it will not advance forward after it is set to this fraction; it will simply set the fraction to this value and perform any appropriate actions based on that fraction. If the animation is already running, then setCurrentFraction() will set the current fraction to this value and continue playing from that point. androidx.core.animation.Animator.AnimatorListener events are not called due to changing the fraction; those events are only processed while the animation is running.

fun setCurrentPlayTime(playTime: Long): Unit

Sets the position of the animation to the specified point in time. This time should be between 0 and the total duration of the animation, including any repetition. If the animation has not yet been started, then it will not advance forward after it is set to this time; it will simply set the time to this value and perform any appropriate actions based on that time. If the animation is already running, then setCurrentPlayTime() will set the current playing time to this value and continue playing from that point.

fun setDuration(duration: Long): ValueAnimator

Sets the length of the animation. The default duration is 300 milliseconds.

fun setEvaluator(value: TypeEvaluator): Unit

The type evaluator to be used when calculating the animated values of this animation. The system will automatically assign a float or int evaluator based on the type of startValue and endValue in the constructor. But if these values are not one of these primitive types, or if different evaluation is desired (such as is necessary with int values that represent colors), a custom evaluator needs to be assigned. For example, when running an animation on color values, the ArgbEvaluator should be used to get correct RGB color interpolation.

If this ValueAnimator has only one set of values being animated between, this evaluator will be used for that set. If there are several sets of values being animated, which is the case if PropertyValuesHolder objects were set on the ValueAnimator, then the evaluator is assigned just to the first PropertyValuesHolder object.

fun setFloatValues(values: FloatArray<Float>): Unit

Sets float values that will be animated between. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

If there are already multiple sets of values defined for this ValueAnimator via more than one PropertyValuesHolder object, this method will set the values for the first of those objects.

java-static fun setFrameDelay(frameDelay: Long): Unit

The amount of time, in milliseconds, between each frame of the animation. This is a requested time that the animation will attempt to honor, but the actual delay between frames may be different, depending on system load and capabilities. This is a static function because the same delay will be applied to all animations, since they are all run off of a single timing loop. The frame delay may be ignored when the animation system uses an external timing source, such as the display refresh rate (vsync), to govern animations. Note that this method should be called from the same thread that start is called in order to have the new frame delay take effect on that animation. A runtime exception will be thrown if the calling thread does not have a Looper.

fun setIntValues(values: IntArray<Int>): Unit

Sets int values that will be animated between. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

If there are already multiple sets of values defined for this ValueAnimator via more than one PropertyValuesHolder object, this method will set the values for the first of those objects.

fun setInterpolator(value: Interpolator?): Unit

The interpolator used in calculating the elapsed fraction of this animation. The interpolator determines whether the animation runs with linear or non-linear motion, such as acceleration and deceleration. The default value is AccelerateDecelerateInterpolator

fun setNameForTrace(animationName: String): Unit

Sets a name for the animation to show up in the systrace. This makes a particular animation identifiable in the systrace.

fun setObjectValues(values: Array<Any!>): Unit

Sets the values to animate between for this animation. A single value implies that that value is the one being animated to. However, this is not typically useful in a ValueAnimator object because there is no way for the object to determine the starting value for the animation (unlike ObjectAnimator, which can derive that value from the target object and property being animated). Therefore, there should typically be two or more values.

Note: The Object values are stored as references to the original objects, which means that changes to those objects after this method is called will affect the values on the animator. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

If there are already multiple sets of values defined for this ValueAnimator via more than one PropertyValuesHolder object, this method will set the values for the first of those objects.

There should be a TypeEvaluator set on the ValueAnimator that knows how to interpolate between these value objects. ValueAnimator only knows how to interpolate between the primitive types specified in the other setValues() methods.

fun setRepeatCount(value: Int): Unit

Sets how many times the animation should be repeated. If the repeat count is 0, the animation is never repeated. If the repeat count is greater than 0 or INFINITE, the repeat mode will be taken into account. The repeat count is 0 by default.

fun setRepeatMode(value: Int): Unit

Defines what this animation should do when it reaches the end. This setting is applied only when the repeat count is either greater than 0 or INFINITE. Defaults to RESTART.

fun setStartDelay(startDelay: Long): Unit

The amount of time, in milliseconds, to delay starting the animation after start is called. Note that the start delay should always be non-negative. Any negative start delay will be clamped to 0 on N and above.

fun setValues(values: Array<PropertyValuesHolder!>): Unit

Sets the values, per property, being animated between. This function is called internally by the constructors of ValueAnimator that take a list of values. But a ValueAnimator can be constructed without values and this method can be called to set the values manually instead.

fun start(): Unit

Starts this animation. If the animation has a nonzero startDelay, the animation will start running after that delay elapses. A non-delayed animation will have its initial value(s) set immediately, followed by calls to onAnimationStart for any listeners of this animator.

The animation started by calling this method will be run on the thread that called this method. This thread should have a Looper on it (a runtime exception will be thrown if this is not the case). Also, if the animation will animate properties of objects in the view hierarchy, then the calling thread should be the UI thread for that view hierarchy.