ObjectAnimator


class ObjectAnimator : ValueAnimator


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.

ObjectAnimator supports the use of PropertyValuesHolder and Keyframe in resource files to create more complex animations. Using PropertyValuesHolders allows animators to animate several properties in parallel.

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.

See also
setPropertyName

Summary

Public constructors

Creates a new ObjectAnimator object.

Public functions

ObjectAnimator
String

Returns the name of this animator for debugging purposes.

String

Gets the name of the property that will be animated.

Any?

The target object whose property will be animated by this animation

java-static ObjectAnimator
ofArgb(target: Any, propertyName: String, values: IntArray)

Constructs and returns an ObjectAnimator that animates between color values.

java-static ObjectAnimator
<T> ofArgb(target: T, property: Property<T!, Int!>, values: IntArray)

Constructs and returns an ObjectAnimator that animates between color values.

java-static ObjectAnimator
ofFloat(target: Any, propertyName: String, values: FloatArray)

Constructs and returns an ObjectAnimator that animates between float values.

java-static ObjectAnimator
<T> ofFloat(target: T, property: Property<T!, Float!>, values: FloatArray)

Constructs and returns an ObjectAnimator that animates between float values.

java-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.

java-static ObjectAnimator
<T> 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.

java-static ObjectAnimator
ofInt(target: Any, propertyName: String, values: IntArray)

Constructs and returns an ObjectAnimator that animates between int values.

java-static ObjectAnimator
<T> ofInt(target: T, property: Property<T!, Int!>, values: IntArray)

Constructs and returns an ObjectAnimator that animates between int values.

java-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.

java-static ObjectAnimator
<T> 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.

java-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.

java-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.

java-static ObjectAnimator
@SafeVarargs
<T> ofMultiFloat(
    target: Any,
    propertyName: String,
    converter: TypeConverter<T!, FloatArray!>,
    evaluator: TypeEvaluator<T!>,
    values: Array<T!>
)

Constructs and returns an ObjectAnimator that animates over values for a multiple float parameters setter.

java-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.

java-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.

java-static ObjectAnimator
@SafeVarargs
<T> ofMultiInt(
    target: Any,
    propertyName: String,
    converter: TypeConverter<T!, IntArray!>,
    evaluator: TypeEvaluator<T!>,
    values: Array<T!>
)

Constructs and returns an ObjectAnimator that animates over values for a multiple int parameters setter.

java-static ObjectAnimator
ofObject(
    target: Any,
    propertyName: String,
    converter: TypeConverter<PointF!, Any!>?,
    path: Path
)

Constructs and returns an ObjectAnimator that animates a property along a Path.

java-static ObjectAnimator
ofObject(
    target: Any,
    propertyName: String,
    evaluator: TypeEvaluator,
    values: Array<Any!>
)

Constructs and returns an ObjectAnimator that animates between Object values.

java-static ObjectAnimator
<T, V> 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.

java-static ObjectAnimator
@SafeVarargs
<T, V> ofObject(
    target: T,
    property: Property<T!, V!>,
    evaluator: TypeEvaluator<V!>,
    values: Array<V!>
)

Constructs and returns an ObjectAnimator that animates between Object values.

java-static ObjectAnimator
@SafeVarargs
<T, V, P> ofObject(
    target: T,
    property: Property<T!, P!>,
    converter: TypeConverter<V!, P!>,
    evaluator: TypeEvaluator<V!>,
    values: Array<V!>
)

Constructs and returns an ObjectAnimator that animates between Object values.

java-static ObjectAnimator

Constructs and returns an ObjectAnimator that animates between the sets of values specified in PropertyValueHolder objects.

Unit

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

Sets float values that will be animated between.

Unit

Sets int values that will be animated between.

Unit

Sets the values to animate between for this animation.

Unit
setProperty(property: Property)

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

This method tells the object to use appropriate information to extract ending values for the animation.

Unit

This method tells the object to use appropriate information to extract starting values for the animation.

Unit

Starts this animation.

String

Inherited Constants

From androidx.core.animation.Animator
const Long

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

From androidx.core.animation.ValueAnimator
const Int

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

