ObjectAnimator

Kotlin |Java

class ObjectAnimator : ValueAnimator

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

This subclass of ValueAnimator provides support for animating properties on target objects. The constructors of this class take parameters to define the target object that will be animated as well as the name of the property that will be animated. Appropriate set/get functions are then determined internally and the animation will call these functions as necessary to animate the property.

Animators can be created from either code or resource files, as shown here:

Starting from API 23, it is possible to use PropertyValuesHolder and Keyframe in resource files to create more complex animations. Using PropertyValuesHolders allows animators to animate several properties in parallel, as shown in this sample:

Using Keyframes allows animations to follow more complex paths from the start to the end values. 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. Also, a keyframe with no value will derive its value from the target object when the animator starts, just like animators with only one value specified. In addition, an optional interpolator can be specified. The interpolator will be applied on the interval between the keyframe that the interpolator is set on and the previous keyframe. When no interpolator is supplied, the default AccelerateDecelerateInterpolator will be used.

Summary

Inherited constants

From class Animator

Long

DURATION_INFINITE

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

From class ValueAnimator

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.

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

Public methods
ObjectAnimator	`clone()`
String?	`getPropertyName()` Gets the name of the property that will be animated.
Any?	`getTarget()` The target object whose property will be animated by this animation
static ObjectAnimator!	`ofArgb(target: Any!, propertyName: String!, vararg values: Int)` Constructs and returns an ObjectAnimator that animates between color values.
static ObjectAnimator!	`ofArgb(target: T, property: Property<T, Int!>!, vararg values: Int)` Constructs and returns an ObjectAnimator that animates between color values.
static ObjectAnimator!	`ofFloat(target: Any!, propertyName: String!, vararg values: Float)` Constructs and returns an ObjectAnimator that animates between float values.
static ObjectAnimator!	`ofFloat(target: Any!, xPropertyName: String!, yPropertyName: String!, path: Path!)` Constructs and returns an ObjectAnimator that animates coordinates along a `Path` using two properties.
static ObjectAnimator!	`ofFloat(target: T, xProperty: Property<T, Float!>!, yProperty: Property<T, Float!>!, path: Path!)` Constructs and returns an ObjectAnimator that animates coordinates along a `Path` using two properties.
static ObjectAnimator!	`ofFloat(target: T, property: Property<T, Float!>!, vararg values: Float)` Constructs and returns an ObjectAnimator that animates between float values.
static ObjectAnimator!	`ofInt(target: Any!, propertyName: String!, vararg values: Int)` Constructs and returns an ObjectAnimator that animates between int values.
static ObjectAnimator!	`ofInt(target: Any!, xPropertyName: String!, yPropertyName: String!, path: Path!)` Constructs and returns an ObjectAnimator that animates coordinates along a `Path` using two properties.
static ObjectAnimator!	`ofInt(target: T, xProperty: Property<T, Int!>!, yProperty: Property<T, Int!>!, path: Path!)` Constructs and returns an ObjectAnimator that animates coordinates along a `Path` using two properties.
static ObjectAnimator!	`ofInt(target: T, property: Property<T, Int!>!, vararg values: Int)` Constructs and returns an ObjectAnimator that animates between int values.
static ObjectAnimator!	`ofMultiFloat(target: Any!, propertyName: String!, converter: TypeConverter<T, FloatArray!>!, evaluator: TypeEvaluator<T>!, vararg values: T)` Constructs and returns an ObjectAnimator that animates over values for a multiple float parameters setter.
static ObjectAnimator!	`ofMultiFloat(target: Any!, propertyName: String!, path: Path!)` Constructs and returns an ObjectAnimator that animates the target using a multi-float setter along the given `Path`.
static ObjectAnimator!	`ofMultiFloat(target: Any!, propertyName: String!, values: Array<FloatArray!>!)` Constructs and returns an ObjectAnimator that animates over float values for a multiple parameters setter.
static ObjectAnimator!	`ofMultiInt(target: Any!, propertyName: String!, converter: TypeConverter<T, IntArray!>!, evaluator: TypeEvaluator<T>!, vararg values: T)` Constructs and returns an ObjectAnimator that animates over values for a multiple int parameters setter.
static ObjectAnimator!	`ofMultiInt(target: Any!, propertyName: String!, path: Path!)` Constructs and returns an ObjectAnimator that animates the target using a multi-int setter along the given `Path`.
static ObjectAnimator!	`ofMultiInt(target: Any!, propertyName: String!, values: Array<IntArray!>!)` Constructs and returns an ObjectAnimator that animates over int values for a multiple parameters setter.
static ObjectAnimator	`ofObject(target: Any!, propertyName: String!, converter: TypeConverter<PointF!, *>?, path: Path!)` Constructs and returns an ObjectAnimator that animates a property along a `Path`.
static ObjectAnimator!	`ofObject(target: Any!, propertyName: String!, evaluator: TypeEvaluator<Any!>!, vararg values: Any!)` Constructs and returns an ObjectAnimator that animates between Object values.
static ObjectAnimator	`ofObject(target: T, property: Property<T, P>!, converter: TypeConverter<V, P>!, evaluator: TypeEvaluator<V>!, vararg values: V)` Constructs and returns an ObjectAnimator that animates between Object values.
static ObjectAnimator	`ofObject(target: T, property: Property<T, V>, converter: TypeConverter<PointF!, V>?, path: Path!)` Constructs and returns an ObjectAnimator that animates a property along a `Path`.
static ObjectAnimator	`ofObject(target: T, property: Property<T, V>!, evaluator: TypeEvaluator<V>!, vararg values: V)` Constructs and returns an ObjectAnimator that animates between Object values.
static ObjectAnimator	`ofPropertyValuesHolder(target: Any!, vararg values: PropertyValuesHolder!)` Constructs and returns an ObjectAnimator that animates between the sets of values specified in `PropertyValueHolder` objects.
Unit	`setAutoCancel(cancel: Boolean)` autoCancel controls whether an ObjectAnimator will be canceled automatically when any other ObjectAnimator with the same target and properties is started.
ObjectAnimator	`setDuration(duration: Long)` Sets the length of the animation.
Unit	`setFloatValues(vararg values: Float)`
Unit	`setIntValues(vararg values: Int)`
Unit	`setObjectValues(vararg values: Any!)`
Unit	`setProperty(property: Property<Any!, Any!>)` Sets the property that will be animated.
Unit	`setPropertyName(propertyName: String)` Sets the name of the property that will be animated.
Unit	`setTarget(target: Any?)` Sets the target object whose property will be animated by this animation.
Unit	`setupEndValues()`
Unit	`setupStartValues()`
Unit	`start()`
String	`toString()` Returns a string representation of the object.

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.

