Class Grid

Class Documentation

class Grid

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.

Public Types

enum Style

Values:

enumerator Lines
enumerator Billboards

Public Functions

RVIZ_RENDERING_PUBLIC 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:

  • manager – The scene manager this object is part of

  • cell_count – The number of cells to draw

  • cell_length – The size of each cell

  • line_width – The line width of the cells if it is rendered in Billboards style

  • color – The color of the lines

RVIZ_RENDERING_PUBLIC ~Grid()
RVIZ_RENDERING_PUBLIC void create ()
inline Ogre::SceneNode *getSceneNode()

Get the Ogre scene node associated with this grid.

Returns:

The Ogre scene node associated with this grid

RVIZ_RENDERING_PUBLIC void setUserData (const Ogre::Any &data)

Sets user data on all ogre objects we own.

RVIZ_RENDERING_PUBLIC void setStyle (Style style)
inline Style getStyle()
RVIZ_RENDERING_PUBLIC void setColor (const Ogre::ColourValue &color)
inline Ogre::ColourValue getColor()
RVIZ_RENDERING_PUBLIC void setCellCount (uint32_t count)
inline uint32_t getCellCount()
RVIZ_RENDERING_PUBLIC void setCellLength (float len)
inline float getCellLength()
RVIZ_RENDERING_PUBLIC void setLineWidth (float width)
inline float getLineWidth()
RVIZ_RENDERING_PUBLIC void setHeight (uint32_t count)
inline uint32_t getHeight()
inline Ogre::ManualObject *getManualObject()

Exposed for testing.

inline std::shared_ptr<BillboardLine> getBillboardLine()