$search

rviz::Tool Class Reference

#include <tool.h>

Inheritance diagram for rviz::Tool:
Inheritance graph
[legend]

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
virtual void enumerateProperties (PropertyManager *property_manager, const CategoryPropertyWPtr &parent)
const std::string & getName ()
char getShortcutKey ()
virtual bool hasProperties ()
virtual int processKeyEvent (wxKeyEvent &event)
virtual int processMouseEvent (ViewportMouseEvent &event)=0
 Tool (const std::string &name, char shortcut_key, VisualizationManager *manager)
virtual void update (float wall_dt, float ros_dt)
virtual ~Tool ()

Protected Attributes

VisualizationManagermanager_
std::string name_
Ogre::SceneManager * scene_manager_
char shortcut_key_

Detailed Description

Definition at line 51 of file tool.h.


Member Enumeration Documentation

Enumerator:
Render 
Finished 

Definition at line 65 of file tool.h.


Constructor & Destructor Documentation

rviz::Tool::Tool ( const std::string &  name,
char  shortcut_key,
VisualizationManager manager 
)

Definition at line 36 of file tool.cpp.

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

Definition at line 55 of file tool.h.


Member Function Documentation

virtual void rviz::Tool::activate (  )  [pure virtual]
virtual void rviz::Tool::deactivate (  )  [pure virtual]
virtual void rviz::Tool::enumerateProperties ( PropertyManager property_manager,
const CategoryPropertyWPtr &  parent 
) [inline, virtual]

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

Definition at line 74 of file tool.h.

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

Definition at line 57 of file tool.h.

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

Definition at line 58 of file tool.h.

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

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

Definition at line 73 of file tool.h.

virtual int rviz::Tool::processKeyEvent ( wxKeyEvent &  event  )  [inline, virtual]

Reimplemented in rviz::SelectionTool.

Definition at line 71 of file tool.h.

virtual int rviz::Tool::processMouseEvent ( ViewportMouseEvent event  )  [pure virtual]
virtual void rviz::Tool::update ( float  wall_dt,
float  ros_dt 
) [inline, virtual]

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

Definition at line 63 of file tool.h.


Member Data Documentation

Definition at line 78 of file tool.h.

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

Definition at line 80 of file tool.h.

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

Definition at line 77 of file tool.h.

char rviz::Tool::shortcut_key_ [protected]

Definition at line 81 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


rviz
Author(s): Josh Faust, Dave Hershberger
autogenerated on Sat Mar 2 14:17:38 2013