brepjs API Reference
    Preparing search index...

    Interface KernelBuilderOps

    interface KernelBuilderOps {
        addHolesInFace(face: any, holeWires: any[]): any;
        bsplineSurface(
            points: [number, number, number][],
            rows: number,
            cols: number,
        ): any;
        buildSolidFromFaces(
            points: { x: number; y: number; z: number }[],
            faces: (readonly [number, number, number])[],
            tolerance: number,
        ): any;
        buildTriFace(
            a: [number, number, number],
            b: [number, number, number],
            c: [number, number, number],
        ): any;
        createAxis1(
            cx: number,
            cy: number,
            cz: number,
            dx: number,
            dy: number,
            dz: number,
        ): any;
        createAxis2(
            ox: number,
            oy: number,
            oz: number,
            zx: number,
            zy: number,
            zz: number,
            xx?: number,
            xy?: number,
            xz?: number,
        ): any;
        createAxis3(
            ox: number,
            oy: number,
            oz: number,
            zx: number,
            zy: number,
            zz: number,
            xx?: number,
            xy?: number,
            xz?: number,
        ): any;
        createDirection3d(x: number, y: number, z: number): any;
        createPoint3d(x: number, y: number, z: number): any;
        createVector3d(x: number, y: number, z: number): any;
        hull(shapes: any[], tolerance: number): any;
        hullFromPoints(
            points: { x: number; y: number; z: number }[],
            tolerance: number,
        ): any;
        makeArcEdge(
            p1: [number, number, number],
            p2: [number, number, number],
            p3: [number, number, number],
        ): any;
        makeBezierEdge(points: [number, number, number][]): any;
        makeCircleArc(
            center: [number, number, number],
            normal: [number, number, number],
            radius: number,
            startAngle: number,
            endAngle: number,
        ): any;
        makeCircleEdge(
            center: [number, number, number],
            normal: [number, number, number],
            radius: number,
        ): any;
        makeCompound(shapes: any[]): any;
        makeEdge(curve: any, start?: number, end?: number): any;
        makeEllipseArc(
            center: [number, number, number],
            normal: [number, number, number],
            majorRadius: number,
            minorRadius: number,
            startAngle: number,
            endAngle: number,
            xDir?: [number, number, number],
        ): any;
        makeEllipseEdge(
            center: [number, number, number],
            normal: [number, number, number],
            majorRadius: number,
            minorRadius: number,
            xDir?: [number, number, number],
        ): any;
        makeFace(wire: any, planar?: boolean): any;
        makeFaceOnSurface(surface: any, wire: any): any;
        makeHelixWire(
            pitch: number,
            height: number,
            radius: number,
            center?: [number, number, number],
            direction?: [number, number, number],
            leftHanded?: boolean,
        ): any;
        makeLineEdge(
            p1: [number, number, number],
            p2: [number, number, number],
        ): any;
        makeNonPlanarFace(wire: any): any;
        makeTangentArc(
            startPoint: [number, number, number],
            startTangent: [number, number, number],
            endPoint: [number, number, number],
        ): any;
        makeVertex(x: number, y: number, z: number): any;
        makeWire(edges: any[]): any;
        makeWireFromMixed(items: any[]): any;
        removeHolesFromFace(face: any): any;
        sewAndSolidify(faces: any[], tolerance: number): any;
        solidFromShell(shell: any): any;
        triangulatedSurface(
            points: [number, number, number][],
            rows: number,
            cols: number,
        ): any;
    }
    Index

    Methods

    • Fit a B-spline surface through a grid of Z-heights.

      Parameters

      • points: [number, number, number][]
      • rows: number
      • cols: number

      Returns any

    • Parameters

      • points: { x: number; y: number; z: number }[]
      • faces: (readonly [number, number, number])[]
      • tolerance: number

      Returns any

    • Build a triangular face from 3 points. Returns null if degenerate. Used by importers, hull, roof, and surface builders.

      Parameters

      • a: [number, number, number]
      • b: [number, number, number]
      • c: [number, number, number]

      Returns any

    • Parameters

      • cx: number
      • cy: number
      • cz: number
      • dx: number
      • dy: number
      • dz: number

      Returns any

    • Parameters

      • ox: number
      • oy: number
      • oz: number
      • zx: number
      • zy: number
      • zz: number
      • Optionalxx: number
      • Optionalxy: number
      • Optionalxz: number

      Returns any

    • Parameters

      • ox: number
      • oy: number
      • oz: number
      • zx: number
      • zy: number
      • zz: number
      • Optionalxx: number
      • Optionalxy: number
      • Optionalxz: number

      Returns any

    • Parameters

      • points: { x: number; y: number; z: number }[]
      • tolerance: number

      Returns any

    • Parameters

      • p1: [number, number, number]
      • p2: [number, number, number]
      • p3: [number, number, number]

      Returns any

    • Parameters

      • center: [number, number, number]
      • normal: [number, number, number]
      • radius: number
      • startAngle: number
      • endAngle: number

      Returns any

    • Parameters

      • center: [number, number, number]
      • normal: [number, number, number]
      • radius: number

      Returns any

    • Parameters

      • center: [number, number, number]
      • normal: [number, number, number]
      • majorRadius: number
      • minorRadius: number
      • startAngle: number
      • endAngle: number
      • OptionalxDir: [number, number, number]

      Returns any

    • Parameters

      • center: [number, number, number]
      • normal: [number, number, number]
      • majorRadius: number
      • minorRadius: number
      • OptionalxDir: [number, number, number]

      Returns any

    • Build a face on an existing surface bounded by a wire.

      Parameters

      • surface: any
      • wire: any

      Returns any

    • Parameters

      • pitch: number
      • height: number
      • radius: number
      • Optionalcenter: [number, number, number]
      • Optionaldirection: [number, number, number]
      • OptionalleftHanded: boolean

      Returns any

    • Parameters

      • p1: [number, number, number]
      • p2: [number, number, number]

      Returns any

    • Parameters

      • startPoint: [number, number, number]
      • startTangent: [number, number, number]
      • endPoint: [number, number, number]

      Returns any

    • Build a wire from a mix of edges and wires (uses Add_1 for edges, Add_2 for wires).

      Parameters

      • items: any[]

      Returns any

    • Remove all inner wires (holes) from a face. Returns a new face with only the outer boundary.

      Parameters

      • face: any

      Returns any

    • Sew triangular faces into a shell and convert to solid.

      Parameters

      • faces: any[]
      • tolerance: number

      Returns any

    • Build a triangulated surface from a height grid.

      Parameters

      • points: [number, number, number][]
      • rows: number
      • cols: number

      Returns any