Added in API level 21

AnimatedVectorDrawable

---

Kotlin |Java

open class AnimatedVectorDrawable : Drawable, Animatable2

kotlin.Any
↳	android.graphics.drawable.Drawable
	↳	android.graphics.drawable.AnimatedVectorDrawable

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.

Define an AnimatedVectorDrawable in three separate XML files

• XML for the VectorDrawable containing properties to be animated

  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:

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

  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>
    

• XML for AnimatedVectorDrawable

  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>
    

• XML for Animations defined using ObjectAnimator or AnimatorSet

  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>
    

Define an AnimatedVectorDrawable all in one XML file

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>
  

Summary

XML attributes
android:animation	The animation for the target path, group or vector drawable.
android:drawable	The static vector drawable.
android:name	The name of the target path, group or vector drawable.

Public constructors
AnimatedVectorDrawable()

Public methods
open Unit	applyTheme(t: Resources.Theme)
open Boolean	canApplyTheme()
open Unit	clearAnimationCallbacks()
open Unit	draw(canvas: Canvas) Draws the AnimatedVectorDrawable into the given canvas.
open Int	getAlpha() For API 25 and later, AnimatedVectorDrawable runs on RenderThread.
open Int	getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created.
open ColorFilter?	getColorFilter()
open Drawable.ConstantState?	getConstantState()
open Int	getIntrinsicHeight()
open Int	getIntrinsicWidth()
open Int	getOpacity()
open Insets	getOpticalInsets()
open Unit	getOutline(outline: Outline) Called to get the drawable to populate the Outline that defines its drawing area.
open Unit	inflate(res: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)
open Boolean	isRunning()
open Boolean	isStateful()
open Drawable	mutate()
open Boolean	onLayoutDirectionChanged(layoutDirection: Int) Called when the drawable's resolved layout direction changes.
open Unit	registerAnimationCallback(callback: Animatable2.AnimationCallback) Adds a callback to listen to the animation events.
open Unit	reset() Resets the AnimatedVectorDrawable to the start state as specified in the animators.
open Unit	setAlpha(alpha: Int)
open Unit	setColorFilter(colorFilter: ColorFilter?)
open Unit	setHotspot(x: Float, y: Float)
open Unit	setHotspotBounds(left: Int, top: Int, right: Int, bottom: Int)
open Unit	setTintBlendMode(blendMode: BlendMode!) Specifies a tint blending mode for this drawable.
open Unit	setTintList(tint: ColorStateList?)
open Boolean	setVisible(visible: Boolean, restart: Boolean)
open Unit	start()
open Unit	stop()
open Boolean	unregisterAnimationCallback(callback: Animatable2.AnimationCallback) Removes the specified animation callback.

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

Inherited functions

