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:

Public Member Functions
void	clearMarkers ()
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.
const std::string &	getMarkerUpdateTopic ()
bool	getShowAxes ()
bool	getShowDescriptions ()
bool	getShowToolTips ()
	InteractiveMarkerDisplay (const std::string &name, VisualizationManager *manager)
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.
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 ()
virtual void	targetFrameChanged ()
	Called from within setTargetFrame, notifying child classes that the target frame has changed.
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

typedef boost::shared_ptr<InteractiveMarker> rviz::InteractiveMarkerDisplay::InteractiveMarkerPtr [protected]

Definition at line 156 of file interactive_marker_display.h.

typedef std::map< std::string, InteractiveMarkerPtr > rviz::InteractiveMarkerDisplay::M_StringToInteractiveMarkerPtr [protected]

Definition at line 157 of file interactive_marker_display.h.

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

Definition at line 169 of file interactive_marker_display.h.

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

Definition at line 171 of file interactive_marker_display.h.

Constructor & Destructor Documentation

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

Definition at line 70 of file interactive_marker_display.cpp.

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

Definition at line 91 of file interactive_marker_display.cpp.

Member Function Documentation

void rviz::InteractiveMarkerDisplay::clearMarkers ( ) [virtual]

Implement this to clear all markers.

Implements rviz::InteractiveMarkerReceiver.

Definition at line 175 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::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 420 of file interactive_marker_display.cpp.

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

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

Implements rviz::Display.

Definition at line 405 of file interactive_marker_display.cpp.

const std::string& rviz::InteractiveMarkerDisplay::getMarkerUpdateTopic ( ) [inline]

Definition at line 91 of file interactive_marker_display.h.

bool rviz::InteractiveMarkerDisplay::getShowAxes ( ) [inline]

Definition at line 101 of file interactive_marker_display.h.

bool rviz::InteractiveMarkerDisplay::getShowDescriptions ( ) [inline]

Definition at line 95 of file interactive_marker_display.h.

bool rviz::InteractiveMarkerDisplay::getShowToolTips ( ) [inline]

Definition at line 98 of file interactive_marker_display.h.

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

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

Implements rviz::Display.

Definition at line 103 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 97 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 195 of file interactive_marker_display.cpp.

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

Called to tell the display to clear its state.

Reimplemented from rviz::Display.

Definition at line 412 of file interactive_marker_display.cpp.

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

Definition at line 111 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::setShowAxes ( bool show )

Definition at line 474 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::setShowDescriptions ( bool show )

Definition at line 452 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::setShowToolTips ( bool show )

Definition at line 466 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 497 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 487 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 492 of file interactive_marker_display.cpp.

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

Definition at line 123 of file interactive_marker_display.cpp.

bool rviz::InteractiveMarkerDisplay::subscribeToInit ( ) [virtual]

Subscribe to just the init messages.

Returns:: true on success, false on failure.

Implements rviz::InteractiveMarkerReceiver.

Definition at line 151 of file interactive_marker_display.cpp.

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

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

Implements rviz::Display.

Definition at line 401 of file interactive_marker_display.cpp.

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

Definition at line 277 of file interactive_marker_display.cpp.

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

Definition at line 269 of file interactive_marker_display.cpp.

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