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

    Interface ObjectDistanceResult

    The result of an object distance measurement (docs/object-distance-measurement-design.md §6)

    interface ObjectDistanceResult {
        distance: number;
        errorMm: number;
        mode: ObjectDistanceMode;
        pointA: vec3;
        pointB: vec3;
        qidA: string | null;
        qidB: string | null;
        referenceKind?: "axis" | "centreLine" | "centreToCentre" | null;
        referenceModes?: ReferenceMode[];
        referenceObjects?: (ReferenceObject | null)[];
    }
    Index

    Properties

    distance errorMm mode pointA pointB qidA qidB referenceKind? referenceModes? referenceObjects?

    Properties

    distance: number

    Shortest distance between the two surfaces in millimetres; 0 when the objects touch or intersect

    errorMm: number

    Upper bound of the quantisation error in the reported distance, mm (the vertex positions are stored quantised)

    mode: ObjectDistanceMode

    The distance definition this result was measured with

    pointA: vec3

    The closest point on the first object, viewer measurement coordinates (mm, globalBaseTranslation subtracted)

    pointB: vec3

    The closest point on the second object

    qidA: string | null
    qidB: string | null
    referenceKind?: "axis" | "centreLine" | "centreToCentre" | null

    What the references measured to were: "axis", "centreLine" (a vertical centre line on at least one side) or "centreToCentre" (two vertical lines: between their middles, the objects' centre points, and in horizontal mode their distance in plan); null when both objects were measured on their surface

    referenceModes?: ReferenceMode[]

    Per object, whether it was measured on its surface or on its reference

    referenceObjects?: (ReferenceObject | null)[]

    Per side, the level or grid line it holds instead of an object (docs/reference-geometry-measurement-design.md §12.4), or null

    Settings

    Member Visibility

    On This Page

    Properties