From class Drawable Unit clearColorFilter() Removes the color filter for this drawable. Unit copyBounds(bounds: Rect) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). The bounds specify where this will draw when its draw() method is called. Rect copyBounds() Return a copy of the drawable's bounds in a new Rect. This returns the same values as getBounds(), but the returned object is guaranteed to not be changed later by the drawable (i.e. it retains no reference to this rect). If the caller already has a Rect allocated, call copyBounds(rect). Drawable? createFromPath(pathName: String!) Create a drawable from file path name. Drawable? createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?) Create a drawable from an inputstream, using the given resources and value to determine density information. Drawable? createFromResourceStream(res: Resources?, value: TypedValue?, is: InputStream?, srcName: String?, opts: BitmapFactory.Options?) Create a drawable from an inputstream, using the given resources and value to determine density information. Drawable? createFromStream(is: InputStream?, srcName: String?) Create a drawable from an inputstream Drawable createFromXml(r: Resources, parser: XmlPullParser) Create a drawable from an XML document. For more information on how to create resources in XML, see Drawable Resources. Drawable createFromXml(r: Resources, parser: XmlPullParser, theme: Resources.Theme?) Create a drawable from an XML document using an optional Theme. For more information on how to create resources in XML, see Drawable Resources. Drawable createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet) Create from inside an XML document. 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. Drawable createFromXmlInner(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?) Create a drawable 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. Rect getBounds() Return the drawable's bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed), so if a persistent copy of the bounds is needed, call copyBounds(rect) instead. You should also not change the object returned by this method as it may be the same object stored in the drawable. Drawable.Callback? getCallback() Return the current Callback implementation attached to this Drawable. Drawable getCurrent() Rect getDirtyBounds() Return the drawable's dirty bounds Rect. Note: for efficiency, the returned object may be the same object stored in the drawable (though this is not guaranteed). By default, this returns the full drawable bounds. Custom drawables may override this method to perform more precise invalidation. Unit getHotspotBounds(outRect: Rect) Populates outRect with the hotspot bounds. Int getLayoutDirection() Returns the resolved layout direction for this Drawable. Int getLevel() Retrieve the current level. Int getMinimumHeight() Returns the minimum height suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its height. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding. Int getMinimumWidth() Returns the minimum width suggested by this Drawable. If a View uses this Drawable as a background, it is suggested that the View use at least this value for its width. (There will be some scenarios where this will not be possible.) This value should INCLUDE any padding. Boolean getPadding(padding: Rect) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset). IntArray getState() Describes the current state, as a union of primitive states, such as android.R.attr#state_focused, android.R.attr#state_selected, etc. Some drawables may modify their imagery based on the selected state. Region? getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent. This can be used to perform drawing operations, identifying which parts of the target will not change when rendering the Drawable. The default implementation returns null, indicating no transparent region; subclasses can optionally override this to return an actual Region if they want to supply this optimization information, but it is not required that they do so. Boolean hasFocusStateSpecified() Indicates whether this drawable has at least one state spec explicitly specifying android.R.attr#state_focused. Note: A View uses a Drawable instance as its background and it changes its appearance based on a state. On keyboard devices, it should specify its android.R.attr#state_focused to make sure the user knows which view is holding the focus. Unit inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet) Inflate this Drawable from an XML resource. Does not apply a theme. Unit invalidateSelf() Use the current Callback implementation to have this Drawable redrawn. Does nothing if there is no Callback attached to the Drawable. Boolean isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See android.util.LayoutDirection. Boolean isFilterBitmap() Boolean isProjected() Whether this drawable requests projection. Indicates that the android.graphics.RenderNode this Drawable will draw into should be drawn immediately after the closest ancestor RenderNode containing a projection receiver. Boolean isVisible() Unit jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations. Int resolveOpacity(op1: Int, op2: Int) Return the appropriate opacity value for two source opacities. If either is UNKNOWN, that is returned; else, if either is TRANSLUCENT, that is returned; else, if either is TRANSPARENT, that is returned; else, OPAQUE is returned. This is to help in implementing getOpacity. Unit scheduleSelf(what: Runnable, when: Long) Use the current Callback implementation to have this Drawable scheduled. Does nothing if there is no Callback attached to the Drawable. Unit setAutoMirrored(mirrored: Boolean) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See android.util.LayoutDirection. Unit setBounds(left: Int, top: Int, right: Int, bottom: Int) Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called. Unit setBounds(bounds: Rect) Specify a bounding rectangle for the Drawable. This is where the drawable will draw when its draw() method is called. Unit setCallback(cb: Drawable.Callback?) Bind a Callback object to this Drawable. Required for clients that want to support animated drawables. Unit setChangingConfigurations(configs: Int) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. Unit setColorFilter(color: Int, mode: PorterDuff.Mode) Specify a color and Porter-Duff mode to be the color filter for this drawable. Convenience for setColorFilter(android.graphics.ColorFilter) which constructs a PorterDuffColorFilter. Note: Setting a color filter disables tint. Unit setDither(dither: Boolean) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component. Unit setFilterBitmap(filter: Boolean) Set to true to have the drawable filter its bitmaps with bilinear sampling when they are scaled or rotated. This can improve appearance when bitmaps are rotated. If the drawable does not use bitmaps, this call is ignored. Boolean setLayoutDirection(layoutDirection: Int) Set the layout direction for this drawable. Should be a resolved layout direction, as the Drawable has no capacity to do the resolution on its own. Boolean setLevel(level: Int) Specify the level for the drawable. This allows a drawable to vary its imagery based on a continuous controller, for example to show progress or volume level. If the new level you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function. Boolean setState(stateSet: IntArray) Specify a set of states for the drawable. These are use-case specific, so see the relevant documentation. As an example, the background for widgets like Button understand the following states: [android.R.attr#state_focused, android.R.attr#state_pressed]. If the new state you are supplying causes the appearance of the Drawable to change, then it is responsible for calling invalidateSelf in order to have itself redrawn, and true will be returned from this function. Note: The Drawable holds a reference on to stateSet until a new state array is given to it, so you must not modify this array during that time. Unit setTint(tintColor: Int) Specifies tint color for this drawable. 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,android.graphics.PorterDuff.Mode). To clear the tint, pass null to setTintList(android.content.res.ColorStateList). Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint. Unit setTintMode(tintMode: PorterDuff.Mode?) 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 PorterDuff.Mode#SRC_IN. Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter) or setColorFilter(int,android.graphics.PorterDuff.Mode) overrides tint. Unit unscheduleSelf(what: Runnable) Use the current Callback implementation to have this Drawable unscheduled. Does nothing if there is no Callback attached to the Drawable.

