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

    Interface OverlayMeshItem

    A prebuilt triangle mesh drawn like an area (fill and outline): many figures merged into one draw (FigureLayers). Positions are relative to anchor, raw world mm

    interface OverlayMeshItem {
        anchor: [number, number, number];
        bounds: { max: number[]; min: number[] };
        color?: string;
        depth?: "always" | "test" | "ghost";
        hoverHighlight?: boolean;
        id: string;
        indices: Uint32Array;
        label?: string;
        labelShow?: "always" | "hover";
        normals: Float32Array;
        outline?: {
            indices: Uint32Array;
            normals: Float32Array;
            positions: Float32Array;
        };
        positions: Float32Array;
        qids?: string[];
        role?: OverlayRole;
        storey?: string;
        style?: { fill?: number; outline?: boolean };
        tooltip?: string;
        type: "mesh";
        views?: ("2d" | "3d")[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    anchor bounds color? depth? hoverHighlight? id indices label? labelShow? normals outline? positions qids? role? storey? style? tooltip? type views?

    Properties

    anchor: [number, number, number]
    bounds: { max: number[]; min: number[] }
    color?: string

    "#rrggbb" or "#rrggbbaa", overrides the role colour

    depth?: "always" | "test" | "ghost"

    "ghost" draws as "test" until the ghost pass arrives

    hoverHighlight?: boolean

    false: hovering does not lighten or tooltip the whole mesh (its parts are different things)

    id: string

    Unique within the overlay

    indices: Uint32Array
    label?: string
    labelShow?: "always" | "hover"

    "hover": the label only while the item or one of its qids is hovered; default "always"

    normals: Float32Array
    outline?: {
        indices: Uint32Array;
        normals: Float32Array;
        positions: Float32Array;
    }
    positions: Float32Array
    qids?: string[]

    Related model objects

    role?: OverlayRole
    storey?: string
    style?: { fill?: number; outline?: boolean }
    tooltip?: string
    type: "mesh"
    views?: ("2d" | "3d")[]

    Settings

    Member Visibility

    On This Page

    Properties