mosaic-animation/com.jakewharton.mosaic.animation/DecayAnimationSpec

DecayAnimationSpec

interface DecayAnimationSpec<T>

DecayAnimationSpec stores the specification of an animation, including 1) the data type to be animated, and 2) the animation configuration (i.e. com.jakewharton.mosaic.animation.VectorizedDecayAnimationSpec) that will be used once the data (of type T) has been converted to AnimationVector.

Any type T can be animated by the system as long as a com.jakewharton.mosaic.animation.TwoWayConverter is supplied to convert the data type T from and to an AnimationVector. There are a number of converters available out of the box. For example, to animate IntOffset the system uses IntOffset.Companion.VectorConverter to convert the object to AnimationVector2D, so that both x and y dimensions are animated independently with separate velocity tracking. This enables multidimensional objects to be animated in a true multi-dimensional way. It is particularly useful for smoothly handling animation interruptions (such as when the target changes during the animation).

Functions

Link copied to clipboard
fun DecayAnimationSpec<Float>.calculateTargetValue(initialValue: Float, initialVelocity: Float): Float

Calculates the target value of a Float decay animation based on the initialValue and initialVelocity.

fun <T, V : AnimationVector> DecayAnimationSpec<T>.calculateTargetValue(typeConverter: TwoWayConverter<T, V>, initialValue: T, initialVelocity: T): T

Calculates the target value of a decay animation based on the initialValue and initialVelocity, and the typeConverter that converts the given type T to AnimationVector.

Link copied to clipboard