Public Types | Public Member Functions | Private Attributes | List of all members
rviz::Grid Class Reference

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

#include <grid.h>

Public Types

enum  Style { Lines, Billboards }
 

Public Member Functions

void create ()
 
float getCellCount ()
 
float getCellLength ()
 
Ogre::ColourValue getColor ()
 
uint32_t getHeight ()
 
float getLineWidth ()
 
Ogre::SceneNode * getSceneNode ()
 Get the Ogre scene node associated with this grid. More...
 
Style getStyle ()
 
 Grid (Ogre::SceneManager *manager, Ogre::SceneNode *parent_node, Style style, uint32_t cell_count, float cell_length, float line_width, const Ogre::ColourValue &color)
 Constructor. More...
 
void setCellCount (uint32_t count)
 
void setCellLength (float len)
 
void setColor (const Ogre::ColourValue &color)
 
void setHeight (uint32_t count)
 
void setLineWidth (float width)
 
void setStyle (Style style)
 
void setUserData (const Ogre::Any &data)
 Sets user data on all ogre objects we own. More...
 
 ~Grid ()
 

Private Attributes

BillboardLinebillboard_line_
 
uint32_t cell_count_
 
float cell_length_
 
Ogre::ColourValue color_
 
uint32_t height_
 
float line_width_
 
Ogre::ManualObject * manual_object_
 The manual object used to draw the grid. More...
 
Ogre::MaterialPtr material_
 
Ogre::SceneManager * scene_manager_
 
Ogre::SceneNode * scene_node_
 The scene node that this grid is attached to. More...
 
Style style_
 

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 XZ plane.

Definition at line 62 of file grid.h.

Member Enumeration Documentation

◆ Style

Enumerator
Lines 
Billboards 

Definition at line 65 of file grid.h.

Constructor & Destructor Documentation

◆ Grid()

rviz::Grid::Grid ( Ogre::SceneManager *  manager,
Ogre::SceneNode *  parent_node,
Style  style,
uint32_t  cell_count,
float  cell_length,
float  line_width,
const Ogre::ColourValue &  color 
)

Constructor.

Parameters
managerThe scene manager this object is part of
cell_countThe number of cells to draw
cell_lengthThe size of each cell
rRed color component, in the range [0, 1]
gGreen color component, in the range [0, 1]
bBlue color component, in the range [0, 1]

Definition at line 45 of file grid.cpp.

◆ ~Grid()

rviz::Grid::~Grid ( )

Definition at line 85 of file grid.cpp.

Member Function Documentation

◆ create()

void rviz::Grid::create ( )

Definition at line 148 of file grid.cpp.

◆ getCellCount()

float rviz::Grid::getCellCount ( )
inline

Definition at line 120 of file grid.h.

◆ getCellLength()

float rviz::Grid::getCellLength ( )
inline

Definition at line 126 of file grid.h.

◆ getColor()

Ogre::ColourValue rviz::Grid::getColor ( )
inline

Definition at line 114 of file grid.h.

◆ getHeight()

uint32_t rviz::Grid::getHeight ( )
inline

Definition at line 138 of file grid.h.

◆ getLineWidth()

float rviz::Grid::getLineWidth ( )
inline

Definition at line 132 of file grid.h.

◆ getSceneNode()

Ogre::SceneNode* rviz::Grid::getSceneNode ( )
inline

Get the Ogre scene node associated with this grid.

Returns
The Ogre scene node associated with this grid

Definition at line 97 of file grid.h.

◆ getStyle()

Style rviz::Grid::getStyle ( )
inline

Definition at line 108 of file grid.h.

◆ setCellCount()

void rviz::Grid::setCellCount ( uint32_t  count)

Definition at line 95 of file grid.cpp.

◆ setCellLength()

void rviz::Grid::setCellLength ( float  len)

Definition at line 102 of file grid.cpp.

◆ setColor()

void rviz::Grid::setColor ( const Ogre::ColourValue &  color)

Definition at line 116 of file grid.cpp.

◆ setHeight()

void rviz::Grid::setHeight ( uint32_t  count)

Definition at line 141 of file grid.cpp.

◆ setLineWidth()

void rviz::Grid::setLineWidth ( float  width)

Definition at line 109 of file grid.cpp.

◆ setStyle()

void rviz::Grid::setStyle ( Style  style)

Definition at line 134 of file grid.cpp.

◆ setUserData()

void rviz::Grid::setUserData ( const Ogre::Any &  data)

Sets user data on all ogre objects we own.

Definition at line 248 of file grid.cpp.

Member Data Documentation

◆ billboard_line_

BillboardLine* rviz::Grid::billboard_line_
private

Definition at line 148 of file grid.h.

◆ cell_count_

uint32_t rviz::Grid::cell_count_
private

Definition at line 153 of file grid.h.

◆ cell_length_

float rviz::Grid::cell_length_
private

Definition at line 154 of file grid.h.

◆ color_

Ogre::ColourValue rviz::Grid::color_
private

Definition at line 157 of file grid.h.

◆ height_

uint32_t rviz::Grid::height_
private

Definition at line 156 of file grid.h.

◆ line_width_

float rviz::Grid::line_width_
private

Definition at line 155 of file grid.h.

◆ manual_object_

Ogre::ManualObject* rviz::Grid::manual_object_
private

The manual object used to draw the grid.

Definition at line 146 of file grid.h.

◆ material_

Ogre::MaterialPtr rviz::Grid::material_
private

Definition at line 150 of file grid.h.

◆ scene_manager_

Ogre::SceneManager* rviz::Grid::scene_manager_
private

Definition at line 144 of file grid.h.

◆ scene_node_

Ogre::SceneNode* rviz::Grid::scene_node_
private

The scene node that this grid is attached to.

Definition at line 145 of file grid.h.

◆ style_

Style rviz::Grid::style_
private

Definition at line 152 of file grid.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Mon Aug 15 2022 02:05:17