SDK JS
    Preparing search index...

    Interface ObstructionProbeOptions

    interface ObstructionProbeOptions {
        baseM: number;
        bearingDeg: number;
        columns?: number;
        halfWidthM: number;
        nearSkipM?: number;
        origin: { lat: number; lng: number };
        reachM: number;
        rows?: number;
        topM: number;
    }
    Index

    Properties

    baseM: number

    Bottom of the scanned band, metres above the map's zero (typically the surface underfoot plus the step-up allowance: anything lower is steppable).

    bearingDeg: number

    Travel bearing, degrees clockwise from north.

    columns?: number

    Lateral resolution across the corridor, pixels. Default 32.

    halfWidthM: number

    Half the body width, metres — the corridor is 2 × halfWidthM wide.

    nearSkipM?: number

    Ignore obstructions nearer than this, metres. Default 0.05 — the probe's own near-plane guard (see buildForwardFrame).

    origin: { lat: number; lng: number }

    The eye's ground position (lng/lat degrees) — the probe starts here.

    reachM: number

    How far ahead to look, metres (the probe's far plane).

    rows?: number

    Vertical resolution of the band, pixels. Default 24.

    topM: number

    Top of the scanned band, metres above the map's zero (typically eye height: anything higher is headroom you walk under).