AnimationDrawable

Kotlin |Java

open class AnimationDrawable : DrawableContainer, Runnable, Animatable

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.DrawableContainer
		↳	android.graphics.drawable.AnimationDrawable

An object used to create frame-by-frame animations, defined by a series of Drawable objects, which can be used as a View object's background.

The simplest way to create a frame-by-frame animation is to define the animation in an XML file, placed in the res/drawable/ folder, and set it as the background to a View object. Then, call start() to run the animation.

An AnimationDrawable defined in XML consists of a single <animation-list> element and a series of nested <item> tags. Each item defines a frame of the animation. See the example below.

spin_animation.xml file in res/drawable/ folder:

<!-- Animation frames are wheel0.png through wheel5.png
      files inside the res/drawable/ folder -->
  <animation-list android:id="@+id/selected" android:oneshot="false">
     <item android:drawable="@drawable/wheel0" android:duration="50" />
     <item android:drawable="@drawable/wheel1" android:duration="50" />
     <item android:drawable="@drawable/wheel2" android:duration="50" />
     <item android:drawable="@drawable/wheel3" android:duration="50" />
     <item android:drawable="@drawable/wheel4" android:duration="50" />
     <item android:drawable="@drawable/wheel5" android:duration="50" />
  </animation-list>

Here is the code to load and play this animation.

// Load the ImageView that will host the animation and
  // set its background to our AnimationDrawable XML resource.
  ImageView img = (ImageView)findViewById(R.id.spinning_wheel_image);
  img.setBackgroundResource(R.drawable.spin_animation);
 
  // Get the background, which has been compiled to an AnimationDrawable object.
  AnimationDrawable frameAnimation = (AnimationDrawable) img.getBackground();
 
  // Start the animation (looped playback by default).
  frameAnimation.start();

Summary

XML attributes
`android:drawable`	Reference to a drawable resource to use for the frame.
`android:duration`	Amount of time (in milliseconds) to display this frame.
`android:oneshot`	If true, the animation will only run a single time and then stop.
`android:variablePadding`	If true, allows the drawable's padding to change based on the current state that is selected.
`android:visible`	Provides initial visibility state of the drawable; the default value is false.

Public constructors
`AnimationDrawable()`

