Bitbybit Docs
    Preparing search index...

    Class HelixWireByTurnsDto (Inputs.OCCT)

    The size of a coil for shapes.wire.createHelixWireByTurns: its radius, how much it climbs per turn and how many turns it makes.

    Index

    Constructors

    constructor

    Properties

    radius pitch numTurns center direction clockwise tolerance

    Constructors

    • Parameters

      • Optionalradius: number
      • Optionalpitch: number
      • OptionalnumTurns: number
      • Optionalcenter: Point3
      • Optionaldirection: Vector3
      • Optionalclockwise: boolean
      • Optionaltolerance: number

      Returns HelixWireByTurnsDto

    Properties

    radius: number

    The distance from the axis to the coil, in model units.

    1

    0

    Infinity

    0.1

    pitch: number

    How far the coil climbs along the axis in one full turn, in model units.

    1

    0

    Infinity

    0.1

    numTurns: number

    How many full turns the coil makes; fractions are allowed.

    5

    0

    Infinity

    0.5

    center: Point3

    The point on the axis where the coil starts climbing from.

    [0, 0, 0]
    direction: Vector3

    The direction of the axis the coil climbs along.

    [0, 1, 0]
    clockwise: boolean

    When true, the coil winds clockwise seen from the tip of the axis.

    false
    tolerance: number

    How far the fitted curve may stray from the exact helix, in model units.

    0.0001

    0

    Infinity

    0.0001

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties