Bitbybit Docs
    Preparing search index...

    Class DrawBasicGeometryOptions (Inputs.Draw)

    Built by draw.optionsSimple for points, lines, polylines, JSCAD paths and meshes, and Verb curves and surfaces: colors, size, opacity, back faces and arrow heads. Drawn with no options, lines, polylines and curves get size 2 in magenta.

    Index

    Constructors

    • Parameters

      • Optionalcolours: string | string[]
      • Optionalsize: number
      • Optionalopacity: number
      • Optionalupdatable: boolean
      • Optionalhidden: boolean
      • OptionaldrawTwoSided: boolean
      • OptionalbackFaceColour: string
      • OptionalbackFaceOpacity: number
      • OptionalcolorMapStrategy: colorMapStrategyEnum
      • OptionalarrowSize: number
      • OptionalarrowAngle: number

      Returns DrawBasicGeometryOptions

    Properties

    colours?: string | string[]

    One hex color for everything drawn, or a list with one per point, line, polyline, surface or JSCAD mesh; a polyline or JSCAD mesh with its own color keeps it.

    #ff0000
    
    colorMapStrategy?: colorMapStrategyEnum

    How a colours list shorter than what is drawn is spread: first color for all, last for the rest, repeating, or back and forth. JSCAD meshes and curves ignore it.

    lastColorRemainder
    
    size?: number

    The diameter of each point in model units and the width of lines, a hundredth of it in model units. Lines drawn without options get 2.

    0.1
    

    0

    Infinity

    0.1

    opacity?: number

    The opacity of points, lines, surfaces and JSCAD meshes, from 0 for invisible to 1 for opaque.

    1
    

    0

    1

    0.1

    updatable?: boolean

    When true, handing the drawn object back as babylonMesh changes it in place instead of drawing a new one.

    false
    
    hidden?: boolean

    When true, surfaces and JSCAD meshes are drawn but not shown until made visible; points and lines ignore it.

    false
    
    drawTwoSided?: boolean

    When true, the back of each surface and JSCAD mesh is drawn in backFaceColour, which shows which way it faces.

    true
    
    backFaceColour?: string

    The color of the back of surfaces and JSCAD meshes, as a hex string; used with drawTwoSided.

    #0000ff
    
    backFaceOpacity?: number

    How opaque the back of surfaces and JSCAD meshes is, from 0 for invisible to 1 for opaque; used with drawTwoSided.

    1
    

    0

    1

    0.1

    arrowSize?: number

    The length of the arrow head at the end of each line and polyline, showing its direction, in model units; 0 draws none.

    0
    

    0

    Infinity

    0.01

    arrowAngle?: number

    The angle, in degrees, between each line of an arrow head and the line it ends; larger spreads the head wider.

    15
    

    0

    90

    1