com.airbnb.lottie

Class LottieDrawable

java.lang.Object

android.graphics.drawable.Drawable

com.airbnb.lottie.LottieDrawable

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback

public class LottieDrawable
extends android.graphics.drawable.Drawable
implements android.graphics.drawable.Drawable.Callback

This can be used to show an lottie animation in any place that would normally take a drawable. If there are masks or mattes, then you MUST call recycleBitmaps() when you are done or else you will leak bitmaps.

It is preferable to use LottieAnimationView when possible because it handles bitmap recycling and asynchronous loading of compositions.

Nested Class Summary

Nested classes/interfaces inherited from class android.graphics.drawable.Drawable

android.graphics.drawable.Drawable.Callback, android.graphics.drawable.Drawable.ConstantState

Constructor Summary

Constructors

Constructor and Description
LottieDrawable()

Method Summary

Modifier and Type	Method and Description
void	addAnimatorListener(android.animation.Animator.AnimatorListener listener)
void	addAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)
void	cancelAnimation()
void	draw(android.graphics.Canvas canvas)
void	enableMergePathsForKitKatAndAbove(boolean enable) Enable this to get merge path support for devices running KitKat (19) and above.
int	getAlpha()
LottieComposition	getComposition()
int	getIntrinsicHeight()
int	getIntrinsicWidth()
int	getOpacity()
float	getProgress()
float	getScale()
boolean	hasMasks() Returns whether or not any layers in this composition has masks.
boolean	hasMatte() Returns whether or not any layers in this composition has a matte layer.
void	invalidateDrawable(android.graphics.drawable.Drawable who) These Drawable.Callback methods proxy the calls so that this is the drawable that is actually invalidated, not a child one which will not pass the view's validateDrawable check.
void	invalidateSelf()
boolean	isAnimating()
boolean	isLooping()
void	loop(boolean loop)
void	playAnimation()
void	recycleBitmaps() If you have image assets and use LottieDrawable directly, you must call this yourself.
void	removeAnimatorListener(android.animation.Animator.AnimatorListener listener)
void	removeAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)
void	resumeAnimation()
void	resumeReverseAnimation()
void	reverseAnimation()
void	scheduleDrawable(android.graphics.drawable.Drawable who, java.lang.Runnable what, long when)
void	setAlpha(int alpha)
void	setColorFilter(android.graphics.ColorFilter colorFilter)
boolean	setComposition(LottieComposition composition)
void	setImageAssetDelegate(ImageAssetDelegate assetDelegate) Use this if you can't bundle images with your app.
void	setImagesAssetsFolder(java.lang.String imageAssetsFolder) If you use image assets, you must explicitly specify the folder in assets/ in which they are located because bodymovin uses the name filenames across all compositions (img_#).
void	setProgress(float progress)
void	setScale(float scale)
void	setSpeed(float speed)
void	unscheduleDrawable(android.graphics.drawable.Drawable who, java.lang.Runnable what)

Methods inherited from class android.graphics.drawable.Drawable

applyTheme, canApplyTheme, clearColorFilter, copyBounds, copyBounds, createFromPath, createFromResourceStream, createFromResourceStream, createFromStream, createFromXml, createFromXml, createFromXmlInner, createFromXmlInner, getBounds, getCallback, getChangingConfigurations, getColorFilter, getConstantState, getCurrent, getDirtyBounds, getHotspotBounds, getLayoutDirection, getLevel, getMinimumHeight, getMinimumWidth, getOutline, getPadding, getState, getTransparentRegion, inflate, inflate, isAutoMirrored, isFilterBitmap, isStateful, isVisible, jumpToCurrentState, mutate, onBoundsChange, onLayoutDirectionChanged, onLevelChange, onStateChange, resolveOpacity, scheduleSelf, setAutoMirrored, setBounds, setBounds, setCallback, setChangingConfigurations, setColorFilter, setDither, setFilterBitmap, setHotspot, setHotspotBounds, setLayoutDirection, setLevel, setState, setTint, setTintList, setTintMode, setVisible, unscheduleSelf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LottieDrawable

public LottieDrawable()

Method Detail

hasMasks

public boolean hasMasks()

Returns whether or not any layers in this composition has masks.

hasMatte

public boolean hasMatte()

Returns whether or not any layers in this composition has a matte layer.

enableMergePathsForKitKatAndAbove

public void enableMergePathsForKitKatAndAbove(boolean enable)

Enable this to get merge path support for devices running KitKat (19) and above. Merge paths currently don't work if the the operand shape is entirely contained within the first shape. If you need to cut out one shape from another shape, use an even-odd fill type instead of using merge paths.

setImagesAssetsFolder

public void setImagesAssetsFolder(java.lang.String imageAssetsFolder)

If you use image assets, you must explicitly specify the folder in assets/ in which they are located because bodymovin uses the name filenames across all compositions (img_#). Do NOT rename the images themselves. If your images are located in src/main/assets/airbnb_loader/ then call `setImageAssetsFolder("airbnb_loader/");`. If you use LottieDrawable directly, you MUST call recycleBitmaps() when you are done. Calling recycleBitmaps() doesn't have to be final and LottieDrawable will recreate the bitmaps if needed but they will leak if you don't recycle them.

recycleBitmaps

public void recycleBitmaps()

If you have image assets and use LottieDrawable directly, you must call this yourself. Calling recycleBitmaps() doesn't have to be final and LottieDrawable will recreate the bitmaps if needed but they will leak if you don't recycle them.

setComposition

public boolean setComposition(LottieComposition composition)

Returns:

True if the composition is different from the previously set composition, false otherwise.

invalidateSelf

public void invalidateSelf()

Overrides:

invalidateSelf in class android.graphics.drawable.Drawable

setAlpha

public void setAlpha(int alpha)

Specified by:

setAlpha in class android.graphics.drawable.Drawable

getAlpha

public int getAlpha()

Overrides:

getAlpha in class android.graphics.drawable.Drawable

setColorFilter

public void setColorFilter(android.graphics.ColorFilter colorFilter)

Specified by:

setColorFilter in class android.graphics.drawable.Drawable

getOpacity

public int getOpacity()

Specified by:

getOpacity in class android.graphics.drawable.Drawable

draw

public void draw(android.graphics.Canvas canvas)

Specified by:

draw in class android.graphics.drawable.Drawable

loop

public void loop(boolean loop)

isLooping

public boolean isLooping()

isAnimating

public boolean isAnimating()

playAnimation

public void playAnimation()

resumeAnimation

public void resumeAnimation()

resumeReverseAnimation

public void resumeReverseAnimation()

reverseAnimation

public void reverseAnimation()

setSpeed

public void setSpeed(float speed)

setProgress

public void setProgress(float progress)

getProgress

public float getProgress()

setScale

public void setScale(float scale)

setImageAssetDelegate

public void setImageAssetDelegate(ImageAssetDelegate assetDelegate)

Use this if you can't bundle images with your app. This may be useful if you download the animations from the network or have the images saved to an SD Card. In that case, Lottie will defer the loading of the bitmap to this delegate.

getScale

public float getScale()

getComposition

public LottieComposition getComposition()

cancelAnimation

public void cancelAnimation()

addAnimatorUpdateListener

public void addAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)

removeAnimatorUpdateListener

public void removeAnimatorUpdateListener(android.animation.ValueAnimator.AnimatorUpdateListener updateListener)

addAnimatorListener

public void addAnimatorListener(android.animation.Animator.AnimatorListener listener)

removeAnimatorListener

public void removeAnimatorListener(android.animation.Animator.AnimatorListener listener)

getIntrinsicWidth

public int getIntrinsicWidth()

Overrides:

getIntrinsicWidth in class android.graphics.drawable.Drawable

getIntrinsicHeight

public int getIntrinsicHeight()

Overrides:

getIntrinsicHeight in class android.graphics.drawable.Drawable

invalidateDrawable

public void invalidateDrawable(android.graphics.drawable.Drawable who)

These Drawable.Callback methods proxy the calls so that this is the drawable that is actually invalidated, not a child one which will not pass the view's validateDrawable check.

Specified by:

invalidateDrawable in interface android.graphics.drawable.Drawable.Callback

scheduleDrawable

public void scheduleDrawable(android.graphics.drawable.Drawable who,
                             java.lang.Runnable what,
                             long when)

Specified by:

scheduleDrawable in interface android.graphics.drawable.Drawable.Callback

unscheduleDrawable

public void unscheduleDrawable(android.graphics.drawable.Drawable who,
                               java.lang.Runnable what)

Specified by:

unscheduleDrawable in interface android.graphics.drawable.Drawable.Callback