FlingAnimation

public final class FlingAnimation
extends DynamicAnimation<FlingAnimation>

java.lang.Object
   ↳ androidx.dynamicanimation.animation.DynamicAnimation<androidx.dynamicanimation.animation.FlingAnimation>
     ↳ androidx.dynamicanimation.animation.FlingAnimation


Fling animation is an animation that continues an initial momentum (most often from gesture velocity) and gradually slows down. The fling animation will come to a stop when the velocity of the animation is below the threshold derived from DynamicAnimation.setMinimumVisibleChange(float), or when the value of the animation has gone beyond the min or max value defined via DynamicAnimation.setMinValue(float) or DynamicAnimation.setMaxValue(float). It is recommended to restrict the fling animation with min and/or max value, such that the animation can end when it goes beyond screen bounds, thus preserving CPU cycles and resources.

For example, you can create a fling animation that animates the translationX of a view:

 FlingAnimation flingAnim = new FlingAnimation(view, DynamicAnimation.TRANSLATION_X)
         // Sets the start velocity to -2000 (pixel/s)
         .setStartVelocity(-2000)
         // Optional but recommended to set a reasonable min and max range for the animation.
         // In this particular case, we set the min and max to -200 and 2000 respectively.
         .setMinValue(-200).setMaxValue(2000);
 flingAnim.start();
 

Summary

Inherited constants

Inherited fields

Public constructors

FlingAnimation(FloatValueHolder floatValueHolder)

This creates a FlingAnimation that animates a FloatValueHolder instance.

FlingAnimation(K object, FloatPropertyCompat<K> property)

This creates a FlingAnimation that animates the property of the given object.

Public methods

float getFriction()

Returns the friction being set on the animation via setFriction(float).

FlingAnimation setFriction(float friction)

Sets the friction for the fling animation.

FlingAnimation setMaxValue(float maxValue)

Sets the max value of the animation.

FlingAnimation setMinValue(float minValue)

Sets the min value of the animation.

FlingAnimation setStartVelocity(float startVelocity)

Start velocity of the animation.

Inherited methods