跳到主要内容

快速开始

在本指南中,我们将使用 Motion Canvas 创建一个简单的动画。

前置条件​

请确保你的机器上已安装 Node.js 16 或更高版本。

你可以运行以下命令检查是否已安装 Node.js:

node -v

创建新项目​

运行以下命令以搭建一个新的 Motion Canvas 项目(如果命令执行失败,请查看下方的故障排除小节):

npm init @motion-canvas@latest

根据提示为项目命名,并选择你想要使用的语言:TypeScript 或纯 JavaScript。我们建议在第一个项目中使用 TypeScript,因为本通篇文档都使用这门语言。

你还会被问及希望如何导出动画。Motion Canvas 内置了图像序列导出器——如果你想把动画导入视频编辑器,它再合适不过。不过,如果你想直接生成最终视频,可以选择安装视频(FFmpeg)导出器。别担心,你可以选择多个导出器,之后也随时可以添加更多。

要完成搭建过程,你需要运行以下命令:

  1. Change Directory(切换目录,cd)到项目根目录(你应该将 <project-path> 替换为搭建时选择的路径):
    cd <project-path>
  2. 安装必要的依赖:
    npm install
  3. 启动编辑器:
    npm start
    访问 http://localhost:9000/ 即可打开编辑器。我们会用它来预览动画,不过目前还没有多少内容可看。

编写动画​

搭建命令会为你创建多个文件,但目前我们只关注 src/scenes/example.tsx,这是添加动画的地方。在文本编辑器中打开 example.tsx,用下面的代码片段替换文件中的所有代码。

Press play to preview the animation
import ...

export default makeScene2D(function* (view) {
const myCircle = createRef<Circle>();

view.add(
<Circle
ref={myCircle}
// try changing these properties:
x={-300}
width={140}
height={140}
fill="#e13238"
/>,
);

yield* all(
myCircle().position.x(300, 1).to(-300, 1),
myCircle().fill('#e6a700', 1).to('#e13238', 1),
);
});

现在保存文件。你所做的任何更改都会被自动检测并反映在预览中。

你应该会在网页应用右上角的预览窗格中看到一个红色圆圈。按下播放按钮,即可看到圆圈在屏幕上移动。

原理解析​

Motion Canvas 中的每个视频都由一个项目配置对象表示。在我们的示例中,该配置在 src/project.ts 中声明:

src/project.ts
import {makeProject} from '@motion-canvas/core';

import example from './scenes/example?scene';

export default makeProject({
scenes: [example],
});

创建项目时,我们需要为其提供一个要显示的场景数组。在本例中,我们只使用从 src/scenes/example.tsx?scene 导入的一个场景。

注意末尾的 ?scene——它是将导入的模块转换为合格场景所必需的。除此之外,它还使得每当你修改场景时都能动态刷新预览。没有它,编辑器将无法工作。

场景是屏幕上显示的一组元素以及控制它们的动画。最基本的场景如下所示:

import {makeScene2D} from '@motion-canvas/2d';

export default makeScene2D(function* (view) {
// animation
});

makeScene2D() 接受一个生成器函数,并将其转换为场景,然后我们在项目文件中导入该场景。生成器函数描述动画的流程控制,而提供的 view 参数用于向场景添加元素。

你可以在场景层次结构小节中了解更多关于场景、节点以及这种类 XML 语法的内容。目前重要的是,在我们的示例中,我们向场景添加了一个单独的 <Circle/> 节点。我们将其设为红色,宽高均为 140 像素,并将其放在中心左侧 300 像素处:

view.add(
<Circle
ref={myCircle}
x={-300}
width={140}
height={140}
fill="#e13238"
/>,
);

要为圆圈制作动画,我们首先需要获取对它的引用。这正是 createRef 函数的作用。我们用它创建引用,并通过 ref 属性将其传递给圆圈:

const myCircle = createRef<Circle>();

view.add(
<Circle
ref={myCircle}
x={-300}
width={140}
height={140}
fill="#e13238"
/>,
);

然后我们通过 myCircle() 访问圆圈,并对其属性制作动画:

yield *
all(
myCircle().fill('#e6a700', 1).to('#e13238', 1),
myCircle().position.x(300, 1).to(-300, 1),
);

这段代码可能看起来有点令人困惑,让我们来分解一下。

节点的每个属性都可以在整个动画过程中读取和更新。例如,在上面的圆圈中,我们将其 fill 属性定义为 '#e13238':