XML attributes

android:animation

android:animation

The animation for the target path, group or vector drawable.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:drawable

android:drawable

The static vector drawable.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:name

android:name

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

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

Public constructors

AnimatedVectorDrawable

Added in API level 21

AnimatedVectorDrawable()

Public methods

applyTheme

Added in API level 21

open fun applyTheme(t: Resources.Theme): Unit

Parameters
t	Resources.Theme: the theme to apply This value cannot be null.

canApplyTheme

Added in API level 21

open fun canApplyTheme(): Boolean

clearAnimationCallbacks

Added in API level 23

open fun clearAnimationCallbacks(): Unit

draw

Added in API level 21

open fun draw(canvas: Canvas): Unit

Draws the AnimatedVectorDrawable into the given canvas.

Note: Calling this method with a software canvas when the AnimatedVectorDrawable is being animated on RenderThread (for API 25 and later) may yield outdated result, as the UI thread is not guaranteed to be in sync with RenderThread on VectorDrawable's property changes during RenderThread animations.

Parameters
canvas	Canvas: The canvas to draw into

getAlpha

Added in API level 21

open fun getAlpha(): Int

For API 25 and later, AnimatedVectorDrawable runs on RenderThread. Therefore, when the root alpha is being animated, this getter does not guarantee to return an up-to-date alpha value.

Return
Int	the containing vector drawable's root alpha value.

getChangingConfigurations

Added in API level 21

open fun getChangingConfigurations(): Int

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.

Return

Int

Value is either 0 or a combination of android.content.pm.ActivityInfo#CONFIG_MCC, android.content.pm.ActivityInfo#CONFIG_MNC, android.content.pm.ActivityInfo#CONFIG_LOCALE, android.content.pm.ActivityInfo#CONFIG_TOUCHSCREEN, android.content.pm.ActivityInfo#CONFIG_KEYBOARD, android.content.pm.ActivityInfo#CONFIG_KEYBOARD_HIDDEN, android.content.pm.ActivityInfo#CONFIG_NAVIGATION, android.content.pm.ActivityInfo#CONFIG_ORIENTATION, android.content.pm.ActivityInfo#CONFIG_SCREEN_LAYOUT, android.content.pm.ActivityInfo#CONFIG_UI_MODE, android.content.pm.ActivityInfo#CONFIG_SCREEN_SIZE, android.content.pm.ActivityInfo#CONFIG_SMALLEST_SCREEN_SIZE, android.content.pm.ActivityInfo#CONFIG_DENSITY, android.content.pm.ActivityInfo#CONFIG_LAYOUT_DIRECTION, android.content.pm.ActivityInfo#CONFIG_COLOR_MODE, android.content.pm.ActivityInfo#CONFIG_FONT_SCALE, and android.content.pm.ActivityInfo#CONFIG_GRAMMATICAL_GENDER

getColorFilter

Added in API level 21

open fun getColorFilter(): ColorFilter?

Return
ColorFilter?	the current color filter, or null if none set

getConstantState

Added in API level 21

