Displays a grid along the XZ plane (XY in robot space). More...
#include <grid_display.h>
Public Types | |
| enum | Plane { XY, XZ, YZ } |
Public Member Functions | |
| virtual void | createProperties () |
| Called from setPropertyManager, gives the display a chance to create some properties immediately. | |
| virtual void | fixedFrameChanged () |
| Called from within setFixedFrame, notifying child classes that the fixed frame has changed. | |
| float | getAlpha () |
| const Color & | getColor () |
| const std::string & | getFrame () |
| Ogre::Vector3 | getOffset () |
| Plane | getPlane () |
| GridDisplay (const std::string &name, VisualizationManager *manager) | |
| void | setAlpha (float a) |
| void | setCellCount (uint32_t cell_count) |
| Set the number of cells. | |
| void | setCellSize (float cell_size) |
| Set the cell size. | |
| void | setColor (const Color &color) |
| Set the color. | |
| void | setFrame (const std::string &frame) |
| void | setHeight (uint32_t height) |
| void | setLineWidth (float width) |
| void | setOffset (const Ogre::Vector3 &offset) |
| void | setPlane (int plane) |
| void | setStyle (int style) |
| virtual void | targetFrameChanged () |
| Called from within setTargetFrame, notifying child classes that the target frame has changed. | |
| virtual void | update (float dt, float ros_dt) |
| Called periodically by the visualization panel. | |
| virtual | ~GridDisplay () |
Protected Member Functions | |
| void | create () |
| Creates the grid with the currently-set parameters. | |
| virtual void | onDisable () |
| Derived classes override this to do the actual work of disabling themselves. | |
| virtual void | onEnable () |
| Derived classes override this to do the actual work of enabling themselves. | |
Protected Attributes | |
| float | alpha_ |
| FloatPropertyWPtr | alpha_property_ |
| IntPropertyWPtr | cell_count_property_ |
| FloatPropertyWPtr | cell_size_property_ |
| Color | color_ |
| ColorPropertyWPtr | color_property_ |
| std::string | frame_ |
| TFFramePropertyWPtr | frame_property_ |
| ogre_tools::Grid * | grid_ |
| Handles actually drawing the grid. | |
| IntPropertyWPtr | height_property_ |
| FloatPropertyWPtr | line_width_property_ |
| Ogre::Vector3 | offset_ |
| Vector3PropertyWPtr | offset_property_ |
| Plane | plane_ |
| EnumPropertyWPtr | plane_property_ |
| Ogre::SceneNode * | scene_node_ |
| EnumPropertyWPtr | style_property_ |
Displays a grid along the XZ plane (XY in robot space).
For more information see ogre_tools::Grid
Definition at line 57 of file grid_display.h.
Definition at line 60 of file grid_display.h.
| rviz::GridDisplay::GridDisplay | ( | const std::string & | name, | |
| VisualizationManager * | manager | |||
| ) |
Definition at line 41 of file grid_display.cpp.
| rviz::GridDisplay::~GridDisplay | ( | ) | [virtual] |
Definition at line 57 of file grid_display.cpp.
| void rviz::GridDisplay::create | ( | ) | [protected] |
Creates the grid with the currently-set parameters.
| void rviz::GridDisplay::createProperties | ( | ) | [virtual] |
Called from setPropertyManager, gives the display a chance to create some properties immediately.
Once this function is called, the property_manager_ member is valid and will stay valid
Reimplemented from rviz::Display.
Definition at line 223 of file grid_display.cpp.
| virtual void rviz::GridDisplay::fixedFrameChanged | ( | ) | [inline, virtual] |
Called from within setFixedFrame, notifying child classes that the fixed frame has changed.
Implements rviz::Display.
Definition at line 104 of file grid_display.h.
| float rviz::GridDisplay::getAlpha | ( | ) | [inline] |
Definition at line 91 of file grid_display.h.
| const Color& rviz::GridDisplay::getColor | ( | ) | [inline] |
Definition at line 85 of file grid_display.h.
| const std::string& rviz::GridDisplay::getFrame | ( | ) | [inline] |
Definition at line 99 of file grid_display.h.
| Ogre::Vector3 rviz::GridDisplay::getOffset | ( | ) | [inline] |
Definition at line 94 of file grid_display.h.
| Plane rviz::GridDisplay::getPlane | ( | ) | [inline] |
Definition at line 97 of file grid_display.h.
| void rviz::GridDisplay::onDisable | ( | ) | [protected, virtual] |
Derived classes override this to do the actual work of disabling themselves.
Implements rviz::Display.
Definition at line 68 of file grid_display.cpp.
| void rviz::GridDisplay::onEnable | ( | ) | [protected, virtual] |
Derived classes override this to do the actual work of enabling themselves.
Implements rviz::Display.
Definition at line 63 of file grid_display.cpp.
| void rviz::GridDisplay::setAlpha | ( | float | a | ) |
Definition at line 129 of file grid_display.cpp.
| void rviz::GridDisplay::setCellCount | ( | uint32_t | cell_count | ) |
Set the number of cells.
| cell_count | The number of cells |
Definition at line 82 of file grid_display.cpp.
| void rviz::GridDisplay::setCellSize | ( | float | cell_size | ) |
Set the cell size.
| cell_size | The cell size |
Definition at line 73 of file grid_display.cpp.
| void rviz::GridDisplay::setColor | ( | const Color & | color | ) |
Set the color.
Definition at line 91 of file grid_display.cpp.
| void rviz::GridDisplay::setFrame | ( | const std::string & | frame | ) |
Definition at line 185 of file grid_display.cpp.
| void rviz::GridDisplay::setHeight | ( | uint32_t | height | ) |
Definition at line 140 of file grid_display.cpp.
| void rviz::GridDisplay::setLineWidth | ( | float | width | ) |
Definition at line 101 of file grid_display.cpp.
| void rviz::GridDisplay::setOffset | ( | const Ogre::Vector3 & | offset | ) |
Definition at line 149 of file grid_display.cpp.
| void rviz::GridDisplay::setPlane | ( | int | plane | ) |
Definition at line 163 of file grid_display.cpp.
| void rviz::GridDisplay::setStyle | ( | int | style | ) |
Definition at line 110 of file grid_display.cpp.
| virtual void rviz::GridDisplay::targetFrameChanged | ( | ) | [inline, virtual] |
Called from within setTargetFrame, notifying child classes that the target frame has changed.
Implements rviz::Display.
Definition at line 103 of file grid_display.h.
| void rviz::GridDisplay::update | ( | float | wall_dt, | |
| float | ros_dt | |||
| ) | [virtual] |
Called periodically by the visualization panel.
| dt | Wall-clock time, in seconds, since the last time the update list was run through. |
Reimplemented from rviz::Display.
Definition at line 191 of file grid_display.cpp.
float rviz::GridDisplay::alpha_ [protected] |
Definition at line 120 of file grid_display.h.
FloatPropertyWPtr rviz::GridDisplay::alpha_property_ [protected] |
Definition at line 135 of file grid_display.h.
IntPropertyWPtr rviz::GridDisplay::cell_count_property_ [protected] |
Definition at line 129 of file grid_display.h.
FloatPropertyWPtr rviz::GridDisplay::cell_size_property_ [protected] |
Definition at line 131 of file grid_display.h.
Color rviz::GridDisplay::color_ [protected] |
Definition at line 119 of file grid_display.h.
ColorPropertyWPtr rviz::GridDisplay::color_property_ [protected] |
Definition at line 134 of file grid_display.h.
std::string rviz::GridDisplay::frame_ [protected] |
Definition at line 118 of file grid_display.h.
TFFramePropertyWPtr rviz::GridDisplay::frame_property_ [protected] |
Definition at line 128 of file grid_display.h.
ogre_tools::Grid* rviz::GridDisplay::grid_ [protected] |
Handles actually drawing the grid.
Definition at line 121 of file grid_display.h.
IntPropertyWPtr rviz::GridDisplay::height_property_ [protected] |
Definition at line 130 of file grid_display.h.
FloatPropertyWPtr rviz::GridDisplay::line_width_property_ [protected] |
Definition at line 132 of file grid_display.h.
Ogre::Vector3 rviz::GridDisplay::offset_ [protected] |
Definition at line 123 of file grid_display.h.
Vector3PropertyWPtr rviz::GridDisplay::offset_property_ [protected] |
Definition at line 137 of file grid_display.h.
Plane rviz::GridDisplay::plane_ [protected] |
Definition at line 124 of file grid_display.h.
EnumPropertyWPtr rviz::GridDisplay::plane_property_ [protected] |
Definition at line 136 of file grid_display.h.
Ogre::SceneNode* rviz::GridDisplay::scene_node_ [protected] |
Definition at line 126 of file grid_display.h.
EnumPropertyWPtr rviz::GridDisplay::style_property_ [protected] |
Definition at line 133 of file grid_display.h.