<Circle
ref={myCircle}
x={-300}
width={140}
height={140}
fill="#e13238"
/>

现在,借助我们的引用可以获取该属性的值:

const fill = myCircle().fill(); // '#e13238'

我们还可以通过将新值作为第一个参数传入来更新它:

myCircle().fill('#e6a700');

这会立即更新圆圈的颜色。如果我们想在一段时间内过渡到新值,可以将过渡时长(以秒为单位)作为第二个参数传入:

myCircle().fill('#e6a700', 1);

这会创建一段补间动画,在一秒内平滑地改变填充颜色。

Motion Canvas 中的动画不会自行播放,我们需要显式地告诉它们播放。这就是为什么场景要使用生成器函数来声明——它们充当动画应如何展开的描述。通过 yield 不同的指令,我们可以让场景动画执行不同的操作。

例如,要播放我们创建的补间动画,可以这样做:

yield * myCircle().fill('#e6a700', 1);

这将暂停生成器,播放我们 yield 的动画,然后继续执行。

要在第一段动画之后紧接着播放另一段动画,只需再写一条 yield* 语句:

yield * myCircle().fill('#e6a700', 1);
yield * myCircle().fill('#e13238', 1);

但由于我们是对同一个属性制作动画,可以用更紧凑的方式编写:

yield * myCircle().fill('#e6a700', 1).to('#e13238', 1);

在我们的示例中,除了改变颜色,我们还移动了圆圈。可以尝试用与颜色动画相同的方式来实现:

yield * myCircle().fill('#e6a700', 1).to('#e13238', 1);
yield * myCircle().position.x(300, 1).to(-300, 1);

这样可行,但位置会在填充颜色之后才开始制作动画。为了让它们同时发生,我们使用 all 函数:

yield *
all(
myCircle().fill('#e6a700', 1).to('#e13238', 1),
myCircle().position.x(300, 1).to(-300, 1),
);

all 接受一个或多个动画并将它们合并在一起。现在它们会同时发生。动画流程控制小节会更深入地介绍生成器以及诸如 all 之类的流程控制函数。

这让我们回到最初的例子:

src/scenes/example.tsx
import {Circle, makeScene2D} from '@motion-canvas/2d';
import {all, createRef} from '@motion-canvas/core';

export default makeScene2D(function* (view) {
const myCircle = createRef<Circle>();

view.add(
<Circle
ref={myCircle}
x={-300}
width={140}
height={140}
fill="#e13238"
/>,
);

yield* all(
myCircle().position.x(300, 1).to(-300, 1),
myCircle().fill('#e6a700', 1).to('#e13238', 1),
);
});

故障排除​

Details

npm init @motion-canvas@latest 执行失败。

曾存在一个 npm bug导致上述命令执行失败。该问题已在 8.15.1 版本中修复。你可以按照本指南更新 npm。或者,你也可以改用以下命令:

npm exec @motion-canvas/create@latest
Details

npm install 失败并报 code ENOENT

如果 npm install 失败并出现以下错误:

npm ERR! code ENOENT
npm ERR! syscall open
npm ERR! path [path]\package.json
npm ERR! errno -4058
npm ERR! enoent ENOENT: no such file or directory, open '[path]\package.json'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent

请确保你在正确的目录中执行该命令。当你用 npm init 完成项目引导后,它会显示三条命令:

cd [path]
npm install
npm start

你是否运行了 cd 命令切换到包含项目的目录?

Details

我把摄像机移得太远,找不到预览了(预览一片漆黑)

你可以按 0 将摄像机重新聚焦到预览上。

Details

动画突然结束,或者没有从头开始播放。

请确保时间轴中的播放范围选择器的起点和终点符合预期,例如位于动画的开头和结尾。范围选择器是时间轴时间刻度上的一条灰色条。当鼠标悬停其上时,会出现六个点,供你进行操作。

Details

文件监听在 Windows Subsystem for Linux (WSL) 2 上不起作用

在 WSL2 上运行 Vite 时,如果文件被 Windows 应用程序编辑,文件系统监听将不起作用。

要解决此问题,请将项目文件夹移动到 WSL2 文件系统中,并使用 WSL2 应用程序编辑文件。从 WSL2 访问 Windows 文件系统速度较慢,因此这样也能提升性能。

更多信息请参阅 Vite 文档。