Public methods
open Unit	`addFrame(frame: Drawable, duration: Int)` Adds a frame to the animation
open Int	`getDuration(i: Int)`
open Drawable!	`getFrame(index: Int)`
open Int	`getNumberOfFrames()`
open Unit	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)`
open Boolean	`isOneShot()`
open Boolean	`isRunning()` Indicates whether the animation is currently running or not.
open Drawable	`mutate()` Make this drawable mutable.
open Unit	`run()` This method exists for implementation purpose only and should not be called directly.
open Unit	`setOneShot(oneShot: Boolean)` Sets whether the animation should play once or repeat.
open Boolean	`setVisible(visible: Boolean, restart: Boolean)` Sets whether this AnimationDrawable is visible.
open Unit	`start()` Starts the animation from the first frame, looping if necessary.
open Unit	`stop()` Stops the animation at the current frame.
open Unit	`unscheduleSelf(what: Runnable)`

Protected methods
open Unit	`setConstantState(state: DrawableContainer.DrawableContainerState)`

Inherited functions

From class DrawableContainer

`Unit`	`applyTheme(theme: Resources.Theme)`
`Boolean`	`canApplyTheme()`
`Unit`	`draw(canvas: Canvas)`
`Int`	`getAlpha()`
`Int`	`getChangingConfigurations()` Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. The default implementation returns whatever was provided through `setChangingConfigurations(int)` or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.
`Drawable.ConstantState?`	`getConstantState()`
`Drawable`	`getCurrent()`
`Unit`	`getHotspotBounds(outRect: Rect)`
`Int`	`getIntrinsicHeight()`
`Int`	`getIntrinsicWidth()`
`Int`	`getMinimumHeight()`
`Int`	`getMinimumWidth()`
`Int`	`getOpacity()`
`Insets`	`getOpticalInsets()`
`Unit`	`getOutline(outline: Outline)` Called to get the drawable to populate the Outline that defines its drawing area. This method is called by the default `android.view.ViewOutlineProvider` to define the outline of the View. The default behavior defines the outline to be the bounding rectangle of 0 alpha. Subclasses that wish to convey a different shape or alpha value must override this method.
`Boolean`	`getPadding(padding: Rect)`
`Boolean`	`hasFocusStateSpecified()`
`Unit`	`invalidateDrawable(who: Drawable)` Called when the drawable needs to be redrawn. A view at this point should invalidate itself (or at least the part of itself where the drawable appears).
`Boolean`	`isAutoMirrored()`
`Boolean`	`isStateful()`
`Unit`	`jumpToCurrentState()`
`Unit`	`onBoundsChange(bounds: Rect)`
`Boolean`	`onLayoutDirectionChanged(layoutDirection: Int)` Called when the drawable's resolved layout direction changes.
`Boolean`	`onLevelChange(level: Int)`
`Boolean`	`onStateChange(state: IntArray)`
`Unit`	`scheduleDrawable(who: Drawable, what: Runnable, when: Long)` A Drawable can call this to schedule the next frame of its animation. An implementation can generally simply call `android.os.Handler#postAtTime(Runnable, Object, long)` with the parameters (what, who, when) to perform the scheduling.
`Boolean`	`selectDrawable(index: Int)` Sets the currently displayed drawable by index. If an invalid index is specified, the current drawable will be set to `null` and the index will be set to `-1`.
`Unit`	`setAlpha(alpha: Int)`
`Unit`	`setAutoMirrored(mirrored: Boolean)`
`Unit`	`setColorFilter(colorFilter: ColorFilter?)`
`Unit`	`setDither(dither: Boolean)`
`Unit`	`setEnterFadeDuration(ms: Int)` Change the global fade duration when a new drawable is entering the scene.
`Unit`	`setExitFadeDuration(ms: Int)` Change the global fade duration when a new drawable is leaving the scene.
`Unit`	`setHotspot(x: Float, y: Float)`
`Unit`	`setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`setTintBlendMode(blendMode: BlendMode!)` Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is `BlendMode#SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)`
`Unit`	`setTintList(tint: ColorStateList?)`
`Unit`	`unscheduleDrawable(who: Drawable, what: Runnable)` A Drawable can call this to unschedule an action previously scheduled with `scheduleDrawable`. An implementation can generally simply call `android.os.Handler#removeCallbacks(Runnable, Object)` with the parameters (what, who) to unschedule the drawable.

From class Drawable

