brepjs API Reference
    Preparing search index...

    Interface KernelSweepOps

    interface KernelSweepOps {
        buildExtrusionLaw(
            profile: "linear" | "s-curve",
            length: number,
            endFactor: number,
        ): any;
        draftPrism(
            shape: any,
            face: any,
            baseFace: any,
            height: number | null,
            angleDeg: number,
            fuse: boolean,
        ): any;
        extrude(
            face: any,
            direction: [number, number, number],
            length: number,
        ): any;
        extrudeBatch?(
            entries: readonly {
                direction: [number, number, number];
                face: any;
                length: number;
            }[],
        ): any[];
        helicalSweep(
            profile: any,
            axisOrigin: [number, number, number],
            axisDirection: [number, number, number],
            radius: number,
            pitch: number,
            turns: number,
        ): any;
        loft(wires: any[], ruled?: boolean, startShape?: any, endShape?: any): any;
        loftAdvanced(
            wires: any[],
            options?: {
                endVertex?: any;
                ruled?: boolean;
                solid?: boolean;
                startVertex?: any;
                tolerance?: number;
            },
        ): any;
        loftBatch?(
            entries: readonly {
                endVertex?: any;
                ruled?: boolean;
                solid?: boolean;
                startVertex?: any;
                tolerance?: number;
                wires: any[];
            }[],
        ): any[];
        revolve(shape: any, axis: any, angle: number): any;
        revolveVec(
            shape: any,
            center: [number, number, number],
            direction: [number, number, number],
            angle: number,
        ): any;
        simplePipe(profile: any, spine: any): any;
        sweep(wire: any, spine: any, options?: { transitionMode?: number }): any;
        sweepPipeShell(
            profile: any,
            spine: any,
            options?: {
                angularTolerance?: number;
                auxiliary?: any;
                boundTolerance?: number;
                contact?: boolean;
                correction?: boolean;
                frenet?: boolean;
                law?: any;
                maxDegree?: number;
                maxSegments?: number;
                shellMode?: boolean;
                support?: any;
                tolerance?: number;
                transitionMode?: "transformed" | "round" | "right";
            },
        ): any;
        sweepWithOptions(
            profile: any,
            pathEdge: any,
            contactMode: string,
            scaleValues: number[],
            segments: number,
        ): any;
    }
    Index

    Methods

    • Build an extrusion scaling law (s-curve or linear).

      Parameters

      • profile: "linear" | "s-curve"
      • length: number
      • endFactor: number

      Returns any

    • Create a draft prism (tapered extrusion with draft angle).

      Parameters

      • shape: any
      • face: any
      • baseFace: any
      • height: number | null
      • angleDeg: number
      • fuse: boolean

      Returns any

    • Parameters

      • face: any
      • direction: [number, number, number]
      • length: number

      Returns any

    • Batch extrude: build N independent extrusions in a single WASM call.

      Parameters

      • entries: readonly { direction: [number, number, number]; face: any; length: number }[]

      Returns any[]

    • Helical sweep of a profile around an axis.

      Parameters

      • profile: any
      • axisOrigin: [number, number, number]
      • axisDirection: [number, number, number]
      • radius: number
      • pitch: number
      • turns: number

      Returns any

    • Parameters

      • wires: any[]
      • Optionalruled: boolean
      • OptionalstartShape: any
      • OptionalendShape: any

      Returns any

    • Loft through wires with options for shell mode, ruled surface, and vertex caps.

      Parameters

      • wires: any[]
      • Optionaloptions: {
            endVertex?: any;
            ruled?: boolean;
            solid?: boolean;
            startVertex?: any;
            tolerance?: number;
        }

      Returns any

    • Batch loft: build N independent lofts in a single WASM call.

      Parameters

      • entries: readonly {
            endVertex?: any;
            ruled?: boolean;
            solid?: boolean;
            startVertex?: any;
            tolerance?: number;
            wires: any[];
        }[]

      Returns any[]

    • Revolve a shape around an axis defined by center+direction (Vec3s, not KernelType axis).

      Parameters

      • shape: any
      • center: [number, number, number]
      • direction: [number, number, number]
      • angle: number

      Returns any

    • Parameters

      • wire: any
      • spine: any
      • Optionaloptions: { transitionMode?: number }

      Returns any

    • Sweep a profile along a spine with advanced options (transition mode, auxiliary spine, law).

      Parameters

      • profile: any
      • spine: any
      • Optionaloptions: {
            angularTolerance?: number;
            auxiliary?: any;
            boundTolerance?: number;
            contact?: boolean;
            correction?: boolean;
            frenet?: boolean;
            law?: any;
            maxDegree?: number;
            maxSegments?: number;
            shellMode?: boolean;
            support?: any;
            tolerance?: number;
            transitionMode?: "transformed" | "round" | "right";
        }

      Returns any

    • Sweep with options (contact mode, scale law, segments).

      Parameters

      • profile: any
      • pathEdge: any
      • contactMode: string
      • scaleValues: number[]
      • segments: number

      Returns any