1 /*
2  * Copyright 2019 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package androidx.compose.animation.core
18 
19 /** Possible reasons for [Animatable]s to end. */
20 public enum class AnimationEndReason {
21     /**
22      * Animation will be forced to end when its value reaches upper/lower bound (if they have been
23      * defined, e.g. via [Animatable.updateBounds])
24      *
25      * Unlike [Finished], when an animation ends due to [BoundReached], it often falls short from
26      * its initial target, and the remaining velocity is often non-zero. Both the end value and the
27      * remaining velocity can be obtained via [AnimationResult].
28      */
29     BoundReached,
30     /** Animation has finished successfully without any interruption. */
31     Finished
32 }
33