`Unit`	`clearColorFilter()` Removes the color filter for this drawable.
`Unit`	`copyBounds(bounds: Rect)` Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called.
`Rect`	`copyBounds()` Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect).
`Drawable?`	`createFromPath(pathName: String!)` Create a drawable from file path name.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`Drawable?`	`createFromStream(is: InputStream?, srcName: String?)` Create a drawable from an inputstream
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser)` Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?)` Create a drawable from an XML document using an optional `Theme`. For more information on how to create resources in XML, see Drawable Resources.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Create from inside an XML document. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.
`Drawable`	`createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Create a drawable from inside an XML document using an optional `Theme`. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns `null` if the tag is not a valid drawable.
`Rect`	`getBounds()` Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable.
`Drawable.Callback?`	`getCallback()` Return the current `Callback` implementation attached to this Drawable.
`ColorFilter?`	`getColorFilter()` Returns the current color filter, or `null` if none set.
`Rect`	`getDirtyBounds()` Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed). By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation.
`Int`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`Int`	`getLevel()` Retrieve the current level.
`IntArray`	`getState()` Describes the current state, as a union of primitive states, such as `android.R.attr#state_focused`, `android.R.attr#state_selected`, etc. Some drawables may modify their imagery based on the selected state.
`Region?`	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so.
`Unit`	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet)` Inflate this Drawable from an XML resource. Does not apply a theme.
`Unit`	`inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)` Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable. Note that framework may have called this once to create the Drawable instance from XML resource.
`Unit`	`invalidateSelf()` Use the current `Callback` implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable.
`Boolean`	`isFilterBitmap()`
`Boolean`	`isProjected()` Whether this drawable requests projection. Indicates that the `android.graphics.RenderNode` this Drawable will draw into should be drawn immediately after the closest ancestor RenderNode containing a projection receiver.
`Boolean`	`isVisible()`
`Int`	`resolveOpacity(op1: Int, op2: Int)` Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned. This is to help in implementing `getOpacity`.
`Unit`	`scheduleSelf(what: Runnable, when: Long)` Use the current `Callback` implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable.
`Unit`	`setBounds(left: Int, top: Int, right: Int, bottom: Int)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setBounds(bounds: Rect)` Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called.
`Unit`	`setCallback(cb: Drawable.Callback?)` Bind a `Callback` object to this Drawable. Required for clients that want to support animated drawables.
`Unit`	`setChangingConfigurations(configs: Int)` Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
`Unit`	`setColorFilter(color: Int, mode: PorterDuff.Mode)` Specify a color and Porter-Duff mode to be the color filter for this drawable. Convenience for `setColorFilter(android.graphics.ColorFilter)` which constructs a `PorterDuffColorFilter`. Note: Setting a color filter disables `tint`.
`Unit`	`setFilterBitmap(filter: Boolean)` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. This can improve appearance when bitmaps are rotated. If the drawable does not use bitmaps, this call is ignored.
`Boolean`	`setLayoutDirection(layoutDirection: Int)` Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own.
`Boolean`	`setLevel(level: Int)` Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level. If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function.
`Boolean`	`setState(stateSet: IntArray)` Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [`android.R.attr#state_focused`, `android.R.attr#state_pressed`]. If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling `invalidateSelf` in order to have itself redrawn, and true will be returned from this function. Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time.
`Unit`	`setTint(tintColor: Int)` Specifies tint color for this drawable. A Drawable's drawing content will be blended together with its tint before it is drawn to the screen. This functions similarly to `setColorFilter(int,android.graphics.PorterDuff.Mode)`. To clear the tint, pass `null` to `setTintList(android.content.res.ColorStateList)`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`setTintMode(tintMode: PorterDuff.Mode?)` Specifies a tint blending mode for this drawable. Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is `PorterDuff.Mode#SRC_IN`. Note: Setting a color filter via `setColorFilter(android.graphics.ColorFilter)` or `setColorFilter(int,android.graphics.PorterDuff.Mode)` overrides tint.
`Unit`	`unscheduleSelf(what: Runnable)` Use the current `Callback` implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

XML attributes

android:drawable

android:drawable

Reference to a drawable resource to use for the frame. If not given, the drawable must be defined by the first child tag.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:duration

android:duration

Amount of time (in milliseconds) to display this frame.

May be an integer value, such as "100".

android:oneshot

android:oneshot

If true, the animation will only run a single time and then stop. If false (the default), it will continually run, restarting at the first frame after the last has finished.

May be a boolean value, such as "true" or "false".

android:variablePadding

android:variablePadding

If true, allows the drawable's padding to change based on the current state that is selected. If false, the padding will stay the same (based on the maximum padding of all the states). Enabling this feature requires that the owner of the drawable deal with performing layout when the state changes, which is often not supported.

May be a boolean value, such as "true" or "false".

android:visible

android:visible

Provides initial visibility state of the drawable; the default value is false. See android.graphics.drawable.Drawable#setVisible.

May be a boolean value, such as "true" or "false".

Public constructors

AnimationDrawable

Added in API level 1

AnimationDrawable()

Public methods

addFrame

Added in API level 1

