Lottie使用文档

开始

Gradle是唯一支持Lottie构建的方式,因此尝试添加如下依赖在project的build.gradle文件中:

dependencies {
    ...
    implementation "com.airbnb.android:lottie:$lottieVersion"
    ...
}

Lottie最新版本请自行查阅.
Lottie不一样的使用请自行查阅.

示例程序

你可以从Play Store下载示例程序来进行build,示例程序包括一些内置动画,但也允许您从内部存储或从URL加载动画。

核心类

  • LottieAnimationView继承ImageView,这个类是使用Lottie动画最简单和默认的方式.
  • LottieDrawable:拥有和LottieAnimationView大部分一样的API,你可以在任何所需的View上使用它.

Loading an Animation

Lottie支持API 16及其以上版本
Lottie animations能够加载动画从:

  • A json animation in src/main/res/raw.
  • A json file in src/main/assets.
  • A zip file in src/main/assets. See images docs for more info.
  • A url to a json or zip file.
  • A json string. The source can be from anything including your own network stack.
  • An InputStream to either a json file or a zip file.

From XML

最简单的使用方式是LottieAnimationView:
建议使用lottie_rawRes,因为您可以通过R使用对动画的静态引用,而不是仅使用字符串名称。
From res/raw (lottie_rawRes) or assets/ (lottie_fileName)

<com.airbnb.lottie.LottieAnimationView
        android:id="@+id/animation_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"

        app:lottie_rawRes="@raw/hello_world"
        // or
        app:lottie_fileName="hello_world.json"

        // Loop indefinitely
        app:lottie_loop="true"
        // Start playing as soon as the animation is loaded
        app:lottie_autoPlay="true" />

你也可以调用Lottie的 LottieAnimationView的API直接使用动画,更多API可以直接查看相关类.

缓存动画

所有Lottie动画默认使用LRU cache缓存模式,默认的缓存的key为加载动画时根据res/raw/ 或者 assets/创建,其他的API要求设置cache key,如果您并行激发同一动画的多个动画请求(例如RecyclerView中的条目),则后续请求将加入现有任务,因此它只会被解析一次(Lottie> = 2.6.0).

Animation Listeners

你可以控制动画的执行或者是添加监听器.

animationView.addAnimatorUpdateListener((animation) -> {
    // Do something.
});
animationView.playAnimation();
...
if (animationView.isAnimating()) {
    // Do something.
}
...
animationView.setProgress(0.5f);
...

在更新监听器回调中:animation.getAnimatedValue()无论当前设置的最小/最大帧[0,1]如何,都将返回动画的进度。
animation.getAnimatedFraction():将返回动画的进度,同时考虑设置的最小/最大帧[minFrame,maxFrame]。

Custom animators

尽管playAnimation()足以满足绝大多数用例的需要,但您可以在自己的动画更新回调中调用setProgress(...),这可以将动画与手势,下载进度或滚动位置联系起来。

// Custom animation speed or duration.
ValueAnimator animator = ValueAnimator.ofFloat(0f, 1f);
animator.addUpdateListener(animation -> {
    animationView.setProgress(animation.getAnimatedValue());
});
animator.start();

Looping

Lottie支持镜像ValueAnimator的高级循环功能.因此,您可以像在ValueAnimator上一样调用setRepeatMode(...)或setRepeatCount(...)您还可以使用lottie_loop =“true”从xml启用循环.

Animation Size (px vs dp)

Lottie将After Effects中的所有px值转换为设备上的dps,以便在设备上以相同的大小呈现所有内容.这意味着它不是在After Effects中制作1920x1080的动画,而是在After Effects中更像411x731px,它大致对应于当今大多数手机的dp屏幕尺寸。
但是,如果您的动画不是完美尺寸,则有两种选择:
ImageView ScaleType
LottieAnimationView就像是一个包装的ImageView,它支持centerCrop和centerInside,因此你可以使用它在任何地方就好像使用imageView一样.
Scaling Up/Down
LottieAnimationView和LottieDrawable均有setScale(float)这个方法,它可以让你手动的去放缩你的动画,这很少有用,但在某些情况下有用。
如果你的动画执行速度较慢,请务必检查文档
但是,请尝试使用scaleType缩放动画。 这将减少Lottie每帧渲染的数量。 如果你有大的遮罩或面具,这将特别有用。

Play Animation Segments

通常播放和循环单个部分的动画是非常简单的,例如,动画的前半部分可能处于“开启”状态,下半部分处于“关闭”状态。
LottieAnimationView 和 LottieDrawable有如下方法:

setMinFrame(...)
setMaxFrame(...)
setMinProgress(...)
setMaxProgress(...)
setMinAndMaxFrame(...)
setMinAndMaxProgress(...)

Hardware Acceleration

