effect-motion
API Referenceeffect-motionNamespacesSceneInterfaces

RunningScene

readonly done: boolean;

Interface: RunningScene<E, R>

Defined in: packages/motion/src/Scene.ts:439

Type Parameters

Type Parameter
E
R

Properties

done

readonly done: boolean;

Defined in: packages/motion/src/Scene.ts:445


fiber

readonly fiber: Fiber<void, E>;

Defined in: packages/motion/src/Scene.ts:444


framesDelivered

framesDelivered: number;

Defined in: packages/motion/src/Scene.ts:447

frames delivered so far — mutated by step for the maxFrames cap


runner

readonly runner: {
  anchorAudio: (id, until?) => void;
  appendChild: (parent, child) => Error | null;
  awaitedCount: () => number;
  backgrounds: Set<BranchEntry>;
  camera: Instance<"Camera">;
  cameraOf: (compId) => Instance<"Camera">;
  clearMask: (target) => void;
  comp: CompConfig;
  countAwaited: (n) => void;
  destroy: (instance) => void;
  failureCause: () => Cause<unknown> | undefined;
  forks: Set<BranchEntry>;
  getDataUnsafe: <Tag>(instance) =>
     | EntityByTag<Tag>
    | null;
  instantiate: <Tag>(...args) => Effect<Instance<Tag>, never, Runner>;
  instantiateEscape: (...args) => Effect<Instance<
     | "Audio"
     | "Line"
     | "Path"
     | "Rect"
     | "Circle"
     | "Ellipse"
     | "Text"
     | "Group"
     | "Hud"
     | "Image"
    | "Camera">, never, never>;
  phaser: {
     arriveAndAwaitAdvance: Effect<void, never, never>;
     awaitAdvance: Effect<number, never, never>;
     deregister: (n) => void;
     register: (n) => void;
     snapshotUnsafe: () => {
        arrived: number;
        parties: number;
        phase: number;
        state: "idle" | "pending" | "running";
     };
  };
  recordFailure: (cause) => void;
  registerComp: (id, config) => void;
  removeChild: (parent, child) => void;
  root: GroupInstance;
  setCamera: (instance, compId) => void;
  setDataUnsafe: <Tag>(instance, state) => void;
  setMask: (target, source, mode) => Error | null;
  settings: {
     frameRate: number;
     maxFrames: number;
     seed: Seed;
  };
  state: Effect<{
     backgroundColor: Color;
     camera: CameraView & PointOfInterest;
     comps: {
      [k: string]: CompFrame;
     };
     frameRate: number;
     height: number;
     instances: Record<string, {
        data:   | {
           audio: {
              id: string;
           };
           gain: number;
           loop: boolean;
           playing: boolean;
           position: {
              x: number;
              y: number;
              z: number;
           };
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           time: number;
         }
           | {
           end: {
              x: number;
              y: number;
              z: number;
           };
           opacity: number;
           position: {
              x: number;
              y: number;
              z: number;
           };
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           scale: {
              x: number;
              y: number;
              z: number;
           };
           start: {
              x: number;
              y: number;
              z: number;
           };
           strokeColor: Color;
           strokeWidth: number;
           visible: boolean;
         }
           | {
           commands: readonly [
              | {
            }
              | {
              x: number;
              y: number;
              z?: ... | ...;
            }
              | {
              x: number;
              y: number;
              z?: ... | ...;
            },
              | {
            }
              | {
              x: number;
              y: number;
              z?: ... | ...;
            }
              | {
              x: number;
              y: number;
              z?: ... | ...;
           }];
           fillColor: Color;
           opacity: number;
           position: {
              x: number;
              y: number;
              z: number;
           };
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           scale: {
              x: number;
              y: number;
              z: number;
           };
           strokeColor?: Color;
           strokeWidth: number;
           visible: boolean;
         }
           | {
           fillColor: Color;
           height: number;
           opacity: number;
           position: {
              x: number;
              y: number;
              z: number;
           };
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           scale: {
              x: number;
              y: number;
              z: number;
           };
           strokeColor?: Color;
           strokeWidth: number;
           visible: boolean;
           width: number;
         }
           | {
           fillColor: Color;
           opacity: number;
           position: {
              x: number;
              y: number;
              z: number;
           };
           radius: number;
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           scale: {
              x: number;
              y: number;
              z: number;
           };
           strokeColor?: Color;
           strokeWidth: number;
           visible: boolean;
         }
           | {
           fillColor: Color;
           opacity: number;
           position: {
              x: number;
              y: number;
              z: number;
           };
           radiusX: number;
           radiusY: number;
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           scale: {
              x: number;
              y: number;
              z: number;
           };
           strokeColor?: Color;
           strokeWidth: number;
           visible: boolean;
         }
           | {
           baseline?: "middle" | "auto" | "hanging";
           fillColor: Color;
           fontFamily: {
              id: string;
           };
           fontSize: number;
           opacity: number;
           position: {
              x: number;
              y: number;
              z: number;
           };
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           scale: {
              x: number;
              y: number;
              z: number;
           };
           text: string;
           textAnchor?: "start" | "end" | "middle";
           visible: boolean;
         }
           | {
           children: readonly string[];
           opacity: number;
           position: {
              x: number;
              y: number;
              z: number;
           };
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           scale: {
              x: number;
              y: number;
              z: number;
           };
           visible: boolean;
         }
           | {
           children: readonly string[];
           opacity: number;
           position: {
              x: number;
              y: number;
              z: number;
           };
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           scale: {
              x: number;
              y: number;
              z: number;
           };
           visible: boolean;
         }
           | {
           height?: number;
           image: {
              id: string;
           };
           opacity: number;
           position: {
              x: number;
              y: number;
              z: number;
           };
           rotation: {
              x: number;
              y: number;
              z: number;
           };
           scale: {
              x: number;
              y: number;
              z: number;
           };
           visible: boolean;
           width?: number;
         }
           | {
           aperture: number;
           focalLength: number;
           focusDistance: number;
           poi:   | {
              x: number;
              y: number;
              z: number;
            }
              | null;
           position: {
              x: number;
              y: number;
              z: number;
           };
           rotation: {
              x: number;
              y: number;
              z: number;
           };
         };
     }>;
     masks: {
      [k: string]: MaskAttachment;
     };
     root: string;
     width: number;
  }, never, never>;
};

