Bitbybit Docs
    Preparing search index...

    Class DrawFrameOptions (Inputs.Draw)

    Feeds draw.optionsFrame: how a frame is drawn, as its three axes in their own colors and a small grid in its plane that marks it as a plane.

    Index

    Constructors

    constructor

    Properties

    size? colorX? colorY? colorZ? drawPlane? colorPlane? lineWidth? updatable?

    Constructors

    • Parameters

      • Optionalsize: number
      • OptionalcolorX: string
      • OptionalcolorY: string
      • OptionalcolorZ: string
      • OptionaldrawPlane: boolean
      • OptionalcolorPlane: string
      • OptionallineWidth: number
      • Optionalupdatable: boolean

      Returns DrawFrameOptions

    Properties

    size?: number

    Length of each axis, in model units; the grid in the plane is as wide, centered on the origin.

    1

    0

    true

    Infinity

    0.1

    colorX?: string

    Color of the X axis, which runs along the frame's direction.

    #ff0000
    colorY?: string

    Color of the Y axis.

    #00ff00
    colorZ?: string

    Color of the Z axis, which runs along the frame's normal.

    #0000ff
    drawPlane?: boolean

    Whether to draw the small grid in the frame's plane around its origin.

    true
    colorPlane?: string

    Color of the grid in the frame's plane.

    #808080
    lineWidth?: number

    How wide the lines are, on the scale the simple drawing options use for a line's size.

    2

    0

    Infinity

    0.1

    updatable?: boolean

    Whether the drawn frame can be redrawn in place by passing it back.

    false

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties