mosaic-animation/com.jakewharton.mosaic.animation/TargetBasedAnimation

TargetBasedAnimation

class TargetBasedAnimation<T, V : AnimationVector> : Animation<T, V>

This is a convenient animation wrapper class that works for all target based animations, i.e. animations that has a pre-defined end value, unlike decay.

It assumes that the starting value and velocity, as well as ending value do not change throughout the animation, and cache these values. This caching enables much more convenient query for animation value and velocity (where only playtime needs to be passed into the methods).

Note: When interruptions happen to the TargetBasedAnimation, a new instance should be created that use the current value and velocity as the starting conditions. This type of interruption handling is the default behavior for both com.jakewharton.mosaic.animation.Animatable and com.jakewharton.mosaic.animation.Transition. Consider using those APIs for the interruption handling, as well as built-in animation lifecycle management.

Parameters

animationSpec

the com.jakewharton.mosaic.animation.VectorizedAnimationSpec that will be used to calculate value/velocity

initialValue

the start value of the animation

targetValue

the end value of the animation

typeConverter

the com.jakewharton.mosaic.animation.TwoWayConverter that is used to convert animation type T from/to V

initialVelocityVector

the start velocity of the animation in the form of AnimationVector

Constructors

TargetBasedAnimation

constructor(animationSpec: AnimationSpec<T>, typeConverter: TwoWayConverter<T, V>, initialValue: T, targetValue: T, initialVelocityVector: V? = null)

Creates a TargetBasedAnimation with the given start/end conditions of the animation, and the provided animationSpec.

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

isInfinite

open override val isInfinite: Boolean

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