Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
rviz::PoseTool Class Referenceabstract

#include <pose_tool.h>

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

Public Member Functions

void activate () override
 
void deactivate () override
 
void onInitialize () override
 
 PoseTool ()
 
int processMouseEvent (ViewportMouseEvent &event) override
 
 ~PoseTool () 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 Types

enum  State { Position, Orientation }
 

Protected Member Functions

virtual void onPoseSet (double x, double y, double theta)=0
 

Protected Attributes

Arrowarrow_
 
Ogre::Vector3 pos_
 
State state_
 
- 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 46 of file pose_tool.h.

Member Enumeration Documentation

◆ State

enum rviz::PoseTool::State
protected
Enumerator
Position 
Orientation 

Definition at line 64 of file pose_tool.h.

Constructor & Destructor Documentation

◆ PoseTool()

rviz::PoseTool::PoseTool ( )

Definition at line 45 of file pose_tool.cpp.

◆ ~PoseTool()

rviz::PoseTool::~PoseTool ( )
override

Definition at line 49 of file pose_tool.cpp.

Member Function Documentation

◆ activate()

void rviz::PoseTool::activate ( )
overridevirtual

Implements rviz::Tool.

Definition at line 61 of file pose_tool.cpp.

◆ deactivate()

void rviz::PoseTool::deactivate ( )
overridevirtual

Implements rviz::Tool.

Definition at line 67 of file pose_tool.cpp.

◆ onInitialize()

void rviz::PoseTool::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 54 of file pose_tool.cpp.

◆ onPoseSet()

virtual void rviz::PoseTool::onPoseSet ( double  x,
double  y,
double  theta 
)
protectedpure virtual

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

◆ processMouseEvent()

int rviz::PoseTool::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 72 of file pose_tool.cpp.

Member Data Documentation

◆ arrow_

Arrow* rviz::PoseTool::arrow_
protected

Definition at line 62 of file pose_tool.h.

◆ pos_

Ogre::Vector3 rviz::PoseTool::pos_
protected

Definition at line 71 of file pose_tool.h.

◆ state_

State rviz::PoseTool::state_
protected

Definition at line 69 of file pose_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:52