Public Member Functions | Private Attributes | List of all members
rviz::SelectionTool Class Reference

#include <selection_tool.h>

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

Public Member Functions

void activate () override
 
void deactivate () override
 
void onInitialize () override
 
int processKeyEvent (QKeyEvent *event, RenderPanel *panel) override
 
int processMouseEvent (ViewportMouseEvent &event) override
 
 SelectionTool ()
 
void update (float wall_dt, float ros_dt) override
 
 ~SelectionTool () override
 
- Public Member Functions inherited from rviz::Tool
bool accessAllKeys ()
 
virtual QString getClassId () const
 Return the class identifier which was used to create this instance. This version just returns whatever was set with setClassId(). More...
 
const QCursor & getCursor ()
 Get current cursor of this tool. More...
 
QString getDescription () const
 Set the description of the tool. This is called by ToolManager during tool initialization. More...
 
const QIcon & getIcon ()
 Get the icon of this tool. More...
 
QString getName () const
 
virtual PropertygetPropertyContainer () const
 Return the container for properties of this Tool. More...
 
char getShortcutKey ()
 
void initialize (DisplayContext *context)
 
virtual void load (const Config &config)
 Load properties from the given Config. More...
 
virtual void save (Config config) const
 Save this entire tool into the given Config node. More...
 
virtual void setClassId (const QString &class_id)
 Set the class identifier used to create this instance. Typically this will be set by the factory object which created it. More...
 
void setCursor (const QCursor &cursor)
 Set the cursor for this tool. More...
 
void setDescription (const QString &description)
 
void setIcon (const QIcon &icon)
 Set the toolbar icon for this tool (will also set its cursor). More...
 
void setName (const QString &name)
 Set the name of the tool. More...
 
void setStatus (const QString &message)
 
 Tool ()
 
 ~Tool () override
 

Private Attributes

M_Picked highlight_
 
MoveToolmove_tool_
 
bool moving_
 
int sel_start_x_
 
int sel_start_y_
 
bool selecting_
 

Additional Inherited Members

- Public Types inherited from rviz::Tool
enum  { Render = 1, Finished = 2 }
 
- Signals inherited from rviz::Tool
void close ()
 
void nameChanged (const QString &name)
 
- Protected Attributes inherited from rviz::Tool
bool access_all_keys_
 
DisplayContextcontext_
 
QCursor cursor_
 
QIcon icon_
 
Ogre::SceneManager * scene_manager_
 
char shortcut_key_
 

Detailed Description

Definition at line 47 of file selection_tool.h.

Constructor & Destructor Documentation

◆ SelectionTool()

rviz::SelectionTool::SelectionTool ( )

Definition at line 60 of file selection_tool.cpp.

◆ ~SelectionTool()

rviz::SelectionTool::~SelectionTool ( )
override

Definition at line 72 of file selection_tool.cpp.

Member Function Documentation

◆ activate()

void rviz::SelectionTool::activate ( )
overridevirtual

Implements rviz::Tool.

Definition at line 82 of file selection_tool.cpp.

◆ deactivate()

void rviz::SelectionTool::deactivate ( )
overridevirtual

Implements rviz::Tool.

Definition at line 91 of file selection_tool.cpp.

◆ onInitialize()

void rviz::SelectionTool::onInitialize ( )
overridevirtual

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

Reimplemented from rviz::Tool.

Definition at line 77 of file selection_tool.cpp.

◆ processKeyEvent()

int rviz::SelectionTool::processKeyEvent ( QKeyEvent *  event,
RenderPanel panel 
)
overridevirtual

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

Reimplemented from rviz::Tool.

Definition at line 175 of file selection_tool.cpp.

◆ processMouseEvent()

int rviz::SelectionTool::processMouseEvent ( ViewportMouseEvent event)
overridevirtual

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

Reimplemented from rviz::Tool.

Definition at line 106 of file selection_tool.cpp.

◆ update()

void rviz::SelectionTool::update ( float  wall_dt,
float  ros_dt 
)
overridevirtual

Reimplemented from rviz::Tool.

Definition at line 96 of file selection_tool.cpp.

Member Data Documentation

◆ highlight_

M_Picked rviz::SelectionTool::highlight_
private

Definition at line 70 of file selection_tool.h.

◆ move_tool_

MoveTool* rviz::SelectionTool::move_tool_
private

Definition at line 64 of file selection_tool.h.

◆ moving_

bool rviz::SelectionTool::moving_
private

Definition at line 72 of file selection_tool.h.

◆ sel_start_x_

int rviz::SelectionTool::sel_start_x_
private

Definition at line 67 of file selection_tool.h.

◆ sel_start_y_

int rviz::SelectionTool::sel_start_y_
private

Definition at line 68 of file selection_tool.h.

◆ selecting_

bool rviz::SelectionTool::selecting_
private

Definition at line 66 of file selection_tool.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat Aug 6 2022 02:06:53