Most visited

Recently visited

Results for

Added in API level 21

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

`void`	`applyTheme(Resources.Theme t)` Applies the specified theme to this Drawable and its children.
`boolean`	`canApplyTheme()`
`void`	`clearColorFilter()` Removes the color filter for this drawable.
`final Rect`	`copyBounds()` Return a copy of the drawable's bounds in a new Rect.
`final void`	`copyBounds(Rect bounds)` Return a copy of the drawable's bounds in the specified Rect (allocated by the caller).
`static Drawable`	`createFromPath(String pathName)` Create a drawable from file path name.
`static Drawable`	`createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`static Drawable`	`createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName)` Create a drawable from an inputstream, using the given resources and value to determine density information.
`static Drawable`	`createFromStream(InputStream is, String srcName)` Create a drawable from an inputstream
`static Drawable`	`createFromXml(Resources r, XmlPullParser parser)` Create a drawable from an XML document.
`static Drawable`	`createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme)` Create a drawable from an XML document using an optional `Resources.Theme`.
`static Drawable`	`createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)` Create a drawable from inside an XML document using an optional `Resources.Theme`.
`static Drawable`	`createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs)` Create from inside an XML document.
`abstract 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.
`final Rect`	`getBounds()` Return the drawable's bounds Rect.
`Drawable.Callback`	`getCallback()` Return the current `Drawable.Callback` implementation attached to this Drawable.
`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.
`Drawable`	`getCurrent()`
`Rect`	`getDirtyBounds()` Return the drawable's dirty bounds Rect.
`void`	`getHotspotBounds(Rect outRect)` Populates `outRect` with the hotspot bounds.
`int`	`getIntrinsicHeight()` Returns the drawable's intrinsic height.
`int`	`getIntrinsicWidth()` Returns the drawable's intrinsic width.
`int`	`getLayoutDirection()` Returns the resolved layout direction for this Drawable.
`final int`	`getLevel()` Retrieve the current level.
`int`	`getMinimumHeight()` Returns the minimum height suggested by this Drawable.
`int`	`getMinimumWidth()` Returns the minimum width suggested by this Drawable.
`abstract 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.
`boolean`	`getPadding(Rect padding)` Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds.
`int[]`	`getState()` Describes the current state, as a union of primitve states, such as `state_focused`, `state_selected`, etc.
`Region`	`getTransparentRegion()` Returns a Region representing the part of the Drawable that is completely transparent.
`void`	`inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)` Inflate this Drawable from an XML resource optionally styled by a theme.
`void`	`inflate(Resources r, XmlPullParser parser, AttributeSet attrs)` Inflate this Drawable from an XML resource.
`void`	`invalidateSelf()` Use the current `Drawable.Callback` implementation to have this Drawable redrawn.
`boolean`	`isAutoMirrored()` Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left.
`boolean`	`isFilterBitmap()`
`boolean`	`isStateful()` Indicates whether this drawable will change its appearance based on state.
`final boolean`	`isVisible()`
`void`	`jumpToCurrentState()` If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
`Drawable`	`mutate()` Make this drawable mutable.
`void`	`onBoundsChange(Rect bounds)` Override this in your subclass to change appearance if you vary based on the bounds.
`boolean`	`onLayoutDirectionChanged(int layoutDirection)` Called when the drawable's resolved layout direction changes.
`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.
`static int`	`resolveOpacity(int op1, int op2)` Return the appropriate opacity value for two source opacities.
`void`	`scheduleSelf(Runnable what, long when)` Use the current `Drawable.Callback` implementation to have this Drawable scheduled.
`abstract void`	`setAlpha(int alpha)` Specify an alpha value for the drawable.
`void`	`setAutoMirrored(boolean mirrored)` Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left).
`void`	`setBounds(int left, int top, int right, int bottom)` Specify a bounding rectangle for the Drawable.
`void`	`setBounds(Rect bounds)` Specify a bounding rectangle for the Drawable.
`final void`	`setCallback(Drawable.Callback cb)` Bind a `Drawable.Callback` object to this Drawable.
`void`	`setChangingConfigurations(int configs)` Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
`void`	`setColorFilter(int color, PorterDuff.Mode mode)` Specify a color and Porter-Duff mode to be the color filter for this drawable.
`abstract void`	`setColorFilter(ColorFilter colorFilter)` Specify an optional color filter for the drawable.
`void`	`setDither(boolean dither)` This method was deprecated in API level 23. This property is ignored.
`void`	`setFilterBitmap(boolean filter)` Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated.
`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.
`final boolean`	`setLayoutDirection(int layoutDirection)` Set the layout direction for this drawable.
`final boolean`	`setLevel(int level)` Specify the level for the drawable.
`boolean`	`setState(int[] stateSet)` Specify a set of states for the drawable.
`void`	`setTint(int tintColor)` Specifies tint color for this drawable.
`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`	`unscheduleSelf(Runnable what)` Use the current `Drawable.Callback` implementation to have this Drawable unscheduled.

From class


  
    java.lang.Object

`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 millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this 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.

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

Parameters
`x`	`float`: The X coordinate of the center of the hotspot
`y`	`float`: The Y coordinate of the center of the hotspot

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

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.

Most visited

Recently visited

Results for

AnimatedVectorDrawable

Summary

XML attributes

Public constructors

Public methods

Protected methods

Inherited methods

XML attributes

android:animation

android:drawable

android:name

Public constructors