IFClite TypeScript API
    Preparing search index...

    Interface SectionPlane

    interface SectionPlane {
        axis: SectionPlaneAxis;
        capStyle?: SectionCapStyleOptions;
        distance?: number;
        enabled: boolean;
        flipped?: boolean;
        id?: string;
        max?: number;
        min?: number;
        normal?: [number, number, number];
        position: number;
        showCap?: boolean;
        showGizmo?: boolean;
        showOutlines?: boolean;
    }
    Index
    axis capStyle? distance? enabled flipped? id? max? min? normal? position showCap? showGizmo? showOutlines?
    axis: SectionPlaneAxis
    capStyle?: SectionCapStyleOptions

    Override the default cap appearance.

    distance?: number

    Plane offset in world units: dot(pointOnPlane, normal).

    enabled: boolean
    flipped?: boolean
    id?: string

    Keys this plane's cap among the cutting planes beyond the first (#7545); unused on the primary plane.

    max?: number
    min?: number
    normal?: [number, number, number]

    Optional world-space plane normal (unit vector). When provided together with distance, the shader clip uses them verbatim and ignores axis, position, min, max, and any buildingRotation. Used for face-pick / arbitrary slice planes (issue #243).

    position: number
    showCap?: boolean

    If true (default), render filled cap surfaces with a screen-space hatch.

    showGizmo?: boolean

    False hides the preview quad of the primary plane (the plane still clips and caps). Default true (#7545).

    showOutlines?: boolean

    If true (default), draw polygon outlines on the cut surfaces. Users can turn surfaces and outlines on/off independently from the UI.

    Settings
    Member Visibility

    On This Page
    Properties