Displays a grid of cells, drawn with lines.
More...
#include <rendering/rendering.hh>
|
| Grid (Scene *_scene, const uint32_t _cellCount, const float _cellLength, const ignition::math::Color &_color) |
| Constructor.
|
|
| ~Grid () |
| Destructor.
|
|
uint32_t | CellCount () const |
| Get the number of cells.
|
|
float | CellLength () const |
| Get the cell length.
|
|
ignition::math::Color | Color () const |
| Return the grid color.
|
|
void | Enable (const bool _enable) |
| Enable or disable the grid.
|
|
VisualPtr | GridVisual () const |
| Get thevisual associated with this grid.
|
|
uint32_t | Height () const |
| Get the number of cells in the normal direction of the grid.
|
|
double | HeightOffset () const |
| Get the height offset.
|
|
void | Init () |
| Initialize the grid.
|
|
void | SetCellCount (const uint32_t _count) |
| Set the number of cells.
|
|
void | SetCellLength (const float _len) |
| Set the cell length.
|
|
void | SetColor (const ignition::math::Color &_color) |
| Sets the color of the grid.
|
|
void | SetHeight (const uint32_t _count) |
| Set the height of the grid.
|
|
void | SetHeightOffset (const double _offset) |
| Set the height offset of the grid.
|
|
void | SetUserData (const Ogre::Any &_data) |
| Sets user data on all ogre objects we own.
|
|
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.
◆ Grid()
Grid |
( |
Scene * | _scene, |
|
|
const uint32_t | _cellCount, |
|
|
const float | _cellLength, |
|
|
const ignition::math::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] | _color | The color of the grid |
◆ ~Grid()
◆ CellCount()
uint32_t CellCount |
( |
| ) |
const |
Get the number of cells.
- Returns
- The number of cells in each direction.
◆ CellLength()
float CellLength |
( |
| ) |
const |
Get the cell length.
- Returns
- The cell length
◆ Color()
ignition::math::Color Color |
( |
| ) |
const |
Return the grid color.
- Returns
- The grid color
◆ Enable()
void Enable |
( |
const bool | _enable | ) |
|
Enable or disable the grid.
- Parameters
-
[in] | _enable | Set to true to view the grid, false to make invisible. |
◆ GridVisual()
Get thevisual associated with this grid.
- Returns
- The visual associated with this grid
◆ Height()
uint32_t Height |
( |
| ) |
const |
Get the number of cells in the normal direction of the grid.
- Returns
- The height
◆ HeightOffset()
double HeightOffset |
( |
| ) |
const |
Get the height offset.
- Returns
- The height offset.
◆ Init()
◆ SetCellCount()
void SetCellCount |
( |
const uint32_t | _count | ) |
|
Set the number of cells.
- Parameters
-
[in] | _count | The number of cells |
◆ SetCellLength()
void SetCellLength |
( |
const float | _len | ) |
|
Set the cell length.
- Parameters
-
◆ SetColor()
void SetColor |
( |
const ignition::math::Color & | _color | ) |
|
Sets the color of the grid.
- Parameters
-
◆ SetHeight()
void SetHeight |
( |
const uint32_t | _count | ) |
|
Set the height of the grid.
- Parameters
-
◆ SetHeightOffset()
void SetHeightOffset |
( |
const double | _offset | ) |
|
Set the height offset of the grid.
- Parameters
-
[in] | _count | Grid height offset. |
◆ SetUserData()
void SetUserData |
( |
const Ogre::Any & | _data | ) |
|
Sets user data on all ogre objects we own.
- Parameters
-
The documentation for this class was generated from the following file: