brepjs API Reference
    Preparing search index...

    Interface KernelBooleanOps

    interface KernelBooleanOps {
        booleanPipeline?(
            base: any,
            steps: readonly { op: "fuse" | "cut" | "intersect"; tool: any }[],
            options?: { fuzzyValue?: number; glueMode?: number },
        ): any;
        checkBoolean(shape: any, tool: any, op: BooleanOpType): CheckBooleanResult;
        cut(shape: any, tool: any, options?: BooleanOptions): any;
        cutAll(shape: any, tools: any[], options?: BooleanOptions): any;
        fuse(shape: any, tool: any, options?: BooleanOptions): any;
        fuseAll(shapes: any[], options?: BooleanOptions): any;
        intersect(shape: any, tool: any, options?: BooleanOptions): any;
        meshBoolean(
            positionsA: number[],
            indicesA: number[],
            positionsB: number[],
            indicesB: number[],
            op: string,
            tolerance: number,
        ): KernelMeshResult;
        section(shape: any, plane: any, approximation?: boolean): any;
        split(shape: any, tools: any[]): any;
    }
    Index

    Methods

    booleanPipeline? checkBoolean cut cutAll fuse fuseAll intersect meshBoolean section split

    Methods

    • Execute a chained boolean pipeline in a single WASM call (optional).

      Parameters

      • base: any
      • steps: readonly { op: "fuse" | "cut" | "intersect"; tool: any }[]
      • Optionaloptions: { fuzzyValue?: number; glueMode?: number }

      Returns any

    • Boolean operation on raw triangle data. Returns merged mesh.

      Cross-kernel note: Only brepkit supports mesh booleans natively. OCCT adapter throws.

      Parameters

      • positionsA: number[]
      • indicesA: number[]
      • positionsB: number[]
      • indicesB: number[]
      • op: string
      • tolerance: number

      Returns KernelMeshResult

    • Cross-section: intersect shape with a plane.

      Parameters

      • shape: any
      • plane: any
      • Optionalapproximation: boolean

      Returns any

    Settings

    Member Visibility

    On This Page

    Methods