brepjs API Reference
    Preparing search index...

    Interface SweepOptions

    Configuration for sweep/pipe operations along a spine.

    interface SweepOptions {
        angularTolerance?: number;
        auxiliarySpine?: { wrapped: any };
        boundTolerance?: number;
        forceProfileSpineOthogonality?: boolean;
        frenet?: boolean;
        law?: any;
        maxDegree?: number;
        maxSegments?: number;
        mode?: "general" | "simple";
        support?: any;
        tolerance?: number;
        transitionMode?: "transformed" | "round" | "right";
        withContact?: boolean;
    }
    Index

    Properties

    angularTolerance? auxiliarySpine? boundTolerance? forceProfileSpineOthogonality? frenet? law? maxDegree? maxSegments? mode? support? tolerance? transitionMode? withContact?

    Properties

    angularTolerance?: number

    Angular tolerance in radians for MakePipeShell.

    auxiliarySpine?: { wrapped: any }

    Auxiliary spine for twist control

    boundTolerance?: number

    Boundary tolerance for MakePipeShell. Defaults to tolerance if set.

    forceProfileSpineOthogonality?: boolean

    Force profile to be orthogonal to spine

    frenet?: boolean

    Use Frenet trihedron for profile orientation

    law?: any

    Scaling law along the path

    maxDegree?: number

    Maximum B-spline degree for pipe surface approximation.

    maxSegments?: number

    Maximum number of approximation segments.

    mode?: "general" | "simple"

    Use BRepOffsetAPI_MakePipe (simple pipe) instead of MakePipeShell. Much faster for constant cross-section profiles, especially rotationally symmetric ones (circles, regular polygons) where orientation doesn't matter. Incompatible with frenet, auxiliarySpine, law, and support options.

    support?: any

    Support surface for constrained sweeps

    tolerance?: number

    3D approximation tolerance for MakePipeShell (default: kernel default ~1e-7).

    transitionMode?: "transformed" | "round" | "right"

    Transition mode at corners: 'right' (sharp), 'transformed', or 'round'

    withContact?: boolean

    Enable contact detection

    Settings

    Member Visibility

    On This Page

    Properties