ValueAnimator

Kotlin |Java

open class ValueAnimator : Animator

kotlin.Any
↳	android.animation.Animator
	↳	android.animation.ValueAnimator

Known Direct Subclasses

ObjectAnimator, TimeAnimator

ObjectAnimator	This subclass of `ValueAnimator` provides support for animating properties on target objects.
TimeAnimator	This class provides a simple callback mechanism to listeners that is synchronized with all other animators in the system.

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 ValueAnimator.setInterpolator(TimeInterpolator).

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

Starting from API 23, it is also possible to use 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:

Summary

Nested classes
abstract	`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`.
abstract	`DurationScaleChangeListener` Listener interface for the system-wide scaling factor for Animator-based animations.

Constants
static Int	`INFINITE` This value used used with the `setRepeatCount(int)` property to repeat the animation indefinitely.
static Int	`RESTART` When the animation reaches the end and `repeatCount` is INFINITE or a positive value, the animation restarts from the beginning.
static 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

From class Animator

Long

DURATION_INFINITE

The value used to indicate infinite duration (e.g. when Animators repeat infinitely).

Public constructors
`ValueAnimator()` Creates a new ValueAnimator object.

Public methods
open Unit	`addUpdateListener(listener: ValueAnimator.AnimatorUpdateListener!)` Adds a listener to the set of listeners that are sent update events through the life of an animation.
open static Boolean	`areAnimatorsEnabled()` Returns whether animators are currently enabled, system-wide.
open Unit	`cancel()`
open ValueAnimator	`clone()`
open Unit	`end()`
open Float	`getAnimatedFraction()` Returns the current animation fraction, which is the elapsed/interpolated fraction used in the most recent frame update on the animation.
open Any!	`getAnimatedValue()` The most recent value calculated by this `ValueAnimator` when there is just one property being animated.
open Any!	`getAnimatedValue(propertyName: String!)` The most recent value calculated by this `ValueAnimator` for `propertyName`.
open 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.
open Long	`getDuration()` Gets the length of the animation.
open static Float	`getDurationScale()` Returns the system-wide scaling factor for Animator-based animations.
open static Long	`getFrameDelay()` The amount of time, in milliseconds, between each frame of the animation.
open TimeInterpolator!	`getInterpolator()` Returns the timing interpolator that this ValueAnimator uses.
open Int	`getRepeatCount()` Defines how many times the animation should repeat.
open Int	`getRepeatMode()` Defines what this animation should do when it reaches the end.
open Long	`getStartDelay()` The amount of time, in milliseconds, to delay starting the animation after `start()` is called.
open Long	`getTotalDuration()`
open Array<PropertyValuesHolder!>!	`getValues()` Returns the values that this ValueAnimator animates between.
open Boolean	`isRunning()`
open Boolean	`isStarted()`
open static ValueAnimator!	`ofArgb(vararg values: Int)` Constructs and returns a ValueAnimator that animates between color values.
open static ValueAnimator!	`ofFloat(vararg values: Float)` Constructs and returns a ValueAnimator that animates between float values.
open static ValueAnimator!	`ofInt(vararg values: Int)` Constructs and returns a ValueAnimator that animates between int values.
open static ValueAnimator!	`ofObject(evaluator: TypeEvaluator<Any!>!, vararg values: Any!)` Constructs and returns a ValueAnimator that animates between Object values.
open static ValueAnimator!	`ofPropertyValuesHolder(vararg values: PropertyValuesHolder!)` Constructs and returns a ValueAnimator that animates between the values specified in the PropertyValuesHolder objects.
open Unit	`pause()`
open static Boolean	`registerDurationScaleChangeListener(listener: ValueAnimator.DurationScaleChangeListener)` Registers a `DurationScaleChangeListener` This listens for changes to the system-wide scaling factor for Animator-based animations.
open Unit	`removeAllUpdateListeners()` Removes all listeners from the set listening to frame updates for this animation.
open Unit	`removeUpdateListener(listener: ValueAnimator.AnimatorUpdateListener!)` Removes a listener from the set listening to frame updates for this animation.
open Unit	`resume()`
open Unit	`reverse()` Plays the ValueAnimator in reverse.
open Unit	`setCurrentFraction(fraction: Float)` Sets the position of the animation to the specified fraction.
open Unit	`setCurrentPlayTime(playTime: Long)` Sets the position of the animation to the specified point in time.
open ValueAnimator!	`setDuration(duration: Long)` Sets the length of the animation.
open Unit	`setEvaluator(value: TypeEvaluator<Any!>!)` The type evaluator to be used when calculating the animated values of this animation.
open Unit	`setFloatValues(vararg values: Float)` Sets float values that will be animated between.
open static Unit	`setFrameDelay(frameDelay: Long)` The amount of time, in milliseconds, between each frame of the animation.
open Unit	`setIntValues(vararg values: Int)` Sets int values that will be animated between.
open Unit	`setInterpolator(value: TimeInterpolator!)` The time interpolator used in calculating the elapsed fraction of this animation.
open Unit	`setObjectValues(vararg values: Any!)` Sets the values to animate between for this animation.
open Unit	`setRepeatCount(value: Int)` Sets how many times the animation should be repeated.
open Unit	`setRepeatMode(value: Int)` Defines what this animation should do when it reaches the end.
open Unit	`setStartDelay(startDelay: Long)` The amount of time, in milliseconds, to delay starting the animation after `start()` is called.
open Unit	`setValues(vararg values: PropertyValuesHolder!)` Sets the values, per property, being animated between.
open Unit	`start()`
open String	`toString()`
open static Boolean	`unregisterDurationScaleChangeListener(listener: ValueAnimator.DurationScaleChangeListener)` Unregisters a DurationScaleChangeListener.

