Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
rviz::InteractiveMarkerDisplay Class Reference

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

#include <interactive_marker_display.h>

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

List of all members.

Public Member Functions

void clearMarkers ()
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.
const std::string & getMarkerUpdateTopic ()
bool getShowAxes ()
bool getShowDescriptions ()
bool getShowToolTips ()
virtual void hideVisible ()
 Hides all visible parts of this display, so they do not show up when the scene is rendered.
 InteractiveMarkerDisplay ()
virtual void onInitialize ()
 Override this function to do subclass-specific initialization.
void processMarkerChanges (const std::vector< visualization_msgs::InteractiveMarker > *markers=NULL, const std::vector< visualization_msgs::InteractiveMarkerPose > *poses=NULL, const std::vector< std::string > *erases=NULL)
virtual void reset ()
 Called to tell the display to clear its state.
virtual void restoreVisible ()
 Restores the display to the state it was in before hideVisible() was called.
void setMarkerUpdateTopic (const std::string &topic)
void setShowAxes (bool show)
void setShowDescriptions (bool show)
void setShowToolTips (bool show)
void setStatusError (const std::string &name, const std::string &text)
void setStatusOk (const std::string &name, const std::string &text)
void setStatusWarn (const std::string &name, const std::string &text)
bool subscribeToInit ()
void unsubscribeFromInit ()
virtual void update (float wall_dt, float ros_dt)
 Called periodically by the visualization panel.
virtual ~InteractiveMarkerDisplay ()

Protected Types

typedef boost::shared_ptr
< InteractiveMarker
InteractiveMarkerPtr
typedef std::map< std::string,
InteractiveMarkerPtr
M_StringToInteractiveMarkerPtr
typedef std::vector
< visualization_msgs::InteractiveMarker::ConstPtr > 
V_InteractiveMarkerMessage
typedef std::vector
< visualization_msgs::InteractiveMarkerPose::ConstPtr > 
V_InteractiveMarkerPoseMessage

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.
void subscribe ()
void tfMarkerFail (const visualization_msgs::InteractiveMarker::ConstPtr &marker, tf::FilterFailureReason reason)
void tfMarkerSuccess (const visualization_msgs::InteractiveMarker::ConstPtr &marker)
void tfPoseFail (const visualization_msgs::InteractiveMarkerPose::ConstPtr &marker_pose, tf::FilterFailureReason reason)
void tfPoseSuccess (const visualization_msgs::InteractiveMarkerPose::ConstPtr &marker_pose)
void unsubscribe ()
void updateMarker (visualization_msgs::InteractiveMarker::ConstPtr &marker)
void updatePose (visualization_msgs::InteractiveMarkerPose::ConstPtr &pose)

Protected Attributes

std::string client_id_
InteractiveMarkerClient im_client_
M_StringToInteractiveMarkerPtr interactive_markers_
ros::Subscriber marker_init_sub_
V_InteractiveMarkerMessage marker_queue_
ros::Subscriber marker_update_sub_
std::string marker_update_topic_
ROSTopicStringPropertyWPtr marker_update_topic_property_
unsigned num_publishers_
V_InteractiveMarkerPoseMessage pose_queue_
boost::mutex queue_mutex_
Ogre::SceneNode * scene_node_
bool show_axes_
BoolPropertyWPtr show_axes_property_
bool show_descriptions_
BoolPropertyWPtr show_descriptions_property_
bool show_tool_tips_
BoolPropertyWPtr show_tool_tips_property_
tf::MessageFilter
< visualization_msgs::InteractiveMarker > * 
tf_filter_
tf::MessageFilter
< visualization_msgs::InteractiveMarkerPose > * 
tf_pose_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 78 of file interactive_marker_display.h.


Member Typedef Documentation

Definition at line 163 of file interactive_marker_display.h.

Definition at line 164 of file interactive_marker_display.h.

typedef std::vector<visualization_msgs::InteractiveMarker::ConstPtr> rviz::InteractiveMarkerDisplay::V_InteractiveMarkerMessage [protected]

Definition at line 176 of file interactive_marker_display.h.

typedef std::vector<visualization_msgs::InteractiveMarkerPose::ConstPtr> rviz::InteractiveMarkerDisplay::V_InteractiveMarkerPoseMessage [protected]

Definition at line 178 of file interactive_marker_display.h.


Constructor & Destructor Documentation

Definition at line 70 of file interactive_marker_display.cpp.

Definition at line 95 of file interactive_marker_display.cpp.


Member Function Documentation

Implement this to clear all markers.

Implements rviz::InteractiveMarkerReceiver.

Definition at line 197 of file interactive_marker_display.cpp.

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 438 of file interactive_marker_display.cpp.

Override to handle changes to fixed_frame_. This base class implementation does nothing.

Reimplemented from rviz::Display.

Definition at line 423 of file interactive_marker_display.cpp.

Definition at line 92 of file interactive_marker_display.h.

Definition at line 102 of file interactive_marker_display.h.

Definition at line 96 of file interactive_marker_display.h.

Definition at line 99 of file interactive_marker_display.h.

Hides all visible parts of this display, so they do not show up when the scene is rendered.

Reimplemented from rviz::Display.

Definition at line 115 of file interactive_marker_display.cpp.

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

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

