AnimatedVectorDrawable Class

Definition

[Android.Runtime.Register("android/graphics/drawable/AnimatedVectorDrawable", DoNotGenerateAcw=true)]
public class AnimatedVectorDrawable : Android.Graphics.Drawables.Drawable, Android.Graphics.Drawables.IAnimatable2, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/graphics/drawable/AnimatedVectorDrawable", DoNotGenerateAcw=true)>]
type AnimatedVectorDrawable = class
    inherit Drawable
    interface IAnimatable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
    interface IAnimatable2

Inheritance

Object

Object

Drawable

AnimatedVectorDrawable

Attributes

RegisterAttribute

Implements

IAnimatable IAnimatable2 IJavaObject IJavaPeerable IDisposable

Remarks

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.

"ThreeXML"><h3>Define an AnimatedVectorDrawable in three separate XML files</h3> <ul> "VDExample"><li><h4>XML for the VectorDrawable containing properties to be animated</h4>

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: <table border="2" align="center" cellpadding="5"> <thead> <tr> <th>Element Name</th> <th>Animatable attribute name</th> </tr> </thead> <tr> <td>&lt;vector&gt;</td> <td>alpha</td> </tr> <tr> <td rowspan="7">&lt;group&gt;</td> <td>rotation</td> </tr> <tr> <td>pivotX</td> </tr> <tr> <td>pivotY</td> </tr> <tr> <td>scaleX</td> </tr> <tr> <td>scaleY</td> </tr> <tr> <td>translateX</td> </tr> <tr> <td>translateY</td> </tr> <tr> <td rowspan="9">&lt;path&gt;</td> <td>pathData</td> </tr> <tr> <td>fillColor</td> </tr> <tr> <td>strokeColor</td> </tr> <tr> <td>strokeWidth</td> </tr> <tr> <td>strokeAlpha</td> </tr> <tr> <td>fillAlpha</td> </tr> <tr> <td>trimPathStart</td> </tr> <tr> <td>trimPathEnd</td> </tr> <tr> <td>trimPathOffset</td> </tr> <tr> <td>&lt;clip-path&gt;</td> <td>pathData</td> </tr> </table>

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>

</li>

"AVDExample"><li><h4>XML for AnimatedVectorDrawable</h4>

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>

</li>

<li><h4>XML for Animations defined using ObjectAnimator or AnimatorSet</h4>

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>

</ul> "OneXML"><h3>Define an AnimatedVectorDrawable all in one XML file</h3>

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>

Java documentation for android.graphics.drawable.AnimatedVectorDrawable.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to