AutoMovie API
    Preparing search index...

    Interface IAutoMovieStage

    The coding-agent-owned set before a shot is performed.

    This is an engine input. Positions and couplings stay declarative so stageScene can validate identities and lower the set into deterministic scene data. Node ids must be non-blank and unique across actors, set pieces, cameras and lights.

    interface IAutoMovieStage {
        actors: IAutoMovieStageActor[];
        cameras: IAutoMovieStageCamera[];
        environment?: IAutoMovieSceneEnvironment;
        fog?: IAutoMovieFog;
        fogVisibility?: {
            cameraDepthM: number;
            color: IAutoMovieColor;
            transmittance: number;
        };
        lights: IAutoMovieStageLight[];
        plan: string;
        scene: IAutoMovieNamedId;
        set?: IAutoMovieStageSetPiece[];
        space?: IAutoMovieSpace;
    }
    Index

    Exactly one placement for every script cast member and none for any other node.

    Cameras available to the shot and its coverage takes. Staging accepts an empty list, but performShot refuses a shot whose staged scene has no camera to frame it.

    Image lighting, exposure, tone mapping and shadow policy, checked against these lights by validateSceneEnvironment and lowered verbatim. Omitted leaves those decisions to the host renderer.

    The set's fog specified by density, range-checked and lowered verbatim. Author this field or fogVisibility. Omit both for a scene without fog.

    fogVisibility?: {
        cameraDepthM: number;
        color: IAutoMovieColor;
        transmittance: number;
    }

    Calibrate the set's fog by the fraction of the subject color retained at a reference camera-axis depth. Staging solves the FogExp2 law for a finite scene density. Use either this field or fog.

    Type Declaration

    • cameraDepthM: number

      Positive finite reference camera-axis depth in metres.

    • color: IAutoMovieColor

      Linear fog color approached as transmittance decreases.

    • transmittance: number

      Finite fraction of subject color retained at that depth, in (0, 1]. One produces zero fog density.

    Physical light declarations lowered into the deterministic scene.

    plan: string

    Human-readable geometric rationale retained beside the authored values; stageScene does not read it.

    Stable scene identity, with a non-blank id, cited by every registered shot that uses this set.

    Optional unrigged set geometry, lowered to motionless scene nodes.

    Walkable surfaces whose geometry drives grounding and locomotion checks, checked by validateSpace and lowered verbatim. Omitted lowers to space: null, the scalar ground plane.