Signals | Public Member Functions | Private Slots | Private Member Functions | Private Attributes
rviz::ToolManager Class Reference

#include <tool_manager.h>

List of all members.

Signals

void configChanged ()
 Emitted when anything changes which will change the saved config file contents.
void toolAdded (Tool *)
 Emitted by addTool() after the tool is added to the list of tools.
void toolChanged (Tool *)
 Emitted by setCurrentTool() after the newly chosen tool is activated.
void toolRefreshed (Tool *)
 Emitted by refreshTool() to gedraw the tool's icon in the toolbar'.
void toolRemoved (Tool *)

Public Member Functions

TooladdTool (const QString &tool_class_lookup_name)
 Create a tool by class lookup name, add it to the list, and return it.
ToolgetCurrentTool ()
 Return the tool currently in use.
ToolgetDefaultTool ()
 Get the default tool.
PluginlibFactory< Tool > * getFactory ()
PropertyTreeModelgetPropertyModel () const
ToolgetTool (int index)
 Return the tool at a given index in the Tool list. If index is less than 0 or greater than the number of tools, this will fail an assertion.
QStringList getToolClasses ()
void handleChar (QKeyEvent *event, RenderPanel *panel)
void initialize ()
 Initialization for after the DisplayContext is created. Loads standard RViz tools.
void load (const Config &config)
int numTools ()
void refreshTool (Tool *tool)
 Triggers redrawing the tool's icon/text in the toolbar.
void removeAll ()
void removeTool (int index)
void save (Config config) const
void setCurrentTool (Tool *tool)
 Set the current tool. The current tool is given all mouse and keyboard events which VisualizationManager receives via handleMouseEvent() and handleChar().
void setDefaultTool (Tool *tool)
 Set the default tool.
 ToolManager (DisplayContext *context)
virtual ~ToolManager ()

Private Slots

void updatePropertyVisibility (Property *property)
 If property has children, it is added to the tool property tree, and if it does not, it is removed.

Private Member Functions

bool toKey (QString const &str, uint &key_out)

Private Attributes

DisplayContextcontext_
Toolcurrent_tool_
Tooldefault_tool_
PluginlibFactory< Tool > * factory_
PropertyTreeModelproperty_tree_model_
std::map< int, Tool * > shortkey_to_tool_map_
QList< Tool * > tools_

Detailed Description

Definition at line 47 of file tool_manager.h.


Constructor & Destructor Documentation

Definition at line 51 of file tool_manager.cpp.

Definition at line 61 of file tool_manager.cpp.


Member Function Documentation

Tool * rviz::ToolManager::addTool ( const QString &  tool_class_lookup_name)

Create a tool by class lookup name, add it to the list, and return it.

Definition at line 223 of file tool_manager.cpp.

Emitted when anything changes which will change the saved config file contents.

Return the tool currently in use.

See also:
setCurrentTool()

Definition at line 69 of file tool_manager.h.

Get the default tool.

See also:
setDefaultTool()

Definition at line 112 of file tool_manager.h.

Definition at line 118 of file tool_manager.h.

Definition at line 60 of file tool_manager.h.

Tool * rviz::ToolManager::getTool ( int  index)

Return the tool at a given index in the Tool list. If index is less than 0 or greater than the number of tools, this will fail an assertion.

Definition at line 199 of file tool_manager.cpp.

Definition at line 301 of file tool_manager.cpp.

void rviz::ToolManager::handleChar ( QKeyEvent *  event,
RenderPanel panel 
)

Definition at line 130 of file tool_manager.cpp.

Initialization for after the DisplayContext is created. Loads standard RViz tools.

Definition at line 68 of file tool_manager.cpp.

void rviz::ToolManager::load ( const Config config)

Definition at line 88 of file tool_manager.cpp.

int rviz::ToolManager::numTools ( ) [inline]

Definition at line 78 of file tool_manager.h.

Triggers redrawing the tool's icon/text in the toolbar.

Definition at line 296 of file tool_manager.cpp.

Definition at line 80 of file tool_manager.cpp.

void rviz::ToolManager::removeTool ( int  index)

Definition at line 269 of file tool_manager.cpp.

void rviz::ToolManager::save ( Config  config) const

Definition at line 106 of file tool_manager.cpp.

Set the current tool. The current tool is given all mouse and keyboard events which VisualizationManager receives via handleMouseEvent() and handleChar().

See also:
getCurrentTool()

Definition at line 177 of file tool_manager.cpp.

Set the default tool.

The default tool is selected directly by pressing the Escape key. The default tool is indirectly selected when a Tool returns Finished in the bit field result of Tool::processMouseEvent(). This is how control moves from the InitialPoseTool back to MoveCamera when InitialPoseTool receives a left mouse button release event.

See also:
getDefaultTool()

Definition at line 194 of file tool_manager.cpp.

bool rviz::ToolManager::toKey ( QString const &  str,
uint &  key_out 
) [private]

Definition at line 114 of file tool_manager.cpp.

void rviz::ToolManager::toolAdded ( Tool ) [signal]

Emitted by addTool() after the tool is added to the list of tools.

void rviz::ToolManager::toolChanged ( Tool ) [signal]

Emitted by setCurrentTool() after the newly chosen tool is activated.

void rviz::ToolManager::toolRefreshed ( Tool ) [signal]

Emitted by refreshTool() to gedraw the tool's icon in the toolbar'.

void rviz::ToolManager::toolRemoved ( Tool ) [signal]
void rviz::ToolManager::updatePropertyVisibility ( Property property) [private, slot]

If property has children, it is added to the tool property tree, and if it does not, it is removed.

Definition at line 207 of file tool_manager.cpp.


Member Data Documentation

Definition at line 147 of file tool_manager.h.

Definition at line 148 of file tool_manager.h.

Definition at line 149 of file tool_manager.h.

Definition at line 144 of file tool_manager.h.

Definition at line 145 of file tool_manager.h.

Definition at line 150 of file tool_manager.h.

QList<Tool*> rviz::ToolManager::tools_ [private]

Definition at line 146 of file tool_manager.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Thu Jun 6 2019 18:02:17