Merge Paths

仅在Android 4.4及更高版本上支持路径合并,使用它们还有一些性能开销,因为Path.Op可能很慢,为了防止工程师在启用路径合并的新设备上进行测试,同时向旧手机上的用户发送破坏的体验,默认情况下会禁用它们,如果您的minSdk> = 19,则可以使用enableMergePathsForKitKatAndAbove()启用.

Basic WorkFlow

Static Asset Workflow
在你的布局中引入png或者vector drawables (xml) in res/drawable:

<ImageView
        android:id="@+id/image_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:scaleType="centerCrop"
        android:src="@drawble/your_drawable" />

Lottie workflow
在你的布局中引入Lottie json in res/raw:

<com.airbnb.lottie.LottieAnimationView
        android:id="@+id/animation_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:scaleType="centerCrop"
        app:lottie_rawRes="@raw/your_animation"
        app:lottie_loop="true"
        app:lottie_autoPlay="true" />

LottieAnimationView继承自ImageView,因此你可以很方便的使用LottieAnimationView替代ImageView,尽管你在使用drawables.

Updating Properties Dynamically

Lottie 2.5.0+以后,你可以在运行中动态更新属性,这可以用作各种目的,例如:

  • 主题 (白天和夜晚或者其他主题)
  • 事件响应(成功或者失败)
  • 以动画的单个部分响应一个事件
  • 响应视图大小或在设计时未知的其他值

Understanding After Effects

要了解如何在Lottie中更改动画属性,首先应该了解动画属性如何存储在Lottie中。 动画属性存储在模拟After Effects信息层次结构的数据树中。 在After Effects中,合成是一组图层,每个图层都有自己的时间轴。 图层对象具有字符串名称,其内容可以是图像,形状图层,填充,笔划或任何可绘制的内容。 After Effects中的每个对象都有一个名称。 Lottie可以使用KeyPath通过名称找到这些对象和属性。

用法

运行中更新属性,你需要做三件事:

  • KeyPath
  • LottieProperty
  • LottieValueCallback
    KeyPath
    KeyPath用于定位将要更新的特定内容或一组内容,KeyPath由与原始动画中After Effects内容的层次结构相对应的字符串列表指定。
    KeyPaths可以包含内容或通配符的特定名称:
'*'

通配符匹配键路径中任何单个内容名称

'**'

匹配零个或多个层次

Image

Lottie可以使用矢量图形,尽管Lottie支持图像渲染,但是有个缺点:

  • 支持动画的文件比它们的等效矢量动画大一个数量级
  • 它们在缩放时会出现不好的支持
  • 它们增加了动画的复杂性,因为您拥有json文件和支撑的图像文件,而不是一个文件

Lottie文件中图像的常见原因是bodymovin将After Effects中的Illustrator图层导出为图像,如果您认为可能出现这种情况,请按照此处的说明操作

设置你的image的方式有三种:

src/assets

如果必须使用image,可以将其放在src/assets之下,不要更改其在json文件中的资源id对应的name,或者可以对应改之。之后通过在LottieAnimationView上调用setImageAssetsFolder或使用资产内部的相对文件夹调用LottieDrawable,将Lottie指向存储图像的assets文件夹,如果您直接使用LottieDrawable,完成动画后,您应该调用recycleBitmaps。

zip file

可以将json和img一起创建一个zip文件,Lottie可以解压缩并阅读内容.

Providing your own images

有时,没有与设备捆绑在一起的image,可以从网络加载动画以节省apk中的空间。要处理这种情况,可以在LottieAnimationView或LottieDrawable上设置ImageAssetDelegate,每次Lottie尝试渲染图像时都会调用delgate,它将传递图像名称并要求您返回位图,如果你还没有(例如,如果它还在下载),那么只返回null,Lottie将继续询问每一帧,直到你返回一个非null值。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容

  • LottieAndroid使用详解及源码解析,让你的应用加载动画变得轻而易举。看源码的时候跟着我最下面的两张时序图...
    Moninn阅读 3,746评论 2 46
  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    阳明先生_x阅读 15,968评论 3 119
  • “恭迎魔尊大人"朱红色的殿堂下一群小喽罗战战兢兢地向殿外地一个穿着黑色衣袍,衣肩上还有许多黑鸦毛做装饰物,一头雪白...
    爱无疆阅读 568评论 0 0
  • 你说过,这样的人生不是你想要的,我不以为然,除了止不住的嘲笑,还有深深的叹息。 “嘿,我们来一个约定怎么样?” “...
    土也零零阅读 353评论 0 7
  • 青春,生命的历程,追梦人留下的足迹;青春,唯美的中国,实现梦想的力量。 青春是幼稚走向成熟的蜕变,...
    追梦诗人阅读 550评论 0 1