open fun addFrame(
    frame: Drawable, 
    duration: Int
): Unit

Adds a frame to the animation

Parameters
`frame`	Drawable: The frame to add This value cannot be `null`.
`duration`	Int: How long in milliseconds the frame should appear

getDuration

Added in API level 1

open fun getDuration(i: Int): Int

Return
`Int`	The duration in milliseconds of the frame at the specified index

getFrame

Added in API level 1

open fun getFrame(index: Int): Drawable!

Return
`Drawable!`	The Drawable at the specified frame index

getNumberOfFrames

Added in API level 1

open fun getNumberOfFrames(): Int

Return
`Int`	The number of frames in the animation

inflate

Added in API level 21

open fun inflate(
    r: Resources, 
    parser: XmlPullParser, 
    attrs: AttributeSet, 
    theme: Resources.Theme?
): Unit

Parameters
`r`	Resources: Resources used to resolve attribute values This value cannot be `null`.
`parser`	XmlPullParser: XML parser from which to inflate this Drawable This value cannot be `null`.
`attrs`	AttributeSet: Base set of attribute values This value cannot be `null`.
`theme`	Resources.Theme?: Theme to apply, may be null

Exceptions
`org.xmlpull.v1.XmlPullParserException`
`java.io.IOException`

isOneShot

Added in API level 1

open fun isOneShot(): Boolean

Return
`Boolean`	True of the animation will play once, false otherwise

isRunning

Added in API level 1

open fun isRunning(): Boolean

Indicates whether the animation is currently running or not.

Return
`Boolean`	true if the animation is running, false otherwise

mutate

Added in API level 3

open fun mutate(): Drawable

Make this drawable mutable. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification. Calling this method on a mutable Drawable will have no effect.

Return
`Drawable`	This value cannot be `null`.

run

Added in API level 1

open fun run(): Unit

This method exists for implementation purpose only and should not be called directly. Invoke start() instead.

See Also

#start()

setOneShot

Added in API level 1

open fun setOneShot(oneShot: Boolean): Unit

Sets whether the animation should play once or repeat.

Parameters
`oneShot`	Boolean: Pass true if the animation should only play once

setVisible

Added in API level 1

open fun setVisible(
    visible: Boolean, 
    restart: Boolean
): Boolean

Sets whether this AnimationDrawable is visible.

When the drawable becomes invisible, it will pause its animation. A subsequent change to visible with restart set to true will restart the animation from the first frame. If restart is false, the drawable will resume from the most recent frame. If the drawable has already reached the last frame, it will then loop back to the first frame, unless it's a one shot drawable (set through setOneShot(boolean)), in which case, it will stay on the last frame.

Parameters
`visible`	Boolean: true if visible, false otherwise
`restart`	Boolean: when visible, true to force the animation to restart from the first frame

Return
`Boolean`	true if the new visibility is different than its previous state

start

Added in API level 1

open fun start(): Unit

Starts the animation from the first frame, looping if necessary. This method has no effect if the animation is running.

Note: Do not call this in the android.app.Activity#onCreate method of your activity, because the AnimationDrawable is not yet fully attached to the window. If you want to play the animation immediately without requiring interaction, then you might want to call it from the android.app.Activity#onWindowFocusChanged method in your activity, which will get called when Android brings your window into focus.

See Also

#isRunning()
#stop()

stop

Added in API level 1

open fun stop(): Unit

Stops the animation at the current frame. This method has no effect if the animation is not running.

See Also

#isRunning()
#start()

unscheduleSelf

Added in API level 1

open fun unscheduleSelf(what: Runnable): Unit

Parameters
`what`	Runnable: The runnable that you no longer want called. This value cannot be `null`.

Protected methods

setConstantState

Added in API level 1

protected open fun setConstantState(state: DrawableContainer.DrawableContainerState): Unit

Parameters
`state`	DrawableContainer.DrawableContainerState: This value cannot be `null`.