AnimatedVectorDrawableCompat

Kotlin |Java

open class AnimatedVectorDrawableCompat : VectorDrawableCommon, Animatable2Compat

androidx.vectordrawable.graphics.drawable.AnimatedVectorDrawableCompat

For API 24 and above, this class is delegating to the framework's . For older API version, this class uses android.animation.ObjectAnimator and android.animation.AnimatorSet to animate the properties of a to create an animated drawable.

AnimatedVectorDrawableCompat are defined in the same XML format as AnimatedVectorDrawable.

Here are all the animatable attributes in VectorDrawableCompat:

Element Name	Animatable attribute name
<vector>	alpha
<group>	rotation
	pivotX
	pivotY
	scaleX
	scaleY
	translateX
	translateY
<path>	fillColor
	pathData
	strokeColor
	strokeWidth
	strokeAlpha
	fillAlpha
	trimPathStart
	trimPathEnd
trimPathOffset

You can always create a AnimatedVectorDrawableCompat object and use it as a Drawable by the Java API. In order to refer to AnimatedVectorDrawableCompat inside a XML file, you can use app:srcCompat attribute in AppCompat library's ImageButton or ImageView.

Note that the animation in AnimatedVectorDrawableCompat now can support the following features:

Path Morphing (PathType evaluator). This is used for morphing one path into another.
Path Interpolation. This is used to defined a flexible interpolator (represented as a path) instead of the system defined ones like LinearInterpolator.
Animating 2 values in one ObjectAnimator according to one path's X value and Y value. One usage is moving one object in both X and Y dimensions along an path.

Summary

Public methods
open Unit	`applyTheme(t: Theme)`
open Boolean	`canApplyTheme()`
open Unit	`clearAnimationCallbacks()`
open static Unit	`clearAnimationCallbacks(dr: Drawable!)` Utility function to clear animation callbacks from Drawable, when the drawable is created from XML and referred in Java code, e.
open static AnimatedVectorDrawableCompat?	`create(@NonNull context: Context, @DrawableRes resId: Int)` Create a AnimatedVectorDrawableCompat object.
open static AnimatedVectorDrawableCompat!	`createFromXmlInner(context: Context!, r: Resources!, parser: XmlPullParser!, attrs: AttributeSet!, theme: Theme!)` Create a AnimatedVectorDrawableCompat from inside an XML document using an optional `Theme`.
open Unit	`draw(canvas: Canvas)`
open Int	`getAlpha()`
open Int	`getChangingConfigurations()`
open ColorFilter?	`getColorFilter()`
open ConstantState?	`getConstantState()` Note that we don't support constant state when SDK < 24.
open Int	`getIntrinsicHeight()`
open Int	`getIntrinsicWidth()`
open Int	`getOpacity()`
open Unit	`inflate(res: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Theme?)`
open Unit	`inflate(res: Resources, parser: XmlPullParser, attrs: AttributeSet)`
open Boolean	`isAutoMirrored()`
open Boolean	`isRunning()`
open Boolean	`isStateful()`
open Drawable	`mutate()` mutate() will be effective only if the getConstantState() is returning non-null.
open Unit	`registerAnimationCallback(@NonNull callback: Animatable2Compat.AnimationCallback)`
open static Unit	`registerAnimationCallback(dr: Drawable!, callback: Animatable2Compat.AnimationCallback!)` Utility function to register callback to Drawable, when the drawable is created from XML and referred in Java code, e.
open Unit	`setAlpha(alpha: Int)`
open Unit	`setAutoMirrored(mirrored: Boolean)`
open Unit	`setColorFilter(colorFilter: ColorFilter?)`
open Unit	`setTint(tint: Int)`
open Unit	`setTintList(tint: ColorStateList?)`
open Unit	`setTintMode(tintMode: Mode?)`
open Boolean	`setVisible(visible: Boolean, restart: Boolean)`
open Unit	`start()`
open Unit	`stop()`
open Boolean	`unregisterAnimationCallback(@NonNull callback: Animatable2Compat.AnimationCallback)`
open static Boolean	`unregisterAnimationCallback(dr: Drawable!, callback: Animatable2Compat.AnimationCallback!)` Utility function to unregister animation callback from Drawable, when the drawable is created from XML and referred in Java code, e.

Protected methods
open Unit	`onBoundsChange(bounds: Rect!)`
open Boolean	`onLevelChange(level: Int)`
open Boolean	`onStateChange(state: IntArray!)`

Public methods

applyTheme

open fun applyTheme(t: Theme): Unit

canApplyTheme

open fun canApplyTheme(): Boolean

