mosaic-animation/com.jakewharton.mosaic.animation/AnimationScope

AnimationScope

class AnimationScope<T, V : AnimationVector>

AnimationScope provides all the animation related info specific to an animation run. An AnimationScope will be accessible during an animation.

See also

Properties

Link copied to clipboard
var finishedTimeNanos: Long

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

Link copied to clipboard
var isRunning: Boolean

Indicates whether the animation is currently running.

Link copied to clipboard
var lastFrameTimeNanos: Long

Last frame time of the animation.

Link copied to clipboard
val startTimeNanos: Long

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

Link copied to clipboard
val targetValue: T

Target value of the animation.

Link copied to clipboard
Link copied to clipboard
var value: T

Current value of the AnimationScope.

Link copied to clipboard
val velocity: T

Velocity of type T, converted from velocityVector.

Link copied to clipboard
var velocityVector: V

Current velocity vector of the AnimationScope.

Functions

Link copied to clipboard
fun cancelAnimation()

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

Link copied to clipboard
fun toAnimationState(): AnimationState<T, V>

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