brepjs API Reference
    Preparing search index...

    Interface ThreadOptions

    Configuration for thread. Units are mm; angles derive from pitch.

    interface ThreadOptions {
        crest?: number;
        depth?: number;
        height: number;
        inward?: boolean;
        lefthand?: boolean;
        pitch: number;
        radius: number;
        sectionsPerTurn?: number;
        toothHalfWidth?: number;
    }
    Index

    Properties

    crest?: number

    Axial half-width of a flat crest, giving a trapezoidal tooth instead of a pointed V. 0 (default) is a sharp V (ISO/UN). Use a positive value for a power-screw profile: ≈0.18 * pitch ≈ Acme/trapezoidal, up near toothHalfWidth ≈ square thread. Must be < toothHalfWidth.

    depth?: number

    Radial thread height (crest minus root). Defaults to 0.6 * pitch (≈ISO 60° V).

    height: number

    Total thread length along the axis. Turn count = height / pitch.

    inward?: boolean

    Point the tooth toward the axis (for an internal thread to cut from a bore).

    lefthand?: boolean

    Left-handed thread. Defaults to false (right-handed).

    pitch: number

    Axial distance per full turn.

    radius: number

    Core radius (external) or nominal hole radius (internal), at the thread root.

    sectionsPerTurn?: number

    Loft sections per turn — higher is smoother but slower. Defaults to 20.

    toothHalfWidth?: number

    Axial half-width of the tooth at the root. Defaults to 0.42 * pitch.