Grid Class Reference

Displays a grid of cells, drawn with lines. More...

#include <rendering/rendering.hh>

Public Member Functions
	Grid (Scene *_scene, uint32_t _cellCount, float _cellLength, float _lineWidth, const common::Color &_color)
	Constructor. More...
	~Grid ()
	Destructor. More...
void	Enable (bool _enable)
	Enable or disable the grid. More...
uint32_t	GetCellCount () const
	Get the number of cells. More...
float	GetCellLength () const
	Get the cell length. More...
common::Color	GetColor () const
	Return the grid color. More...
uint32_t	GetHeight () const
	Get the height of the grid. More...
float	GetLineWidth () const
	Get the width of the grid line. More...
Ogre::SceneNode *	GetSceneNode ()
	Get the Ogre scene node associated with this grid. More...
void	Init ()
	Initialize the grid. More...
void	SetCellCount (uint32_t _count)
	Set the number of cells. More...
void	SetCellLength (float _len)
	Set the cell length. More...
void	SetColor (const common::Color &_color)
	Sets the color of the grid. More...
void	SetHeight (uint32_t _count)
	Set the height of the grid. More...
void	SetLineWidth (float _width)
	Set the line width. More...
void	SetUserData (const Ogre::Any &_data)
	Sets user data on all ogre objects we own. More...

Detailed Description

Displays a grid of cells, drawn with lines.

Displays a grid of cells, drawn with lines. A grid with an identity orientation is drawn along the XY plane.

Constructor & Destructor Documentation

Grid()

Grid	(	Scene *	_scene,
		uint32_t	_cellCount,
		float	_cellLength,
		float	_lineWidth,
		const common::Color &	_color
	)

Constructor.

Parameters

[in]	_scene	The scene this object is part of
[in]	_cellCount	The number of cells to draw
[in]	_cellLength	The size of each cell
[in]	_lineWidth	The width of the lines to use
[in]	_color	The color of the grid

~Grid()

~Grid

(

)

Destructor.

Member Function Documentation

Enable()

void Enable

(

bool

_enable

)

Enable or disable the grid.

Parameters

[in]

_enable

Set to true to view the grid, false to make invisible.

GetCellCount()

uint32_t GetCellCount ( ) const

inline

Get the number of cells.

GetCellLength()

float GetCellLength ( ) const

inline

Get the cell length.

Returns

The cell length

GetColor()

common::Color GetColor ( ) const

inline

Return the grid color.

Returns

The grid color

GetHeight()

uint32_t GetHeight ( ) const

inline

Get the height of the grid.

Returns

The height

GetLineWidth()

float GetLineWidth ( ) const

inline

Get the width of the grid line.

Returns

The line width

GetSceneNode()

Ogre::SceneNode* GetSceneNode ( )

inline

Get the Ogre scene node associated with this grid.

Returns

The Ogre scene node associated with this grid

Init()

void Init

(

)

Initialize the grid.

SetCellCount()

void SetCellCount

(

uint32_t

_count

)

Set the number of cells.

Parameters

[in]

_count

The number of cells

SetCellLength()

void SetCellLength

(

float

_len

)

Set the cell length.

Parameters

[in]

_len

The cell length

SetColor()

void SetColor

(

const common::Color &

_color

)

Sets the color of the grid.

Parameters

[in]

_color

The grid color

SetHeight()

void SetHeight

(

uint32_t

_count

)

Set the height of the grid.

Parameters

[in]

_count

Grid height

SetLineWidth()

void SetLineWidth

(

float

_width

)

Set the line width.

Parameters

[in]

_width

The width of the grid

SetUserData()

void SetUserData

(

const Ogre::Any &

_data

)

Sets user data on all ogre objects we own.

Parameters

[in]

_data

The user data

---

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

• Grid.hh