#include <interactive_marker.h>

Classes
struct	MenuNode
Signals
void	statusUpdate (StatusProperty::Level level, const std::string &name, const std::string &text)
void	userFeedback (visualization_msgs::InteractiveMarkerFeedback &feedback)
Public Member Functions
boost::shared_ptr< QMenu >	getMenu ()
const std::string &	getName ()
const Ogre::Quaternion &	getOrientation ()
const Ogre::Vector3 &	getPosition ()
const std::string &	getReferenceFrame ()
float	getSize ()
bool	handle3DCursorEvent (ViewportMouseEvent &event, const Ogre::Vector3 &cursor_pos, const Ogre::Quaternion &cursor_rot, const std::string &control_name)
bool	handleMouseEvent (ViewportMouseEvent &event, const std::string &control_name)
bool	hasMenu ()
	InteractiveMarker (Ogre::SceneNode scene_node, DisplayContext context)
bool	processMessage (const visualization_msgs::InteractiveMarker &message)
void	processMessage (const visualization_msgs::InteractiveMarkerPose &message)
void	publishFeedback (visualization_msgs::InteractiveMarkerFeedback &feedback, bool mouse_point_valid=false, const Ogre::Vector3 &mouse_point_rel_world=Ogre::Vector3(0, 0, 0))
void	requestPoseUpdate (Ogre::Vector3 position, Ogre::Quaternion orientation)
void	rotate (Ogre::Quaternion delta_orientation, const std::string &control_name)
void	setPose (Ogre::Vector3 position, Ogre::Quaternion orientation, const std::string &control_name)
void	setShowAxes (bool show)
void	setShowDescription (bool show)
void	setShowVisualAids (bool show)
void	showMenu (ViewportMouseEvent &event, const std::string &control_name, const Ogre::Vector3 &three_d_point, bool valid_point)
void	startDragging ()
void	stopDragging ()
void	translate (Ogre::Vector3 delta_position, const std::string &control_name)
void	update (float wall_dt)
virtual	~InteractiveMarker ()
Protected Types
typedef boost::shared_ptr < InteractiveMarkerControl >	InteractiveMarkerControlPtr
typedef std::map< std::string, InteractiveMarkerControlPtr >	M_ControlPtr
Protected Slots
void	handleMenuSelect (int menu_item_id)
Protected Member Functions
QString	makeMenuString (const std::string &entry)
void	populateMenu (QMenu *menu, std::vector< uint32_t > &ids)
void	publishPose ()
void	reset ()
void	updateReferencePose ()
Protected Attributes
Axes *	axes_
std::string	client_id_
DisplayContext *	context_
M_ControlPtr	controls_
std::string	description_
InteractiveMarkerControlPtr	description_control_
bool	dragging_
bool	frame_locked_
bool	got_3d_point_for_menu_
bool	has_menu_
double	heart_beat_t_
std::string	last_control_name_
boost::shared_ptr< QMenu >	menu_
std::map< uint32_t, MenuNode >	menu_entries_
boost::recursive_mutex	mutex_
std::string	name_
Ogre::Quaternion	orientation_
bool	pose_changed_
bool	pose_update_requested_
Ogre::Vector3	position_
std::string	reference_frame_
Ogre::SceneNode *	reference_node_
ros::Time	reference_time_
Ogre::Quaternion	requested_orientation_
Ogre::Vector3	requested_position_
float	scale_
bool	show_visual_aids_
boost::shared_ptr< boost::thread >	sys_thread_
Ogre::Vector3	three_d_point_for_menu_
double	time_since_last_feedback_
std::vector< uint32_t >	top_level_menu_ids_
std::string	topic_ns_

Detailed Description

Definition at line 65 of file interactive_marker.h.

Member Typedef Documentation

typedef boost::shared_ptr<InteractiveMarkerControl> rviz::InteractiveMarker::InteractiveMarkerControlPtr [protected]

Definition at line 189 of file interactive_marker.h.

typedef std::map<std::string, InteractiveMarkerControlPtr> rviz::InteractiveMarker::M_ControlPtr [protected]

Definition at line 190 of file interactive_marker.h.

Constructor & Destructor Documentation

rviz::InteractiveMarker::InteractiveMarker	(	Ogre::SceneNode *	scene_node,
		DisplayContext *	context
	)

Definition at line 58 of file interactive_marker.cpp.

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

Definition at line 71 of file interactive_marker.cpp.

Member Function Documentation

boost::shared_ptr<QMenu> rviz::InteractiveMarker::getMenu ( ) [inline]

Returns:: A shared_ptr to the QMenu owned by this InteractiveMarker.

