Bitbybit Docs
    Preparing search index...

    Class PolarDto (Inputs.Frame)

    The count, radius and sweep of the ring of frames frame.polar lays out around the normal of frame, in its plane.

    Index

    Constructors

    • Parameters

      • Optionalframe: Bit.Inputs.Base.Frame
      • Optionalcount: number
      • Optionalradius: number
      • Optionalangle: number
      • OptionalstartAngle: number
      • Optionalrotate: boolean

      Returns PolarDto

    Properties

    The frame the ring turns around, about its normal; left out, the world frame.

    undefined
    

    true

    count?: number

    How many frames in the ring.

    6
    

    1

    Infinity

    1

    radius?: number

    The distance from the center to each frame, in model units; at 0 the frames only turn in place.

    3
    

    0

    Infinity

    0.1

    angle?: number

    The angle the ring covers, in degrees, from -360 to 360. A full turn spaces the frames evenly without repeating the first; a smaller angle puts one at each end.

    360
    

    -360

    360

    1

    startAngle?: number

    The angle of the first frame, in degrees from the X axis toward the Y axis.

    0
    

    -Infinity

    Infinity

    1

    rotate?: boolean

    When true the frames rotate with the ring, as copies around a hub do; otherwise every frame keeps the axes of frame.

    true