open fun getConstantState(): Drawable.ConstantState?

Return
Drawable.ConstantState?	The ConstantState associated to that Drawable. This value may be null.

getIntrinsicHeight

Added in API level 21

open fun getIntrinsicHeight(): Int

Return
Int	the intrinsic height, or -1 if no intrinsic height

getIntrinsicWidth

Added in API level 21

open fun getIntrinsicWidth(): Int

Return
Int	the intrinsic width, or -1 if no intrinsic width

getOpacity

Added in API level 21

open fun getOpacity(): Int

Return
Int	int The opacity class of the Drawable. Value is android.graphics.PixelFormat#UNKNOWN, android.graphics.PixelFormat#TRANSLUCENT, android.graphics.PixelFormat#TRANSPARENT, or android.graphics.PixelFormat#OPAQUE

getOpticalInsets

Added in API level 29

open fun getOpticalInsets(): Insets

Return
Insets	This value cannot be null.

getOutline

Added in API level 21

open fun getOutline(outline: Outline): Unit

Called to get the drawable to populate the Outline that defines its drawing area.

This method is called by the default android.view.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: This value cannot be null.

inflate

Added in API level 21

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

Parameters
r	Resources used to resolve attribute values This value cannot be null.
parser	XmlPullParser: XML parser from which to inflate this Drawable This value cannot be null.
attrs	AttributeSet: Base set of attribute values This value cannot be null.
theme	Resources.Theme?: Theme to apply, may be null

Exceptions
org.xmlpull.v1.XmlPullParserException
java.io.IOException

isRunning

Added in API level 21

open fun isRunning(): Boolean

Return
Boolean	True if the animation is running, false otherwise.

isStateful

Added in API level 21

open fun isStateful(): Boolean

Return
Boolean	True if this drawable changes its appearance based on state, false otherwise.

mutate

Added in API level 21

open fun mutate(): Drawable

Return
Drawable	This drawable. This value cannot be null.

onLayoutDirectionChanged

Added in API level 23

open fun onLayoutDirectionChanged(layoutDirection: Int): Boolean

Called when the drawable's resolved layout direction changes.

Parameters
layoutDirection	Int: Value is android.view.View#LAYOUT_DIRECTION_LTR, or android.view.View#LAYOUT_DIRECTION_RTL

Return
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

open fun registerAnimationCallback(callback: Animatable2.AnimationCallback): Unit

Adds a callback to listen to the animation events.

Parameters
callback	Animatable2.AnimationCallback: This value cannot be null.

reset

Added in API level 23

open fun reset(): Unit

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

setAlpha

Added in API level 21

open fun setAlpha(alpha: Int): Unit

Parameters
alpha	Int: Value is between 0 and 255 inclusive

setColorFilter

Added in API level 21

open fun setColorFilter(colorFilter: ColorFilter?): Unit

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

setHotspot

Added in API level 21

open fun setHotspot(
    x: Float, 
    y: Float
): Unit

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

open fun setHotspotBounds(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

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

setTintBlendMode

Added in API level 29

open fun setTintBlendMode(blendMode: BlendMode!): Unit

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

Note: Setting a color filter via setColorFilter(android.graphics.ColorFilter)

Parameters
blendMode	BlendMode!: This value cannot be null.

setTintList

Added in API level 21

open fun setTintList(tint: ColorStateList?): Unit

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

setVisible

Added in API level 21

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

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.

Return
Boolean	boolean Returns true if the new visibility is different than its previous state.

start

Added in API level 21

open fun start(): Unit

stop

Added in API level 21

open fun stop(): Unit

unregisterAnimationCallback

Added in API level 23

open fun unregisterAnimationCallback(callback: Animatable2.AnimationCallback): Boolean

Removes the specified animation callback.

Parameters
callback	Animatable2.AnimationCallback: This value cannot be null.

Return
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

protected open fun onBoundsChange(bounds: Rect): Unit

Parameters
bounds	Rect: This value cannot be null.

onLevelChange

Added in API level 21

protected open fun onLevelChange(level: Int): Boolean

Return
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

protected open fun onStateChange(state: IntArray): Boolean

Parameters
state	IntArray: This value cannot be null.

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