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

    Interface ObjectReference

    The reference geometry of an object (docs/reference-geometry-measurement-design.md §5): its centre line ("line") or a wall's axis plane ("plane"), in viewer measurement coordinates (mm), from the reference figures the server writes at check-in. A door, window, piece of furniture or other object without an axis has its vertical centre line instead (docs/vertical-centre-line-measurement-design.md)

    interface ObjectReference {
        centre?: vec3[];
        estimated: boolean;
        kind: "line" | "plane";
        method: string;
        points: vec3[];
        ports?: vec3[];
        quads?: vec3[][];
        vertical?: boolean;
    }
    Index

    Properties

    centre? estimated kind method points ports? quads? vertical?

    Properties

    centre?: vec3[]

    The true centre where it differs from the axis (a wall's layer centre, a member's profile centroid)

    estimated: boolean

    Whether the axis is an estimate from the geometry rather than an IFC definition

    kind: "line" | "plane"
    method: string

    How the server derived the axis: axisCurve, extrusionAxis, sweepDirectrix, revolvedArc, portsAxis, principalAxisEstimate, ...; for a vertical centre line openingCentre (through the centre of the opening the object fills) or planCentre (of its plan rectangle)

    points: vec3[]

    The centre line, or the base line of the axis plane

    ports?: vec3[]

    The object's ports, in nesting order

    quads?: vec3[][]

    Plane only: one four-point ring per straight segment of the axis, over the wall's height

    vertical?: boolean

    True for a vertical centre line (method openingCentre or planCentre): two of them are measured centre to centre

    Settings

    Member Visibility

    On This Page

    Properties