Definition at line 145 of file interactive_marker.h.

const std::string& rviz::InteractiveMarker::getName ( ) [inline]

Definition at line 101 of file interactive_marker.h.

const Ogre::Quaternion& rviz::InteractiveMarker::getOrientation ( ) [inline]

Definition at line 97 of file interactive_marker.h.

const Ogre::Vector3& rviz::InteractiveMarker::getPosition ( ) [inline]

Definition at line 96 of file interactive_marker.h.

const std::string& rviz::InteractiveMarker::getReferenceFrame ( ) [inline]

Definition at line 100 of file interactive_marker.h.

float rviz::InteractiveMarker::getSize ( ) [inline]

Definition at line 99 of file interactive_marker.h.

bool rviz::InteractiveMarker::handle3DCursorEvent	(	ViewportMouseEvent &	event,
		const Ogre::Vector3 &	cursor_pos,
		const Ogre::Quaternion &	cursor_rot,
		const std::string &	control_name
	)

Supports selection and menu events from a 3D cursor.

Parameters:

event	A struct holding certain event data (see full description InteractiveMarkerControl::handle3DCursorEvent)
cursor_pos	The world-relative position of the 3D cursor.
cursor_rot	The world-relative orientation of the 3D cursor.
control_name	The name of the child InteractiveMarkerControl calling this function.

Returns:: true if the cursor event was intercepted, false if it was ignored

Definition at line 493 of file interactive_marker.cpp.

void rviz::InteractiveMarker::handleMenuSelect ( int menu_item_id ) [protected, slot]

Definition at line 598 of file interactive_marker.cpp.

bool rviz::InteractiveMarker::handleMouseEvent	(	ViewportMouseEvent &	event,
		const std::string &	control_name
	)

Definition at line 540 of file interactive_marker.cpp.

bool rviz::InteractiveMarker::hasMenu ( ) [inline]

Definition at line 142 of file interactive_marker.h.

QString rviz::InteractiveMarker::makeMenuString ( const std::string & entry ) [protected]

Definition at line 281 of file interactive_marker.cpp.

void rviz::InteractiveMarker::populateMenu	(	QMenu *	menu,
		std::vector< uint32_t > &	ids
	)		`[protected]`

Definition at line 255 of file interactive_marker.cpp.

bool rviz::InteractiveMarker::processMessage ( const visualization_msgs::InteractiveMarker & message )

Definition at line 97 of file interactive_marker.cpp.

void rviz::InteractiveMarker::processMessage ( const visualization_msgs::InteractiveMarkerPose & message )

Definition at line 77 of file interactive_marker.cpp.

void rviz::InteractiveMarker::publishFeedback	(	visualization_msgs::InteractiveMarkerFeedback &	feedback,
		bool	mouse_point_valid = `false`,
		const Ogre::Vector3 &	mouse_point_rel_world = `Ogre::Vector3(0,0,0)`
	)

Definition at line 637 of file interactive_marker.cpp.

void rviz::InteractiveMarker::publishPose ( ) [protected]

Definition at line 388 of file interactive_marker.cpp.

void rviz::InteractiveMarker::requestPoseUpdate	(	Ogre::Vector3	position,
		Ogre::Quaternion	orientation
	)

Definition at line 398 of file interactive_marker.cpp.

void rviz::InteractiveMarker::reset ( ) [protected]

void rviz::InteractiveMarker::rotate	(	Ogre::Quaternion	delta_orientation,
		const std::string &	control_name
	)

Definition at line 468 of file interactive_marker.cpp.

void rviz::InteractiveMarker::setPose	(	Ogre::Vector3	position,
		Ogre::Quaternion	orientation,
		const std::string &	control_name
	)

Definition at line 414 of file interactive_marker.cpp.

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

Definition at line 445 of file interactive_marker.cpp.

void rviz::InteractiveMarker::setShowDescription ( bool show )

Definition at line 436 of file interactive_marker.cpp.

void rviz::InteractiveMarker::setShowVisualAids ( bool show )

Definition at line 451 of file interactive_marker.cpp.

void rviz::InteractiveMarker::showMenu	(	ViewportMouseEvent &	event,
		const std::string &	control_name,
		const Ogre::Vector3 &	three_d_point,
		bool	valid_point
	)

Pop up the context menu for this marker.

Parameters:

event	A struct holding certain event data (see full description on InteractiveMarkerControl::handle3DCursorEvent)
control_name	The name of the InteractiveMarkerControl that was selected.
three_d_point	The world-relative position associated with this mouse-click or cursor event.
valid_point	True if three_d_point is valid (e.g. if the mouse ray was successfully intersected with marker geometry).