From class ValueAnimator

`Unit`	`addUpdateListener(listener: ValueAnimator.AnimatorUpdateListener!)` Adds a listener to the set of listeners that are sent update events through the life of an animation. This method is called on all listeners for every frame of the animation, after the values for the animation have been calculated.
`Boolean`	`areAnimatorsEnabled()` 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.
`Unit`	`cancel()`
`Unit`	`end()`
`Float`	`getAnimatedFraction()` Returns the current animation fraction, which is the elapsed/interpolated fraction used in the most recent frame update on the animation.
`Any!`	`getAnimatedValue()` 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 `AnimatorUpdateListener.onAnimationUpdate(ValueAnimator)`, which is called during each animation frame, immediately after the value is calculated.
`Any!`	`getAnimatedValue(propertyName: String!)` 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 `AnimatorUpdateListener.onAnimationUpdate(ValueAnimator)`, which is called during each animation frame, immediately after the value is calculated.
`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. An animation that is not yet started will return a value of zero, unless the animation has has its play time set via `setCurrentPlayTime(long)` or `setCurrentFraction(float)`, in which case it will return the time that was set.
`Long`	`getDuration()` Gets the length of the animation. The default duration is 300 milliseconds.
`Float`	`getDurationScale()` Returns the system-wide scaling factor for Animator-based animations. This affects both the start delay and duration of all such animations. Setting to 0 will cause animations to end immediately. The default value is 1.0f.
`Long`	`getFrameDelay()` 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.
`TimeInterpolator!`	`getInterpolator()` Returns the timing interpolator that this ValueAnimator uses.
`Int`	`getRepeatCount()` Defines how many times the animation should repeat. The default value is 0.
`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()`
`Array<PropertyValuesHolder!>!`	`getValues()` 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.
`Boolean`	`isRunning()`
`Boolean`	`isStarted()`
`ValueAnimator!`	`ofArgb(vararg values: Int)` 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.
`ValueAnimator!`	`ofFloat(vararg values: Float)` 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.
`ValueAnimator!`	`ofInt(vararg values: Int)` 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.
`ValueAnimator!`	`ofObject(evaluator: TypeEvaluator<Any!>!, vararg values: Any!)` 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.
`ValueAnimator!`	`ofPropertyValuesHolder(vararg values: PropertyValuesHolder!)` Constructs and returns a ValueAnimator that animates between the values specified in the PropertyValuesHolder objects.
`Unit`	`pause()`
`Boolean`	`registerDurationScaleChangeListener(listener: ValueAnimator.DurationScaleChangeListener)` Registers a `DurationScaleChangeListener` This listens for changes to the system-wide scaling factor for Animator-based animations. Listeners will be called on the main thread.
`Unit`	`removeAllUpdateListeners()` Removes all listeners from the set listening to frame updates for this animation.
`Unit`	`removeUpdateListener(listener: ValueAnimator.AnimatorUpdateListener!)` Removes a listener from the set listening to frame updates for this animation.
`Unit`	`resume()`
`Unit`	`reverse()` 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.
`Unit`	`setCurrentFraction(fraction: Float)` 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. `Animator.AnimatorListener` events are not called due to changing the fraction; those events are only processed while the animation is running.
`Unit`	`setCurrentPlayTime(playTime: Long)` 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.
`Unit`	`setEvaluator(value: TypeEvaluator<Any!>!)` 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.
`Unit`	`setFrameDelay(frameDelay: 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 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.
`Unit`	`setInterpolator(value: TimeInterpolator!)` The time 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 `android.view.animation.AccelerateDecelerateInterpolator`
`Unit`	`setRepeatCount(value: Int)` 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.
`Unit`	`setRepeatMode(value: Int)` 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`.
`Unit`	`setStartDelay(startDelay: Long)` 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.
`Unit`	`setValues(vararg values: PropertyValuesHolder!)` 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.
`Boolean`	`unregisterDurationScaleChangeListener(listener: ValueAnimator.DurationScaleChangeListener)` Unregisters a DurationScaleChangeListener.

Parameters
`target`	Any!: The object whose property is to be animated. This object should have a public method on it called `setName()`, where `name` is the value of the `propertyName` parameter.
`propertyName`	String!: The name of the property being animated.
`values`	Int: A set of values that the animation will animate between over time.

Parameters
`target`	T: The object whose property is to be animated.
`property`	Property<T, Int!>!: The property being animated.
`values`	Int: A set of values that the animation will animate between over time.

Parameters
`target`	Any!: The object whose properties are to be animated. This object should have public methods on it called `setNameX()` and `setNameY`, where `nameX` and `nameY` are the value of the `xPropertyName` and `yPropertyName` parameters, respectively.
`xPropertyName`	String!: The name of the property for the x coordinate being animated.
`yPropertyName`	String!: The name of the property for the y coordinate being animated.
`path`	Path!: The `Path` to animate values along.

Parameters
`target`	T: The object whose properties are to be animated.
`xProperty`	Property<T, Float!>!: The property for the x coordinate being animated.
`yProperty`	Property<T, Float!>!: The property for the y coordinate being animated.
`path`	Path!: The `Path` to animate values along.

ObjectAnimator

Summary

Public constructors

ObjectAnimator

Public methods

clone

getPropertyName

getTarget

ofArgb

ofArgb

ofFloat

ofFloat

ofFloat

ofFloat

ofInt

ofInt

ofInt

ofInt

ofMultiFloat

ofMultiFloat

ofMultiFloat

ofMultiInt

ofMultiInt

ofMultiInt

ofObject

ofObject

ofObject

ofObject

ofObject

ofPropertyValuesHolder

setAutoCancel

setDuration

setFloatValues

setIntValues

setObjectValues

setProperty

setPropertyName

setTarget

setupEndValues

setupStartValues

start

toString