AutoMovie API
    Preparing search index...

    Interface IAutoMovieDaylightRequest

    Everything one daylight or artificial-light study is configured with.

    analyzeAutoMovieDaylight throws on a blank id, subject, revision or sky name, an invalid environment context, an instant the context does not declare, a malformed workplane, luminaire or shading solid, a sky sample count that is not a positive safe integer, or a malformed target. A null instant makes the run an artificial-light run, otherwise it is daylight. The settings digest covers the context's id, ground, north and occluders, the resolved instant record, and every other field except id, subject and inputRevision.

    interface IAutoMovieDaylightRequest {
        context: IAutoMovieEnvironmentContext;
        diffuseSamples: number;
        id: string;
        inputRevision: string;
        instant: string | null;
        luminaires: readonly IAutoMovieAnalysisLuminaire[];
        shades: readonly IAutoMovieAnalysisSolid[];
        sky: string;
        subject: string;
        targets: readonly IAutoMovieAnalysisTarget[];
        workplane: IAutoMovieAnalysisWorkplane;
    }
    Index

    Read-only external world, validated in full on every study; its occluders block rays alongside shades.

    diffuseSamples: number

    Sky-vault sample count per measurement point; a positive safe integer with no upper bound.

    id: string

    Stable run identity; non-blank.

    inputRevision: string

    Design revision being read; non-blank.

    instant: string | null

    Instant id of context to study, or null for an artificial-light-only study.

    luminaires: readonly IAutoMovieAnalysisLuminaire[]

    Artificial sources contributing to the same plane; ids unique.

    shades: readonly IAutoMovieAnalysisSolid[]

    Building-owned convex shading solids such as a canopy or a fin; ids unique within this list.

    sky: string

    Sky luminance distribution requested; only isotropic is implemented, and any other non-blank name yields an unsupported run.

    subject: string

    Logical space or surface being studied; non-blank.

    targets: readonly IAutoMovieAnalysisTarget[]

    Targets the production declares for this study.

    Measurement grid.