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

    Interface OverlayPathItem

    A 3D polyline on the walking surface (an escape route), drawn as a tube ("snake") raised by lift, in front of the model by default (depth "always"). Lengths in mm (docs/check-result-interaction-design.md §7)

    interface OverlayPathItem {
        arrows?: { spacing: number };
        color?: string;
        depth?: "always" | "test" | "ghost";
        directed?: boolean;
        id: string;
        label?: string;
        labelShow?: "always" | "hover";
        lift?: number;
        marks?: { at: number; kind?: string; label?: string }[];
        points: number[];
        qids?: string[];
        role?: OverlayRole;
        segmentRoles?: [number, number, OverlayRole][];
        stations?: { interval: number; labels?: boolean };
        storey?: string;
        style?: {
            kind?: "line" | "snake" | "ribbon";
            radius?: number;
            smooth?: "none" | "corners" | "spline";
        };
        tooltip?: string;
        type: "path";
        views?: ("2d" | "3d")[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    arrows? color? depth? directed? id label? labelShow? lift? marks? points qids? role? segmentRoles? stations? storey? style? tooltip? type views?

    Properties

    arrows?: { spacing: number }

    Direction cones every spacing mm along the drawn path

    color?: string

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

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

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

    directed?: boolean

    Runs from the first point to the last: a cone at the end

    id: string

    Unique within the overlay

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

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

    lift?: number

    mm above the points, default the radius + 10

    marks?: { at: number; kind?: string; label?: string }[]

    A collar (and its label above it) at an arc length on the points as sent

    points: number[]

    Flat x,y,z triples on the walking surface

    qids?: string[]

    Related model objects

    role?: OverlayRole
    segmentRoles?: [number, number, OverlayRole][]

    [fromPoint, toPoint, role]: those segments in another role's colour

    stations?: { interval: number; labels?: boolean }

    Not drawn yet

    storey?: string
    style?: {
        kind?: "line" | "snake" | "ribbon";
        radius?: number;
        smooth?: "none" | "corners" | "spline";
    }

    Only "snake" with rounded corners is drawn so far; radius default 60 mm

    tooltip?: string
    type: "path"
    views?: ("2d" | "3d")[]

    Settings

    Member Visibility

    On This Page

    Properties