Bitbybit Docs
    Preparing search index...

    Class SceneDrawGridMeshDto (Inputs.Draw)

    Feeds draw.drawGridMesh: the size of the ground grid, how its lines are spaced and weighted, and its colors and opacity.

    Index

    Constructors

    constructor

    Properties

    width? height? subdivisions? majorUnitFrequency? minorUnitVisibility? gridRatio? opacity? backFaceCulling? mainColor? secondaryColor?

    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

    Full size of the grid along X, in scene units

    400

    0

    Infinity

    10

    height?: number

    Height of the ground

    400

    0

    Infinity

    10

    subdivisions?: number

    Number of cells the ground mesh is divided into along each side

    10

    0

    Infinity

    1

    majorUnitFrequency?: number

    The frequency of thicker lines.

    10

    0

    Infinity

    1

    minorUnitVisibility?: number

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

    0.45

    0

    1

    0.1

    gridRatio?: number

    The scale of the grid compared to unit.

    0.5

    0

    Infinity

    0.1

    opacity?: number

    The grid opacity outside of the lines.

    0.5

    0

    1

    0.1

    backFaceCulling?: boolean

    Cull the back faces

    false
    mainColor?: string

    Main color of the grid (e.g. between lines)

    #ffffff
    secondaryColor?: string

    Color of the grid lines.

    #ffffff

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties