brepjs API Reference
    Preparing search index...

    Interface BooleanOptions

    Options shared by all boolean and compound operations.

    interface BooleanOptions {
        fuzzyValue?: number;
        optimisation?: "none" | "commonFace" | "sameFace";
        signal?: AbortSignal;
        simplify?: boolean;
        strategy?: "native" | "pairwise";
        trackEvolution?: boolean;
        unsafe?: boolean;
    }
    Index

    Properties

    fuzzyValue? optimisation? signal? simplify? strategy? trackEvolution? unsafe?

    Properties

    fuzzyValue?: number

    Fuzzy tolerance for boolean operations. When set to a small positive value (e.g., 1e-5), OCCT merges nearly-coincident vertices and edges early, reducing intersection computation. Useful for 3D printing workflows where sub-micron precision is not needed. Default: 0 (exact geometry).

    optimisation?: "none" | "commonFace" | "sameFace"

    Glue algorithm hint for faces shared between operands.

    signal?: AbortSignal

    Abort signal to cancel long-running operations between steps.

    simplify?: boolean

    Merge same-domain faces/edges after the boolean.

    strategy?: "native" | "pairwise"

    Algorithm selection: 'native' uses N-way BRepAlgoAPI_BuilderAlgo; 'pairwise' uses recursive divide-and-conquer.

    trackEvolution?: boolean

    When false, skips face evolution tracking (hash collection, Modified/Generated/Deleted queries, metadata propagation). This is a performance optimization for intermediate boolean operations where face tags/colors are not needed. Defaults to true.

    unsafe?: boolean

    When true, accepts any Shape3D (shells, compounds) without requiring ValidSolid branding. This is a type-level escape hatch only — no runtime effect.

    Settings

    Member Visibility

    On This Page

    Properties