rviz::MarkerDisplay Class Reference

Displays "markers" sent in by other ROS nodes on the "visualization_marker" topic. More...

#include <marker_display.h>

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

List of all members.

Classes

struct  Namespace

Public Member Functions

virtual void createProperties ()
 Called from setPropertyManager, gives the display a chance to create some properties immediately.
void deleteMarker (MarkerID id)
void deleteMarkerStatus (MarkerID id)
virtual void fixedFrameChanged ()
 Called from within setFixedFrame, notifying child classes that the fixed frame has changed.
const std::string & getMarkerTopic ()
bool isNamespaceEnabled (const std::string &ns)
 MarkerDisplay (const std::string &name, VisualizationManager *manager)
virtual void reset ()
 Called to tell the display to clear its state.
void setMarkerStatus (MarkerID id, StatusLevel level, const std::string &text)
void setMarkerTopic (const std::string &topic)
void setNamespaceEnabled (const std::string &ns, bool enabled)
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 ~MarkerDisplay ()

Protected Types

typedef std::map< MarkerID,
MarkerBasePtr
M_IDToMarker
typedef std::map< std::string,
Namespace
M_Namespace
typedef std::set< MarkerBasePtrS_MarkerBase
typedef std::vector
< visualization_msgs::Marker::ConstPtr > 
V_MarkerMessage

Protected Member Functions

void clearMarkers ()
 Removes all the markers.
void failedMarker (const visualization_msgs::Marker::ConstPtr &marker, tf::FilterFailureReason reason)
MarkerBasePtr getMarker (MarkerID id)
void incomingMarker (const visualization_msgs::Marker::ConstPtr &marker)
 ROS callback notifying us of a new marker.
void incomingMarkerArray (const visualization_msgs::MarkerArray::ConstPtr &array)
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 processAdd (const visualization_msgs::Marker::ConstPtr &message)
 Processes an "Add" marker message.
void processDelete (const visualization_msgs::Marker::ConstPtr &message)
 Processes a "Delete" marker message.
void processMessage (const visualization_msgs::Marker::ConstPtr &message)
 Processes a marker message.
void subscribe ()
 Subscribes to the "visualization_marker" and "visualization_marker_array" topics.
void unsubscribe ()
 Unsubscribes from the "visualization_marker" "visualization_marker_array" topics.

Protected Attributes

ros::Subscriber array_sub_
S_MarkerBase frame_locked_markers_
std::string marker_topic_
ROSTopicStringPropertyWPtr marker_topic_property_
M_IDToMarker markers_
 Map of marker id to the marker info structure.
S_MarkerBase markers_with_expiration_
V_MarkerMessage message_queue_
M_Namespace namespaces_
CategoryPropertyWPtr namespaces_category_
boost::mutex queue_mutex_
Ogre::SceneNode * scene_node_
 Scene node all the marker objects are parented to.
message_filters::Subscriber
< visualization_msgs::Marker > 
sub_
tf::MessageFilter
< visualization_msgs::Marker > 
tf_filter_

Detailed Description

Displays "markers" sent in by other ROS nodes on the "visualization_marker" topic.

Markers come in as visualization_msgs::Marker messages. See the Marker message for more information.

Definition at line 76 of file marker_display.h.


Member Typedef Documentation

Definition at line 146 of file marker_display.h.

typedef std::map<std::string, Namespace> rviz::MarkerDisplay::M_Namespace [protected]

Definition at line 170 of file marker_display.h.

typedef std::set<MarkerBasePtr> rviz::MarkerDisplay::S_MarkerBase [protected]

Definition at line 147 of file marker_display.h.

typedef std::vector<visualization_msgs::Marker::ConstPtr> rviz::MarkerDisplay::V_MarkerMessage [protected]

Definition at line 151 of file marker_display.h.


Constructor & Destructor Documentation

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

Definition at line 58 of file marker_display.cpp.

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

Definition at line 70 of file marker_display.cpp.


Member Function Documentation

void rviz::MarkerDisplay::clearMarkers (  )  [protected]

Removes all the markers.

Definition at line 88 of file marker_display.cpp.

void rviz::MarkerDisplay::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 493 of file marker_display.cpp.

void rviz::MarkerDisplay::deleteMarker ( MarkerID  id  ) 

Definition at line 165 of file marker_display.cpp.

void rviz::MarkerDisplay::deleteMarkerStatus ( MarkerID  id  ) 

Definition at line 228 of file marker_display.cpp.

void rviz::MarkerDisplay::failedMarker ( const visualization_msgs::Marker::ConstPtr &  marker,
tf::FilterFailureReason  reason 
) [protected]