Defined in: packages/motion/src/Scene.ts:440

anchorAudio

anchorAudio: (id, until?) => void;
Parameters
ParameterType
idstring
until?number
Returns

void

appendChild

appendChild: (parent, child) => Error | null;
Parameters
ParameterType
parentGroupInstance
childInstance
Returns

Error | null

awaitedCount

awaitedCount: () => number;
Returns

number

backgrounds

backgrounds: Set<BranchEntry>;

camera

camera: Instance<"Camera">;

cameraOf

cameraOf: (compId) => Instance<"Camera">;
Parameters
ParameterType
compIdstring | null
Returns

Instance<"Camera">

clearMask

clearMask: (target) => void;
Parameters
ParameterType
targetInstance<MaskableTag>
Returns

void

comp

comp: CompConfig;

countAwaited

countAwaited: (n) => void;
Parameters
ParameterType
nnumber
Returns

void

destroy

destroy: (instance) => void;
Parameters
ParameterType
instanceInstance
Returns

void

failureCause

failureCause: () => Cause<unknown> | undefined;
Returns

Cause<unknown> | undefined

forks

forks: Set<BranchEntry>;

getDataUnsafe

getDataUnsafe: <Tag>(instance) =>
  | EntityByTag<Tag>
  | null;
Type Parameters
Type Parameter
Tag extends | "Audio" | "Line" | "Path" | "Rect" | "Circle" | "Ellipse" | "Text" | "Group" | "Hud" | "Image" | "Camera"
Parameters
ParameterType
instanceInstance<Tag>
Returns

| EntityByTag<Tag> | null

instantiate

instantiate: <Tag>(...args) => Effect<Instance<Tag>, never, Runner>;
Type Parameters
Type Parameter
Tag extends | "Audio" | "Line" | "Path" | "Rect" | "Circle" | "Ellipse" | "Text" | "Group" | "Hud" | "Image" | "Camera"
Parameters
ParameterType
...args[Tag, InstantiateProps<Tag>]
Returns

Effect<Instance<Tag>, never, Runner>

instantiateEscape

