mosaic-animation/com.jakewharton.mosaic.animation/DecayAnimation

DecayAnimation

class DecayAnimation<T, V : AnimationVector>(animationSpec: VectorizedDecayAnimationSpec<V>, val typeConverter: TwoWayConverter<T, V>, val initialValue: T, initialVelocityVector: V) : Animation<T, V>

DecayAnimation is an animation that slows down from initialVelocityVector as time goes on. DecayAnimation is stateless, and it does not have any concept of lifecycle. It serves as an animation calculation engine that supports convenient query of value/velocity given a play time. To achieve that, DecayAnimation stores all the animation related information: initialValue, initialVelocityVector, decay animation spec, typeConverter.

Note: Unless there's a need to control the timing manually, it's generally recommended to use higher level animation APIs that build on top DecayAnimation, such as com.jakewharton.mosaic.animation.Animatable.animateDecay, com.jakewharton.mosaic.animation.animateDecay, etc.

Constructors

DecayAnimation

constructor(animationSpec: DecayAnimationSpec<T>, typeConverter: TwoWayConverter<T, V>, initialValue: T, initialVelocityVector: V)

constructor(animationSpec: DecayAnimationSpec<T>, typeConverter: TwoWayConverter<T, V>, initialValue: T, initialVelocity: T)

DecayAnimation is an animation that slows down from initialVelocity as time goes on. DecayAnimation is stateless, and it does not have any concept of lifecycle. It serves as an animation calculation engine that supports convenient query of value/velocity given a play time. To achieve that, DecayAnimation stores all the animation related information: initialValue, initialVelocity, animationSpec, typeConverter.

constructor(animationSpec: VectorizedDecayAnimationSpec<V>, typeConverter: TwoWayConverter<T, V>, initialValue: T, initialVelocityVector: V)

Properties

durationNanos

open override val durationNanos: Long

This amount of time in nanoseconds that the animation will run before it finishes

initialValue

val initialValue: T

initialVelocityVector

val initialVelocityVector: V

isInfinite

open override val isInfinite: Boolean = false

Whether or not the Animation represents an infinite animation. That is, one that will not finish by itself, one that needs an external action to stop. For examples, an indeterminate progress bar, which will only stop when it is removed from the composition.

targetValue

open override val targetValue: T

This is the value that the Animation will reach when it finishes uninterrupted.

typeConverter

open override val typeConverter: TwoWayConverter<T, V>

The com.jakewharton.mosaic.animation.TwoWayConverter that will be used to convert value/velocity from any arbitrary data type to AnimationVector. This makes it possible to animate different dimensions of the data object independently (e.g. x/y dimensions of the position data).