Bitbybit Docs
    Preparing search index...

    Class StarDto (Inputs.OCCT)

    The proportions of a star for shapes.wire.createStarWire and shapes.face.createStarFace, which lay it flat on the ground unless direction says otherwise.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    center? direction? numRays? outerRadius? innerRadius? offsetOuterEdges? half?

    Constructors

    • Parameters

      • OptionalouterRadius: number
      • OptionalinnerRadius: number
      • OptionalnumRays: number
      • Optionalcenter: Point3
      • Optionaldirection: Vector3
      • OptionaloffsetOuterEdges: number
      • Optionalhalf: boolean

      Returns Bit.Inputs.OCCT.StarDto

    Properties

    center?: Point3

    The point the star is centered on.

    [0,0,0]
    direction?: Vector3

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

    [0, 1, 0]
    numRays?: number

    How many points the star has.

    7

    3

    Infinity

    1

    outerRadius?: number

    The distance from the center to the tip of each ray, in model units.

    2

    0

    Infinity

    0.1

    innerRadius?: number

    The distance from the center to the notch between two rays, in model units.

    1

    0

    Infinity

    0.1

    offsetOuterEdges?: number

    Lifts the ray tips out of the plane along the normal, in model units, making a 3D star; keep it 0 for a face.

    0

    -Infinity

    Infinity

    0.1

    half?: boolean

    When true, only the first half of the rays are built, as an open wire.

    false

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties