AnimationEndReason

Kotlin |Java

enum class AnimationEndReason

kotlin.Any
↳	kotlin.Enum<androidx.compose.animation.core.AnimationEndReason>
	↳	androidx.compose.animation.core.AnimationEndReason

Known Direct Subclasses AnimationEndReason.BoundReached, AnimationEndReason.Interrupted, AnimationEndReason.TargetReached AnimationEndReason.BoundReached Animation will be forced to end when its value reaches upper/lower bound (if they have been defined, e. AnimationEndReason.Interrupted Animation was interrupted, e. AnimationEndReason.TargetReached Animation has successfully reached the BaseAnimatedValue.targetValue value and come to stop

Possible reasons with which DynamicTargetAnimation can finish

Summary

Enum values
BoundReached Animation will be forced to end when its value reaches upper/lower bound (if they have been defined, e.
Interrupted Animation was interrupted, e.
TargetReached Animation has successfully reached the BaseAnimatedValue.targetValue value and come to stop

Enum values

BoundReached

enum val BoundReached : AnimationEndReason

Animation will be forced to end when its value reaches upper/lower bound (if they have been defined, e.g via AnimatedFloat.setBounds)

Unlike TargetReached, when an animation ends due to BoundReached, it often falls short from its initial target, and the remaining velocity is often non-zero. Both the end value and the remaining velocity can be obtained via onEnd param in AnimatedFloat.fling callback

Interrupted

enum val Interrupted : AnimationEndReason

Animation was interrupted, e.g by another animation

TargetReached

enum val TargetReached : AnimationEndReason

Animation has successfully reached the BaseAnimatedValue.targetValue value and come to stop