State for the reference grid overlay. More...

#include <bgi_types.h>

Data Fields
bool	enabled {false}

int	gridColor {DARKGRAY}
	colour for all non-axis grid lines

int	halfExtent {4}
	grid spans ±(halfExtent×spacing) from UCS origin

float	spacing {25.f}
	world units between adjacent grid lines

std::string	ucsName
	which UCS to use; empty = BgiState::activeUcs

int	xAxisColor {RED}
	colour for the line coincident with UCS local X axis

int	yAxisColor {GREEN}
	colour for the line coincident with UCS local Y axis

Detailed Description

State for the reference grid overlay.

The grid is drawn in the XY plane of the active (or specified) UCS and projected through each camera that renders the scene. It is NOT a DDS object and cannot be selected or serialised.

Field Documentation

◆ enabled

bool bgi::OverlayGridState::enabled {false}

◆ gridColor

int bgi::OverlayGridState::gridColor {DARKGRAY}

colour for all non-axis grid lines

◆ halfExtent

int bgi::OverlayGridState::halfExtent {4}

grid spans ±(halfExtent×spacing) from UCS origin

◆ spacing

float bgi::OverlayGridState::spacing {25.f}

world units between adjacent grid lines

◆ ucsName

std::string bgi::OverlayGridState::ucsName

which UCS to use; empty = BgiState::activeUcs

◆ xAxisColor

int bgi::OverlayGridState::xAxisColor {RED}

colour for the line coincident with UCS local X axis

◆ yAxisColor

int bgi::OverlayGridState::yAxisColor {GREEN}

colour for the line coincident with UCS local Y axis

The documentation for this struct was generated from the following file:

src/bgi_types.h

Data Fields