instantiateEscape: (...args) => Effect<Instance<
  | "Audio"
  | "Line"
  | "Path"
  | "Rect"
  | "Circle"
  | "Ellipse"
  | "Text"
  | "Group"
  | "Hud"
  | "Image"
| "Camera">, never, never>;

ponytail: create a tree node for an entity that is NOT in the union — the particle system only (design D10). Mounts under the ambient parent like any instance. Delete with the particles rewrite; see particlesEscapeInstantiate.

Parameters
ParameterType
...args[ | { audio: { id: string; }; gain: number; loop: boolean; playing: boolean; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; time: number; } | { end: { x: number; y: number; z: number; }; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; start: { x: number; y: number; z: number; }; strokeColor: Color; strokeWidth: number; visible: boolean; } | { commands: readonly [ | { } | { x: number; y: number; z?: number; } | { x: number; y: number; z?: number; }, | { } | { x: number; y: number; z?: number; } | { x: number; y: number; z?: number; }]; fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { fillColor: Color; height: number; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; width: number; } | { fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; radius: number; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; radiusX: number; radiusY: number; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { baseline?: "middle" | "auto" | "hanging"; fillColor: Color; fontFamily: { id: string; }; fontSize: number; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; text: string; textAnchor?: "start" | "end" | "middle"; visible: boolean; } | { children: readonly string[]; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; } | { children: readonly string[]; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; } | { height?: number; image: { id: string; }; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; width?: number; } | { aperture: number; focalLength: number; focusDistance: number; poi: | { x: number; y: number; z: number; } | null; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; }]
Returns

Effect<Instance< | "Audio" | "Line" | "Path" | "Rect" | "Circle" | "Ellipse" | "Text" | "Group" | "Hud" | "Image" | "Camera">, never, never>

phaser

phaser: {
  arriveAndAwaitAdvance: Effect<void, never, never>;
  awaitAdvance: Effect<number, never, never>;
  deregister: (n) => void;
  register: (n) => void;
  snapshotUnsafe: () => {
     arrived: number;
     parties: number;
     phase: number;
     state: "idle" | "pending" | "running";
  };
};
phaser.arriveAndAwaitAdvance
arriveAndAwaitAdvance: Effect<void, never, never>;
phaser.awaitAdvance
awaitAdvance: Effect<number, never, never>;
phaser.deregister
deregister: (n) => void;
Parameters
ParameterType
nnumber
Returns

void

phaser.register
register: (n) => void;
Parameters
ParameterType
nnumber
Returns

void

phaser.snapshotUnsafe
snapshotUnsafe: () => {
  arrived: number;
  parties: number;
  phase: number;
  state: "idle" | "pending" | "running";
};

debug/test view of the internal counters

Returns
{
  arrived: number;
  parties: number;
  phase: number;
  state: "idle" | "pending" | "running";
}
arrived
arrived: number;
parties
parties: number;
phase
phase: number;
state
state: "idle" | "pending" | "running";

recordFailure

recordFailure: (cause) => void;
Parameters
ParameterType
causeCause<unknown>
Returns

void

registerComp

registerComp: (id, config) => void;
Parameters
ParameterType
idstring
configCompConfig
Returns

void

removeChild

removeChild: (parent, child) => void;
Parameters
ParameterType
parentGroupInstance
childInstance
Returns

void

root

root: GroupInstance;

setCamera

setCamera: (instance, compId) => void;
Parameters
ParameterTypeDefault value
instanceInstance<"Camera">undefined
compIdstring | nullnull
Returns

void

setDataUnsafe

setDataUnsafe: <Tag>(instance, state) => void;
Type Parameters
Type Parameter
Tag extends | "Audio" | "Line" | "Path" | "Rect" | "Circle" | "Ellipse" | "Text" | "Group" | "Hud" | "Image" | "Camera"
Parameters
ParameterType
instanceInstance<Tag>
stateEntityByTag<Tag>
Returns

void

setMask

setMask: (target, source, mode) => Error | null;
Parameters
ParameterType
targetInstance<MaskableTag>
sourceInstance<MaskableTag>
mode"alpha" | "inverse"
Returns

Error | null

settings

settings: {
  frameRate: number;
  maxFrames: number;
  seed: Seed;
} = resolvedSettings;
settings.frameRate
frameRate: number;
settings.maxFrames
maxFrames: number;
settings.seed
seed: Seed;

state

state: Effect<{
  backgroundColor: Color;
  camera: CameraView & PointOfInterest;
  comps: {
   [k: string]: CompFrame;
  };
  frameRate: number;
  height: number;
  instances: Record<string, {
     data:   | {
        audio: {
           id: string;
        };
        gain: number;
        loop: boolean;
        playing: boolean;
        position: {
           x: number;
           y: number;
           z: number;
        };
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        time: number;
      }
        | {
        end: {
           x: number;
           y: number;
           z: number;
        };
        opacity: number;
        position: {
           x: number;
           y: number;
           z: number;
        };
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        scale: {
           x: number;
           y: number;
           z: number;
        };
        start: {
           x: number;
           y: number;
           z: number;
        };
        strokeColor: Color;
        strokeWidth: number;
        visible: boolean;
      }
        | {
        commands: readonly [
           | {
         }
           | {
           x: number;
           y: number;
           z?: ... | ...;
         }
           | {
           x: number;
           y: number;
           z?: ... | ...;
         },
           | {
         }
           | {
           x: number;
           y: number;
           z?: ... | ...;
         }
           | {
           x: number;
           y: number;
           z?: ... | ...;
        }];
        fillColor: Color;
        opacity: number;
        position: {
           x: number;
           y: number;
           z: number;
        };
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        scale: {
           x: number;
           y: number;
           z: number;
        };
        strokeColor?: Color;
        strokeWidth: number;
        visible: boolean;
      }
        | {
        fillColor: Color;
        height: number;
        opacity: number;
        position: {
           x: number;
           y: number;
           z: number;
        };
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        scale: {
           x: number;
           y: number;
           z: number;
        };
        strokeColor?: Color;
        strokeWidth: number;
        visible: boolean;
        width: number;
      }
        | {
        fillColor: Color;
        opacity: number;
        position: {
           x: number;
           y: number;
           z: number;
        };
        radius: number;
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        scale: {
           x: number;
           y: number;
           z: number;
        };
        strokeColor?: Color;
        strokeWidth: number;
        visible: boolean;
      }
        | {
        fillColor: Color;
        opacity: number;
        position: {
           x: number;
           y: number;
           z: number;
        };
        radiusX: number;
        radiusY: number;
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        scale: {
           x: number;
           y: number;
           z: number;
        };
        strokeColor?: Color;
        strokeWidth: number;
        visible: boolean;
      }
        | {
        baseline?: "middle" | "auto" | "hanging";
        fillColor: Color;
        fontFamily: {
           id: string;
        };
        fontSize: number;
        opacity: number;
        position: {
           x: number;
           y: number;
           z: number;
        };
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        scale: {
           x: number;
           y: number;
           z: number;
        };
        text: string;
        textAnchor?: "start" | "end" | "middle";
        visible: boolean;
      }
        | {
        children: readonly string[];
        opacity: number;
        position: {
           x: number;
           y: number;
           z: number;
        };
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        scale: {
           x: number;
           y: number;
           z: number;
        };
        visible: boolean;
      }
        | {
        children: readonly string[];
        opacity: number;
        position: {
           x: number;
           y: number;
           z: number;
        };
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        scale: {
           x: number;
           y: number;
           z: number;
        };
        visible: boolean;
      }
        | {
        height?: number;
        image: {
           id: string;
        };
        opacity: number;
        position: {
           x: number;
           y: number;
           z: number;
        };
        rotation: {
           x: number;
           y: number;
           z: number;
        };
        scale: {
           x: number;
           y: number;
           z: number;
        };
        visible: boolean;
        width?: number;
      }
        | {
        aperture: number;
        focalLength: number;
        focusDistance: number;
        poi:   | {
           x: number;
           y: number;
           z: number;
         }
           | null;
        position: {
           x: number;
           y: number;
           z: number;
        };
        rotation: {
           x: number;
           y: number;
           z: number;
        };
      };
  }>;
  masks: {
   [k: string]: MaskAttachment;
  };
  root: string;
  width: number;
}, never, never>;

scene

readonly scene: Scene<E, R>;

Defined in: packages/motion/src/Scene.ts:442

On this page