TranslateAnimation


public class TranslateAnimation
extends Animation

java.lang.Object
   ↳ android.view.animation.Animation
     ↳ android.view.animation.TranslateAnimation


An animation that controls the position of an object. See the full package description for details and sample code.

Summary

Inherited XML attributes

android:backdropColor Special option for window animations: whether the window's background should be used as a background to the animation. 
android:detachWallpaper Special option for window animations: if this window is on top of a wallpaper, don't animate the wallpaper with it. 
android:duration Amount of time (in milliseconds) for the animation to run. 
android:fillAfter When set to true, the animation transformation is applied after the animation is over. 
android:fillBefore When set to true or when fillEnabled is not set to true, the animation transformation is applied before the animation has started. 
android:fillEnabled When set to true, the value of fillBefore is taken into account. 
android:interpolator Defines the interpolator used to smooth the animation movement in time. 
android:repeatCount Defines how many times the animation should repeat. 
android:repeatMode Defines the animation behavior when it reaches the end and the repeat count is greater than 0 or infinite. 
android:showBackdrop Special option for window animations: whether to show a background behind the animating windows. 
android:startOffset Delay in milliseconds before the animation runs, once start time is reached. 
android:zAdjustment Allows for an adjustment of the Z ordering of the content being animated for the duration of the animation. 

Inherited constants

int ABSOLUTE

The specified dimension is an absolute number of pixels.

int INFINITE

Repeat the animation indefinitely.

int RELATIVE_TO_PARENT

The specified dimension holds a float and should be multiplied by the height or width of the parent of the object being animated.

int RELATIVE_TO_SELF

The specified dimension holds a float and should be multiplied by the height or width of the object being animated.

int RESTART

When the animation reaches the end and the repeat count is INFINTE_REPEAT or a positive value, the animation restarts from the beginning.

int REVERSE

When the animation reaches the end and the repeat count is INFINTE_REPEAT or a positive value, the animation plays backward (and then forward again).

int START_ON_FIRST_FRAME

Can be used as the start time to indicate the start time should be the current time when getTransformation(long, android.view.animation.Transformation) is invoked for the first animation frame.

int ZORDER_BOTTOM

Requests that the content being animated be forced under all other content for the duration of the animation.

int ZORDER_NORMAL

Requests that the content being animated be kept in its current Z order.

int ZORDER_TOP

Requests that the content being animated be forced on top of all other content for the duration of the animation.

Public constructors

TranslateAnimation(Context context, AttributeSet attrs)

Constructor used when a TranslateAnimation is loaded from a resource.

TranslateAnimation(float fromXDelta, float toXDelta, float fromYDelta, float toYDelta)

Constructor to use when building a TranslateAnimation from code

TranslateAnimation(int fromXType, float fromXValue, int toXType, float toXValue, int fromYType, float fromYValue, int toYType, float toYValue)

Constructor to use when building a TranslateAnimation from code

Public methods

void initialize(int width, int height, int parentWidth, int parentHeight)

Initialize this animation with the dimensions of the object being animated as well as the objects parents.

Protected methods

void applyTransformation(float interpolatedTime, Transformation t)

Helper for getTransformation.

Inherited methods

void applyTransformation(float interpolatedTime, Transformation t)

Helper for getTransformation.

void cancel()

Cancel the animation.

Animation clone()

Creates and returns a copy of this object.

long computeDurationHint()

Compute a hint at how long the entire animation may last, in milliseconds.

void ensureInterpolator()

Gurantees that this animation has an interpolator.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

int getBackdropColor()

Returns the background color to show behind the animating windows.

int getBackgroundColor()

This method was deprecated in API level 30. None of window animations are running with background color.

boolean getDetachWallpaper()

This method was deprecated in API level 29. All window animations are running with detached wallpaper.

long getDuration()

How long this animation should last

boolean getFillAfter()

If fillAfter is true, this animation will apply its transformation after the end time of the animation.

boolean getFillBefore()

If fillBefore is true, this animation will apply its transformation before the start time of the animation.

Interpolator getInterpolator()

Gets the acceleration curve type for this animation.

int getRepeatCount()

Defines how many times the animation should repeat.

int getRepeatMode()

Defines what this animation should do when it reaches the end.

float getScaleFactor()

The scale factor is set by the call to getTransformation.

boolean getShowBackdrop()

If showBackdrop is true and this animation is applied on a window, then the windows in the animation will animate with the background associated with this window behind them.

long getStartOffset()

When this animation should start, relative to StartTime

long getStartTime()

When this animation should start.

boolean getTransformation(long currentTime, Transformation outTransformation, float scale)

Gets the transformation to apply at a specified point in time.

boolean getTransformation(long currentTime, Transformation outTransformation)

Gets the transformation to apply at a specified point in time.

int getZAdjustment()

Returns the Z ordering mode to use while running the animation as previously set by setZAdjustment(int).

boolean hasEnded()

Indicates whether this animation has ended or not.

boolean hasStarted()

Indicates whether this animation has started or not.

void initialize(int width, int height, int parentWidth, int parentHeight)

Initialize this animation with the dimensions of the object being animated as well as the objects parents.

boolean isFillEnabled()

If fillEnabled is true, this animation will apply the value of fillBefore.

boolean isInitialized()

Whether or not the animation has been initialized.

void reset()

Reset the initialization state of this animation.

float resolveSize(int type, float value, int size, int parentSize)

