Displays a nav_msgs::Path message. More...
#include <path_display.h>
Public Member Functions | |
| virtual void | createProperties () |
| Called from setPropertyManager, gives the display a chance to create some properties immediately. | |
| virtual void | fixedFrameChanged () |
| Override to handle changes to fixed_frame_. This base class implementation does nothing. | |
| float | getAlpha () |
| const Color & | getColor () |
| const std::string & | getTopic () |
| virtual const char * | getType () const |
| virtual void | onInitialize () |
| Override this function to do subclass-specific initialization. | |
| PathDisplay () | |
| virtual void | reset () |
| Called to tell the display to clear its state. | |
| void | setAlpha (float alpha) |
| void | setColor (const Color &color) |
| void | setTopic (const std::string &topic) |
| virtual void | update (float wall_dt, float ros_dt) |
| Called periodically by the visualization panel. | |
| virtual | ~PathDisplay () |
Static Public Member Functions | |
| static const char * | getDescription () |
| static const char * | getTypeStatic () |
Protected Member Functions | |
| void | clear () |
| void | incomingMessage (const nav_msgs::Path::ConstPtr &msg) |
| 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. | |
| void | processMessage (const nav_msgs::Path::ConstPtr &msg) |
| void | subscribe () |
| void | unsubscribe () |
Protected Attributes | |
| float | alpha_ |
| FloatPropertyWPtr | alpha_property_ |
| Color | color_ |
| ColorPropertyWPtr | color_property_ |
| nav_msgs::Path::ConstPtr | current_message_ |
| Ogre::ManualObject * | manual_object_ |
| uint32_t | messages_received_ |
| Ogre::SceneNode * | scene_node_ |
| message_filters::Subscriber < nav_msgs::Path > | sub_ |
| tf::MessageFilter < nav_msgs::Path > * | tf_filter_ |
| std::string | topic_ |
| ROSTopicStringPropertyWPtr | topic_property_ |
Detailed Description
Displays a nav_msgs::Path message.
Definition at line 63 of file path_display.h.
Constructor & Destructor Documentation
Definition at line 51 of file path_display.cpp.
| rviz::PathDisplay::~PathDisplay | ( | ) | [virtual] |
Definition at line 58 of file path_display.cpp.
Member Function Documentation
| void rviz::PathDisplay::clear | ( | void | ) | [protected] |
Definition at line 87 of file path_display.cpp.
| void rviz::PathDisplay::createProperties | ( | ) | [virtual] |
Called from setPropertyManager, gives the display a chance to create some properties immediately.
When this function is called, the property_manager_ member is valid and will stay valid
Reimplemented from rviz::Display.
Definition at line 242 of file path_display.cpp.
| void rviz::PathDisplay::fixedFrameChanged | ( | ) | [virtual] |
Override to handle changes to fixed_frame_. This base class implementation does nothing.
Reimplemented from rviz::Display.
Definition at line 163 of file path_display.cpp.
| float rviz::PathDisplay::getAlpha | ( | ) | [inline] |
Definition at line 78 of file path_display.h.
| const Color& rviz::PathDisplay::getColor | ( | ) | [inline] |
Definition at line 75 of file path_display.h.
| const char * rviz::PathDisplay::getDescription | ( | ) | [static] |
Definition at line 258 of file path_display.cpp.
| const std::string& rviz::PathDisplay::getTopic | ( | ) | [inline] |
Definition at line 72 of file path_display.h.
| virtual const char* rviz::PathDisplay::getType | ( | ) | const [inline, virtual] |
Definition at line 87 of file path_display.h.
| static const char* rviz::PathDisplay::getTypeStatic | ( | ) | [inline, static] |
Definition at line 86 of file path_display.h.
| void rviz::PathDisplay::incomingMessage | ( | const nav_msgs::Path::ConstPtr & | msg | ) | [protected] |
Definition at line 231 of file path_display.cpp.
| void rviz::PathDisplay::onDisable | ( | ) | [protected, virtual] |
Derived classes override this to do the actual work of disabling themselves.
Implements rviz::Display.
Definition at line 156 of file path_display.cpp.
| void rviz::PathDisplay::onEnable | ( | ) | [protected, virtual] |
Derived classes override this to do the actual work of enabling themselves.
Implements rviz::Display.
Definition at line 150 of file path_display.cpp.
| void rviz::PathDisplay::onInitialize | ( | ) | [virtual] |
Override this function to do subclass-specific initialization.
This is called after vis_manager_ and scene_manager_ are set.
Reimplemented from rviz::Display.
Definition at line 68 of file path_display.cpp.
| void rviz::PathDisplay::processMessage | ( | const nav_msgs::Path::ConstPtr & | msg | ) | [protected] |
Definition at line 181 of file path_display.cpp.
| void rviz::PathDisplay::reset | ( | ) | [virtual] |
Called to tell the display to clear its state.
Reimplemented from rviz::Display.
Definition at line 236 of file path_display.cpp.
| void rviz::PathDisplay::setAlpha | ( | float | alpha | ) |
Definition at line 117 of file path_display.cpp.
| void rviz::PathDisplay::setColor | ( | const Color & | color | ) |
Definition at line 107 of file path_display.cpp.
| void rviz::PathDisplay::setTopic | ( | const std::string & | topic | ) |
Definition at line 95 of file path_display.cpp.
| void rviz::PathDisplay::subscribe | ( | ) | [protected] |
Definition at line 127 of file path_display.cpp.
| void rviz::PathDisplay::unsubscribe | ( | ) | [protected] |
Definition at line 145 of file path_display.cpp.
| void rviz::PathDisplay::update | ( | float | wall_dt, |
| float | ros_dt | ||
| ) | [virtual] |
Called periodically by the visualization panel.
- Parameters:
-
dt Wall-clock time, in seconds, since the last time the update list was run through.
Reimplemented from rviz::Display.
Definition at line 170 of file path_display.cpp.
Member Data Documentation
float rviz::PathDisplay::alpha_ [protected] |
Definition at line 103 of file path_display.h.
FloatPropertyWPtr rviz::PathDisplay::alpha_property_ [protected] |
Definition at line 116 of file path_display.h.
Color rviz::PathDisplay::color_ [protected] |
Definition at line 102 of file path_display.h.
ColorPropertyWPtr rviz::PathDisplay::color_property_ [protected] |
Definition at line 114 of file path_display.h.
nav_msgs::Path::ConstPtr rviz::PathDisplay::current_message_ [protected] |
Definition at line 112 of file path_display.h.
Ogre::ManualObject* rviz::PathDisplay::manual_object_ [protected] |
Definition at line 108 of file path_display.h.
uint32_t rviz::PathDisplay::messages_received_ [protected] |
Definition at line 105 of file path_display.h.
Ogre::SceneNode* rviz::PathDisplay::scene_node_ [protected] |
Definition at line 107 of file path_display.h.
message_filters::Subscriber<nav_msgs::Path> rviz::PathDisplay::sub_ [protected] |
Definition at line 110 of file path_display.h.
tf::MessageFilter<nav_msgs::Path>* rviz::PathDisplay::tf_filter_ [protected] |
Definition at line 111 of file path_display.h.
std::string rviz::PathDisplay::topic_ [protected] |
Definition at line 101 of file path_display.h.
ROSTopicStringPropertyWPtr rviz::PathDisplay::topic_property_ [protected] |
Definition at line 115 of file path_display.h.
The documentation for this class was generated from the following files: