rviz::Tool Class Reference

#include <tool.h>

Inheritance diagram for rviz::Tool:

Public Types
enum	Flags { Render = 1 << 0, Finished = 1 << 1 }
Public Member Functions
virtual void	activate ()=0
virtual void	deactivate ()=0
std::string	getClassLookupName ()
const std::string &	getName ()
char	getShortcutKey ()
virtual bool	hasProperties ()
void	initialize (VisualizationManager *manager)
virtual void	onInitialize ()
virtual int	processKeyEvent (QKeyEvent event, RenderPanel panel)
virtual int	processMouseEvent (ViewportMouseEvent &event)=0
	Tool ()
virtual void	update (float wall_dt, float ros_dt)
virtual	~Tool ()
Protected Attributes
VisualizationManager *	manager_
std::string	name_
Ogre::SceneManager *	scene_manager_
char	shortcut_key_
Private Attributes
std::string	class_lookup_name_

Detailed Description

Definition at line 50 of file tool.h.

Member Enumeration Documentation

enum rviz::Tool::Flags

Enumerator:

Render
Finished

Definition at line 78 of file tool.h.

Constructor & Destructor Documentation

rviz::Tool::Tool ( ) [inline]

Default constructor. Pluginlib only instantiates classes via default constructors. Subclasses of Tool should set the name_ and shortcut_key_ fields in their constructors.

Definition at line 56 of file tool.h.

virtual rviz::Tool::~Tool ( ) [inline, virtual]

Definition at line 57 of file tool.h.

Member Function Documentation

virtual void rviz::Tool::activate ( ) [pure virtual]

Implemented in rviz::InteractionTool, rviz::MoveTool, rviz::PoseTool, and rviz::SelectionTool.

virtual void rviz::Tool::deactivate ( ) [pure virtual]

Implemented in rviz::InteractionTool, rviz::MoveTool, rviz::PoseTool, and rviz::SelectionTool.

std::string rviz::Tool::getClassLookupName ( ) [inline]

Definition at line 76 of file tool.h.

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

Definition at line 69 of file tool.h.

char rviz::Tool::getShortcutKey ( ) [inline]

Definition at line 70 of file tool.h.

virtual bool rviz::Tool::hasProperties ( ) [inline, virtual]

If your Tool subclass defines properties in enumerateProperties(), also override this function to return true.

Reimplemented in rviz::GoalTool, and rviz::InitialPoseTool.

Definition at line 96 of file tool.h.

void rviz::Tool::initialize ( VisualizationManager * manager )

Initialize the tool. Sets the VisualizationManager and calls onInitialize().

Definition at line 36 of file tool.cpp.

virtual void rviz::Tool::onInitialize ( ) [inline, virtual]

Override onInitialize to do any setup needed after the VisualizationManager has been set. This is called by Tool::initialize(). The base implementation here does nothing.

Reimplemented in rviz::GoalTool, rviz::InitialPoseTool, rviz::InteractionTool, rviz::PoseTool, and rviz::SelectionTool.

Definition at line 67 of file tool.h.