跳到主要内容

效果

效果让你可以观察信号的变化并对此作出响应。 与信号不同,效果不是惰性的:

  • createEffect() 会在其任何依赖项发生变化 后立即运行回调函数。
  • createDeferredEffect() 会在其 任何依赖项发生变化的那一帧结束时 运行回调函数。

它们适用于副作用场景,例如修改节点层级结构, 或响应某些信号的变化而生成后台动画。

如果要修改节点的属性, 建议优先使用信号。

概述​

效果通过 createEffect() 和createDeferredEffect() 函数创建。第一个参数指定要调用的回调函数:

import {createSignal, createEffect} from '@motion-canvas/core';

const signal = createSignal(0);
createEffect(() => {
console.log('Signal changed: ', signal());
});

创建后,可以使用返回的函数来释放效果:

const unsubscribe = createEffect(() => {
console.log('Signal changed: ', signal());
});

// do something

unsubscribe();

原理解析​

要理解信号与效果之间的区别, 请看这个改编自信号一节的示例:

const radius = createSignal(1);
const area = createSignal(() => {
console.log('area recalculated!');
return Math.PI * radius() * radius();
});

createEffect(() => {
area();
});
// area recalculated!

radius(2);
// area recalculated!
radius(3);
// area recalculated!
radius(4);
// area recalculated!

这一次,area 信号是在一个效果内部被调用的, 而不是直接调用。现在,每当 radius 信号发生变化时, 效果就会被触发,从而立即重新计算 area 信号。

这是一种折中。一方面,你现在可以立即对变化作出响应, 而不必每一帧都调用信号。另一方面, 效果的所有依赖项都不再是惰性的。 通常情况下这不会成为问题,但如果效果的依赖项频繁变化且计算开销较大, 则可能会影响定位性能。

延迟效果​

如果你的效果引用了多个频繁变化的依赖项, 可以使用createDeferredEffect() 将它们延迟到当前帧结束时再处理。 这样, 即使多个依赖项发生变化,效果也只会执行一次。 代价是延迟效果所引起的副作用不会立即显现。 它们会在当前生成器步骤结束后、渲染开始前显现。

const a = createSignal(1);
const b = createSignal(2);

let value = 0;
createEffect(() => {
console.log('effect invoked');
value = a() + b();
});
// effect invoked

let deferredValue = 0;
createDeferredEffect(() => {
console.log('deferred effect invoked');
deferredValue = a() + b();
});
// deferred effect invoked

a(2);
// effect invoked
b(3);
// effect invoked

console.log(value); // 5 - effect's value is updated immediately.
console.log(deferredValue); // 3 - deferred effect's value is not yet ready.

yield; // deferred effect invoked
console.log(deferredValue); // 5

复杂示例​

以下示例演示如何使用效果自动更新节点层级结构, 使显示的圆圈数量与 count 信号的值保持一致:

Press play to preview the animation
import ...

export default makeScene2D(function* (view) {
const count = createSignal(0);
const container = createRef<Layout>();

view.add(<Layout alignItems={'center'} ref={container} layout />);

const circles: Circle[] = [];
createEffect(() => {
const targetCount = Math.round(count());
let i = circles.length;
// add any missing circles
for (; i < targetCount; i++) {
const circle = (<Circle fill={'white'} />) as Circle;
circles.push(circle);
container().add(circle);
spawn(circle.size(80, 0.3));
}
// remove any extra circles
for (; i > targetCount; i--) {
const circle = circles.pop()!;
spawn(circle.size(0, 0.3).do(() => circle.remove()));
}
});

count(1);
yield* waitFor(1);
count(6);
yield* waitFor(1);
count(4);
yield* count(0, 2);
yield* waitFor(1);
});