PropertyValuesHolder

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.

java-static fun ofFloat(propertyName: String, values: FloatArray): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder with a given property name and set of float values.

java-static fun ofFloat(property: Property<Any!, Float!>, values: FloatArray): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder with a given property and set of float values.

java-static fun ofInt(propertyName: String, values: IntArray): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder with a given property name and set of int values.

java-static fun ofInt(property: Property<Any!, Int!>, values: IntArray): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder with a given property and set of int values.

@SafeVarargs
java-static fun ofKeyframe(propertyName: String, values: Array<Keyframe!>): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder object with the specified property name and set of values. These values can be of any type, but the type should be consistent so that an appropriate TypeEvaluator can be found that matches the common type.

If there is only one value, it is assumed to be the end value of an animation, and an initial value will be derived, if possible, by calling a getter function on the object. Also, if any value is null, the value will be filled in when the animation starts in the same way. This mechanism of automatically getting null values only works if the PropertyValuesHolder object is used in conjunction ObjectAnimator, and with a getter function derived automatically from propertyName, since otherwise PropertyValuesHolder has no way of determining what the value should be.

@SafeVarargs
java-static fun ofKeyframe(property: Property, values: Array<Keyframe!>): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder object with the specified property and set of values. These values can be of any type, but the type should be consistent so that an appropriate androidx.core.animation.TypeEvaluator can be found that matches the common type.

If there is only one value, it is assumed to be the end value of an animation, and an initial value will be derived, if possible, by calling the property's get function. Also, if any value is null, the value will be filled in when the animation starts in the same way. This mechanism of automatically getting null values only works if the PropertyValuesHolder object is used in conjunction with ObjectAnimator, since otherwise PropertyValuesHolder has no way of determining what the value should be.

java-static fun ofMultiFloat(propertyName: String, path: Path): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder with a given property name to use as a multi-float setter. The values are animated along the path, with the first parameter of the setter set to the x coordinate and the second set to the y coordinate.

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

Constructs and returns a PropertyValuesHolder with a given property name and set of float[] values. At least two float[] values must be supplied, a start and end value. If more values are supplied, the values will be animated from the start, through all intermediate values to the end value. When used with ObjectAnimator, the elements of the array represent the parameters of the setter function.

@SafeVarargs
java-static fun <V> ofMultiFloat(
    propertyName: String,
    converter: TypeConverter<V!, FloatArray!>,
    evaluator: TypeEvaluator<V!>,
    values: Array<V!>
): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder with a given property and set of Object values for use with ObjectAnimator multi-value setters. The Object values are converted to float[] using the converter.

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

Constructs and returns a PropertyValuesHolder object with the specified property name or setter name for use in a multi-float setter function using ObjectAnimator. The values can be of any type, but the type should be consistent so that the supplied TypeEvaluator can be used to to evaluate the animated value. The converter converts the values to parameters in the setter function.

At least two values must be supplied, a start and an end value.

java-static fun ofMultiInt(propertyName: String, path: Path): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder with a given property name to use as a multi-int setter. The values are animated along the path, with the first parameter of the setter set to the x coordinate and the second set to the y coordinate.

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

Constructs and returns a PropertyValuesHolder with a given property name and set of int[] values. At least two int[] values must be supplied, a start and end value. If more values are supplied, the values will be animated from the start, through all intermediate values to the end value. When used with ObjectAnimator, the elements of the array represent the parameters of the setter function.

@SafeVarargs
java-static fun <V> ofMultiInt(
    propertyName: String,
    converter: TypeConverter<V!, IntArray!>,
    evaluator: TypeEvaluator<V!>,
    values: Array<V!>
): PropertyValuesHolder

Constructs and returns a PropertyValuesHolder with a given property and set of Object values for use with ObjectAnimator multi-value setters. The Object values are converted to int[] using the converter.

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

Constructs and returns a PropertyValuesHolder object with the specified property name or setter name for use in a multi-int setter function using ObjectAnimator. The values can be of any type, but the type should be consistent so that the supplied TypeEvaluator can be used to to evaluate the animated value. The converter converts the values to parameters in the setter function.

At least two values must be supplied, a start and an end value.

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

Constructs and returns a PropertyValuesHolder with a given property name and a Path along which the values should be animated. This variant supports a TypeConverter to convert from PointF to the target type.

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.

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

Constructs and returns a PropertyValuesHolder with a given property name and set of Object values. This variant also takes a TypeEvaluator because the system cannot automatically interpolate between objects of unknown type.

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 PropertyValuesHolder. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

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

Constructs and returns a PropertyValuesHolder with a given property and a Path along which the values should be animated. This variant supports a TypeConverter to convert from PointF to the target type.

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.

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

Constructs and returns a PropertyValuesHolder with a given property and set of Object values. This variant also takes a TypeEvaluator because the system cannot automatically interpolate between objects of unknown type.

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 PropertyValuesHolder. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

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

Constructs and returns a PropertyValuesHolder with a given property and set of Object values. This variant also takes a TypeEvaluator because the system cannot automatically interpolate between objects of unknown type. This variant also takes a TypeConverter to convert from 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 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 PropertyValuesHolder. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

fun setConverter(converter: TypeConverter?): Unit

Sets the converter to convert from the values type to the setter's parameter type. If only one value is supplied, converter must be a BidirectionalTypeConverter.

fun setEvaluator(evaluator: TypeEvaluator): Unit

The TypeEvaluator will be automatically determined based on the type of values supplied to PropertyValuesHolder. The evaluator can be manually set, however, if so desired. This may be important in cases where either the type of the values supplied do not match the way that they should be interpolated between, or if the values are of a custom type or one not currently understood by the animation system. Currently, only values of type float and int (and their Object equivalents: Float and Integer) are correctly interpolated; all other types require setting a TypeEvaluator.

fun setFloatValues(values: FloatArray): Unit

Set the animated values for this object to this set of floats. If there is only one value, it is assumed to be the end value of an animation, and an initial value will be derived, if possible, by calling a getter function on the object. Also, if any value is null, the value will be filled in when the animation starts in the same way. This mechanism of automatically getting null values only works if the PropertyValuesHolder object is used in conjunction ObjectAnimator, and with a getter function derived automatically from propertyName, since otherwise PropertyValuesHolder has no way of determining what the value should be.

fun setIntValues(values: IntArray): Unit

Set the animated values for this object to this set of ints. If there is only one value, it is assumed to be the end value of an animation, and an initial value will be derived, if possible, by calling a getter function on the object. Also, if any value is null, the value will be filled in when the animation starts in the same way. This mechanism of automatically getting null values only works if the PropertyValuesHolder object is used in conjunction ObjectAnimator, and with a getter function derived automatically from propertyName, since otherwise PropertyValuesHolder has no way of determining what the value should be.

fun setKeyframes(values: Array<Keyframe!>): Unit

Set the animated values for this object to this set of Keyframes.

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

Set the animated values for this object to this set of Objects. If there is only one value, it is assumed to be the end value of an animation, and an initial value will be derived, if possible, by calling a getter function on the object. Also, if any value is null, the value will be filled in when the animation starts in the same way. This mechanism of automatically getting null values only works if the PropertyValuesHolder object is used in conjunction ObjectAnimator, and with a getter function derived automatically from propertyName, since otherwise PropertyValuesHolder has no way of determining what the value should be.

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 PropertyValuesHolder. If the objects will be mutated externally after this method is called, callers should pass a copy of those objects instead.

fun setProperty(property: Property): Unit

Sets the property that will be animated.

Note that if this PropertyValuesHolder object is used with ObjectAnimator, the property must exist on the target object specified in that ObjectAnimator.

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.

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.