AutoMovie API
    Preparing search index...

    Interface IAutoMoviePatternPlacement

    One laid module occurrence: the identity geometry, finish, and take-off share.

    Produced by generateAutoMovieSurfacePattern. The module rectangle is clipped to its zone region; a candidate whose clipped area, or whose area after exclusions, is at most 1e-12 m² is absent rather than recorded with zero area. variant depends only on the pattern seed, the variant count and id, so it does not change when other pieces are added or reordered.

    interface IAutoMoviePatternPlacement {
        area: number;
        center: IAutoMoviePatternPoint;
        coverage: number;
        cut: "none" | "boundary" | "exclusion" | "both";
        grainDeg: number;
        id: string;
        material: string | null;
        mirror: boolean;
        module: string;
        outline: IAutoMoviePatternPoint[];
        punchedArea: number;
        rotationDeg: number;
        size: { u: number; v: number };
        variant: number;
        zone: string;
    }
    Index
    area: number

    Surviving area in square metres: the region clip minus excluded area.

    Module centre in face-local metres, as generated.

    coverage: number

    Surviving fraction of the module's own area, within (0, 1] up to floating-point rounding of the clipped area.

    cut: "none" | "boundary" | "exclusion" | "both"

    What reduced the module: boundary when the region clip lost area, exclusion when an exclusion did, both, or none.

    grainDeg: number

    Grain direction in degrees, read modulo 180.

    id: string

    Occurrence identity, "<zone>/<module>".

    material: string | null

    Surface material id inherited from the zone, or null.

    mirror: boolean

    Whether the piece is laid face-flipped, its own U axis reversed.

    module: string

    The generator's own module id inside that zone.

    The module clipped to its zone region, counter-clockwise.

    This, and not the module rectangle, is what a joint is measured between, because a joint is read on the surface rather than on the drawing.

    punchedArea: number

    Square metres an exclusion took out of the area outline draws.

    The outline is a convex polygon, because a convex module clipped to a convex region stays convex. Subtracting an exclusion generally does not, so a punched piece's true shape is not this outline and no convex kernel path can build it; the run reports that as its own finding rather than handing back an outline that quietly covers the opening. Zero means no exclusion reached the piece and the outline is the piece.

    rotationDeg: number

    In-plane module rotation in degrees.

    size: { u: number; v: number }

    Module footprint in metres, as generated.

    Type Declaration

    • u: number

      Extent along the module's own U axis.

    • v: number

      Extent along the module's own V axis.

    variant: number

    Seeded variant index within [0, variants).

    zone: string

    The zone that laid it.