AutoMovie API
    Preparing search index...

    Complete sampled scene and explicit work budgets for deterministic fixed-step simulation.

    rate is cached intervals/s; substeps multiplies it into native ticks/s. Positive duration times rate is an exact safe integer bounded by maximumSteps. AutoMoviePhysicalSimulation owns a clone with defaults applied; settings, profiles, targets and impulses participate in content identity and checkpoint compatibility. admitPhysicalSimulation checks finite native-range scalars, floor dimensions, population and clock budgets before world allocation. Empty arrays are valid where no body or impulse is needed; invalid references or budgets throw.

    interface IInput {
        bodies: IAutoMoviePhysicalSimulationInput.IBody[];
        checkpointEvery: number;
        contactFrequency?: number;
        contactTolerance?: number;
        duration: number;
        floor: number;
        floorBounds: {
            max: { x: number; z: number };
            min: { x: number; z: number };
            thickness: number;
        };
        gravity: IAutoMovieVector3;
        impulses: {
            body: string;
            bone: string;
            impulse: IAutoMovieVector3;
            point: IAutoMovieVector3;
            step: number;
        }[];
        internalIterations?: number;
        iterations: number;
        maximumSegments: number;
        maximumSteps: number;
        rate: number;
        substeps?: number;
        yieldEvery: number;
    }
    Index

    Scene bodies, in deterministic construction order.

    checkpointEvery: number

    Positive safe-integer number of cached intervals between complete native/controller/balance snapshots; frame zero also has a checkpoint.

    contactFrequency?: number

    Native contact spring frequency, Hz; defaults to 240.

    contactTolerance?: number

    Native allowed linear contact error, metres; defaults to 0.0001.

    duration: number

    Positive finite local film duration in seconds; duration times rate must be a safe integer.

    floor: number

    Flat floor top height, metres.

    floorBounds: {
        max: { x: number; z: number };
        min: { x: number; z: number };
        thickness: number;
    }

    Explicit finite floor domain; escaping shapes refuse rather than silently losing support.

    Type Declaration

    • max: { x: number; z: number }

      Upper horizontal coordinates, metres.

      • x: number

        Finite upper world X extent of the floor, metres; strictly above min.x.

      • z: number

        Finite upper world Z extent of the floor, metres; strictly above min.z.

    • min: { x: number; z: number }

      Lower horizontal coordinates, metres.

      • x: number

        Finite lower world X extent of the floor, metres; strictly below max.x.

      • z: number

        Finite lower world Z extent of the floor, metres; strictly below max.z.

    • thickness: number

      Positive solid floor depth below its top, metres.

    World gravitational acceleration, m/s².

    impulses: {
        body: string;
        bone: string;
        impulse: IAutoMovieVector3;
        point: IAutoMovieVector3;
        step: number;
    }[]

    Explicit impulses, including declared mixed-mode boundary events.

    Type Declaration

    • body: string

      Admitted scene body receiving the impulse.

    • bone: string

      Segment id within that body's physical profile.

    • impulse: IAutoMovieVector3

      Finite world linear impulse in N s before the body's exaggerated-mode impulse factor.

    • point: IAutoMovieVector3

      Finite world application point in metres; its offset from COM also generates angular impulse.

    • step: number

      Cached interval index in 1..duration*rate. Applied once before that interval's first native integration step, at its starting boundary.

    internalIterations?: number

    Native constraint sweeps at each solver iteration, 1..128; defaults to 1.

    iterations: number

    Positive native solver iteration count, integer at most 0xffffffff; released island quality may request a larger minimum.

    maximumSegments: number

    Positive safe-integer cap on the sum of physical profile segment counts across bodies.

    maximumSteps: number

    Positive safe-integer cap on duration times rate, checked before native allocation; does not include frame zero.

    rate: number

    Positive safe-integer cached intervals per second; native steps occur at rate times substeps.

    substeps?: number

    Uniform native steps per cached interval, 1..128; defaults to 16.

    yieldEvery: number

    Positive safe-integer number of cached intervals between host yields and progress reports; completion also reports progress.