rviz::GridDisplay Class Reference

Displays a grid in either the XY, YZ, or XZ plane. More...

#include <grid_display.h>

Inheritance diagram for rviz::GridDisplay:
Inheritance graph
[legend]

List of all members.

Public Types

enum  Plane { XY, XZ, YZ }

Public Member Functions

 GridDisplay ()
virtual void onInitialize ()
 Override this function to do subclass-specific initialization.
virtual void update (float dt, float ros_dt)
 Called periodically by the visualization manager.
virtual ~GridDisplay ()

Protected Member Functions

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.

Private Slots

void updateCellCount ()
void updateCellSize ()
void updateColor ()
void updateHeight ()
void updateLineWidth ()
void updateOffset ()
void updatePlane ()
void updateStyle ()

Private Attributes

FloatPropertyalpha_property_
IntPropertycell_count_property_
FloatPropertycell_size_property_
ColorPropertycolor_property_
TfFramePropertyframe_property_
Gridgrid_
 Handles actually drawing the grid.
IntPropertyheight_property_
FloatPropertyline_width_property_
VectorPropertyoffset_property_
EnumPropertyplane_property_
Ogre::SceneNode * scene_node_
EnumPropertystyle_property_

Detailed Description

Displays a grid in either the XY, YZ, or XZ plane.

For more information see Grid

Definition at line 51 of file grid_display.h.


Member Enumeration Documentation

Enumerator:
XY 
XZ 
YZ 

Definition at line 55 of file grid_display.h.


Constructor & Destructor Documentation

rviz::GridDisplay::GridDisplay (  ) 

Definition at line 46 of file grid_display.cpp.

rviz::GridDisplay::~GridDisplay (  )  [virtual]

Definition at line 103 of file grid_display.cpp.


Member Function Documentation

void rviz::GridDisplay::onDisable (  )  [protected, virtual]

Derived classes override this to do the actual work of disabling themselves.

Reimplemented from rviz::Display.

Definition at line 132 of file grid_display.cpp.

void rviz::GridDisplay::onEnable (  )  [protected, virtual]

Derived classes override this to do the actual work of enabling themselves.

Reimplemented from rviz::Display.

Definition at line 127 of file grid_display.cpp.

void rviz::GridDisplay::onInitialize (  )  [virtual]

Override this function to do subclass-specific initialization.

This is called after vis_manager_ and scene_manager_ are set, and before load() or setEnabled().

setName() may or may not have been called before this.

Reimplemented from rviz::Display.

Definition at line 109 of file grid_display.cpp.

void rviz::GridDisplay::update ( float  wall_dt,
float  ros_dt 
) [virtual]

Called periodically by the visualization manager.

Parameters:
wall_dt Wall-clock time, in seconds, since the last time the update list was run through.
ros_dt ROS time, in seconds, since the last time the update list was run through.

Reimplemented from rviz::Display.

Definition at line 137 of file grid_display.cpp.

void rviz::GridDisplay::updateCellCount (  )  [private, slot]

Definition at line 179 of file grid_display.cpp.

void rviz::GridDisplay::updateCellSize (  )  [private, slot]

Definition at line 173 of file grid_display.cpp.

void rviz::GridDisplay::updateColor (  )  [private, slot]

Definition at line 165 of file grid_display.cpp.

void rviz::GridDisplay::updateHeight (  )  [private, slot]

Definition at line 191 of file grid_display.cpp.

void rviz::GridDisplay::updateLineWidth (  )  [private, slot]

Definition at line 185 of file grid_display.cpp.

void rviz::GridDisplay::updateOffset (  )  [private, slot]

Definition at line 215 of file grid_display.cpp.

void rviz::GridDisplay::updatePlane (  )  [private, slot]

Definition at line 221 of file grid_display.cpp.

void rviz::GridDisplay::updateStyle (  )  [private, slot]

Definition at line 197 of file grid_display.cpp.


Member Data Documentation

Definition at line 95 of file grid_display.h.

Definition at line 89 of file grid_display.h.

Definition at line 91 of file grid_display.h.

Definition at line 94 of file grid_display.h.

Definition at line 88 of file grid_display.h.

Handles actually drawing the grid.

Definition at line 85 of file grid_display.h.

Definition at line 90 of file grid_display.h.

Definition at line 92 of file grid_display.h.

Definition at line 97 of file grid_display.h.

Definition at line 96 of file grid_display.h.

Ogre::SceneNode* rviz::GridDisplay::scene_node_ [private]

Definition at line 86 of file grid_display.h.

Definition at line 93 of file grid_display.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Wed Jun 6 11:25:47 2012