Bitbybit Docs
    Preparing search index...

    Class SceneDrawGridMeshDto (Inputs.Draw)

    Feeds draw.drawGridMesh and draw.drawGridMeshNoReturn: the size of the grid on the ground plane, how far apart its lines are and which are drawn thicker, and the color and opacity of its lines.

    Index

    Constructors

    • Parameters

      • Optionalwidth: number
      • Optionalheight: number
      • Optionalsubdivisions: number
      • OptionalmajorUnitFrequency: number
      • OptionalminorUnitVisibility: number
      • OptionalgridRatio: number
      • Optionalopacity: number
      • OptionalbackFaceCulling: boolean
      • OptionalmainColor: string
      • OptionalsecondaryColor: string

      Returns SceneDrawGridMeshDto

    Properties

    width?: number

    The size of the grid along X, in model units; the grid is centered on the origin.

    400
    

    0

    Infinity

    10

    height?: number

    The size of the grid along Z, its depth on the ground plane, in model units.

    400
    

    0

    Infinity

    10

    subdivisions?: number

    How many segments the ground mesh is cut into along each side; the spacing of the lines comes from gridRatio, not from this.

    10
    

    0

    Infinity

    1

    majorUnitFrequency?: number

    How many lines it takes from one thick major line to the next; the thinner lines between them are the minor lines.

    10
    

    0

    Infinity

    1

    minorUnitVisibility?: number

    How strongly the thin minor lines between the major ones show, from 0 for hidden to 1 for full.

    0.45
    

    0

    1

    0.1

    gridRatio?: number

    The distance between two neighboring lines, in model units.

    0.5
    

    0

    Infinity

    0.1

    opacity?: number

    How opaque the grid lines are, from 0 for invisible to 1 for opaque.

    0.5
    

    0

    1

    0.1

    backFaceCulling?: boolean

    When true, the grid is not drawn when seen from below.

    false
    
    mainColor?: string

    The color between the lines, as a hex string. This grid draws only its lines, so the color does not show.

    #ffffff
    
    secondaryColor?: string

    The color of the grid lines, as a hex string.

    #ffffff