Added in API level 21

AnimatedVectorDrawable


open class AnimatedVectorDrawable : Drawable, Animatable2
kotlin.Any
   ↳ android.graphics.drawable.Drawable
   ↳ android.graphics.drawable.AnimatedVectorDrawable

This class animates properties of a android.graphics.drawable.VectorDrawable with animations defined using android.animation.ObjectAnimator or android.animation.AnimatorSet.

Starting from API 25, AnimatedVectorDrawable runs on RenderThread (as opposed to on UI thread for earlier APIs). This means animations in AnimatedVectorDrawable can remain smooth even when there is heavy workload on the UI thread. Note: If the UI thread is unresponsive, RenderThread may continue animating until the UI thread is capable of pushing another frame. Therefore, it is not possible to precisely coordinate a RenderThread-enabled AnimatedVectorDrawable with UI thread animations. Additionally, android.graphics.drawable.Animatable2.AnimationCallback#onAnimationEnd(Drawable) will be called the frame after the AnimatedVectorDrawable finishes on the RenderThread.

AnimatedVectorDrawable can be defined in either three separate XML files, or one XML.

Define an AnimatedVectorDrawable in three separate XML files

  • XML for the VectorDrawable containing properties to be animated

    Animations can be performed on the animatable attributes in android.graphics.drawable.VectorDrawable. These attributes will be animated by android.animation.ObjectAnimator. The ObjectAnimator's target can be the root element, a group element or a path element. The targeted elements need to be named uniquely within the same VectorDrawable. Elements without animation do not need to be named.

    Here are all the animatable attributes in android.graphics.drawable.VectorDrawable:

    Element Name Animatable attribute name
    <vector> alpha
    <group> rotation
    pivotX
    pivotY
    scaleX
    scaleY
    translateX
    translateY
    <path> pathData
    fillColor
    strokeColor
    strokeWidth
    strokeAlpha
    fillAlpha
    trimPathStart
    trimPathEnd
    trimPathOffset
    <clip-path> pathData

    Below is an example of a VectorDrawable defined in vectordrawable.xml. This VectorDrawable is referred to by its file name (not including file suffix) in the AnimatedVectorDrawable XML example.
    <vector xmlns:android="http://schemas.android.com/apk/res/android"
          android:height="64dp"
          android:width="64dp"
          android:viewportHeight="600"
          android:viewportWidth="600" >
          <group
              android:name="rotationGroup"
              android:pivotX="300.0"
              android:pivotY="300.0"
              android:rotation="45.0" >
              <path
                  android:name="v"
                  android:fillColor="#000000"
                  android:pathData="M300,70 l 0,-70 70,70 0,0 -70,70z" />
          </group>
      </vector>
      
  • XML for AnimatedVectorDrawable

    An AnimatedVectorDrawable element has a VectorDrawable attribute, and one or more target element(s). The target element can specify its target by android:name attribute, and link the target with the proper ObjectAnimator or AnimatorSet by android:animation attribute.

    The following code sample defines an AnimatedVectorDrawable. Note that the names refer to the groups and paths in the VectorDrawable XML above.
    <animated-vector xmlns:android="http://schemas.android.com/apk/res/android"
          android:drawable="@drawable/vectordrawable" >
          <target
              android:name="rotationGroup"
              android:animation="@animator/rotation" />
          <target
              android:name="v"
              android:animation="@animator/path_morph" />
      </animated-vector>
      
  • XML for Animations defined using ObjectAnimator or AnimatorSet

    From the previous example of AnimatedVectorDrawable, two animations were used: rotation.xml and path_morph.xml.

    rotation.xml rotates the target group from 0 degree to 360 degrees over 6000ms:
    <objectAnimator
          android:duration="6000"
          android:propertyName="rotation"
          android:valueFrom="0"
          android:valueTo="360" />
      
    path_morph.xml morphs the path from one shape into the other. Note that the paths must be compatible for morphing. Specifically, the paths must have the same commands, in the same order, and must have the same number of parameters for each command. It is recommended to store path strings as string resources for reuse.
    <set xmlns:android="http://schemas.android.com/apk/res/android">
          <objectAnimator
              android:duration="3000"
              android:propertyName="pathData"
              android:valueFrom="M300,70 l 0,-70 70,70 0,0 -70,70z"
              android:valueTo="M300,70 l 0,-70 70,0  0,140 -70,0 z"
              android:valueType="pathType"/>
      </set>
      

Define an AnimatedVectorDrawable all in one XML file

Since the AAPT tool supports a new format that bundles several related XML files together, we can merge the XML files from the previous examples into one XML file:

