effect-motion
API ReferencerendererNamespacesSyncInterfaces

CompState

A nested scene (from `Scene.play`) as the renderer holds it.

Interface: CompState

Defined in: packages/renderer/src/Sync.ts:237

A nested scene (from Scene.play) as the renderer holds it.

Remarks

A sub-composition is drawn to its OWN render target and the result is pasted onto a plane in the parent scene, like a precomp in After Effects. That is what lets a whole nested scene be moved, faded, or scaled as one object, and what makes its background and bounds mean something.

The child renders through its OWN active camera (frame.comps[id].camera), exactly as it would standalone — camera moves, depth, and parallax inside the child all show — and the result is clipped to the child's bounds. Its content is flattened before compositing: depth inside a nested scene does not react to the outer camera, which only places the comp's plane.

ponytail: outer-camera parallax INSIDE a precomp (AE's collapse transformations) would need a frustum-clip design if a scene ever wants it.

Properties

height

height: number;

Defined in: packages/renderer/src/Sync.ts:250


holder

readonly holder: Group;

Defined in: packages/renderer/src/Sync.ts:241

holder at the group's world anchor (in a scene tier); billboarded unless the group's composed transform rotates it


hud

hud: boolean;

Defined in: packages/renderer/src/Sync.ts:251


material

readonly material: MeshBasicNodeMaterial;

Defined in: packages/renderer/src/Sync.ts:246


plane

readonly plane: Mesh;

Defined in: packages/renderer/src/Sync.ts:245


rotated

rotated: boolean;

Defined in: packages/renderer/src/Sync.ts:242


rt

rt: RenderTarget | null;

Defined in: packages/renderer/src/Sync.ts:248

created/resized by the render path (GPU-side)


sync

readonly sync: Sync;

Defined in: packages/renderer/src/Sync.ts:238


transformHolder

readonly transformHolder: Group;

Defined in: packages/renderer/src/Sync.ts:244

carries the group's 2D affine about the bounds center


width

width: number;

Defined in: packages/renderer/src/Sync.ts:249

On this page