Android APIs
public class

AnimatedVectorDrawable

extends Drawable
implements Animatable
java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.AnimatedVectorDrawable

Class Overview

This class uses ObjectAnimator and AnimatorSet to animate the properties of a VectorDrawable to create an animated drawable.

AnimatedVectorDrawable are normally defined as 3 separate XML files.

First is the XML file for VectorDrawable. Note that we allow the animation happen on the group's attributes and path's attributes, which requires they are uniquely named in this xml file. Groups and paths without animations do not need names.

  • Here is a simple VectorDrawable in this vectordrawable.xml file.
     <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>
     
  • Second is the AnimatedVectorDrawable's xml file, which defines the target VectorDrawable, the target paths and groups to animate, the properties of the path and group to animate and the animations defined as the ObjectAnimators or AnimatorSets.

  • Here is a simple AnimatedVectorDrawable defined in this avd.xml file. Note how we use the names to refer to the groups and paths in the vectordrawable.xml.
     <animated-vector xmlns:android="http://schemas.android.com/apk/res/android"
       android:drawable="@drawable/vectordrawable" >
         <target
             android:name="rotationGroup"
             android:animation="@anim/rotation" />
         <target
             android:name="v"
             android:animation="@anim/path_morph" />
     </animated-vector>
     
  • Last is the Animator xml file, which is the same as a normal ObjectAnimator or AnimatorSet. To complete this example, here are the 2 animator files used in avd.xml: rotation.xml and path_morph.xml.

  • Here is the rotation.xml, which will rotate the target group for 360 degrees.
     <objectAnimator
         android:duration="6000"
         android:propertyName="rotation"
         android:valueFrom="0"
         android:valueTo="360" />
     
  • Here is the path_morph.xml, which will morph the path from one shape to the other. Note that the paths must be compatible for morphing. In more details, the paths should have exact same length of commands , and exact same length of parameters for each commands. Note that the path string are better stored in strings.xml for reusing.
     <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>
     
  • Summary

    XML Attributes
    Attribute Name Related Method Description
    android:animation The animation for the target path, group or vector drawable

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

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

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

    Public Constructors
    AnimatedVectorDrawable()
    Public Methods
    void applyTheme(Resources.Theme t)
    Applies the specified theme to this Drawable and its children.
    boolean canApplyTheme()
    void draw(Canvas canvas)
    Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
    int getAlpha()
    Gets the current alpha value for the drawable.
    int getChangingConfigurations()
    Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
    Drawable.ConstantState getConstantState()
    Return a Drawable.ConstantState instance that holds the shared state of this Drawable.
    int getIntrinsicHeight()
    Return the intrinsic height of the underlying drawable object.
    int getIntrinsicWidth()
    Return the intrinsic width of the underlying drawable object.
    int getOpacity()
    Return the opacity/transparency of this Drawable.
    void getOutline(Outline outline)
    Called to get the drawable to populate the Outline that defines its drawing area.
    void inflate(Resources res, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
    Inflate this Drawable from an XML resource optionally styled by a theme.
    boolean isRunning()
    Indicates whether the animation is running.
    boolean isStateful()
    Indicates whether this drawable will change its appearance based on state.
    Drawable mutate()
    Make this drawable mutable.
    void setAlpha(int alpha)
    Specify an alpha value for the drawable.
    void setColorFilter(ColorFilter colorFilter)
    Specify an optional color filter for the drawable.
    void setHotspot(float x, float y)
    Specifies the hotspot's location within the drawable.
    void setHotspotBounds(int left, int top, int right, int bottom)
    Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
    void setTintList(ColorStateList tint)
    Specifies a tint for this drawable as a color state list.
    void setTintMode(PorterDuff.Mode tintMode)
    Specifies a tint blending mode for this drawable.
    boolean setVisible(boolean visible, boolean restart)
    Set whether this Drawable is visible.
    void start()
    Starts the drawable's animation.
    void stop()
    Stops the drawable's animation.
    Protected Methods
    void onBoundsChange(Rect bounds)
    Override this in your subclass to change appearance if you vary based on the bounds.
    boolean onLevelChange(int level)
    Override this in your subclass to change appearance if you vary based on level.
    boolean onStateChange(int[] state)
    Override this in your subclass to change appearance if you recognize the specified state.
    [Expand]
    Inherited Methods
    From class android.graphics.drawable.Drawable
    From class java.lang.Object
    From interface android.graphics.drawable.Animatable

    XML Attributes

    android:animation

    The animation for the target path, group or vector drawable

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

    This corresponds to the global attribute resource symbol animation.

    Related Methods

    android:drawable

    The static vector drawable.

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

    This corresponds to the global attribute resource symbol drawable.

    Related Methods

    android:name

    The name of the target path, group or vector drawable

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

    This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

    This corresponds to the global attribute resource symbol name.

    Related Methods

    Public Constructors

    public AnimatedVectorDrawable ()

    Added in API level 21

    Public Methods

    public void applyTheme (Resources.Theme t)

    Added in API level 21

    Applies the specified theme to this Drawable and its children.

    public boolean canApplyTheme ()

    Added in API level 21

    public void draw (Canvas canvas)

    Added in API level 21

    Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).

    Parameters
    canvas The canvas to draw into

    public int getAlpha ()

    Added in API level 21

    Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.

    public int getChangingConfigurations ()

    Added in API level 21

    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.

    Returns
    • Returns a mask of the changing configuration parameters, as defined by ActivityInfo.

    public Drawable.ConstantState getConstantState ()

    Added in API level 21

    Return a Drawable.ConstantState instance that holds the shared state of this Drawable.

    Returns
    • The ConstantState associated to that Drawable.

    public int getIntrinsicHeight ()

    Added in API level 21

    Return the intrinsic height of the underlying drawable object. Returns -1 if it has no intrinsic height, such as with a solid color.

    public int getIntrinsicWidth ()

    Added in API level 21

    Return the intrinsic width of the underlying drawable object. Returns -1 if it has no intrinsic width, such as with a solid color.

    public int getOpacity ()

    Added in API level 21

    Return the opacity/transparency of this Drawable. The returned value is one of the abstract format constants in PixelFormat: UNKNOWN, TRANSLUCENT, TRANSPARENT, or OPAQUE.

    Generally a Drawable should be as conservative as possible with the value it returns. For example, if it contains multiple child drawables and only shows one of them at a time, if only one of the children is TRANSLUCENT and the others are OPAQUE then TRANSLUCENT should be returned. You can use the method resolveOpacity(int, int) to perform a standard reduction of two opacities to the appropriate single output.

    Note that the returned value does not take into account a custom alpha or color filter that has been applied by the client through the setAlpha(int) or setColorFilter(ColorFilter) methods.

    Returns
    • int The opacity class of the Drawable.

    public void getOutline (Outline outline)

    Added in API level 21

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

    This method is called by the default 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.

    public void inflate (Resources res, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)

    Added in API level 21

    Inflate this Drawable from an XML resource optionally styled by a theme.

    Parameters
    res Resources used to resolve attribute values
    parser XML parser from which to inflate this Drawable
    attrs Base set of attribute values
    theme Theme to apply, may be null

    public boolean isRunning ()

    Added in API level 21

    Indicates whether the animation is running.

    Returns
    • True if the animation is running, false otherwise.

    public boolean isStateful ()

    Added in API level 21

    Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.

    Returns
    • True if this drawable changes its appearance based on state, false otherwise.

    public Drawable mutate ()

    Added in API level 21

    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.

    Returns
    • This drawable.

    public void setAlpha (int alpha)

    Added in API level 21

    Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.

    public void setColorFilter (ColorFilter colorFilter)

    Added in API level 21

    Specify an optional color filter for the drawable. Pass null to remove any existing color filter.

    Parameters
    colorFilter the color filter to apply, or null to remove the existing color filter

    public void setHotspot (float x, float y)

    Added in API level 21

    Specifies the hotspot's location within the drawable.

    Parameters
    x The X coordinate of the center of the hotspot
    y The Y coordinate of the center of the hotspot

    public void setHotspotBounds (int left, int top, int right, int bottom)

    Added in API level 21

    Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.

    public void setTintList (ColorStateList tint)

    Added in API level 21

    Specifies a tint for this drawable as a color state list.

    Setting a color filter via setColorFilter(ColorFilter) overrides tint.

    Parameters
    tint Color state list to use for tinting this drawable, or null to clear the tint

    public void setTintMode (PorterDuff.Mode tintMode)

    Added in API level 21

    Specifies a tint blending mode for this drawable.

    Setting a color filter via setColorFilter(ColorFilter) overrides tint.

    Parameters
    tintMode A Porter-Duff blending mode

    public boolean setVisible (boolean visible, boolean restart)

    Added in API level 21

    Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.

    Parameters
    visible Set to true if visible, false if not.
    restart 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.
    Returns
    • boolean Returns true if the new visibility is different than its previous state.

    public void start ()

    Added in API level 21

    Starts the drawable's animation.

    public void stop ()

    Added in API level 21

    Stops the drawable's animation.

    Protected Methods

    protected void onBoundsChange (Rect bounds)

    Added in API level 21

    Override this in your subclass to change appearance if you vary based on the bounds.

    protected boolean onLevelChange (int level)

    Added in API level 21

    Override this in your subclass to change appearance if you vary based on level.

    Returns
    • 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.

    protected boolean onStateChange (int[] state)

    Added in API level 21

    Override this in your subclass to change appearance if you recognize the specified state.

    Returns
    • 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.