clearAnimationCallbacks

open fun clearAnimationCallbacks(): Unit

clearAnimationCallbacks

open static fun clearAnimationCallbacks(dr: Drawable!): Unit

Utility function to clear animation callbacks from Drawable, when the drawable is created from XML and referred in Java code, e.g: ImageView.getDrawable(). From API 24 on, the drawable is treated as an AnimatedVectorDrawable. Otherwise, it is treated as AnimatedVectorDrawableCompat.

create

@Nullable open static fun create(
    @NonNull context: Context, 
    @DrawableRes resId: Int
): AnimatedVectorDrawableCompat?

Create a AnimatedVectorDrawableCompat object.

Parameters
`context`	Context: the context for creating the animators.
`resId`	Int: the resource ID for AnimatedVectorDrawableCompat object.

Return
`AnimatedVectorDrawableCompat?`	a new AnimatedVectorDrawableCompat or null if parsing error is found.

createFromXmlInner

open static fun createFromXmlInner(
    context: Context!, 
    r: Resources!, 
    parser: XmlPullParser!, 
    attrs: AttributeSet!, 
    theme: Theme!
): AnimatedVectorDrawableCompat!

Create a AnimatedVectorDrawableCompat from inside an XML document using an optional Theme. Called on a parser positioned at a tag in an XML document, tries to create a Drawable from that tag. Returns null if the tag is not a valid drawable.

draw

open fun draw(canvas: Canvas): Unit

getAlpha

open fun getAlpha(): Int

getChangingConfigurations

open fun getChangingConfigurations(): Int

getColorFilter

open fun getColorFilter(): ColorFilter?

getConstantState

open fun getConstantState(): ConstantState?

Note that we don't support constant state when SDK < 24. Make sure you check the return value before using it.

getIntrinsicHeight

open fun getIntrinsicHeight(): Int

getIntrinsicWidth

open fun getIntrinsicWidth(): Int

getOpacity

open fun getOpacity(): Int

inflate

open fun inflate(
    res: Resources, 
    parser: XmlPullParser, 
    attrs: AttributeSet, 
    theme: Theme?
): Unit

inflate

open fun inflate(
    res: Resources, 
    parser: XmlPullParser, 
    attrs: AttributeSet
): Unit

isAutoMirrored

open fun isAutoMirrored(): Boolean

isRunning

open fun isRunning(): Boolean

isStateful

open fun isStateful(): Boolean

mutate

open fun mutate(): Drawable

mutate() will be effective only if the getConstantState() is returning non-null. Otherwise, it just return the current object without modification.

registerAnimationCallback

open fun registerAnimationCallback(@NonNull callback: Animatable2Compat.AnimationCallback): Unit

registerAnimationCallback

open static fun registerAnimationCallback(
    dr: Drawable!, 
    callback: Animatable2Compat.AnimationCallback!
): Unit

Utility function to register callback to Drawable, when the drawable is created from XML and referred in Java code, e.g: ImageView.getDrawable(). From API 24 on, the drawable is treated as an AnimatedVectorDrawable. Otherwise, it is treated as AnimatedVectorDrawableCompat.

setAlpha

open fun setAlpha(alpha: Int): Unit

setAutoMirrored

open fun setAutoMirrored(mirrored: Boolean): Unit

setColorFilter

open fun setColorFilter(colorFilter: ColorFilter?): Unit

setTint

open fun setTint(tint: Int): Unit

setTintList

open fun setTintList(tint: ColorStateList?): Unit

setTintMode

open fun setTintMode(tintMode: Mode?): Unit

setVisible

open fun setVisible(
    visible: Boolean, 
    restart: Boolean
): Boolean

start

open fun start(): Unit

stop

open fun stop(): Unit

unregisterAnimationCallback

open fun unregisterAnimationCallback(@NonNull callback: Animatable2Compat.AnimationCallback): Boolean

unregisterAnimationCallback

open static fun unregisterAnimationCallback(
    dr: Drawable!, 
    callback: Animatable2Compat.AnimationCallback!
): Boolean

Utility function to unregister animation callback from Drawable, when the drawable is created from XML and referred in Java code, e.g: ImageView.getDrawable(). From API 24 on, the drawable is treated as an AnimatedVectorDrawable. Otherwise, it is treated as AnimatedVectorDrawableCompat.

Protected methods

onBoundsChange

protected open fun onBoundsChange(bounds: Rect!): Unit

onLevelChange

protected open fun onLevelChange(level: Int): Boolean

onStateChange

protected open fun onStateChange(state: IntArray!): Boolean