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

DynamicAnimation

public abstract class DynamicAnimation
extends Object

java.lang.Object
   ↳ android.support.animation.DynamicAnimation<T extends android.support.animation.DynamicAnimation<T>>
Known Direct Subclasses


This class is the base class of physics-based animations. It manages the animation's lifecycle such as start() and cancel(). This base class also handles the common setup for all the subclass animations. For example, DynamicAnimation supports adding DynamicAnimation.OnAnimationEndListener and DynamicAnimation.OnAnimationUpdateListener so that the important animation events can be observed through the callbacks. The start conditions for any subclass of DynamicAnimation can be set using setStartValue(float) and setStartVelocity(float).

Summary

Nested classes

interface DynamicAnimation.OnAnimationEndListener

An animation listener that receives end notifications from an animation. 

interface DynamicAnimation.OnAnimationUpdateListener

Implementors of this interface can add themselves as update listeners to an DynamicAnimation instance to receive callbacks on every animation frame, after the current frame's values have been calculated for that DynamicAnimation

class DynamicAnimation.ViewProperty

ViewProperty holds the access of a property of a View

Constants

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.

Fields

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 methods

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.

Inherited methods

From class java.lang.Object

Constants

MIN_VISIBLE_CHANGE_ALPHA

added in version 25.4.0
float MIN_VISIBLE_CHANGE_ALPHA

The minimum visible change in alpha that can be visible to users.

Constant Value: 0.00390625

MIN_VISIBLE_CHANGE_PIXELS

added in version 25.4.0
float MIN_VISIBLE_CHANGE_PIXELS

The minimum visible change in pixels that can be visible to users.

Constant Value: 1.0

MIN_VISIBLE_CHANGE_ROTATION_DEGREES

added in version 25.4.0
float MIN_VISIBLE_CHANGE_ROTATION_DEGREES

The minimum visible change in degrees that can be visible to users.

Constant Value: 0.1

MIN_VISIBLE_CHANGE_SCALE

added in version 25.4.0
float MIN_VISIBLE_CHANGE_SCALE

The minimum visible change in scale that can be visible to users.

Constant Value: 0.002

Fields

ALPHA

added in version 25.4.0
DynamicAnimation.ViewProperty ALPHA

View's alpha property.

ROTATION

added in version 25.4.0
DynamicAnimation.ViewProperty ROTATION

View's rotation property.

ROTATION_X

added in version 25.4.0
DynamicAnimation.ViewProperty ROTATION_X

View's rotationX property.

ROTATION_Y

added in version 25.4.0
DynamicAnimation.ViewProperty ROTATION_Y

View's rotationY property.

SCALE_X

added in version 25.4.0
DynamicAnimation.ViewProperty SCALE_X

View's scaleX property.

SCALE_Y

added in version 25.4.0
DynamicAnimation.ViewProperty SCALE_Y

View's scaleY property.

SCROLL_X

added in version 25.4.0
DynamicAnimation.ViewProperty SCROLL_X

View's scrollX property.

SCROLL_Y

added in version 25.4.0
DynamicAnimation.ViewProperty SCROLL_Y

View's scrollY property.

TRANSLATION_X

added in version 25.4.0
DynamicAnimation.ViewProperty TRANSLATION_X

View's translationX property.

TRANSLATION_Y

added in version 25.4.0
DynamicAnimation.ViewProperty TRANSLATION_Y

View's translationY property.

TRANSLATION_Z

added in version 25.4.0
DynamicAnimation.ViewProperty TRANSLATION_Z

View's translationZ property.

X

added in version 25.4.0
DynamicAnimation.ViewProperty X

View's x property.

Y

added in version 25.4.0
DynamicAnimation.ViewProperty Y

View's y property.

Z

added in version 25.4.0
DynamicAnimation.ViewProperty Z

View's z property.

Public methods

addEndListener

added in version 25.4.0
T addEndListener (DynamicAnimation.OnAnimationEndListener listener)

Adds an end listener to the animation for receiving onAnimationEnd callbacks. If the listener is null or has already been added to the list of listeners for the animation, no op.

Parameters
listener DynamicAnimation.OnAnimationEndListener: the listener to be added

Returns
T the animation to which the listener is added

addUpdateListener

added in version 25.4.0
T addUpdateListener (DynamicAnimation.OnAnimationUpdateListener listener)

Adds an update listener to the animation for receiving per-frame animation update callbacks. If the listener is null or has already been added to the list of listeners for the animation, no op.

Note that update listener should only be added before the start of the animation.

Parameters
listener DynamicAnimation.OnAnimationUpdateListener: the listener to be added

Returns
T the animation to which the listener is added

Throws
UnsupportedOperationException if the update listener is added after the animation has started

cancel

added in version 25.4.0
void cancel ()

Cancels the on-going animation. If the animation hasn't started, no op. Note that this method should only be called on main thread.

Throws
AndroidRuntimeException if this method is not called on the main thread

getMinimumVisibleChange

added in version 25.4.0
float getMinimumVisibleChange ()

Returns the minimum change in the animation property that could be visibly different to users.

Returns
float minimum change in property value that is visible to users

isRunning

added in version 25.4.0
boolean isRunning ()

Returns whether the animation is currently running.

Returns
boolean true if the animation is currently running, false otherwise

removeEndListener

added in version 25.4.0
void removeEndListener (DynamicAnimation.OnAnimationEndListener listener)

Removes the end listener from the animation, so as to stop receiving animation end callbacks.

Parameters
listener DynamicAnimation.OnAnimationEndListener: the listener to