帧动画

帧动画是一种内置的动画实现,提供给开发者类似于 CSS 动画的能力,去控制一个元素下所有组件的数据。

我们提供了一种资源来定义帧动画,之后可以用对应的加载器加载,在组件中使用。

帧动画资源

首先我们要准备一个帧动画资源,它是被存储为json格式,大致如下:

{
  "keyframe": {
    "parent": {
      "0": {
        "rotation": [0, 0, 0],
      },
      "100": {
        "rotation": [0, 6.28, 0]
      }
    },
    "child": {
      "0": {
        "position.y": -0.5,
        "material.u_baseColorFactor": [0.48, 0.78, 0.64, 1]
      },
      "100": {
        "position.y": 1.5,
        "material.u_baseColorFactor": [0.176, 0.368, 0.937, 1]
      }
    }
  },
  "animation": {
    "parent": {
      "keyframe": "parent",
      "duration": 8,
      "ease": "linear",
      "loop": -1
    },
    "child": {
      "keyframe": "child",
      "duration": 4,
      "ease": "ease-in-out",
      "direction": "both",
      "loop": -1
    }
  }
}

可以看到其中有两个部分:keyframeanimation

keyframe中定义了帧动画具体的行为,本质上类似于css3中的keyframes,其中进度的范围是0~100,每个进度下是动画具体影响的键和值。其中键的规则是[组件].[属性].[属性2].[属性...],比如transform.postion.x,就是对应于使用了这个帧动画的元素下的transform组件的position属性的x属性变化。

当然我们不难看到,如果仅仅是按照这样的规则,一来是开发者必须要实现对应组件下每个属性的访问器,其次是对于一些常见的属性写起来会繁琐,再者对于材质动画会无从下手。为了解决这个问题,我做了一些实现上的优化:

  1. 如果整个属性路径最终是[组件].[属性]的形式,则不需要写访问器,会自动设置。
  2. positionrotationscale会被自动代理到transform组件下。
  3. material是一种特殊的定义,会被自动代理到mesh组件的材质的uniform下。

要注意,属性的值仅仅支持numbernumber-arraycolor类型的数据。 有了keyframe,再者就是animation了。animation中定义了真的暴露给animator的片段,其中第一级的每个键都是片段的名字,它对应的值就是其作为动画播放时的一些参数。keyframe定义这个片段对应于上面定义的哪个keyframeduration是以秒为单位的时长,loop是默认循环次数(-1为永远循环),delay是播放延迟,direction是播放方向,默认forwards,可选backwardsboth(在循环时交替前向反向),ease则是时间函数,决定动画的插值曲线。

支持的时间函数可见 API 文档:noneParamsEaseFuncs 和 useParamsEaseFuncs。

使用

有了资源我们便可以加载使用它,和其他资源一样,keyframe资源遵循标准加载流程:

<xr-asset-load type="keyframe" asset-id="anim" src="/assets/keyframes/test.json" />

然后便可以引用使用:

<xr-node anim-keyframe="anim" anim-autoplay="clip:parent">
  <xr-node position="0 -0.5 3" anim-keyframe="anim" anim-autoplay="clip:child">
  </xr-node>
</xr-node>

注意这里使用了anim-keyframe字段来指定animator组件要默认使用哪个keyframe动画。

动画组件

动画组件Animator用于管理所挂载元素下所有的动画。

和其他组件一样,它也提供了在xml中和脚本控制两种方法。我们先看看脚本控制是怎么做的:

const animator = el.getComponent(xrFrameSystem.Animator);

// 添加一个动画,`clipMap`可选
animator.addAnimation(new XrTeamCameraAnimation(data), clipMap);

// 通过动画类直接创建一个动画,`clipMap`可选
const anim = animator.createAnimation(XrTeamCameraAnimation, data, clipMap);

// 移除一个动画
animator.removeAnimation(anim);

// 播放名为`name`的动画,可以同时播放多个
animator.play(name, options);

// 暂停名为`name`的动画,不填`name`则暂停所有
animator.pause(name);

// 唤醒名为`name`的动画,不填`name`则唤醒所有
animator.resume(name);

// 停止名为`name`的动画,不填`name`则停止所有
animator.stop(name);

// 将名为`name`的片段定格到某个进度
animator.pauseToFrame(name, progress);

这里要特别注意的有几个点:

  1. clipMap本质上是给开发者提供了一个从动画组件片段的名字到动画实例片段名字的映射,这一般在动画组件有多个动画实例、而动画实例中的片段有重名的情况下会很有用。如果不填,则会默认使用动画实例的片段名来索引。
  2. options是播放时的参数,具体的定义可以参照API文档,要说明的是在play时提供的这个参数,会覆盖掉动画实例onPlay时返回的参数。

