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

AnimationResult

public final class AnimationResult<T extends Object, V extends AnimationVector>


AnimationResult contains information about an animation at the end of the animation. endState captures the value/velocity/frame time, etc of the animation at its last frame. It can be useful for starting another animation to continue the velocity from the previously interrupted animation. endReason describes why the animation ended, it could be either of the following:

import androidx.compose.animation.core.Animatable
import androidx.compose.animation.core.AnimationEndReason
import androidx.compose.animation.core.exponentialDecay
import androidx.compose.ui.geometry.Offset
import androidx.compose.ui.geometry.Size

suspend fun CoroutineScope.animateBouncingOffBounds(
    animatable: Animatable<Offset, *>,
    flingVelocity: Offset,
    parentSize: Size
) {
    launch {
        var startVelocity = flingVelocity
        // Set bounds for the animation, so that when it reaches bounds it will stop
        // immediately. We can then inspect the returned `AnimationResult` and decide whether
        // we should start another animation.
        animatable.updateBounds(Offset(0f, 0f), Offset(parentSize.width, parentSize.height))
        do {
            val result = animatable.animateDecay(startVelocity, exponentialDecay())
            // Copy out the end velocity of the previous animation.
            startVelocity = result.endState.velocity

            // Negate the velocity for the dimension that hits the bounds, to create a
            // bouncing off the bounds effect.
            with(animatable) {
                if (value.x == upperBound?.x || value.x == lowerBound?.x) {
                    // x dimension hits bounds
                    startVelocity = startVelocity.copy(x = -startVelocity.x)
                }
                if (value.y == upperBound?.y || value.y == lowerBound?.y) {
                    // y dimension hits bounds
                    startVelocity = startVelocity.copy(y = -startVelocity.y)
                }
            }
            // Repeat the animation until the animation ends for reasons other than hitting
            // bounds, e.g. if `stop()` is called, or preempted by another animation.
        } while (result.endReason == AnimationEndReason.BoundReached)
    }
}

Summary

Public constructors

<T extends Object, V extends AnimationVector> AnimationResult(
    @NonNull AnimationState<@NonNull T, @NonNull V> endState,
    @NonNull AnimationEndReason endReason
)

Public methods

final @NonNull AnimationEndReason

The reason why the animation has ended.

final @NonNull AnimationState<@NonNull T, @NonNull V>

The state of the animation in its last frame before it's canceled or reset.

@NonNull String

Public constructors

AnimationResult

public <T extends Object, V extends AnimationVector> AnimationResult(
    @NonNull AnimationState<@NonNull T, @NonNull V> endState,
    @NonNull AnimationEndReason endReason
)

Public methods

getEndReason

public final @NonNull AnimationEndReason getEndReason()

The reason why the animation has ended. Could be either of the following:

getEndState

public final @NonNull AnimationState<@NonNull T, @NonNull V> getEndState()

The state of the animation in its last frame before it's canceled or reset. This captures the animation value/velocity/frame time, etc at the point of interruption, or before the velocity is reset when the animation finishes successfully.

toString

public @NonNull String toString()