Skip to content

Most visited

Recently visited

navigation

AnimatedVectorDrawable

public class AnimatedVectorDrawable
extends Drawable implements Animatable2

java.lang.Object
   ↳ android.graphics.drawable.Drawable
     ↳ android.graphics.drawable.AnimatedVectorDrawable


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 to 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 strings 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

    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 clearAnimationCallbacks()

    Removes all existing animation callbacks.

    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()

    AnimatedVectorDrawable is running on render thread now.

    int getChangingConfigurations()

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

    ColorFilter getColorFilter()

    Returns the current color filter, or null if none set.

    Drawable.ConstantState getConstantState()

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

    int getIntrinsicHeight()

    Returns the drawable's intrinsic height.

    int getIntrinsicWidth()

    Returns the drawable's intrinsic width.

    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.

    boolean onLayoutDirectionChanged(int layoutDirection)

    Called when the drawable's resolved layout direction changes.

    void registerAnimationCallback(Animatable2.AnimationCallback callback)

    Adds a callback to listen to the animation events.

    void reset()

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

    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 tint color 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.

    boolean unregisterAnimationCallback(Animatable2.AnimationCallback callback)

    Removes the specified animation callback.

    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.

    Inherited methods

    From class android.graphics.drawable.Drawable
    From class java.lang.Object
    From interface android.graphics.drawable.Animatable2
    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.

    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.

    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.

    Public constructors

    AnimatedVectorDrawable

    Added in API level 21
    AnimatedVectorDrawable ()

    Public methods

    applyTheme

    Added in API level 21
    void applyTheme (Resources.Theme t)

    Applies the specified theme to this Drawable and its children.

    Parameters
    t Resources.Theme: the theme to apply

    canApplyTheme

    Added in API level 21
    boolean canApplyTheme ()

    Returns
    boolean

    clearAnimationCallbacks

    Added in API level 23
    void clearAnimationCallbacks ()

    Removes all existing animation callbacks.

    draw

    Added in API level 21
    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).

    Parameters
    canvas Canvas: The canvas to draw into

    getAlpha

    Added in API level 21
    int getAlpha ()

    AnimatedVectorDrawable is running on render thread now. Therefore, if the root alpha is being animated, then the root alpha value we get from this call could be out of sync with alpha value used in the render thread. Otherwise, the root alpha should be always the same value.

    Returns
    int the containing vector drawable's root alpha value.

    getChangingConfigurations

    Added in API level 21
    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.

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

    getColorFilter

    Added in API level 21
    ColorFilter getColorFilter ()

    Returns the current color filter, or null if none set.

    Returns
    ColorFilter the current color filter, or null if none set

    getConstantState

    Added in API level 21
    Drawable.ConstantState getConstantState ()

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

    Returns
    Drawable.ConstantState The ConstantState associated to that Drawable.

    getIntrinsicHeight

    Added in API level 21
    int getIntrinsicHeight ()

    Returns the drawable's intrinsic height.

    Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1.

    Returns
    int the intrinsic height, or -1 if no intrinsic height

    getIntrinsicWidth

    Added in API level 21
    int getIntrinsicWidth ()

    Returns the drawable's intrinsic width.

    Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1.

    Returns
    int the intrinsic width, or -1 if no intrinsic width

    getOpacity

    Added in API level 21
    int getOpacity ()

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

    An OPAQUE drawable is one that draws all all content within its bounds, completely covering anything behind the drawable. A TRANSPARENT drawable is one that draws nothing within its bounds, allowing everything behind it to show through. A TRANSLUCENT drawable is a drawable in any other state, where the drawable will draw some, but not all, of the content within its bounds and at least some content behind the drawable will be visible. If the visibility of the drawable's contents cannot be determined, the safest/best return value is TRANSLUCENT.

    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 necessarily take into account a custom alpha or color filter that has been applied by the client through the setAlpha(int) or setColorFilter(ColorFilter) methods. Some subclasses, such as BitmapDrawable, ColorDrawable, and GradientDrawable, do account for the value of setAlpha(int), but the general behavior is dependent upon the implementation of the subclass.

    Returns
    int int The opacity class of the Drawable.

    getOutline

    Added in API level 21
    void getOutline (Outline outline)

    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.

    Parameters
    outline Outline

    inflate

    Added in API level 21
    void inflate (Resources res, 
                    XmlPullParser parser, 
                    AttributeSet attrs, 
                    Resources.Theme 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.

    Parameters
    res Resources: Resources used to resolve attribute values
    parser XmlPullParser: XML parser from which to inflate this Drawable
    attrs AttributeSet: Base set of attribute values
    theme Resources.Theme: Theme to apply, may be null
    Throws
    XmlPullParserException
    IOException

    isRunning

    Added in API level 21
    boolean isRunning ()

    Indicates whether the animation is running.

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

    isStateful

    Added in API level 21
    boolean isStateful ()

    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
    boolean True if this drawable changes its appearance based on state, false otherwise.

    mutate

    Added in API level 21
    Drawable mutate ()

    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
    Drawable This drawable.

    onLayoutDirectionChanged

    Added in API level 23
    boolean onLayoutDirectionChanged (int layoutDirection)

    Called when the drawable's resolved layout direction changes.

    Parameters
    layoutDirection int: the new resolved layout direction
    Returns
    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
    void registerAnimationCallback (Animatable2.AnimationCallback callback)

    Adds a callback to listen to the animation events.

    Parameters
    callback Animatable2.AnimationCallback: Callback to add.

    reset

    Added in API level 23
    void reset ()

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

    setAlpha

    Added in API level 21
    void setAlpha (int alpha)

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

    Parameters
    alpha int

    setColorFilter

    Added in API level 21
    void setColorFilter (ColorFilter colorFilter)

    Specify an optional color filter for the drawable.

    If a Drawable has a ColorFilter, each output pixel of the Drawable's drawing contents will be modified by the color filter before it is blended onto the render target of a Canvas.

    Pass null to remove any existing color filter.

    Note: Setting a non-null color filter disables tint.

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

    setHotspot

    Added in API level 21
    void setHotspot (float x, 
                    float y)

    Specifies the hotspot's location within the drawable.

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

    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

    setTintList

    Added in API level 21
    void setTintList (ColorStateList tint)

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

    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, PorterDuff.Mode).

    Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

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

    setTintMode

    Added in API level 21
    void setTintMode (PorterDuff.Mode tintMode)

    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 SRC_IN.

    Note: Setting a color filter via setColorFilter(ColorFilter) or setColorFilter(int, PorterDuff.Mode) overrides tint.

    Parameters
    tintMode PorterDuff.Mode: A Porter-Duff blending mode

    setVisible

    Added in API level 21
    boolean setVisible (boolean visible, 
                    boolean restart)

    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 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.
    Returns
    boolean boolean Returns true if the new visibility is different than its previous state.

    start

    Added in API level 21
    void start ()

    Starts the drawable's animation.

    stop

    Added in API level 21
    void stop ()

    Stops the drawable's animation.

    unregisterAnimationCallback

    Added in API level 23
    boolean unregisterAnimationCallback (Animatable2.AnimationCallback callback)

    Removes the specified animation callback.

    Parameters
    callback Animatable2.AnimationCallback: Callback to remove.
    Returns
    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
    void onBoundsChange (Rect bounds)

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

    Parameters
    bounds Rect

    onLevelChange

    Added in API level 21
    boolean onLevelChange (int level)

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

    Parameters
    level int
    Returns
    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
    boolean onStateChange (int[] state)

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

    Parameters
    state int
    Returns
    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.
    This site uses cookies to store your preferences for site-specific language and display options.

    Hooray!

    This class requires API level or higher

    This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

    For more information about specifying the API level your app requires, read Supporting Different Platform Versions.