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	fixedFrameChanged ()
	Called by setFixedFrame(). Override to respond to changes to fixed_frame_.
	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.
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 manager.
virtual	~InteractiveMarkerDisplay ()
Protected Slots
void	updateShowAxes ()
void	updateShowDescriptions ()
void	updateTopic ()
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.
Private 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
Private Member Functions
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)
Private 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_
RosTopicProperty *	marker_update_topic_property_
unsigned	num_publishers_
V_InteractiveMarkerPoseMessage	pose_queue_
boost::mutex	queue_mutex_
Ogre::SceneNode *	scene_node_
BoolProperty *	show_axes_property_
BoolProperty *	show_descriptions_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 73 of file interactive_marker_display.h.

Member Typedef Documentation

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

Definition at line 144 of file interactive_marker_display.h.

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

Definition at line 145 of file interactive_marker_display.h.

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

Definition at line 157 of file interactive_marker_display.h.

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

Definition at line 159 of file interactive_marker_display.h.

Constructor & Destructor Documentation

rviz::InteractiveMarkerDisplay::InteractiveMarkerDisplay ( )

Definition at line 64 of file interactive_marker_display.cpp.

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

Definition at line 100 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 182 of file interactive_marker_display.cpp.

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

Called by setFixedFrame(). Override to respond to changes to fixed_frame_.

Reimplemented from rviz::Display.

Definition at line 409 of file interactive_marker_display.cpp.

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

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

Reimplemented from rviz::Display.

Definition at line 114 of file interactive_marker_display.cpp.

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

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

Reimplemented from rviz::Display.

Definition at line 108 of file interactive_marker_display.cpp.

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

Override this function to do subclass-specific initialization.

This is called after vis_manager_ and scene_manager_ are set, and before load() or setEnabled().

setName() may or may not have been called before this.

Reimplemented from rviz::Display.

Definition at line 82 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 202 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 416 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 456 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 446 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 451 of file interactive_marker_display.cpp.

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

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

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

Definition at line 285 of file interactive_marker_display.cpp.

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

Definition at line 277 of file interactive_marker_display.cpp.

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

Definition at line 299 of file interactive_marker_display.cpp.

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

Definition at line 291 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::unsubscribe ( ) [private]

Definition at line 189 of file interactive_marker_display.cpp.

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

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

Implements rviz::InteractiveMarkerReceiver.

Definition at line 197 of file interactive_marker_display.cpp.

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

Called periodically by the visualization manager.

Parameters:

	wall_dt	Wall-clock time, in seconds, since the last time the update list was run through.
	ros_dt	ROS time, in seconds, since the last time the update list was run through.

Reimplemented from rviz::Display.

Definition at line 308 of file interactive_marker_display.cpp.

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

Definition at line 365 of file interactive_marker_display.cpp.

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

Definition at line 393 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::updateShowAxes ( ) [protected, slot]

Definition at line 435 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::updateShowDescriptions ( ) [protected, slot]

Definition at line 424 of file interactive_marker_display.cpp.

void rviz::InteractiveMarkerDisplay::updateTopic ( ) [protected, slot]

Definition at line 122 of file interactive_marker_display.cpp.

Member Data Documentation

std::string rviz::InteractiveMarkerDisplay::client_id_ [private]

Definition at line 165 of file interactive_marker_display.h.

InteractiveMarkerClient rviz::InteractiveMarkerDisplay::im_client_ [private]

Definition at line 139 of file interactive_marker_display.h.

M_StringToInteractiveMarkerPtr rviz::InteractiveMarkerDisplay::interactive_markers_ [private]

Definition at line 146 of file interactive_marker_display.h.

ros::Subscriber rviz::InteractiveMarkerDisplay::marker_init_sub_ [private]

Definition at line 154 of file interactive_marker_display.h.

V_InteractiveMarkerMessage rviz::InteractiveMarkerDisplay::marker_queue_ [private]

Definition at line 158 of file interactive_marker_display.h.

ros::Subscriber rviz::InteractiveMarkerDisplay::marker_update_sub_ [private]

Definition at line 153 of file interactive_marker_display.h.

RosTopicProperty* rviz::InteractiveMarkerDisplay::marker_update_topic_property_ [private]

Definition at line 168 of file interactive_marker_display.h.

unsigned rviz::InteractiveMarkerDisplay::num_publishers_ [private]

Definition at line 163 of file interactive_marker_display.h.

V_InteractiveMarkerPoseMessage rviz::InteractiveMarkerDisplay::pose_queue_ [private]

Definition at line 160 of file interactive_marker_display.h.

boost::mutex rviz::InteractiveMarkerDisplay::queue_mutex_ [private]

Definition at line 161 of file interactive_marker_display.h.

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

Definition at line 142 of file interactive_marker_display.h.

BoolProperty* rviz::InteractiveMarkerDisplay::show_axes_property_ [private]

Definition at line 170 of file interactive_marker_display.h.

BoolProperty* rviz::InteractiveMarkerDisplay::show_descriptions_property_ [private]

Definition at line 169 of file interactive_marker_display.h.

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

Definition at line 150 of file interactive_marker_display.h.

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

Definition at line 151 of file interactive_marker_display.h.

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

/u/hersh/groovy_stacks/visualization/rviz/src/rviz/default_plugin/interactive_marker_display.h
/u/hersh/groovy_stacks/visualization/rviz/src/rviz/default_plugin/interactive_marker_display.cpp

rviz::InteractiveMarkerDisplay Class Reference

Public Member Functions

Protected Slots

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation