All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
gazebo::rendering::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.
 
 ~Grid ()
 Destructor.
 
void Enable (bool _enable)
 Enable or disable the grid.
 
uint32_t GetCellCount () const
 Get the number of cells.
 
float GetCellLength () const
 Get the cell length.
 
common::Color GetColor () const
 Return the grid color.
 
uint32_t GetHeight () const
 Get the height of the grid.
 
float GetLineWidth () const
 Get the width of the grid line.
 
Ogre::SceneNode * GetSceneNode ()
 Get the Ogre scene node associated with this grid.
 
void Init ()
 Initialize the grid.
 
void SetCellCount (uint32_t _count)
 Set the number of cells.
 
void SetCellLength (float _len)
 Set the cell length.
 
void SetColor (const common::Color &_color)
 Sets the color of the grid.
 
void SetHeight (uint32_t _count)
 Set the height of the grid.
 
void SetLineWidth (float _width)
 Set the line width.
 
void SetUserData (const Ogre::Any &_data)
 Sets user data on all ogre objects we own.
 

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

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

Constructor.

Parameters
[in]_sceneThe scene this object is part of
[in]_cellCountThe number of cells to draw
[in]_cellLengthThe size of each cell
[in]_lineWidthThe width of the lines to use
[in]_colorThe color of the grid
gazebo::rendering::Grid::~Grid ( )

Destructor.

Member Function Documentation

void gazebo::rendering::Grid::Enable ( bool  _enable)

Enable or disable the grid.

Parameters
[in]_enableSet to true to view the grid, false to make invisible.
uint32_t gazebo::rendering::Grid::GetCellCount ( ) const
inline

Get the number of cells.

float gazebo::rendering::Grid::GetCellLength ( ) const
inline

Get the cell length.

Returns
The cell length
common::Color gazebo::rendering::Grid::GetColor ( ) const
inline

Return the grid color.

Returns
The grid color
uint32_t gazebo::rendering::Grid::GetHeight ( ) const
inline

Get the height of the grid.

Returns
The height
float gazebo::rendering::Grid::GetLineWidth ( ) const
inline

Get the width of the grid line.

Returns
The line width
Ogre::SceneNode* gazebo::rendering::Grid::GetSceneNode ( )
inline

Get the Ogre scene node associated with this grid.

Returns
The Ogre scene node associated with this grid
void gazebo::rendering::Grid::Init ( )

Initialize the grid.

void gazebo::rendering::Grid::SetCellCount ( uint32_t  _count)

Set the number of cells.

Parameters
[in]_countThe number of cells
void gazebo::rendering::Grid::SetCellLength ( float  _len)

Set the cell length.

Parameters
[in]_lenThe cell length
void gazebo::rendering::Grid::SetColor ( const common::Color _color)

Sets the color of the grid.

Parameters
[in]_colorThe grid color
void gazebo::rendering::Grid::SetHeight ( uint32_t  _count)

Set the height of the grid.

Parameters
[in]_countGrid height
void gazebo::rendering::Grid::SetLineWidth ( float  _width)

Set the line width.

Parameters
[in]_widthThe width of the grid
void gazebo::rendering::Grid::SetUserData ( const Ogre::Any &  _data)

Sets user data on all ogre objects we own.

Parameters
[in]_dataThe user data

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