相较于脚本控制,大部分开发者在xml中用动画组件会比较常见。所有派生自XRElement元素的元素,都会拥有默认的动画属性映射:

<xr-node
  anim-keyframe="basic-anim"
  anim-clipmap="default:cube"
  anim-autoplay="clip:cube, speed:2"
></xr-node>

这三个属性对应于动画组件的三个数据,最后一个anim-autoplay指定了是否要默认播放以及默认播放的片段和参数,如果不写clip数据则会播放所有的片段。anim-clipmap则是给默认加载的动画指定一个片段映射,而这个默认的动画就是anim-keyframe指定的,它就是前面提到的内置的帧动画,这个可以在后面的章节看到详细说明。

除了anim-keyframe,其他两个参数可以作用于前面提到的gltf动画,也可以在相关章节查看。

事件

动画组件为元素提供了以下事件:

事件 参数 立即 wxml 时机
anim-stop 对象,其中name是片段名字 某个片段播放停止时

动画实现

动画实现的基础是基类Animation,所有的动画都必须派生于它去实现必要的方法。让我们以一个例子来看看:

import XrFrame from 'XrFrame';
const xrFrameSystem = wx.getXrFrameSystem();

// 定制动画接受的初始化数据接口
interface IXrTeamCameraAnimtionData {
  targets: {
    hikari: XrFrame.Vector3;
    roam: XrFrame.Vector3;
    xinyi: XrFrame.Vector3;
    final: XrFrame.Vector3;
  },
}

// 定制动画接受的播放额外配置接口
interface IXrTeamCameraAnimationOptions {

}

// 定制动画的实现
class XrTeamCameraAnimation extends xrFrameSystem.Animation<
  IXrTeamCameraAnimtionData,
  IXrTeamCameraAnimationOptions
> {
  private _camera: XrFrame.Transform | undefined;
  private _target: XrFrame.Transform | undefined;
  private _targets: IXrTeamCameraAnimtionData['targets'] | undefined;
  private _startC: XrFrame.Vector3 = new xrFrameSystem.Vector3();
  private _endC: XrFrame.Vector3 = new xrFrameSystem.Vector3();
  private _startT: XrFrame.Vector3 = new xrFrameSystem.Vector3();
  private _endT: XrFrame.Vector3 = new xrFrameSystem.Vector3();

  // 动画初始化时会被执行,传入初始数据
  // 必须设置`this.clipNames`,提供给动画组件必要的信息
  public onInit(data: IXrTeamCameraAnimtionData) {
    this._targets = data.targets;
    this.clipNames = ['hikari', 'roam', 'xinyi'];
  }

  // 动画被播放时会被执行,必须返回片段时长`duration`
  // 剩下三个返回参数是可选的,详见API文档
  public onPlay(el: XrFrame.Element, clipName: string, options: IXrTeamCameraAnimationOptions): {
    duration: number,
    loop?: number,
    delay?: number,
    direction?: XrFrame.TDirection
  } {
    this._camera = this._camera || el.getComponent(xrFrameSystem.Transform);
    this._target = el.getComponent(xrFrameSystem.Camera).target;
    this._startT.set(this._target.position);
    this._endT.setValue(this._targets![clipName].x, this._targets![clipName].y, this._targets![clipName].z);
    this._startC.set(this._camera.position);
    this._endC.set(this._endT);
    this._endC.z += 2;

    return {duration: 3};
  }

  // 动画播放进度更新是会被执行,`progress`的范围是`0~1`
  // `el`参数是指这个动画目前作用于哪个元素,因为动画和元素、组件并非总是一一对应的
  public onUpdate(el: XrFrame.Element, progress: number, reverse: boolean) {
    progress = xrFrameSystem.noneParamsEaseFuncs['ease-in-out'](progress);
    this._startT?.lerp(this._endT, progress, this._target?.position);
    this._startC?.lerp(this._endC, progress, this._camera?.position);
  }

  // 动画播放暂停时会被执行,暂停本身的逻辑是自动的
  public onPause(el: XrFrame.Element) {

  }

  // 动画从暂停中唤醒时会被执行
  public onResume(el: XrFrame.Element) {

  }

  // 动画停止时会被执行,包括播放结束和手动停止
  public onStop(el: XrFrame.Element) {

  }
}

这段代码中,我们定制了一个动画,它的几个生命周期来定义其是如何运作的。框架内置了两种动画帧动画和gltf动画,但这里我们先不讨论它们,先看看在实现了一个动画后,如何去创建和操纵它,这也就引入了动画组件。