Implements rviz::Display.

Definition at line 108 of file interactive_marker_display.cpp.

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

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

Implements rviz::Display.

Definition at line 103 of file interactive_marker_display.cpp.

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 79 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::processMarkerChanges ( const std::vector< visualization_msgs::InteractiveMarker > *  markers = NULL,
const std::vector< visualization_msgs::InteractiveMarkerPose > *  poses = NULL,
const std::vector< std::string > *  erases = NULL 
) [virtual]

Implement this to add or update all markers in "markers", update the poses of all markers mentioned in "poses", and to erase all markers named in "erases".

Implements rviz::InteractiveMarkerReceiver.

Definition at line 217 of file interactive_marker_display.cpp.

Called to tell the display to clear its state.

Reimplemented from rviz::Display.

Definition at line 430 of file interactive_marker_display.cpp.

Restores the display to the state it was in before hideVisible() was called.

Reimplemented from rviz::Display.

Definition at line 124 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::setMarkerUpdateTopic ( const std::string &  topic)

Definition at line 133 of file interactive_marker_display.cpp.

Definition at line 492 of file interactive_marker_display.cpp.

Definition at line 470 of file interactive_marker_display.cpp.

Definition at line 484 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::setStatusError ( const std::string &  name,
const std::string &  text 
) [virtual]

Implement this to receive named status messages indicating an "error" state.

Implements rviz::InteractiveMarkerReceiver.

Definition at line 515 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::setStatusOk ( const std::string &  name,
const std::string &  text 
) [virtual]

Implement this to receive named status messages indicating an "OK" state.

Implements rviz::InteractiveMarkerReceiver.

Definition at line 505 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::setStatusWarn ( const std::string &  name,
const std::string &  text 
) [virtual]

Implement this to receive named status messages indicating a "warning" state.

Implements rviz::InteractiveMarkerReceiver.

Definition at line 510 of file interactive_marker_display.cpp.

Definition at line 145 of file interactive_marker_display.cpp.

Subscribe to just the init messages.

Returns:
true on success, false on failure.

Implements rviz::InteractiveMarkerReceiver.

Definition at line 173 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::tfMarkerFail ( const visualization_msgs::InteractiveMarker::ConstPtr &  marker,
tf::FilterFailureReason  reason 
) [protected]

Definition at line 299 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::tfMarkerSuccess ( const visualization_msgs::InteractiveMarker::ConstPtr &  marker) [protected]

Definition at line 291 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::tfPoseFail ( const visualization_msgs::InteractiveMarkerPose::ConstPtr &  marker_pose,
tf::FilterFailureReason  reason 
) [protected]

Definition at line 313 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::tfPoseSuccess ( const visualization_msgs::InteractiveMarkerPose::ConstPtr &  marker_pose) [protected]

Definition at line 305 of file interactive_marker_display.cpp.

Definition at line 204 of file interactive_marker_display.cpp.

Implement this to unsubscribe from the init messages. Should never fail.

Implements rviz::InteractiveMarkerReceiver.

Definition at line 212 of file interactive_marker_display.cpp.

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

Called periodically by the visualization panel.

Parameters:
dtWall-clock time, in seconds, since the last time the update list was run through.

Reimplemented from rviz::Display.

Definition at line 322 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::updateMarker ( visualization_msgs::InteractiveMarker::ConstPtr &  marker) [protected]

Definition at line 379 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::updatePose ( visualization_msgs::InteractiveMarkerPose::ConstPtr &  pose) [protected]

Definition at line 407 of file interactive_marker_display.cpp.


Member Data Documentation

Definition at line 184 of file interactive_marker_display.h.

Definition at line 158 of file interactive_marker_display.h.

Definition at line 165 of file interactive_marker_display.h.

Definition at line 173 of file interactive_marker_display.h.

Definition at line 177 of file interactive_marker_display.h.

Definition at line 172 of file interactive_marker_display.h.

Definition at line 188 of file interactive_marker_display.h.

ROSTopicStringPropertyWPtr rviz::InteractiveMarkerDisplay::marker_update_topic_property_ [protected]

Definition at line 189 of file interactive_marker_display.h.

Definition at line 182 of file interactive_marker_display.h.

Definition at line 179 of file interactive_marker_display.h.

Definition at line 180 of file interactive_marker_display.h.

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

Definition at line 161 of file interactive_marker_display.h.

Definition at line 197 of file interactive_marker_display.h.

Definition at line 198 of file interactive_marker_display.h.

Definition at line 191 of file interactive_marker_display.h.

Definition at line 192 of file interactive_marker_display.h.

Definition at line 194 of file interactive_marker_display.h.

Definition at line 195 of file interactive_marker_display.h.

tf::MessageFilter<visualization_msgs::InteractiveMarker>* rviz::InteractiveMarkerDisplay::tf_filter_ [protected]

Definition at line 169 of file interactive_marker_display.h.

tf::MessageFilter<visualization_msgs::InteractiveMarkerPose>* rviz::InteractiveMarkerDisplay::tf_pose_filter_ [protected]

Definition at line 170 of file interactive_marker_display.h.


The documentation for this class was generated from the following files:


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Mon Jan 6 2014 11:54:33