belongs to Maven artifact com.android.support:animated-vector-drawable:28.0.0-alpha1
AnimatedVectorDrawableCompat
public
class
AnimatedVectorDrawableCompat
extends Drawable
implements
Animatable2Compat
java.lang.Object | ||
↳ | android.graphics.drawable.Drawable | |
↳ | android.support.graphics.drawable.AnimatedVectorDrawableCompat |
For API 24 and above, this class is delegating to the framework's AnimatedVectorDrawable
.
For older API version, this class uses ObjectAnimator
and
AnimatorSet
to animate the properties of a
VectorDrawableCompat
to create an animated drawable.
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 |
- 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 | |
---|---|
void
|
applyTheme(Resources.Theme t)
|
boolean
|
canApplyTheme()
|
void
|
clearAnimationCallbacks()
Removes all existing animation callbacks. |
static
void
|
clearAnimationCallbacks(Drawable dr)
Utility function to clear animation callbacks from Drawable, when the drawable is created from XML and referred in Java code, e.g: ImageView.getDrawable(). |
void
|
clearColorFilter()
|
static
AnimatedVectorDrawableCompat
|
create(Context context, int resId)
Create a AnimatedVectorDrawableCompat object. |
static
AnimatedVectorDrawableCompat
|
createFromXmlInner(Context context, Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Create a AnimatedVectorDrawableCompat from inside an XML document using an optional
|
void
|
draw(Canvas canvas)
|
int
|
getAlpha()
|
int
|
getChangingConfigurations()
|
ColorFilter
|
getColorFilter()
|
Drawable.ConstantState
|
getConstantState()
Note that we don't support constant state when SDK < 24. |
Drawable
|
getCurrent()
|
int
|
getIntrinsicHeight()
|
int
|
getIntrinsicWidth()
|
int
|
getMinimumHeight()
|
int
|
getMinimumWidth()
|
int
|
getOpacity()
|
boolean
|
getPadding(Rect padding)
|
int[]
|
getState()
|
Region
|
getTransparentRegion()
|
void
|
inflate(Resources res, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
|
void
|
inflate(Resources res, XmlPullParser parser, AttributeSet attrs)
|
boolean
|
isAutoMirrored()
|
boolean
|
isRunning()
|
boolean
|
isStateful()
|
void
|
jumpToCurrentState()
|
Drawable
|
mutate()
mutate() will be effective only if the getConstantState() is returning non-null. |
static
void
|
registerAnimationCallback(Drawable dr, Animatable2Compat.AnimationCallback callback)
Utility function to register callback to Drawable, when the drawable is created from XML and referred in Java code, e.g: ImageView.getDrawable(). |
void
|
registerAnimationCallback(Animatable2Compat.AnimationCallback callback)
Adds a callback to listen to the animation events. |
void
|
setAlpha(int alpha)
|
void
|
setAutoMirrored(boolean mirrored)
|
void
|
setChangingConfigurations(int configs)
|
void
|
setColorFilter(int color, PorterDuff.Mode mode)
|
void
|
setColorFilter(ColorFilter colorFilter)
|
void
|
setFilterBitmap(boolean filter)
|
void
|
setHotspot(float x, float y)
|
void
|
setHotspotBounds(int left, int top, int right, int bottom)
|
boolean
|
setState(int[] stateSet)
|
void
|
setTint(int tint)
|
void
|
setTintList(ColorStateList tint)
|
void
|
setTintMode(PorterDuff.Mode tintMode)
|
boolean
|
setVisible(boolean visible, boolean restart)
|
void
|
start()
|
void
|
stop()
|
boolean
|
unregisterAnimationCallback(Animatable2Compat.AnimationCallback callback)
Removes the specified animation callback. |
static
boolean
|
unregisterAnimationCallback(Drawable dr, Animatable2Compat.AnimationCallback callback)
Utility function to unregister animation callback from Drawable, when the drawable is created from XML and referred in Java code, e.g: ImageView.getDrawable(). |
Protected methods | |
---|---|
void
|
onBoundsChange(Rect bounds)
|
boolean
|
onLevelChange(int level)
|
boolean
|
onStateChange(int[] state)
|
Inherited methods | |
---|---|
![]()
android.graphics.drawable.Drawable
| |
![]()
java.lang.Object
| |
![]()
android.support.graphics.drawable.Animatable2Compat
| |
![]()
android.graphics.drawable.Animatable
|
Public methods
canApplyTheme
boolean canApplyTheme ()
Returns | |
---|---|
boolean |
clearAnimationCallbacks
void clearAnimationCallbacks ()
Removes all existing animation callbacks.
clearAnimationCallbacks
void clearAnimationCallbacks (Drawable dr)
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.
Parameters | |
---|---|
dr |
Drawable |
clearColorFilter
void clearColorFilter ()
create
AnimatedVectorDrawableCompat create (Context context, int resId)
Create a AnimatedVectorDrawableCompat object.
Parameters | |
---|---|
context |
Context : the context for creating the animators. |
resId |
int : the resource ID for AnimatedVectorDrawableCompat object. |
Returns | |
---|---|
AnimatedVectorDrawableCompat |
a new AnimatedVectorDrawableCompat or null if parsing error is found. |
createFromXmlInner
AnimatedVectorDrawableCompat createFromXmlInner (Context context, Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme)
Create a AnimatedVectorDrawableCompat from inside an XML document using an optional
Resources.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.
Parameters | |
---|---|
context |
Context |
r |
Resources |
parser |
XmlPullParser |
attrs |
AttributeSet |
theme |
Resources.Theme |
Returns | |
---|---|
AnimatedVectorDrawableCompat |
Throws | |
---|---|
XmlPullParserException |
|
IOException |
getAlpha
int getAlpha ()
Returns | |
---|---|
int |
getChangingConfigurations
int getChangingConfigurations ()
Returns | |
---|---|
int |