Bitbybit Docs
    Preparing search index...

    Class DrawLineDto<T> (Inputs.Line)

    One line and how to draw it: its width, color and opacity, and whether the drawn mesh will be updated later.

    Type Parameters

    • T
    Index

    Constructors

    • Provide options without default values

      Type Parameters

      • T

      Parameters

      • Optionalline: LinePointsDto
      • Optionalopacity: number
      • Optionalcolours: string | string[]
      • Optionalsize: number
      • Optionalupdatable: boolean
      • OptionallineMesh: T

      Returns DrawLineDto<T>

    Properties

    The line to draw, with its start and end.

    undefined
    
    opacity?: number

    How opaque the line is, from 0 (invisible) to 1 (solid).

    1
    

    0

    1

    0.1

    colours?: string | string[]

    Color of the line as a hex text such as #ff0000; a list of texts is also accepted.

    #444444
    
    size?: number

    Width of the drawn line.

    3
    

    0

    Infinity

    0.1

    updatable?: boolean

    When true, the drawn mesh is built so its ends can be moved later without redrawing.

    false
    
    lineMesh?: T

    A mesh drawn earlier for this line; when given it is updated in place instead of a new one being made.

    undefined
    

    true