Definition at line 254 of file marker_display.cpp.

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

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

Implements rviz::Display.

Definition at line 480 of file marker_display.cpp.

MarkerBasePtr rviz::MarkerDisplay::getMarker ( MarkerID  id  )  [protected]

Definition at line 77 of file marker_display.cpp.

const std::string& rviz::MarkerDisplay::getMarkerTopic (  )  [inline]

Definition at line 89 of file marker_display.h.

void rviz::MarkerDisplay::incomingMarker ( const visualization_msgs::Marker::ConstPtr &  marker  )  [protected]

ROS callback notifying us of a new marker.

Definition at line 247 of file marker_display.cpp.

void rviz::MarkerDisplay::incomingMarkerArray ( const visualization_msgs::MarkerArray::ConstPtr &  array  )  [protected]

Definition at line 236 of file marker_display.cpp.

bool rviz::MarkerDisplay::isNamespaceEnabled ( const std::string &  ns  ) 

Definition at line 209 of file marker_display.cpp.

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

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

Implements rviz::Display.

Definition at line 115 of file marker_display.cpp.

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

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

Implements rviz::Display.

Definition at line 108 of file marker_display.cpp.

void rviz::MarkerDisplay::processAdd ( const visualization_msgs::Marker::ConstPtr &  message  )  [protected]

Processes an "Add" marker message.

Parameters:
message The message to process

Definition at line 293 of file marker_display.cpp.

void rviz::MarkerDisplay::processDelete ( const visualization_msgs::Marker::ConstPtr &  message  )  [protected]

Processes a "Delete" marker message.

Parameters:
message The message to process

Definition at line 418 of file marker_display.cpp.

void rviz::MarkerDisplay::processMessage ( const visualization_msgs::Marker::ConstPtr &  message  )  [protected]

Processes a marker message.

Parameters:
message The message to process

Definition at line 270 of file marker_display.cpp.

void rviz::MarkerDisplay::reset (  )  [virtual]

Called to tell the display to clear its state.

Reimplemented from rviz::Display.

Definition at line 487 of file marker_display.cpp.

void rviz::MarkerDisplay::setMarkerStatus ( MarkerID  id,
StatusLevel  level,
const std::string &  text 
)

Definition at line 220 of file marker_display.cpp.

void rviz::MarkerDisplay::setMarkerTopic ( const std::string &  topic  ) 

Definition at line 125 of file marker_display.cpp.

void rviz::MarkerDisplay::setNamespaceEnabled ( const std::string &  ns,
bool  enabled 
)

Definition at line 178 of file marker_display.cpp.

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

Subscribes to the "visualization_marker" and "visualization_marker_array" topics.

Definition at line 134 of file marker_display.cpp.

void rviz::MarkerDisplay::targetFrameChanged (  )  [virtual]

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

Implements rviz::Display.

Definition at line 476 of file marker_display.cpp.

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

Unsubscribes from the "visualization_marker" "visualization_marker_array" topics.

Definition at line 159 of file marker_display.cpp.

void rviz::MarkerDisplay::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 424 of file marker_display.cpp.


Member Data Documentation

ros::Subscriber rviz::MarkerDisplay::array_sub_ [protected]

Definition at line 160 of file marker_display.h.

Definition at line 150 of file marker_display.h.

std::string rviz::MarkerDisplay::marker_topic_ [protected]

Definition at line 162 of file marker_display.h.

ROSTopicStringPropertyWPtr rviz::MarkerDisplay::marker_topic_property_ [protected]

Definition at line 173 of file marker_display.h.

Map of marker id to the marker info structure.

Definition at line 148 of file marker_display.h.

Definition at line 149 of file marker_display.h.

Marker message queue. Messages are added to this as they are received, and then processed in our update() function

Definition at line 152 of file marker_display.h.

Definition at line 171 of file marker_display.h.

CategoryPropertyWPtr rviz::MarkerDisplay::namespaces_category_ [protected]

Definition at line 174 of file marker_display.h.

boost::mutex rviz::MarkerDisplay::queue_mutex_ [protected]

Definition at line 154 of file marker_display.h.

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

Scene node all the marker objects are parented to.

Definition at line 156 of file marker_display.h.

message_filters::Subscriber<visualization_msgs::Marker> rviz::MarkerDisplay::sub_ [protected]

Definition at line 158 of file marker_display.h.

tf::MessageFilter<visualization_msgs::Marker> rviz::MarkerDisplay::tf_filter_ [protected]

Definition at line 159 of file marker_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
autogenerated on Fri Jan 11 09:36:33 2013