$search

rviz::PathDisplay Class Reference

Displays a nav_msgs::Path message. More...

#include <path_display.h>

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

List of all members.

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 ColorgetColor ()
const std::string & getTopic ()
virtual const char * getType () const
 PathDisplay (const std::string &name, VisualizationManager *manager)
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 targetFrameChanged ()
 Called from within setTargetFrame, notifying child classes that the target frame has changed.
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::Pathtf_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

rviz::PathDisplay::PathDisplay ( const std::string &  name,
VisualizationManager manager 
)

Definition at line 51 of file path_display.cpp.

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

Definition at line 73 of file path_display.cpp.


Member Function Documentation

void rviz::PathDisplay::clear (  )  [protected]

Definition at line 82 of file path_display.cpp.

void rviz::PathDisplay::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 229 of file path_display.cpp.

void rviz::PathDisplay::fixedFrameChanged (  )  [virtual]

Called from within setFixedFrame, notifying child classes that the fixed frame has changed.

Implements rviz::Display.

Definition at line 150 of file path_display.cpp.

float rviz::PathDisplay::getAlpha (  )  [inline]

Definition at line 76 of file path_display.h.

const Color& rviz::PathDisplay::getColor (  )  [inline]

Definition at line 73 of file path_display.h.

const char * rviz::PathDisplay::getDescription (  )  [static]

Definition at line 245 of file path_display.cpp.

const std::string& rviz::PathDisplay::getTopic (  )  [inline]

Definition at line 70 of file path_display.h.

virtual const char* rviz::PathDisplay::getType (  )  const [inline, virtual]

Definition at line 86 of file path_display.h.

static const char* rviz::PathDisplay::getTypeStatic (  )  [inline, static]

Definition at line 85 of file path_display.h.

void rviz::PathDisplay::incomingMessage ( const nav_msgs::Path::ConstPtr msg  )  [protected]

Definition at line 218 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 143 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 137 of file path_display.cpp.

void rviz::PathDisplay::processMessage ( const nav_msgs::Path::ConstPtr msg  )  [protected]

Definition at line 168 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 223 of file path_display.cpp.

void rviz::PathDisplay::setAlpha ( float  alpha  ) 

Definition at line 112 of file path_display.cpp.

void rviz::PathDisplay::setColor ( const Color color  ) 

Definition at line 102 of file path_display.cpp.

void rviz::PathDisplay::setTopic ( const std::string &  topic  ) 

Definition at line 90 of file path_display.cpp.

void rviz::PathDisplay::subscribe (  )  [protected]

Definition at line 122 of file path_display.cpp.

virtual void rviz::PathDisplay::targetFrameChanged (  )  [inline, virtual]

Called from within setTargetFrame, notifying child classes that the target frame has changed.

Implements rviz::Display.

Definition at line 79 of file path_display.h.

void rviz::PathDisplay::unsubscribe (  )  [protected]

Definition at line 132 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 157 of file path_display.cpp.


Member Data Documentation

float rviz::PathDisplay::alpha_ [protected]

Definition at line 102 of file path_display.h.

FloatPropertyWPtr rviz::PathDisplay::alpha_property_ [protected]

Definition at line 115 of file path_display.h.

Definition at line 101 of file path_display.h.

ColorPropertyWPtr rviz::PathDisplay::color_property_ [protected]

Definition at line 113 of file path_display.h.

Definition at line 111 of file path_display.h.

Ogre::ManualObject* rviz::PathDisplay::manual_object_ [protected]

Definition at line 107 of file path_display.h.

Definition at line 104 of file path_display.h.

Ogre::SceneNode* rviz::PathDisplay::scene_node_ [protected]

Definition at line 106 of file path_display.h.

Definition at line 109 of file path_display.h.

Definition at line 110 of file path_display.h.

std::string rviz::PathDisplay::topic_ [protected]

Definition at line 100 of file path_display.h.

ROSTopicStringPropertyWPtr rviz::PathDisplay::topic_property_ [protected]

Definition at line 114 of file path_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): Josh Faust, Dave Hershberger
autogenerated on Sat Mar 2 14:17:36 2013