added in version 25.4.0
belongs to Maven artifact com.android.support:support-dynamic-animation:28.0.0-alpha1

Summary: Inherited Constants | Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

FlingAnimation

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public final class FlingAnimation
extends DynamicAnimation<FlingAnimation>

java.lang.Object
↳	android.support.animation.DynamicAnimation<android.support.animation.FlingAnimation>
	↳	android.support.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 setMinimumVisibleChange(float), or when the value of the animation has gone beyond the min or max value defined via setMinValue(float) or 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

From class android.support.animation.DynamicAnimation float MIN_VISIBLE_CHANGE_ALPHA The minimum visible change in alpha that can be visible to users. float MIN_VISIBLE_CHANGE_PIXELS The minimum visible change in pixels that can be visible to users. float MIN_VISIBLE_CHANGE_ROTATION_DEGREES The minimum visible change in degrees that can be visible to users. float MIN_VISIBLE_CHANGE_SCALE The minimum visible change in scale that can be visible to users.

Inherited fields

From class android.support.animation.DynamicAnimation public static final DynamicAnimation.ViewProperty ALPHA View's alpha property. public static final DynamicAnimation.ViewProperty ROTATION View's rotation property. public static final DynamicAnimation.ViewProperty ROTATION_X View's rotationX property. public static final DynamicAnimation.ViewProperty ROTATION_Y View's rotationY property. public static final DynamicAnimation.ViewProperty SCALE_X View's scaleX property. public static final DynamicAnimation.ViewProperty SCALE_Y View's scaleY property. public static final DynamicAnimation.ViewProperty SCROLL_X View's scrollX property. public static final DynamicAnimation.ViewProperty SCROLL_Y View's scrollY property. public static final DynamicAnimation.ViewProperty TRANSLATION_X View's translationX property. public static final DynamicAnimation.ViewProperty TRANSLATION_Y View's translationY property. public static final DynamicAnimation.ViewProperty TRANSLATION_Z View's translationZ property. public static final DynamicAnimation.ViewProperty X View's x property. public static final DynamicAnimation.ViewProperty Y View's y property. public static final DynamicAnimation.ViewProperty Z View's z property.

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
From class android.support.animation.DynamicAnimation T addEndListener(DynamicAnimation.OnAnimationEndListener listener) Adds an end listener to the animation for receiving onAnimationEnd callbacks. T addUpdateListener(DynamicAnimation.OnAnimationUpdateListener listener) Adds an update listener to the animation for receiving per-frame animation update callbacks. void cancel() Cancels the on-going animation. float getMinimumVisibleChange() Returns the minimum change in the animation property that could be visibly different to users. boolean isRunning() Returns whether the animation is currently running. void removeEndListener(DynamicAnimation.OnAnimationEndListener listener) Removes the end listener from the animation, so as to stop receiving animation end callbacks. void removeUpdateListener(DynamicAnimation.OnAnimationUpdateListener listener) Removes the update listener from the animation, so as to stop receiving animation update callbacks. T setMaxValue(float max) Sets the max value of the animation. T setMinValue(float min) Sets the min value of the animation. T setMinimumVisibleChange(float minimumVisibleChange) This method sets the minimal change of animation value that is visible to users, which helps determine a reasonable threshold for the animation's termination condition. T setStartValue(float startValue) Sets the start value of the animation. T setStartVelocity(float startVelocity) Start velocity of the animation. void start() Starts an animation.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public constructors

FlingAnimation

added in version 25.4.0

FlingAnimation (FloatValueHolder floatValueHolder)

This creates a FlingAnimation that animates a FloatValueHolder instance. During the animation, the FloatValueHolder instance will be updated via setValue(float) each frame. The caller can obtain the up-to-date animation value via getValue().

Note: changing the value in the FloatValueHolder via setValue(float) outside of the animation during an animation run will not have any effect on the on-going animation.

Parameters
floatValueHolder	FloatValueHolder: the property to be animated

FlingAnimation

added in version 25.4.0

FlingAnimation (K object, 
                FloatPropertyCompat<K> property)

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

Parameters
object	K: the Object whose property will be animated
property	FloatPropertyCompat: the property to be animated

Public methods

getFriction

added in version 25.4.0

float getFriction ()

Returns the friction being set on the animation via setFriction(float). If the friction has not been set, the default friction of 1 will be returned.

Returns
float	friction being used in the animation

setFriction

added in version 25.4.0

FlingAnimation setFriction (float friction)

Sets the friction for the fling animation. The greater the friction is, the sooner the animation will slow down. When not set, the friction defaults to 1.

Parameters
friction	float: the friction used in the animation Value is 0.0 or greater.

Returns
FlingAnimation	the animation whose friction will be scaled

Throws
IllegalArgumentException	if the input friction is not positive

setMaxValue

added in version 25.4.0

FlingAnimation setMaxValue (float maxValue)

Sets the max value of the animation. When a fling animation reaches the max value, the animation will end immediately. Animations will not animate beyond the max value.

Parameters
maxValue	float: maximum value of the property to be animated

Returns
FlingAnimation	the Animation whose max value is being set

setMinValue

added in version 25.4.0

FlingAnimation setMinValue (float minValue)

Sets the min value of the animation. When a fling animation reaches the min value, the animation will end immediately. Animations will not animate beyond the min value.

Parameters
minValue	float: minimum value of the property to be animated

Returns
FlingAnimation	the Animation whose min value is being set

setStartVelocity

added in version 25.4.0

FlingAnimation setStartVelocity (float startVelocity)

Start velocity of the animation. Default velocity is 0. Unit: pixel/second

A non-zero start velocity is required for a FlingAnimation. If no start velocity is set through setStartVelocity(float), the start velocity defaults to 0. In that case, the fling animation will consider itself done in the next frame.

Note when using a fixed value as the start velocity (as opposed to getting the velocity through touch events), it is recommended to define such a value in dp/second and convert it to pixel/second based on the density of the screen to achieve a consistent look across different screens.

To convert from dp/second to pixel/second:

 float pixelPerSecond = TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, dpPerSecond,
         getResources().getDisplayMetrics());
 

Parameters
startVelocity	float: start velocity of the animation in pixel/second

Returns
FlingAnimation	the Animation whose start velocity is being set

• Interfaces

  • DynamicAnimation.OnAnimationEndListener
  • DynamicAnimation.OnAnimationUpdateListener

• Classes

  • DynamicAnimation
  • DynamicAnimation.ViewProperty
  • FlingAnimation
  • FloatPropertyCompat
  • FloatValueHolder
  • SpringAnimation
  • SpringForce