Inherited functions

From class Animator

`Unit`	`addListener(listener: Animator.AnimatorListener!)` Adds a listener to the set of listeners that are sent events through the life of an animation, such as start, repeat, and end.
`Unit`	`addPauseListener(listener: Animator.AnimatorPauseListener!)` Adds a pause listener to this animator.
`ArrayList<Animator.AnimatorListener!>!`	`getListeners()` Gets the set of `android.animation.Animator.AnimatorListener` objects that are currently listening for events on this `Animator` object.
`Boolean`	`isPaused()` Returns whether this animator is currently in a paused state.
`Unit`	`removeAllListeners()` Removes all `listeners` and `pauseListeners` from this object.
`Unit`	`removeListener(listener: Animator.AnimatorListener!)` Removes a listener from the set listening to this animation.
`Unit`	`removePauseListener(listener: Animator.AnimatorPauseListener!)` Removes a pause listener from the set listening to this animation.
`Unit`	`setTarget(target: Any?)` Sets the target object whose property will be animated by this animation. Not all subclasses operate on target objects (for example, `ValueAnimator`, but this method is on the superclass for the convenience of dealing generically with those subclasses that do handle targets. Note: The target is stored as a weak reference internally to avoid leaking resources by having animators directly reference old targets. Therefore, you should ensure that animator targets always have a hard reference elsewhere.
`Unit`	`setupEndValues()` This method tells the object to use appropriate information to extract ending values for the animation. For example, a AnimatorSet object will pass this call to its child objects to tell them to set up the values. A ObjectAnimator object will use the information it has about its target object and PropertyValuesHolder objects to get the start values for its properties. A ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values.
`Unit`	`setupStartValues()` This method tells the object to use appropriate information to extract starting values for the animation. For example, a AnimatorSet object will pass this call to its child objects to tell them to set up the values. A ObjectAnimator object will use the information it has about its target object and PropertyValuesHolder objects to get the start values for its properties. A ValueAnimator object will ignore the request since it does not have enough information (such as a target object) to gather these values.

Parameters
`evaluator`	TypeEvaluator<Any!>!: A TypeEvaluator that will be called on each animation frame to provide the ncessry interpolation between the Object values to derive the animated value.
`values`	Any!: A set of values that the animation will animate between over time.

ValueAnimator

Summary

Constants

INFINITE

RESTART

REVERSE

Public constructors

ValueAnimator

Public methods

addUpdateListener

areAnimatorsEnabled

cancel

clone

end

getAnimatedFraction

getAnimatedValue

getAnimatedValue

getCurrentPlayTime

getDuration

getDurationScale

getFrameDelay

getInterpolator

getRepeatCount

getRepeatMode

getStartDelay

getTotalDuration

getValues

isRunning

isStarted

ofArgb

ofFloat

ofInt

ofObject

ofPropertyValuesHolder

pause

registerDurationScaleChangeListener

removeAllUpdateListeners

removeUpdateListener

resume

reverse

setCurrentFraction

setCurrentPlayTime

setDuration

setEvaluator

setFloatValues

setFrameDelay

setIntValues

setInterpolator

setObjectValues

setRepeatCount

setRepeatMode

setStartDelay

setValues

start

toString

unregisterDurationScaleChangeListener