rviz::Tool Class Reference

#include <tool.h>

Inheritance diagram for rviz::Tool:
Inheritance graph

List of all members.

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

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


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]
virtual void rviz::Tool::deactivate (  )  [pure virtual]
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.

virtual int rviz::Tool::processKeyEvent ( QKeyEvent *  event,
RenderPanel panel 
) [inline, virtual]

Process a key event. Override if your tool should handle any other keypresses than the tool shortcuts, which are handled separately.

Reimplemented in rviz::MoveTool, and rviz::SelectionTool.

Definition at line 91 of file tool.h.

virtual int rviz::Tool::processMouseEvent ( ViewportMouseEvent event  )  [pure virtual]

Process a mouse event. This is the central function of all the tools, as it defines how the mouse is used.

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

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

Reimplemented in rviz::SelectionTool.

Definition at line 75 of file tool.h.

Member Data Documentation

std::string rviz::Tool::class_lookup_name_ [private]

Definition at line 106 of file tool.h.

Definition at line 100 of file tool.h.

std::string rviz::Tool::name_ [protected]

Definition at line 102 of file tool.h.

Ogre::SceneManager* rviz::Tool::scene_manager_ [protected]

Definition at line 99 of file tool.h.

char rviz::Tool::shortcut_key_ [protected]

Definition at line 103 of file tool.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Author(s): Dave Hershberger, Josh Faust
autogenerated on Wed Jun 6 11:25:48 2012