Class SceneGrid

Handles rendering of the grid in the scene view.

Hierarchy

  • FrameworkObject
    • SceneGrid

Constructors

  • Parameters

    • camera: Camera
    • OptionalisInternalConstructor: boolean

    Returns SceneGrid

Accessors

  • get enabled(): boolean
  • Defines if the scene grid is enabled.

    Returns boolean

  • set enabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get linesOpacity(): number
  • Set opacity of grid lines.

    Returns number

  • set linesOpacity(value): void
  • Parameters

    • value: number

    Returns void

  • get planeOpacity(): number
  • Set opacity of grid plane.

    Returns number

  • set planeOpacity(value): void
  • Parameters

    • value: number

    Returns void

  • get size(): number
  • Sets the total width/height of the grid in XZ plane.

    Returns number

  • set size(value): void
  • Parameters

    • value: number

    Returns void

  • get spacing(): number
  • Sets the spacing between grid lines.

    Returns number

  • set spacing(value): void
  • Parameters

    • value: number

    Returns void

Methods

  • Destroy the grid and remove it from engine subsystems.

    Returns void

  • Called once per frame.

    Returns void