AutoMovie API
    Preparing search index...

    Interface IAutoMovieDrawingView

    How one drawing is taken from one design.

    A view supplies cut/projection placement, scale, filters, dimensions, authored notes and a pen to a drawing derivation. Geometry comes from the built-environment snapshot, but tessellation, clipping, rounding and unimplemented derivations limit agreement with rendered geometry. The drawing is output; IAutoMovieDesignReference is separately authored evidence, and neither is automatically read back into building source.

    deriveAutoMovieDrawing validates the design first and throws for an invalid one. Its frame gate then requires finite origin/direction/up components, direction and up lengths above 1e-9, an up-cross-normal length above 1e-9, positive finite scale and finite nonnegative depth/overhead when non-null. Duplicate dimension or annotation ids also throw; canonical output encoding can refuse non-finite derived values or invalid Unicode text.

    interface IAutoMovieDrawingView {
        annotations: IAutoMovieDrawingAnnotationSpec[];
        depth: number | null;
        dimensions: IAutoMovieDrawingDimensionSpec[];
        direction: IAutoMovieVector3;
        discipline: string;
        elementKinds: string[];
        id: string;
        origin: IAutoMovieVector3;
        overhead: number | null;
        projection: AutoMovieDrawingProjection;
        scale: number;
        spaces: string[];
        style: IAutoMovieDrawingStyle;
        up: IAutoMovieVector3;
    }
    Index

    Notes this view draws, in the order it draws them.

    depth: number | null

    How far past the cut plane the view reaches, in metres, or null for no bound; finite and not negative.

    An element lying wholly deeper than this is drawn hidden rather than dropped, so a footing under a slab is still stated.

    Dimensions this view draws, in the order it draws them.

    Direction the view looks, from the viewer into the design; finite and non-zero, with any length.

    A plan looks along -Y, a reflected ceiling plan along +Y, and an elevation or section along a horizontal direction. An oblique direction is accepted and drafted with the same orthographic projection.

    discipline: string

    Open discipline label, such as architectural, finish, ceiling, furniture, lighting or mechanical.

    The label is copied onto the drawing and selects nothing; a discipline view selects its content through elementKinds and spaces.

    elementKinds: string[]

    Element kinds this view draws; empty draws every kind. A boundary that draws its own face is matched by its boundary kind.

    The filter decides linework only. Regions and opening marks are bounded by spaces alone, so a lighting plan of a room still answers for that room's doors. A kind that matches nothing yields an empty sheet without a gap, because kinds are an open vocabulary.

    id: string

    Stable view identity within the production; the drawing repeats it.

    World point the cut plane passes through, and the page origin, in metres.

    The normal component places the cut and in-plane components move the page origin. For the usual vertical plan direction only world height changes the plane; an admitted oblique plan direction also makes horizontal origin components affect its cut. Projection labels do not override the supplied direction.

    overhead: number | null

    How far toward the viewer geometry the cut removed is still drawn, in metres, or null to draw none of it; finite and not negative.

    An element wholly on the viewer's side whose closest corner to the plane lies within this band is drawn overhead, the dashed convention floor plans use for beams and wall cabinets above the cut. An elevation cuts nothing and ignores the band.

    Cut and projection convention this view follows.

    scale: number

    Drawing scale denominator, so 50 means 1:50; finite and positive.

    Derived coordinates stay in model metres whatever the scale; only the SVG serializer applies it, at 1000 / scale page millimetres per metre.

    spaces: string[]

    Logical spaces this view is restricted to, descendants included; empty includes every space.

    Lines, regions and opening marks outside every included space are left out, and an element bound to no space is left out of a filtered view. A boundary that draws its own face is kept when any space it separates is included, and an opening is kept when its host boundary touches one, so a party wall and its door appear on both rooms' sheets.

    An id the design does not declare selects nothing and is reported once as the view-space-filter gap.

    Pen weights, dash patterns and text height the SVG serializer applies.

    Page-up hint; finite, non-zero and not parallel to direction.

    The hint is re-orthogonalized against the view direction, so an author may write the nearest cardinal axis rather than an exact in-plane vector. A plan that writes -Z puts world -Z up the page and world +X to the right; an elevation writes +Y.