const Int

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

const Int

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

Inherited functions

From androidx.core.animation.Animator
Unit

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

Adds a pause listener to this animator.

Unit

Adds a listener to the set of listeners that are sent update events through the life of an animation.

Animator
Boolean

Returns whether this animator is currently in a paused state.

Unit

Removes all listeners and pauseListeners from this object.

Unit

Removes all listeners from the set listening to frame updates for this animation.

Unit

Removes a listener from the set listening to this animation.

Unit

Removes a pause listener from the set listening to this animation.

Unit

Removes a listener from the set listening to frame updates for this animation.

abstract Animator
setDuration(duration: @IntRange(from = 0) Long)

Sets the duration of the animation.

abstract Unit
setStartDelay(startDelay: @IntRange(from = 0) Long)

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

From androidx.core.animation.ValueAnimator
java-static Boolean

Returns whether animators are currently enabled, system-wide.

Unit

Cancels the animation.

Unit
end()

Ends the animation.

Float

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

Any

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

Any?
getAnimatedValue(propertyName: String)

The most recent value calculated by this ValueAnimator for propertyName.

Long

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

Long

Gets the length of the animation.

java-static Long

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

Interpolator?

Returns the timing interpolator that this ValueAnimator uses.

Int

Defines how many times the animation should repeat.

Int

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

Long

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

Long

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

Array<PropertyValuesHolder!>

Returns the values that this ValueAnimator animates between.

Boolean

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

Boolean

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

java-static ValueAnimator
ofArgb(values: IntArray)

Constructs and returns a ValueAnimator that animates between color values.

java-static ValueAnimator

Constructs and returns a ValueAnimator that animates between float values.

java-static ValueAnimator
ofInt(values: IntArray)

Constructs and returns a ValueAnimator that animates between int values.

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

Constructs and returns a ValueAnimator that animates between Object values.

java-static ValueAnimator

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

Unit

Pauses a running animation.

Unit

Resumes a paused animation, causing the animator to pick up where it left off when it was paused.

Unit

Plays the ValueAnimator in reverse.

Unit

Sets the position of the animation to the specified fraction.

Unit

Sets the position of the animation to the specified point in time.

Unit

The type evaluator to be used when calculating the animated values of this animation.

java-static Unit
setFrameDelay(frameDelay: Long)

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

Unit

The interpolator used in calculating the elapsed fraction of this animation.

Unit
setNameForTrace(animationName: String)

Sets a name for the animation to show up in the systrace.

Unit

Sets how many times the animation should be repeated.

Unit

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

Unit
setStartDelay(startDelay: Long)

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

Unit

Sets the values, per property, being animated between.

Public constructors

ObjectAnimator

ObjectAnimator()

Creates a new ObjectAnimator object. This default constructor is primarily for use internally; the other constructors which take parameters are more generally useful.

Public functions

clone

fun clone(): ObjectAnimator

getNameForTrace

fun getNameForTrace(): String

Returns the name of this animator for debugging purposes.

getPropertyName

fun getPropertyName(): String

Gets the name of the property that will be animated. This name will be used to derive a setter function that will be called to set animated values. For example, a property name of foo will result in a call to the function setFoo() on the target object. If either valueFrom or valueTo is null, then a getter function will also be derived and called.

If this animator was created with a Property object instead of the string name of a property, then this method will return the name of that Property object instead. If this animator was created with one or more PropertyValuesHolder objects, then this method will return the name of that object (if there was just one) or a comma-separated list of all of the names (if there are more than one).

getTarget

fun getTarget(): Any?

The target object whose property will be animated by this animation

Returns
Any?

The object being animated

ofArgb

java-static fun ofArgb(target: Any, propertyName: String, values: IntArray): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between color values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

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: IntArray

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofArgb

java-static fun <T> ofArgb(target: T, property: Property<T!, Int!>, values: IntArray): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between color values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target: T

The object whose property is to be animated.

property: Property<T!, Int!>

The property being animated.

values: IntArray

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofFloat

java-static fun ofFloat(target: Any, propertyName: String, values: FloatArray): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between float values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

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: FloatArray

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofFloat

