AutoMovie API
    Preparing search index...

    Interface IAutoMovieDesignSourceFrame

    One page, sheet, or image of a design reference and how its own coordinates are read as world coordinates.

    The frame owns the mapping, not the observation: a primitive is always recorded in the source's own units, so a corrected scale or a corrected north never rewrites what was seen. A frame whose scale is null has an unsettled scale, and nothing read through it can become metric geometry.

    A source point (x, y) maps to origin + unit(axisX) * (x - anchor.x) * s plus unit(axisY) * (y - anchor.y) * s for the settled metres per unit s, and the sum then passes through transform. The two axes must not be parallel but need not be perpendicular, so skewed axes shear the mapping. up, north, level, and view are validated but never read by the mapping or by promotion.

    interface IAutoMovieDesignSourceFrame {
        anchor: { x: number; y: number };
        axisX: IAutoMovieVector3;
        axisY: IAutoMovieVector3;
        bounds: { height: number; width: number };
        id: string;
        level: string | null;
        north: IAutoMovieVector3 | null;
        origin: IAutoMovieVector3;
        page: number;
        scale: string | null;
        scaleCandidates: IAutoMovieDesignScaleCandidate[];
        transform: IAutoMovieTransform | null;
        up: IAutoMovieVector3;
        view: "plan" | "section" | "elevation" | "detail" | "perspective";
    }
    Index
    anchor: { x: number; y: number }

    Source-space point that maps onto origin.

    Type Declaration

    • x: number

      Finite source-space x, inside [0, bounds.width].

    • y: number

      Finite source-space y, inside [0, bounds.height].

    World direction the frame's own +x axis points along; non-zero.

    World direction the frame's own +y axis points along; non-zero and not parallel to axisX.

    bounds: { height: number; width: number }

    Source-space extent: pixels for raster, user units for vector.

    The host must compare these dimensions with the actual sheet where measurement is available; this record and the Engine frame check do not inspect its bytes.

    Type Declaration

    • height: number

      Finite, strictly positive height in source units.

    • width: number

      Finite, strictly positive width in source units.

    id: string

    Stable, non-blank frame identity, unique within the document.

    level: string | null

    Non-blank storey or datum label this frame belongs to, or null.

    north: IAutoMovieVector3 | null

    World direction the drawing calls north, or null when unmarked.

    Finite world position of anchor, in metres.

    page: number

    One-based whole page or image index inside the asset. PNG, JPEG and SVG are intended to use page one; the Engine frame check alone does not enforce container-specific page population.

    scale: string | null

    Chosen scale candidate id, or null while the scale is unknown.

    Every scale reading recorded for this frame. Several may coexist; only the one scale names is used.

    transform: IAutoMovieTransform | null

    Extra world placement applied after the axis mapping, or null: the mapped point is scaled per axis, rotated by the normalized rotation, and then translated, all about the world origin.

    World direction the drawing calls up; non-zero.

    view: "plan" | "section" | "elevation" | "detail" | "perspective"

    Drawing family this frame shows.