BIM.works SDKs - v3.0.0-beta.168
    Preparing search index...

    Type Alias WalkableSurfacesSpan

    What a click on one of the view's polygons says about the span under it

    type WalkableSurfacesSpan = {
        decidedBy: Vid | null;
        door: boolean;
        floorZMm: number;
        headroomMm: number;
        label: string;
        model: string;
        obstacleDistanceMm: number | null;
        point: [number, number, number];
        reason: string;
        state: WalkableSurfacesState;
        surface: "flat" | "ramp" | "stair" | "obstacle top" | "too steep";
        unknown: string | null;
        vid: Vid;
    }
    Index

    Properties

    decidedBy: Vid | null

    The version whose solid makes the span occupied or unknown, else null

    door: boolean
    floorZMm: number

    The floor's height in the render frame, mm

    headroomMm: number
    label: string

    The state in words, for a legend or tooltip

    model: string
    obstacleDistanceMm: number | null

    Distance to the nearest obstacle, mm; null when none is near

    point: [number, number, number]

    The cell's centre on the floor, render frame

    reason: string

    Why: "walkable", "headroom 1.42 m < 1.80 m", "Architecture.ifc has a solid standing here ..."

    surface: "flat" | "ramp" | "stair" | "obstacle top" | "too steep"
    unknown: string | null

    When another model makes the span unknown: what it has there; else null

    vid: Vid

    The version the span belongs to, and its name