• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 显式动画
2
3提供全局animateTo显式动画接口来指定由于闭包代码导致的状态变化插入过渡动效。同属性动画,布局类改变宽高的动画,内容都是直接到终点状态,例如文字、canvas的内容、linearGradient等,如果要内容跟随宽高变化,可以使用[renderFit](ts-universal-attributes-renderfit.md)属性配置。
4
5>  **说明:**
6>
7>  从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8>
9>  本模块功能依赖UI的执行上下文,不可在UI上下文不明确的地方使用,参见[UIContext](../apis/js-apis-arkui-UIContext.md#uicontext)说明。
10>
11>从API version 9开始,该接口支持在ArkTS卡片中使用。
12>
13>  从API version 10开始,可以通过使用[UIContext](../apis/js-apis-arkui-UIContext.md#uicontext)中的[animateTo](../apis/js-apis-arkui-UIContext.md#animateto)来明确UI的执行上下文。
14
15## 接口
16animateTo(value: AnimateParam, event: () => void): void
17
18
19**参数:**
20| 参数    | 类型                                | 是否必填 | 描述                                    |
21| ----- | --------------------------------- | ---- | ------------------------------------- |
22| value | [AnimateParam](#animateparam对象说明) | 是    | 设置动画效果相关参数。                           |
23| event | () => void                        | 是    | 指定显示动效的闭包函数,在闭包函数中导致的状态变化系统会自动插入过渡动画。 |
24
25## AnimateParam对象说明
26
27| 名称         | 类型                                       | 描述                                       |
28| ---------- | ---------------------------------------- | ---------------------------------------- |
29| duration   | number                                   | 动画持续时间,单位为毫秒。<br/>默认值:1000<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>**说明:**<br/>- 在ArkTS卡片上最大动画持续时间为1000毫秒,若超出则固定为1000毫秒。<br/>-&nbsp;设置小于0的值时按0处理。<br/>-&nbsp;设置浮点型类型的值时,向下取整。例如,设置值为1.2,按照1处理。 |
30| tempo      | number                                   | 动画播放速度,值越大动画播放越快,值越小播放越慢,为0时无动画效果。<br/>默认值:1.0<br/>**说明:** <br/>当设置小于0的值时按值为1处理。 |
31| curve      | [Curve](ts-appendix-enums.md#curve)&nbsp;\|&nbsp;[ICurve<sup>9+</sup>](../apis/js-apis-curve.md#icurve)&nbsp;\|&nbsp;string | 动画曲线。<br/>默认值:Curve.EaseInOut<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
32| delay      | number                                   | 动画延迟播放时间,单位为ms(毫秒),默认不延时播放。<br/>默认值:0<br/>取值范围:(-∞, +∞)<br/>**说明:** <br/>-&nbsp;delay>=0为延迟播放,delay<0表示提前播放。对于delay<0的情况:当delay的绝对值小于实际动画时长,动画将在开始后第一帧直接运动到delay绝对值的时刻的状态;当delay的绝对值大于等于实际动画时长,动画将在开始后第一帧直接运动到终点状态。其中实际动画时长等于单次动画时长乘以动画播放次数。<br/>-&nbsp;设置浮点型类型的值时,向下取整。例如,设置值为1.2,按照1处理。 |
33| iterations | number                                   | 动画播放次数。默认播放一次,设置为-1时表示无限次播放。设置为0时表示无动画效果。<br/>默认值:1 <br/>取值范围:[-1, +∞)          |
34| playMode   | [PlayMode](ts-appendix-enums.md#playmode) | 动画播放模式,默认播放完成后重头开始播放。<br/>默认值:PlayMode.Normal<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。<br/>相关使用约束请参考PlayMode说明。 |
35| onFinish   | ()&nbsp;=&gt;&nbsp;void                  | 动画播放完成回调。<br/>从API version 9开始,该接口支持在ArkTS卡片中使用。 |
36
37> **PlayMode说明:**
38> - PlayMode推荐使用PlayMode.NormalPlayMode.Alternate,此场景下动画的第一轮是正向播放的。如使用PlayMode.ReversePlayMode.AlternateReverse,则动画的第一轮是逆向播放的,在动画刚开始时会跳变到终止状态,然后逆向播放动画。
39> - 使用PlayMode.AlternatePlayMode.AlternateReverse时,开发者应保证动画最终状态和状态变量的取值一致,即应保证动画的最后一轮是正向播放的。使用PlayMode.Alternate时,iterations应为奇数。使用PlayMode.AlternateReverse时,iterations应为偶数。
40> - 不推荐使用PlayMode.Reverse,此场景下不仅会导致动画刚开始就跳变到终止状态,也会导致动画最终状态和状态变量的取值不同。
41
42## 示例
43
44```ts
45// xxx.ets
46@Entry
47@Component
48struct AnimateToExample {
49  @State widthSize: number = 250
50  @State heightSize: number = 100
51  @State rotateAngle: number = 0
52  private flag: boolean = true
53
54  build() {
55    Column() {
56      Button('change size')
57        .width(this.widthSize)
58        .height(this.heightSize)
59        .margin(30)
60        .onClick(() => {
61          if (this.flag) {
62            animateTo({
63              duration: 2000,
64              curve: Curve.EaseOut,
65              iterations: 3,
66              playMode: PlayMode.Normal,
67              onFinish: () => {
68                console.info('play end')
69              }
70            }, () => {
71              this.widthSize = 150
72              this.heightSize = 60
73            })
74          } else {
75            animateTo({}, () => {
76              this.widthSize = 250
77              this.heightSize = 100
78            })
79          }
80          this.flag = !this.flag
81        })
82      Button('change rotate angle')
83        .margin(50)
84        .rotate({ x: 0, y: 0, z: 1, angle: this.rotateAngle })
85        .onClick(() => {
86          animateTo({
87            duration: 1200,
88            curve: Curve.Friction,
89            delay: 500,
90            iterations: -1, // 设置-1表示动画无限循环
91            playMode: PlayMode.Alternate,
92            onFinish: () => {
93              console.info('play end')
94            }
95          }, () => {
96            this.rotateAngle = 90
97          })
98        })
99    }.width('100%').margin({ top: 5 })
100  }
101}
102```
103
104![animation1](figures/animation1.gif)
105