java-static fun <T> ofFloat(target: T, property: Property<T!, Float!>, values: FloatArray): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between float values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target: T

The object whose property is to be animated.

property: Property<T!, Float!>

The property being animated.

values: FloatArray

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofFloat

java-static fun ofFloat(
    target: Any,
    xPropertyName: String?,
    yPropertyName: String?,
    path: Path
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are floats that are set to separate properties designated by xPropertyName and yPropertyName.

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 nameYare the value of the xPropertyName and yPropertyNameparameters, 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.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate along path.

ofFloat

java-static fun <T> ofFloat(
    target: T,
    xProperty: Property<T!, Float!>?,
    yProperty: Property<T!, Float!>?,
    path: Path
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are floats that are set to separate properties, xProperty and yProperty.

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.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate along path.

ofInt

java-static fun ofInt(target: Any, propertyName: String, values: IntArray): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between int values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

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: IntArray

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofInt

java-static fun <T> ofInt(target: T, property: Property<T!, Int!>, values: IntArray): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between int values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target: T

The object whose property is to be animated.

property: Property<T!, Int!>

The property being animated.

values: IntArray

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofInt

java-static fun ofInt(target: Any, xPropertyName: String, yPropertyName: String, path: Path): ObjectAnimator

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are integers that are set to separate properties designated by xPropertyName and yPropertyName.

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 nameYare the value of xPropertyName and yPropertyNameparameters, 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.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate along path.

ofInt

java-static fun <T> ofInt(
    target: T,
    xProperty: Property<T!, Int!>?,
    yProperty: Property<T!, Int!>?,
    path: Path
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates coordinates along a Path using two properties. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are integers that are set to separate properties, xProperty and yProperty.

Parameters
target: T

The object whose properties are to be animated.

xProperty: Property<T!, Int!>?

The property for the x coordinate being animated.

yProperty: Property<T!, Int!>?

The property for the y coordinate being animated.

path: Path

The Path to animate values along.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate along path.

ofMultiFloat

java-static fun ofMultiFloat(target: Any, propertyName: String, path: Path): ObjectAnimator

Constructs and returns an ObjectAnimator that animates the target using a multi-float setter along the given Path. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are float x and y coordinates used in the first and second parameter of the setter, respectively.

Parameters
target: Any

The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.

propertyName: String

The name of the property being animated or the name of the setter method.

path: Path

The Path to animate values along.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate along path.

ofMultiFloat

java-static fun ofMultiFloat(target: Any, propertyName: String, values: Array<FloatArray!>): ObjectAnimator

Constructs and returns an ObjectAnimator that animates over float values for a multiple parameters setter. Only public methods that take only float parameters are supported. Each float[] contains a complete set of parameters to the setter method. At least two float[] values must be provided, a start and end. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target: Any

The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.

propertyName: String

The name of the property being animated or the name of the setter method.

values: Array<FloatArray!>

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofMultiFloat

@SafeVarargs
java-static fun <T> ofMultiFloat(
    target: Any,
    propertyName: String,
    converter: TypeConverter<T!, FloatArray!>,
    evaluator: TypeEvaluator<T!>,
    values: Array<T!>
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates over values for a multiple float parameters setter. Only public methods that take only float parameters are supported.

At least two values must be provided, a start and end. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target: Any

The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.

propertyName: String

The name of the property being animated or the name of the setter method.

converter: TypeConverter<T!, FloatArray!>

Converts T objects into float parameters for the multi-value setter.

evaluator: TypeEvaluator<T!>

A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.

values: Array<T!>

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofMultiInt

java-static fun ofMultiInt(target: Any, propertyName: String, path: Path): ObjectAnimator

Constructs and returns an ObjectAnimator that animates the target using a multi-int setter along the given Path. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. In this variation, the coordinates are integer x and y coordinates used in the first and second parameter of the setter, respectively.

Parameters
target: Any

The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.

propertyName: String

The name of the property being animated or the name of the setter method.

path: Path

The Path to animate values along.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate along path.

ofMultiInt

java-static fun ofMultiInt(target: Any, propertyName: String, values: Array<IntArray!>): ObjectAnimator

Constructs and returns an ObjectAnimator that animates over int values for a multiple parameters setter. Only public methods that take only int parameters are supported. Each int[] contains a complete set of parameters to the setter method. At least two int[] values must be provided, a start and end. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target: Any

The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.

propertyName: String

The name of the property being animated or the name of the setter method.

values: Array<IntArray!>

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofMultiInt

@SafeVarargs
java-static fun <T> ofMultiInt(
    target: Any,
    propertyName: String,
    converter: TypeConverter<T!, IntArray!>,
    evaluator: TypeEvaluator<T!>,
    values: Array<T!>
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates over values for a multiple int parameters setter. Only public methods that take only int parameters are supported.

At least two values must be provided, a start and end. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Parameters
target: Any

The object whose property is to be animated. This object may have a public method on it called setName(), where name is the value of the propertyName parameter. propertyName may also be the case-sensitive complete name of the public setter method.

propertyName: String

The name of the property being animated or the name of the setter method.

converter: TypeConverter<T!, IntArray!>

Converts T objects into int parameters for the multi-value setter.

evaluator: TypeEvaluator<T!>

A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.

values: Array<T!>

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofObject

java-static fun ofObject(
    target: Any,
    propertyName: String,
    converter: TypeConverter<PointF!, Any!>?,
    path: Path
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates a property along a Path. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. This variant animates the coordinates in a PointF to follow the Path. If the Property associated with propertyName uses a type other than PointF, converter can be used to change from PointF to the type associated with the Property.

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.

converter: TypeConverter<PointF!, Any!>?

Converts a PointF to the type associated with the setter. May be null if conversion is unnecessary.

path: Path

The Path to animate values along.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate along path.

ofObject

java-static fun ofObject(
    target: Any,
    propertyName: String,
    evaluator: TypeEvaluator,
    values: Array<Any!>
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between Object values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Note: The 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.

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.

evaluator: TypeEvaluator

A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.

values: Array<Any!>

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofObject

java-static fun <T, V> ofObject(
    target: T,
    property: Property<T!, V!>,
    converter: TypeConverter<PointF!, V!>?,
    path: Path
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates a property along a Path. A Path animation moves in two dimensions, animating coordinates (x, y) together to follow the line. This variant animates the coordinates in a PointF to follow the Path. If property uses a type other than PointF, converter can be used to change from PointF to the type associated with the Property.

The PointF passed to converter or property, if converter is null, is reused on each animation frame and should not be stored by the setter or TypeConverter.

Parameters
target: T

The object whose property is to be animated.

property: Property<T!, V!>

The property being animated. Should not be null.

converter: TypeConverter<PointF!, V!>?

Converts a PointF to the type associated with the setter. May be null if conversion is unnecessary.

path: Path

The Path to animate values along.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate along path.

ofObject

@SafeVarargs
java-static fun <T, V> ofObject(
    target: T,
    property: Property<T!, V!>,
    evaluator: TypeEvaluator<V!>,
    values: Array<V!>
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between Object values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation).

Note: The 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.

Parameters
target: T

The object whose property is to be animated.

property: Property<T!, V!>

The property being animated.

evaluator: TypeEvaluator<V!>

A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.

values: Array<V!>

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofObject

@SafeVarargs
java-static fun <T, V, P> ofObject(
    target: T,
    property: Property<T!, P!>,
    converter: TypeConverter<V!, P!>,
    evaluator: TypeEvaluator<V!>,
    values: Array<V!>
): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between Object values. A single value implies that that value is the one being animated to, in which case the start value will be derived from the property being animated and the target object when start is called for the first time. Two values imply starting and ending values. More than two values imply a starting value, values to animate through along the way, and an ending value (these values will be distributed evenly across the duration of the animation). This variant supplies a TypeConverter to convert from the animated values to the type of the property. If only one value is supplied, the TypeConverter must be a BidirectionalTypeConverter to retrieve the current value.

Note: The 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.

Parameters
target: T

The object whose property is to be animated.

property: Property<T!, P!>

The property being animated.

converter: TypeConverter<V!, P!>

Converts the animated object to the Property type.

evaluator: TypeEvaluator<V!>

A TypeEvaluator that will be called on each animation frame to provide the necessary interpolation between the Object values to derive the animated value.

values: Array<V!>

A set of values that the animation will animate between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

ofPropertyValuesHolder

java-static fun ofPropertyValuesHolder(target: Any, values: Array<PropertyValuesHolder!>): ObjectAnimator

Constructs and returns an ObjectAnimator that animates between the sets of values specified in PropertyValueHolder objects. This variant should be used when animating several properties at once with the same ObjectAnimator, since PropertyValuesHolder allows you to associate a set of animation values with a property name.

Parameters
target: Any

The object whose property is to be animated. Depending on how the PropertyValuesObjects were constructed, the target object should either have the objects used to construct the PropertyValuesHolder objects or (if the PropertyValuesHOlder objects were created with property names) the target object should have public methods on it called setName(), where name is the name of the property passed in as the propertyName parameter for each of the PropertyValuesHolder objects.

values: Array<PropertyValuesHolder!>

A set of PropertyValuesHolder objects whose values will be animated between over time.

Returns
ObjectAnimator

An ObjectAnimator object that is set up to animate between the given values.

setAutoCancel

fun setAutoCancel(cancel: Boolean): Unit

autoCancel controls whether an ObjectAnimator will be canceled automatically when any other ObjectAnimator with the same target and properties is started. Setting this flag may make it easier to run different animators on the same target object without having to keep track of whether there are conflicting animators that need to be manually canceled. Canceling animators must have the same exact set of target properties, in the same order.

Parameters
cancel: Boolean

Whether future ObjectAnimators with the same target and properties as this ObjectAnimator will cause this ObjectAnimator to be canceled.

setDuration

fun setDuration(duration: Long): ObjectAnimator

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

Parameters
duration: Long

The length of the animation, in milliseconds.

Returns
ObjectAnimator

ObjectAnimator The object called with setDuration(). This return value makes it easier to compose statements together that construct and then set the duration, as in ObjectAnimator.ofInt(target, propertyName, 0, 10).setDuration(500).start().

setFloatValues

fun setFloatValues(values: FloatArray): 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.

Parameters
values: FloatArray

A set of values that the animation will animate between over time.

setIntValues

fun setIntValues(values: IntArray): 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.

Parameters
values: IntArray

A set of values that the animation will animate between over time.

setObjectValues

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.

Parameters
values: Array<Any!>

The set of values to animate between.

setProperty

fun setProperty(property: Property): Unit

Sets the property that will be animated. Property objects will take precedence over properties specified by the setPropertyName method. Animations should be set up to use one or the other, not both.

Parameters
property: Property

The property being animated. Should not be null.

setPropertyName

fun setPropertyName(propertyName: String): Unit

Sets the name of the property that will be animated. This name is used to derive a setter function that will be called to set animated values. For example, a property name of foo will result in a call to the function setFoo() on the target object. If either valueFrom or valueTo is null, then a getter function will also be derived and called.

For best performance of the mechanism that calls the setter function determined by the name of the property being animated, use float or int typed values, and make the setter function for those properties have a void return value. This will cause the code to take an optimized path for these constrained circumstances. Other property types and return types will work, but will have more overhead in processing the requests due to normal reflection mechanisms.

Note that the setter function derived from this property name must take the same parameter type as the valueFrom and valueTo properties, otherwise the call to the setter function will fail.

If this ObjectAnimator has been set up to animate several properties together, using more than one PropertyValuesHolder objects, then setting the propertyName simply sets the propertyName in the first of those PropertyValuesHolder objects.

Parameters
propertyName: String

The name of the property being animated. Should not be null.

setTarget

fun setTarget(target: Any?): Unit

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.

Parameters
target: Any?

The object being animated

setupEndValues

fun setupEndValues(): Unit

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.

setupStartValues

fun setupStartValues(): Unit

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.

start

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.

toString

fun toString(): String