<animated-vector xmlns:android="http://schemas.android.com/apk/res/android"
                   xmlns:aapt=&quothttp://schemas.android.com/aapt" >
      <aapt:attr name="android:drawable">
          <vector
              android:height="64dp"
              android:width="64dp"
              android:viewportHeight="600"
              android:viewportWidth="600" >
              <group
                  android:name="rotationGroup"
                  android:pivotX="300.0"
                  android:pivotY="300.0"
                  android:rotation="45.0" >
                  <path
                      android:name="v"
                      android:fillColor="#000000"
                      android:pathData="M300,70 l 0,-70 70,70 0,0 -70,70z" />
              </group>
          </vector>
      </aapt:attr>
 
      <target android:name="rotationGroup"> *
          <aapt:attr name="android:animation">
              <objectAnimator
              android:duration="6000"
              android:propertyName="rotation"
              android:valueFrom="0"
              android:valueTo="360" />
          </aapt:attr>
      </target>
 
      <target android:name="v" >
          <aapt:attr name="android:animation">
              <set>
                  <objectAnimator
                      android:duration="3000"
                      android:propertyName="pathData"
                      android:valueFrom="M300,70 l 0,-70 70,70 0,0 -70,70z"
                      android:valueTo="M300,70 l 0,-70 70,0  0,140 -70,0 z"
                      android:valueType="pathType"/>
              </set>
          </aapt:attr>
       </target>
  </animated-vector>
  

Summary

XML attributes
android:animation The animation for the target path, group or vector drawable.
android:drawable The static vector drawable.
android:name The name of the target path, group or vector drawable.
Public constructors

Public methods
open Unit

open Boolean

open Unit

open Unit
draw(canvas: Canvas)

Draws the AnimatedVectorDrawable into the given canvas.

open Int

For API 25 and later, AnimatedVectorDrawable runs on RenderThread.

open Int

Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.

open ColorFilter?

open Drawable.ConstantState?

open Int

open Int

open Int

open Insets

open Unit
getOutline(outline: Outline)

Called to get the drawable to populate the Outline that defines its drawing area.

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

open Boolean

open Boolean

open Drawable

open Boolean
onLayoutDirectionChanged(layoutDirection: Int)

Called when the drawable's resolved layout direction changes.

open Unit

Adds a callback to listen to the animation events.

open Unit

Resets the AnimatedVectorDrawable to the start state as specified in the animators.

open Unit
setAlpha(alpha: Int)

open Unit
setColorFilter(colorFilter: ColorFilter?)

open Unit

open Unit
setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)

open Unit

Specifies a tint blending mode for this drawable.

open Unit

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

open Unit

open Unit

open Boolean

Removes the specified animation callback.

Protected methods
open Unit

open Boolean

open Boolean

Inherited functions

XML attributes

android:animation

android:animation
The animation for the target path, group or vector drawable.

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

android:drawable

android:drawable
The static vector drawable.

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

android:name

android:name
The name of the target path, group or vector drawable.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

Public constructors

AnimatedVectorDrawable

Added in API level 21
AnimatedVectorDrawable()

Public methods

applyTheme

Added in API level 21
open fun applyTheme(t: Resources.Theme): Unit
Parameters
t Resources.Theme: the theme to apply This value cannot be null.

canApplyTheme

Added in API level 21
open fun canApplyTheme(): Boolean

clearAnimationCallbacks

Added in API level 23
open fun clearAnimationCallbacks(): Unit

draw

Added in API level 21
open fun draw(canvas: Canvas): Unit

Draws the AnimatedVectorDrawable into the given canvas.

Note: Calling this method with a software canvas when the AnimatedVectorDrawable is being animated on RenderThread (for API 25 and later) may yield outdated result, as the UI thread is not guaranteed to be in sync with RenderThread on VectorDrawable's property changes during RenderThread animations.

Parameters
canvas Canvas: The canvas to draw into

getAlpha

Added in API level 21
open fun getAlpha(): Int

For API 25 and later, AnimatedVectorDrawable runs on RenderThread. Therefore, when the root alpha is being animated, this getter does not guarantee to return an up-to-date alpha value.

Return
Int the containing vector drawable's root alpha value.

getColorFilter

Added in API level 21
open fun getColorFilter(): ColorFilter?
Return
ColorFilter? the current color filter, or null if none set

getConstantState

Added in API level 21
open fun getConstantState(): Drawable.ConstantState?
Return
Drawable.ConstantState? The ConstantState associated to that Drawable. This value may be null.

getIntrinsicHeight

