Grid

Visual primitive representing a finite reference grid on the XZ plane.

Grid is a scene node used to display a uniform grid, typically for orientation and spatial reference in 3D scenes. It is useful during development to visualize world units and object placement.

The grid is centered at the origin and lies flat on the XZ plane. Grid lines are evenly spaced based on the provided size and division count.

cpp

auto grid = vglx::Grid::Create({
    .size = 4.0f,
    .divisions = 16,
    .color = 0x333333
});
scene->Add(grid);

INFO

Derives from Node and inherits all public properties and methods.

Construction

Constructors

Grid()

Constructs a Grid object.

cpp

Grid::Grid(const Parameters& params);

Parameter	Description
params	Grid::Parameters

Factories preferred

Grid::Create() auto

Creates a shared pointer to a Grid object.

cpp

static auto Grid::Create(const Parameters& params);

Parameter	Description
params	Grid::Parameters

Types

Grid::Parameters struct

Parameters for constructing an Grid object.

Parameter	Description
size float	Size of the grid.
divisions unsigned	Number of divisions.
color Color	Color of the grid.

Grid ​

Construction ​

Constructors ​

Grid() ​

Factories preferred ​

Grid::Create() auto ​

Types ​

Grid::Parameters struct ​