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

#include <interaction_tool.h>

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

Public Slots

void hideInactivePropertyChanged ()
 

Public Member Functions

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

Protected Member Functions

void updateFocus (const ViewportMouseEvent &event)
 Check if the mouse has moved from one object to another, and update focused_object_ if so. More...
 

Protected Attributes

InteractiveObjectWPtr focused_object_
 The object (control) which currently has the mouse focus. More...
 
BoolPropertyhide_inactive_property_
 
uint64_t last_selection_frame_count_
 
MoveTool move_tool_
 
- Protected Attributes inherited from rviz::Tool
bool access_all_keys_
 
DisplayContextcontext_
 
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

Definition at line 45 of file interaction_tool.h.

Constructor & Destructor Documentation

◆ InteractionTool()

rviz::InteractionTool::InteractionTool ( )

Definition at line 50 of file interaction_tool.cpp.

◆ ~InteractionTool()

rviz::InteractionTool::~InteractionTool ( )
override

Definition at line 59 of file interaction_tool.cpp.

Member Function Documentation

◆ activate()

void rviz::InteractionTool::activate ( )
overridevirtual

Implements rviz::Tool.

Definition at line 70 of file interaction_tool.cpp.

◆ deactivate()

void rviz::InteractionTool::deactivate ( )
overridevirtual

Implements rviz::Tool.

Definition at line 76 of file interaction_tool.cpp.

◆ hideInactivePropertyChanged

void rviz::InteractionTool::hideInactivePropertyChanged ( )
inlineslot

Definition at line 62 of file interaction_tool.h.

◆ onInitialize()

void rviz::InteractionTool::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 63 of file interaction_tool.cpp.

◆ processKeyEvent()

int rviz::InteractionTool::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 189 of file interaction_tool.cpp.

◆ processMouseEvent()

int rviz::InteractionTool::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 133 of file interaction_tool.cpp.

◆ updateFocus()

void rviz::InteractionTool::updateFocus ( const ViewportMouseEvent event)
protected

Check if the mouse has moved from one object to another, and update focused_object_ if so.

Definition at line 81 of file interaction_tool.cpp.

Member Data Documentation

◆ focused_object_

InteractiveObjectWPtr rviz::InteractionTool::focused_object_
protected

The object (control) which currently has the mouse focus.

Definition at line 70 of file interaction_tool.h.

◆ hide_inactive_property_

BoolProperty* rviz::InteractionTool::hide_inactive_property_
protected

Definition at line 76 of file interaction_tool.h.

◆ last_selection_frame_count_

uint64_t rviz::InteractionTool::last_selection_frame_count_
protected

Definition at line 72 of file interaction_tool.h.

◆ move_tool_

MoveTool rviz::InteractionTool::move_tool_
protected

Definition at line 74 of file interaction_tool.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Fri Aug 12 2022 02:06:10