PropKey

Kotlin |Java

interface PropKey<T, V : AnimationVector>

androidx.animation.PropKey

Known Direct Subclasses

ColorPropKey, DpPropKey, FloatPropKey, IntPropKey, PxPositionPropKey, PxPropKey, RectPropKey

ColorPropKey	Built-in property key for Color properties.
DpPropKey	Built-in property key for Dp properties.
FloatPropKey	Built-in property key for Float properties.
IntPropKey	Built-in property key for Int properties.
PxPositionPropKey	Built-in property key for PxPosition properties.
PxPropKey	Built-in property key for Px properties.
RectPropKey	Built-in property key for Rect properties.

Property key of T type.

PropKeys are used when defining a TransitionDefinition, as a part of creating a state-based animation. Each property (to be animated) needs to be associated with a PropKey of the type of the property. For example, this creates an alpha property: val alpha = FloatPropKey(). PropKeys for common data types are provided out of the box: such as androidx.ui.animation.DpPropKey, androidx.ui.animation.PxPositionPropKey, etc. To create a custom PropKey of type T, a typeConverter needs to be supplied to define how the animated data type can be converted to and from an AnimationVector, so that animations can support multi-dimensional data types.

Summary

Properties
open String	`label` A label for distinguishing different prop keys in Tools (i.
abstract TwoWayConverter<T, V>	`typeConverter` A TwoWayConverter that converts T (the data type to be animated) to and from V (any subclass of AnimationVector).

Properties

label

open val label: String

A label for distinguishing different prop keys in Tools (i.e. Android Studio).

typeConverter

abstract val typeConverter: TwoWayConverter<T, V>

A TwoWayConverter that converts T (the data type to be animated) to and from V (any subclass of AnimationVector).