Convert the information in the description of a size to an actual dimension

void restrictDuration(long durationMillis)

Ensure that the duration that this animation will run is not longer than durationMillis.

void scaleCurrentDuration(float scale)

How much to scale the duration by.

void setAnimationListener(Animation.AnimationListener listener)

Binds an animation listener to this animation.

void setBackdropColor(int backdropColor)

Set the color to use for the backdrop shown behind the animating windows.

void setBackgroundColor(int bg)

This method was deprecated in API level 30. None of window animations are running with background color.

void setDetachWallpaper(boolean detachWallpaper)

This method was deprecated in API level 29. All window animations are running with detached wallpaper.

void setDuration(long durationMillis)

How long this animation should last.

void setFillAfter(boolean fillAfter)

If fillAfter is true, the transformation that this animation performed will persist when it is finished.

void setFillBefore(boolean fillBefore)

If fillBefore is true, this animation will apply its transformation before the start time of the animation.

void setFillEnabled(boolean fillEnabled)

If fillEnabled is true, the animation will apply the value of fillBefore.

void setInterpolator(Interpolator i)

Sets the acceleration curve for this animation.

void setInterpolator(Context context, int resID)

Sets the acceleration curve for this animation.

void setRepeatCount(int repeatCount)

Sets how many times the animation should be repeated.

void setRepeatMode(int repeatMode)

Defines what this animation should do when it reaches the end.

void setShowBackdrop(boolean showBackdrop)

If showBackdrop is true and this animation is applied on a window, then the windows in the animation will animate with the background associated with this window behind them.

void setStartOffset(long startOffset)

When this animation should start relative to the start time.

void setStartTime(long startTimeMillis)

When this animation should start.

void setZAdjustment(int zAdjustment)

Set the Z ordering mode to use while running the animation.

void start()

Convenience method to start the animation the first time getTransformation(long, android.view.animation.Transformation) is invoked.

void startNow()

Convenience method to start the animation at the current time in milliseconds.

boolean willChangeBounds()

Indicates whether or not this animation will affect the bounds of the animated view.

boolean willChangeTransformationMatrix()

Indicates whether or not this animation will affect the transformation matrix.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

TranslateAnimation

Added in API level 1
public TranslateAnimation (Context context, 
                AttributeSet attrs)

Constructor used when a TranslateAnimation is loaded from a resource.

Parameters
context Context: Application context to use

attrs AttributeSet: Attribute set from which to read values

TranslateAnimation

Added in API level 1
public TranslateAnimation (float fromXDelta, 
                float toXDelta, 
                float fromYDelta, 
                float toYDelta)

Constructor to use when building a TranslateAnimation from code

Parameters
fromXDelta float: Change in X coordinate to apply at the start of the animation

toXDelta float: Change in X coordinate to apply at the end of the animation

fromYDelta float: Change in Y coordinate to apply at the start of the animation

toYDelta float: Change in Y coordinate to apply at the end of the animation

TranslateAnimation

Added in API level 1
public TranslateAnimation (int fromXType, 
                float fromXValue, 
                int toXType, 
                float toXValue, 
                int fromYType, 
                float fromYValue, 
                int toYType, 
                float toYValue)

Constructor to use when building a TranslateAnimation from code

Parameters
fromXType int: Specifies how fromXValue should be interpreted. One of Animation.ABSOLUTE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.

fromXValue float: Change in X coordinate to apply at the start of the animation. This value can either be an absolute number if fromXType is ABSOLUTE, or a percentage (where 1.0 is 100%) otherwise.

toXType int: Specifies how toXValue should be interpreted. One of Animation.ABSOLUTE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.

toXValue float: Change in X coordinate to apply at the end of the animation. This value can either be an absolute number if toXType is ABSOLUTE, or a percentage (where 1.0 is 100%) otherwise.

fromYType int: Specifies how fromYValue should be interpreted. One of Animation.ABSOLUTE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.

fromYValue float: Change in Y coordinate to apply at the start of the animation. This value can either be an absolute number if fromYType is ABSOLUTE, or a percentage (where 1.0 is 100%) otherwise.

toYType int: Specifies how toYValue should be interpreted. One of Animation.ABSOLUTE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.

toYValue float: Change in Y coordinate to apply at the end of the animation. This value can either be an absolute number if toYType is ABSOLUTE, or a percentage (where 1.0 is 100%) otherwise.

Public methods

initialize

Added in API level 1
public void initialize (int width, 
                int height, 
                int parentWidth, 
                int parentHeight)

Initialize this animation with the dimensions of the object being animated as well as the objects parents. (This is to support animation sizes being specified relative to these dimensions.)

Objects that interpret Animations should call this method when the sizes of the object being animated and its parent are known, and before calling getTransformation(long, Transformation).

Parameters
width int: Width of the object being animated

height int: Height of the object being animated

parentWidth int: Width of the animated object's parent

parentHeight int: Height of the animated object's parent

Protected methods

applyTransformation

Added in API level 1
protected void applyTransformation (float interpolatedTime, 
                Transformation t)

Helper for getTransformation. Subclasses should implement this to apply their transforms given an interpolation value. Implementations of this method should always replace the specified Transformation or document they are doing otherwise.

Parameters
interpolatedTime float: The value of the normalized time (0.0 to 1.0) after it has been run through the interpolation function.

t Transformation: The Transformation object to fill in with the current transforms.