Public Member Functions | Protected Attributes | List of all members
rviz::FocusTool Class Reference

#include <focus_tool.h>

Inheritance diagram for rviz::FocusTool:
Inheritance graph

Public Member Functions

void activate () override
void deactivate () override
 FocusTool ()
void onInitialize () override
int processMouseEvent (ViewportMouseEvent &event) override
 ~FocusTool () 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 int processKeyEvent (QKeyEvent *event, RenderPanel *panel)
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 ()
virtual void update (float wall_dt, float ros_dt)
 ~Tool () override

Protected Attributes

QCursor hit_cursor_
QCursor std_cursor_
- Protected Attributes inherited from rviz::Tool
bool access_all_keys_
QCursor cursor_
QIcon icon_
Ogre::SceneManager * scene_manager_
char shortcut_key_

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)

Detailed Description

The Focus Tool allows the user to set the focal point of the current view controller with a single mouse click.

Definition at line 41 of file focus_tool.h.

Constructor & Destructor Documentation

◆ FocusTool()

rviz::FocusTool::FocusTool ( )

Definition at line 48 of file focus_tool.cpp.

◆ ~FocusTool()

rviz::FocusTool::~FocusTool ( )

Definition at line 52 of file focus_tool.cpp.

Member Function Documentation

◆ activate()

void rviz::FocusTool::activate ( )

Implements rviz::Tool.

Definition at line 62 of file focus_tool.cpp.

◆ deactivate()

void rviz::FocusTool::deactivate ( )

Implements rviz::Tool.

Definition at line 66 of file focus_tool.cpp.

◆ onInitialize()

void rviz::FocusTool::onInitialize ( )

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 56 of file focus_tool.cpp.

◆ processMouseEvent()

int rviz::FocusTool::processMouseEvent ( ViewportMouseEvent event)

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 70 of file focus_tool.cpp.

Member Data Documentation

◆ hit_cursor_

QCursor rviz::FocusTool::hit_cursor_

Definition at line 56 of file focus_tool.h.

◆ std_cursor_

QCursor rviz::FocusTool::std_cursor_

Definition at line 55 of file focus_tool.h.

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

Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Fri Feb 3 2023 03:06:43