brepjs API Reference
    Preparing search index...

    Interface KernelModifierOps

    interface KernelModifierOps {
        chamfer(
            shape: any,
            edges: any[],
            distance:
                | number
                | [number, number]
                | ((edge: any) => number | [number, number]),
        ): any;
        chamferDistAngle(
            shape: any,
            edges: any[],
            distance: number,
            angleDeg: number,
        ): any;
        defeature(shape: any, faces: any[]): any;
        draft(
            shape: any,
            faces: any[],
            pullDirection: [number, number, number],
            neutralPlane: [number, number, number],
            angleDeg: number | ((face: any) => number),
        ): any;
        fillet(
            shape: any,
            edges: any[],
            radius:
                | number
                | [number, number]
                | ((edge: any) => number | [number, number]),
        ): any;
        filletBatch?(
            entries: readonly {
                edges: readonly { edge: any; r2?: number; radius: number }[];
                shape: any;
            }[],
        ): any[];
        filletVariable(shape: any, spec: string): any;
        offset(shape: any, distance: number, tolerance?: number): any;
        offsetWire2D(
            wire: any,
            offset: number,
            joinType?: number | "arc" | "intersection" | "tangent",
        ): any;
        reverseShape(shape: any): any;
        shell(shape: any, faces: any[], thickness: number, tolerance?: number): any;
        shellBatch?(
            entries: readonly {
                faces: any[];
                shape: any;
                thickness: number;
                tolerance?: number;
            }[],
        ): any[];
        simplify(shape: any): any;
        thicken(shape: any, thickness: number): any;
    }
    Index

    Methods

    chamfer chamferDistAngle defeature draft fillet filletBatch? filletVariable offset offsetWire2D reverseShape shell shellBatch? simplify thicken

    Methods

    • Parameters

      • shape: any
      • edges: any[]
      • distance: number | [number, number] | ((edge: any) => number | [number, number])

      Returns any

    • Parameters

      • shape: any
      • edges: any[]
      • distance: number
      • angleDeg: number

      Returns any

    • Draft (taper) faces of a solid along a pull direction about a neutral plane.

      The neutral plane is the surface where material is neither added nor removed. Angle is in degrees; positive tapers outward from the pull direction.

      Parameters

      • shape: any
      • faces: any[]
      • pullDirection: [number, number, number]
      • neutralPlane: [number, number, number]
      • angleDeg: number | ((face: any) => number)

        Uniform angle, or per-face callback returning degrees (null to skip).

      Returns any

    • Parameters

      • shape: any
      • edges: any[]
      • radius: number | [number, number] | ((edge: any) => number | [number, number])

      Returns any

    • Batch fillet: round edges on N solids in a single WASM call.

      Parameters

      • entries: readonly {
            edges: readonly { edge: any; r2?: number; radius: number }[];
            shape: any;
        }[]

      Returns any[]

    • Variable-radius fillet. Each entry specifies edges and radii per edge.

      Parameters

      • shape: any
      • spec: string

      Returns any

    • 2D offset for wires on a plane.

      Parameters

      • wire: any
      • offset: number
      • OptionaljoinType: number | "arc" | "intersection" | "tangent"

      Returns any

    • Parameters

      • shape: any
      • faces: any[]
      • thickness: number
      • Optionaltolerance: number

      Returns any

    • Batch shell: hollow N solids in a single WASM call.

      Parameters

      • entries: readonly { faces: any[]; shape: any; thickness: number; tolerance?: number }[]

      Returns any[]

    Settings

    Member Visibility

    On This Page

    Methods