SDK JS
    Preparing search index...

    The complete slice-tool state.

    interface SliceState {
        active: boolean;
        depthM: number;
        flipped: boolean;
        halfWidthM: number;
        headingDeg: number;
        placing: boolean;
        position: SlicePosition | null;
        tiltDeg: number;
    }
    Index

    Properties

    active: boolean

    Whether the slice is applied to the scene (master toggle; the plane definition is retained).

    depthM: number

    DEPTH of the cut behind the plane (how far the clipped box extends), metres. The vertical column is unbounded so buildings are cut floor-to-roof.

    flipped: boolean

    Swap which half-space is kept.

    halfWidthM: number

    Half-WIDTH of the slice volume along the plane's in-plane horizontal axis, metres.

    headingDeg: number

    Compass heading (degrees clockwise from north, [0, 360)) of the normal's horizontal direction.

    placing: boolean

    Whether the tool is armed and waiting for a map click to place the plane.

    position: SlicePosition | null

    The point the plane passes through, or null before first placement.

    tiltDeg: number

    Normal elevation above the horizon in degrees [-90, 90]; 0 = vertical slicing plane.