AutoMovie API
    Preparing search index...

    Interface IAutoMovieSurfacePatternZone

    One area of the host face filled by one module program.

    Every module the generator returns is clipped to region, so a zone owns exactly the pieces inside it, and a neighbouring zone meets it along a shared border that the neighbour scan measures across. An occurrence of this zone is identified as <zone id>/<module id>.

    interface IAutoMovieSurfacePatternZone {
        generate: AutoMovieSurfacePatternGenerator;
        id: string;
        material: string | null;
        origin: IAutoMoviePatternPoint;
        period: { u: number; v: number };
        reach: { u: number; v: number };
        region: IAutoMoviePatternPoint[];
    }
    Index

    The author's pure module program for this zone.

    id: string

    Stable, non-blank zone id, unique inside one pattern.

    material: string | null

    IAutoMovieMaterial id this zone's modules carry, or null when its placements name no material.

    Face-local metre position of lattice cell (0, 0).

    period: { u: number; v: number }

    Lattice pitch in metres; the generator runs once per cell, over at most AUTOMOVIE_MAX_PATTERN_CELLS cells.

    Type Declaration

    • u: number

      Cell pitch along U, strictly above zero.

    • v: number

      Cell pitch along V, strictly above zero.

    reach: { u: number; v: number }

    How far in metres a generated module may reach from its cell origin.

    The lattice is enumerated wide enough that every cell whose modules could touch the region is visited, which is only knowable if the author states the reach. A module with a corner beyond it is refused with a throw rather than silently dropped at the region's edge.

    Type Declaration

    • u: number

      Greatest reach along U, strictly above zero.

    • v: number

      Greatest reach along V, strictly above zero.

    Convex-position face-local point set with at least three non-collinear points and no interior/duplicate points. The run canonicalizes hull order rather than preserving the authored ring and refuses overlap above its area tolerance.