AnimationScope

fun cancelAnimation(): Unit

Cancels the animation that this AnimationScope corresponds to. The scope will not be updated any more after cancelAnimation is called.

fun toAnimationState(): AnimationState<T, V>

Creates an AnimationState that populates all the fields in AnimationState from AnimationScope.

val finishedTimeNanos: Long

The time when the animation finished successfully in the System.nanoTime timebase.

If the animation has never finished (i.e. currently running, interrupted, or never started), this will be AnimationConstants.UnspecifiedTime, unless specified otherwise in AnimationState constructor.

val isRunning: Boolean

Indicates whether the animation is currently running.

val lastFrameTimeNanos: Long

Last frame time of the animation.

If the animation has never started, this will be AnimationConstants.UnspecifiedTime, unless specified otherwise in the AnimationState constructor. lastFrameTimeNanos is the frame time when the animation is last updated, in the System.nanoTime timebase. It is also used for starting a sequential animation in AnimationState.animateTo. This allows the sequential animation to set its start time to when the previous animation is interrupted or finished.

val startTimeNanos: Long

Start time of the animation in the System.nanoTime timebase.

val targetValue: T

Target value of the animation.

val typeConverter: TwoWayConverter<T, V>

TwoWayConverter to convert type T from and to AnimationVector.

val value: T

Current value of the AnimationScope.

val velocity: T

Velocity of type T, converted from velocityVector.

val velocityVector: V

Current velocity vector of the AnimationScope.