ObjectAnimator
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 | |
---|---|
Public constructors | |
---|---|
Creates a new ObjectAnimator object. |
Public methods | |
---|---|
ObjectAnimator |
clone() |
String? |
Gets the name of the property that will be animated. |
Any? |
The target object whose property will be animated by this animation |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates between color values. |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates between color values. |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates between float values. |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates coordinates along a |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates between float values. |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates coordinates along a |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates between int values. |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates coordinates along a |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates between int values. |
static ObjectAnimator! |
Constructs and returns an ObjectAnimator that animates coordinates along a |
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! |
ofMultiFloat(target: Any!, propertyName: String!, path: Path!) Constructs and returns an ObjectAnimator that animates the target using a multi-float setter along the given |
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! |
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! |
ofMultiInt(target: Any!, propertyName: String!, path: Path!) Constructs and returns an ObjectAnimator that animates the target using a multi-int setter along the given |
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! |
Constructs and returns an ObjectAnimator that animates between Object values. |
static ObjectAnimator |
Constructs and returns an ObjectAnimator that animates a property along a |
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 |
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 |
static ObjectAnimator |
ofPropertyValuesHolder(target: Any!, vararg values: PropertyValuesHolder!) Constructs and returns an ObjectAnimator that animates between the sets of values specified in |
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 |
Sets the target object whose property will be animated by this animation. |
Unit | |
Unit | |
Unit |
start() |
String |
toString() Returns a string representation of the object. |
Inherited functions | |
---|---|
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 methods
clone
fun clone(): ObjectAnimator
Return | |
---|---|
ObjectAnimator |
a clone of this instance. |
Exceptions | |
---|---|
java.lang.CloneNotSupportedException |
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned. |
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
Return | |
---|---|
Any? |
The object being animated This value may be null . |
ofArgb
static fun ofArgb(
target: Any!,
propertyName: String!,
vararg values: Int
): 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 |
Int: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofArgb
static fun <T : Any!> ofArgb(
target: T,
property: Property<T, Int!>!,
vararg values: Int
): 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 |
Int: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofFloat
static fun ofFloat(
target: Any!,
propertyName: String!,
vararg values: Float
): 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 |
Float: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofFloat
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 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. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate along path . |
ofFloat
static fun <T : Any!> ofFloat(
target: T,
property: Property<T, Float!>!,
vararg values: Float
): 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 |
Float: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofFloat
static fun <T : Any!> 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. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate along path . |
ofInt
static fun ofInt(
target: Any!,
propertyName: String!,
vararg values: Int
): 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 |
Int: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofInt
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 nameY are the value of 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. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate along path . |
ofInt
static fun <T : Any!> ofInt(
target: T,
property: Property<T, Int!>!,
vararg values: Int
): 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 |
Int: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofInt
static fun <T : Any!> 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. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate along path . |
ofMultiFloat
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. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofMultiFloat
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. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate along path . |
ofMultiFloat
@SafeVarargs static fun <T : Any!> ofMultiFloat(
target: Any!,
propertyName: String!,
converter: TypeConverter<T, FloatArray!>!,
evaluator: TypeEvaluator<T>!,
vararg values: 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 |
T: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofMultiInt
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. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofMultiInt
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. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate along path . |
ofMultiInt
@SafeVarargs static fun <T : Any!> ofMultiInt(
target: Any!,
propertyName: String!,
converter: TypeConverter<T, IntArray!>!,
evaluator: TypeEvaluator<T>!,
vararg values: 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 |
T: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofObject
static fun ofObject(
target: Any!,
propertyName: String!,
evaluator: TypeEvaluator<Any!>!,
vararg values: 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<Any!>!: 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 |
Any!: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator! |
An ObjectAnimator object that is set up to animate between the given values. |
ofObject
static fun ofObject(
target: Any!,
propertyName: String!,
converter: TypeConverter<PointF!, *>?,
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!, *>?: 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. |
Return | |
---|---|
ObjectAnimator |
An ObjectAnimator object that is set up to animate along path . This value cannot be null . |
ofObject
@SafeVarargs static fun <T : Any!, V : Any!> ofObject(
target: T,
property: Property<T, V>!,
evaluator: TypeEvaluator<V>!,
vararg values: 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 |
V: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator |
An ObjectAnimator object that is set up to animate between the given values. This value cannot be null . |
ofObject
@SafeVarargs static fun <T : Any!, V : Any!, P : Any!> ofObject(
target: T,
property: Property<T, P>!,
converter: TypeConverter<V, P>!,
evaluator: TypeEvaluator<V>!,
vararg values: 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 android.animation.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 |
V: A set of values that the animation will animate between over time. |
Return | |
---|---|
ObjectAnimator |
An ObjectAnimator object that is set up to animate between the given values. This value cannot be null . |
ofObject
static fun <T : Any!, V : Any!> 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. |
Return | |
---|---|
ObjectAnimator |
An ObjectAnimator object that is set up to animate along path . |
ofPropertyValuesHolder
static fun ofPropertyValuesHolder(
target: Any!,
vararg values: 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 |
PropertyValuesHolder!: A set of PropertyValuesHolder objects whose values will be animated between over time. |
Return | |
---|---|
ObjectAnimator |
An ObjectAnimator object that is set up to animate between the given values. This value cannot be null . |
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. |
Return | |
---|---|
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() . This value cannot be null . |
setFloatValues
fun setFloatValues(vararg values: Float): Unit
Parameters | |
---|---|
values |
Float: A set of values that the animation will animate between over time. |
setIntValues
fun setIntValues(vararg values: Int): Unit
Parameters | |
---|---|
values |
Int: A set of values that the animation will animate between over time. |
setObjectValues
fun setObjectValues(vararg values: Any!): Unit
Parameters | |
---|---|
values |
Any!: The set of values to animate between. |
setProperty
fun setProperty(property: Property<Any!, Any!>): Unit
Sets the property that will be animated. Property objects will take precedence over properties specified by the setPropertyName(java.lang.String)
method. Animations should be set up to use one or the other, not both.
Parameters | |
---|---|
property |
Property<Any!, Any!>: 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?: This value may be null . |
toString
fun toString(): String
Returns a string representation of the object.
Return | |
---|---|
String |
This value cannot be null . |