{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

AnimationEndReason

public enum AnimationEndReason extends Enum

java.lang.Object
   ↳ kotlin.Enum
     ↳ androidx.compose.animation.core.AnimationEndReason

Possible reasons for Animatables to end.

Summary

Enum Values

BoundReached

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

Finished

Animation has finished successfully without any interruption.

Public methods

final @NonNull EnumEntries<@NonNull AnimationEndReason>

Possible reasons for Animatables to end.

final @NonNull AnimationEndReason

Returns the enum constant of this type with the specified name.

final @NonNull AnimationEndReason[]

Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

BoundReached

AnimationEndReason AnimationEndReason.BoundReached

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

Unlike Finished, 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 AnimationResult.

Finished

AnimationEndReason AnimationEndReason.Finished

Animation has finished successfully without any interruption.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull AnimationEndReasongetEntries()

Possible reasons for Animatables to end.

valueOf

public final @NonNull AnimationEndReason valueOf(@NonNull String value)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

public final @NonNull AnimationEndReason[] values()

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.