BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    What fitAlignment found

    interface AlignmentFit {
        allow: AlignmentFitKind;
        degenerate: "coincident" | null;
        exact: boolean;
        kind: AlignmentFitKind;
        matrix: number[];
        maxResidual: number;
        missingPairs: number;
        residuals: number[];
        scale: number;
        turnDegrees: number;
    }
    Index

    Properties

    The kind asked for

    degenerate: "coincident" | null

    "coincident" when the pairs lie at one place in plan, so no turn could be found; null otherwise

    exact: boolean

    The pairs fix the fit exactly (1 pair of a move, 2 of a turn and scale), so the residuals check nothing

    The kind fitted: "move" while there are too few pairs to turn, or when the pairs lie at one place in plan

    matrix: number[]

    The alignment of the model to move: 16 numbers, column-major, mm (what SetAlignment and setModelAlignment take)

    maxResidual: number
    missingPairs: number

    How many pairs the kind asked for still needs; 0 when it has them

    residuals: number[]

    Per pair, how far the moved point lands from its onto point, in mm

    scale: number

    The uniform scale; 1 unless the kind is "turn-scale"

    turnDegrees: number

    The turn about the vertical axis, in degrees (-180, 180]