Most visited

Recently visited

Added in API level 21

AnimatedVectorDrawable

public class AnimatedVectorDrawable
extends Drawable implements Animatable2

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


这个类使用 ObjectAnimatorAnimatorSet到一个动画的属性 VectorDrawable创建动画绘制。

AnimatedVectorDrawable通常定义为3个独立的XML文件。

首先是VectorDrawable的XML文件。 请注意,我们允许动画发生在组的属性和路径属性上,这要求它们在此XML文件中唯一命名。 没有动画的组和路径不需要名称。

  • 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>
     
  • 其次是AnimatedVectorDrawable的XML文件,该文件定义目标VectorDrawable,要设置动画的目标路径和组,动画的路径和组的属性以及定义为ObjectAnimators或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>
     
  • 最后是Animator XML文件,它与普通的ObjectAnimator或AnimatorSet相同。 为了完成这个例子,下面是avd.xml中使用的2个动画文件:rotation.xml和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

    必须是另一个资源的引用,其形式为“ @[+][package:]type:name ”,或者其形式为“一个主题属性 ?[package:][type:]name ”。

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

    必须是字符串值,使用'\\;' 转义字符如'\\ n'或'\\ uxxxx'作为unicode字符。

    Public constructors

    AnimatedVectorDrawable()

    Public methods

    void applyTheme(Resources.Theme t)

    将指定的主题应用于此Drawable及其子项。

    boolean canApplyTheme()
    void clearAnimationCallbacks()

    删除所有现有的动画回调。

    void draw(Canvas canvas)

    在其边界(通过setBounds设置)中绘制,考虑可选效果,如alpha(通过setAlpha设置)和color filter(通过setColorFilter设置)。

    int getAlpha()

    AnimatedVectorDrawable现在在渲染线程上运行。

    int getChangingConfigurations()

    返回此drawable可能更改的配置参数的掩码,要求重新创建它。

    ColorFilter getColorFilter()

    返回当前的颜色过滤器,如果没有设置,则返回 null

    Drawable.ConstantState getConstantState()

    返回保存此Drawable的共享状态的 Drawable.ConstantState实例。

    int getIntrinsicHeight()

    返回drawable的内在高度。

    int getIntrinsicWidth()

    返回drawable的内部宽度。

    int getOpacity()

    返回此Drawable的不透明度/透明度。

    void getOutline(Outline outline)

    调用drawable来填充定义其绘图区域的Outline。

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

    从可选的由主题设计的XML资源中扩展此Drawable。

    boolean isRunning()

    指示动画是否正在运行。

    boolean isStateful()

    指示此drawable是否会根据状态更改其外观。

    Drawable mutate()

    使这个drawable可变。

    boolean onLayoutDirectionChanged(int layoutDirection)

    当drawable的解析布局方向改变时调用。

    void registerAnimationCallback(Animatable2.AnimationCallback callback)

    添加回调来收听动画事件。

    void reset()

    将AnimatedVectorDrawable重置为动画器中指定的开始状态。

    void setAlpha(int alpha)

    为drawable指定一个alpha值。

    void setColorFilter(ColorFilter colorFilter)

    为绘图指定一个可选的颜色过滤器。

    void setHotspot(float x, float y)

    指定可绘制内的热点位置。

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

    设置热点受限的边界,如果它们应该与可绘制边界不同。

    void setTintList(ColorStateList tint)

    指定该drawable的色彩颜色作为颜色状态列表。

    void setTintMode(PorterDuff.Mode tintMode)

    指定该drawable的色调混合模式。

    boolean setVisible(boolean visible, boolean restart)

    设置此Drawable是否可见。

    void start()

    开始drawable的动画。

    void stop()

    停止绘图的动画。

    boolean unregisterAnimationCallback(Animatable2.AnimationCallback callback)

    删除指定的动画回调。

    Protected methods

    void onBoundsChange(Rect bounds)

    如果您根据边界而变化,请在您的子类中覆盖此内容以更改外观。

    boolean onLevelChange(int level)

    如果您根据级别而变化,请在您的子类中覆盖此内容以更改外观。

    boolean onStateChange(int[] 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

    目标路径,组或矢量的动画可绘制

    必须是另一个资源的引用,其形式为“ @[+][package:]type:name ”,或者其形式为“一个主题属性 ?[package:][type:]name ”。

    这对应于全局属性资源符号 animation

    android:drawable

    静态向量可绘制。

    必须是另一个资源的引用,其形式为“ @[+][package:]type:name ”,或者其形式为“一个主题属性 ?[package:][type:]name ”。

    这对应于全局属性资源符号 drawable

    android:name

    目标路径,组或矢量的名称可绘制

    必须是字符串值,使用'\\;' 转义字符如'\\ n'或'\\ uxxxx'作为unicode字符。

    这也可能是对包含此类型值的资源(形式为“ @[package:]type:name ”)或主题属性(形式为“ ?[package:][type:]name ”)的 ?[package:][type:]name

    这对应于全局属性资源符号 name

    Public constructors

    AnimatedVectorDrawable

    Added in API level 21
    AnimatedVectorDrawable ()

    Public methods

    applyTheme

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

    将指定的主题应用于此Drawable及其子项。

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

    删除所有现有的动画回调。

    draw

    Added in API level 21
    void draw (Canvas canvas)

    在其边界(通过setBounds设置)中绘制,考虑可选效果,如alpha(通过setAlpha设置)和color filter(通过setColorFilter设置)。

    Parameters
    canvas Canvas: The canvas to draw into

    getAlpha

    Added in API level 21
    int getAlpha ()

    AnimatedVectorDrawable现在在渲染线程上运行。 因此,如果根alpha被动画,那么我们从这个调用获得的根alpha值可能与渲染线程中使用的alpha值不同步。 否则,根alpha应该始终是相同的值。

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

    getChangingConfigurations

    Added in API level 21
    int getChangingConfigurations ()

    返回此drawable可能更改的配置参数的掩码,要求重新创建它。 缺省实现返回默认情况下通过setChangingConfigurations(int)或0提供的值。 子类可以将其扩展到它们所拥有的任何其他drawable的变化配置中或其中。

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

    getColorFilter

    Added in API level 21
    ColorFilter getColorFilter ()

    返回当前的颜色过滤器,如果没有设置则返回 null

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

    getConstantState

    Added in API level 21
    Drawable.ConstantState getConstantState ()

    返回保存此Drawable的共享状态的 Drawable.ConstantState实例。

    Returns
    Drawable.ConstantState The ConstantState associated to that Drawable.

    getIntrinsicHeight

    Added in API level 21
    int getIntrinsicHeight ()

    返回drawable的内在高度。

    固有高度是可拉伸的布局高度,包括任何固有的填充。 如果drawable没有固有的高度,例如纯色,则此方法返回-1。

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

    getIntrinsicWidth

    Added in API level 21
    int getIntrinsicWidth ()

    返回drawable的内部宽度。

    固有宽度是可展开的布局的宽度,包括任何固有的填充。 如果drawable没有固有的宽度,例如纯色,则此方法返回-1。

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

    getOpacity

    Added in API level 21
    int getOpacity ()

    返回此Drawable的不透明度/透明度。 返回的值是在抽象格式常数之一PixelFormatUNKNOWNTRANSLUCENTTRANSPARENT ,或OPAQUE

    OPAQUE drawable是一个绘制所有内容的范围,完全覆盖drawable后面的所有内容。 一个TRANSPARENT drawable是一个在其范围内没有绘制任何东西的图形,允许它后面的所有东西都显示出来。 TRANSLUCENT drawable是任何其他状态中的drawable,drawable将绘制其边界内的一些内容,但不是全部内容,并且至少drawable后面的某些内容将可见。 如果无法确定可绘制内容的可见性,则最安全/最佳返回值为TRANSLUCENT。

    一般而言,Drawable应该尽可能保守并且返回值。 例如,如果它包含多个子drawable,并且一次只显示其中一个,如果只有一个子项是TRANSLUCENT,而其他子项是OPAQUE,则应返回TRANSLUCENT。 您可以使用方法resolveOpacity(int, int)将两个不透明度标准减少到相应的单个输出。

    请注意,返回的值不一定会考虑客户端通过setAlpha(int)setColorFilter(ColorFilter)方法应用的自定义alpha或颜色过滤器。 一些子类,比如BitmapDrawableColorDrawable ,并GradientDrawable ,对价值做账setAlpha(int) ,但总的行为是依赖于子类实现的。

    Returns
    int int The opacity class of the Drawable.

    getOutline

    Added in API level 21
    void getOutline (Outline outline)

    调用drawable来填充定义其绘图区域的Outline。

    此方法由默认的 ViewOutlineProvider以定义视图的轮廓。

    默认行为将轮廓定义为0 alpha的边界矩形。 希望传达不同形状或阿尔法值的子类必须重写此方法。

    Parameters
    outline Outline

    inflate

    Added in API level 21
    void inflate (Resources res, 
                    XmlPullParser parser, 
                    AttributeSet attrs, 
                    Resources.Theme theme)

    从可选的由主题设计的XML资源中扩展此Drawable。 对于每个Drawable,这不能被调用一次以上。 请注意,框架可能已经调用过这一次从XML资源创建Drawable实例。

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

    指示动画是否正在运行。

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

    isStateful

    Added in API level 21
    boolean isStateful ()

    指示此drawable是否会根据状态更改其外观。 客户可以使用它来确定是否有必要计算它们的状态并调用setState。

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

    mutate

    Added in API level 21
    Drawable mutate ()

    使这个drawable可变。 这个操作不能逆转。 一个可变的drawable保证不与其他drawable共享它的状态。 当你需要修改从资源加载的drawable的属性时,这是特别有用的。 默认情况下,从同一资源加载的所有可绘制实例共享一个公共状态; 如果修改一个实例的状态,则所有其他实例都将收到相同的修改。 在可变Drawable上调用此方法将不起作用。

    Returns
    Drawable This drawable.

    onLayoutDirectionChanged

    Added in API level 23
    boolean onLayoutDirectionChanged (int layoutDirection)

    当drawable的解析布局方向改变时调用。

    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)

    添加回调来收听动画事件。

    Parameters
    callback Animatable2.AnimationCallback: Callback to add.

    reset

    Added in API level 23
    void reset ()

    将AnimatedVectorDrawable重置为动画器中指定的开始状态。

    setAlpha

    Added in API level 21
    void setAlpha (int alpha)

    为drawable指定一个alpha值。 0表示完全透明,255表示完全不透明。

    Parameters
    alpha int

    setColorFilter

    Added in API level 21
    void setColorFilter (ColorFilter colorFilter)

    为绘图指定一个可选的颜色过滤器。

    如果Drawable具有ColorFilter,则Drawable的绘图内容的每个输出像素在混合到Canvas的渲染目标之前将被颜色过滤器修改。

    通过 null删除任何现有的颜色过滤器。

    注意:设置非 null颜色过滤器会禁用 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)

    指定可绘制内的热点位置。

    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)

    设置热点受限的边界,如果它们应该与可绘制边界不同。

    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)

    指定该drawable的色彩颜色作为颜色状态列表。

    Drawable的绘图内容在绘制到屏幕前将与它的色调混合在一起。 这功能与setColorFilter(int, PorterDuff.Mode)类似。

    注意:通过 setColorFilter(ColorFilter)setColorFilter(int, PorterDuff.Mode)设置颜色过滤器会覆盖色调。

    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)

    指定该drawable的色调混合模式。

    定义在绘制屏幕之前,该绘制的色调应该如何混合到绘图中。 默认色调模式是SRC_IN

    注意:通过 setColorFilter(ColorFilter)setColorFilter(int, PorterDuff.Mode)设置颜色过滤器会覆盖色调。

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

    setVisible

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

    设置此Drawable是否可见。 这通常不会影响Drawable的行为,但它是一些可供Drawables使用的提示,例如,可以决定是否运行动画。

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

    开始drawable的动画。

    stop

    Added in API level 21
    void stop ()

    停止绘图的动画。

    unregisterAnimationCallback

    Added in API level 23
    boolean unregisterAnimationCallback (Animatable2.AnimationCallback 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)

    如果您根据边界而变化,请在您的子类中覆盖此内容以更改外观。

    Parameters
    bounds Rect

    onLevelChange

    Added in API level 21
    boolean onLevelChange (int 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)

    如果您认识到指定的状态,请在您的子类中覆盖此内容以更改外观。

    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.

    Hooray!