Added in API level 21
open fun getIntrinsicHeight(): Int
Return
Int the intrinsic height, or -1 if no intrinsic height

getIntrinsicWidth

Added in API level 21
open fun getIntrinsicWidth(): Int
Return
Int the intrinsic width, or -1 if no intrinsic width

getOpticalInsets

Added in API level 29
open fun getOpticalInsets(): Insets
Return
Insets This value cannot be null.

getOutline

Added in API level 21
open fun getOutline(outline: Outline): Unit

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.

Parameters
outline Outline: This value cannot be null.

inflate

Added in API level 21
open fun inflate(
    res: Resources,
    parser: XmlPullParser,
    attrs: AttributeSet,
    theme: Resources.Theme?
): Unit
Parameters
r 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

isRunning

Added in API level 21
open fun isRunning(): Boolean
Return
Boolean True if the animation is running, false otherwise.

isStateful

Added in API level 21
open fun isStateful(): Boolean
Return
Boolean True if this drawable changes its appearance based on state, false otherwise.

mutate

Added in API level 21
open fun mutate(): Drawable
Return
Drawable This drawable. This value cannot be null.

onLayoutDirectionChanged

Added in API level 23
open fun onLayoutDirectionChanged(layoutDirection: Int): Boolean

Called when the drawable's resolved layout direction changes.

Parameters
layoutDirection Int: Value is android.view.View#LAYOUT_DIRECTION_LTR, or android.view.View#LAYOUT_DIRECTION_RTL
Return
Boolean true if the layout direction change has caused the appearance of the drawable to change such that it needs to be re-drawn, false otherwise

registerAnimationCallback

Added in API level 23
open fun registerAnimationCallback(callback: Animatable2.AnimationCallback): Unit

Adds a callback to listen to the animation events.

Parameters
callback Animatable2.AnimationCallback: This value cannot be null.

reset

Added in API level 23
open fun reset(): Unit

Resets the AnimatedVectorDrawable to the start state as specified in the animators.

setAlpha

Added in API level 21
open fun setAlpha(alpha: Int): Unit
Parameters
alpha Int: Value is between 0 and 255 inclusive

setColorFilter

Added in API level 21
open fun setColorFilter(colorFilter: ColorFilter?): Unit
Parameters
colorFilter ColorFilter?: The color filter to apply, or null to remove the existing color filter

setHotspot

Added in API level 21
open fun setHotspot(
    x: Float,
    y: Float
): Unit
Parameters
x Float: The X coordinate of the center of the hotspot
y Float: The Y coordinate of the center of the hotspot

setHotspotBounds

Added in API level 21
open fun setHotspotBounds(
    left: Int,
    top: Int,
    right: Int,
    bottom: Int
): Unit
Parameters
left Int: position in pixels of the left bound
top Int: position in pixels of the top bound
right Int: position in pixels of the right bound
bottom Int: position in pixels of the bottom bound

setTintBlendMode

Added in API level 29
open fun setTintBlendMode(blendMode: BlendMode!): Unit

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)

Parameters
blendMode BlendMode!: This value cannot be null.

setTintList

Added in API level 21
open fun setTintList(tint: ColorStateList?): Unit
Parameters
tint ColorStateList?: Color state list to use for tinting this drawable, or null to clear the tint

setVisible

Added in API level 21
open fun setVisible(
    visible: Boolean,
    restart: Boolean
): Boolean
Parameters
visible Boolean: Set to true if visible, false if not.
restart Boolean: You can supply true here to force the drawable to behave as if it has just become visible, even if it had last been set visible. Used for example to force animations to restart.
Return
Boolean boolean Returns true if the new visibility is different than its previous state.

start

Added in API level 21
open fun start(): Unit

stop

Added in API level 21
open fun stop(): Unit

unregisterAnimationCallback

Added in API level 23
open fun unregisterAnimationCallback(callback: Animatable2.AnimationCallback): Boolean

Removes the specified animation callback.

Parameters
callback Animatable2.AnimationCallback: This value cannot be null.
Return
Boolean false if callback didn't exist in the call back list, or true if callback has been removed successfully.

Protected methods

onBoundsChange

Added in API level 21
protected open fun onBoundsChange(bounds: Rect): Unit
Parameters
bounds Rect: This value cannot be null.

onLevelChange

Added in API level 21
protected open fun onLevelChange(level: Int): Boolean
Return
Boolean Returns true if the level change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last level.

onStateChange

Added in API level 21
protected open fun onStateChange(state: IntArray): Boolean
Parameters
state IntArray: This value cannot be null.
Return
Boolean Returns true if the state change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last state.