Bitbybit Docs
    Preparing search index...

    Class FlatSpiralWireDto (Inputs.OCCT)

    The size of a flat spiral for shapes.wire.createFlatSpiralWire: the radius at each end and the number of turns between them.

    Index

    Constructors

    constructor

    Properties

    startRadius endRadius numTurns center direction clockwise tolerance

    Constructors

    • Parameters

      • OptionalstartRadius: number
      • OptionalendRadius: number
      • OptionalnumTurns: number
      • Optionalcenter: Point3
      • Optionaldirection: Vector3
      • Optionalclockwise: boolean
      • Optionaltolerance: number

      Returns FlatSpiralWireDto

    Properties

    startRadius: number

    The distance from the center where the spiral starts, in model units.

    0.5

    0

    Infinity

    0.1

    endRadius: number

    The distance from the center where the spiral ends, in model units.

    5

    0

    Infinity

    0.1

    numTurns: number

    How many full turns the spiral makes between the two radii; fractions are allowed.

    5

    0

    Infinity

    0.5

    center: Point3

    The point the spiral winds around.

    [0, 0, 0]
    direction: Vector3

    The normal of the plane the spiral lies in; the default lays it flat on the ground.

    [0, 1, 0]
    clockwise: boolean

    When true, the spiral winds clockwise seen from the tip of the normal.

    false
    tolerance: number

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

    0.0001

    0

    Infinity

    0.0001

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties