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

#include <goal_tool.h>

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

Public Member Functions

 GoalTool ()
 
void onInitialize () override
 
 ~GoalTool () override
 
- Public Member Functions inherited from rviz::PoseTool
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 Member Functions

void onPoseSet (double x, double y, double theta) override
 

Private Slots

void updateTopic ()
 

Private Attributes

ros::NodeHandle nh_
 
ros::Publisher pub_
 
StringPropertytopic_property_
 

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 Types inherited from rviz::PoseTool
enum  State { Position, Orientation }
 
- Protected Attributes inherited from rviz::PoseTool
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_
 

Detailed Description

Definition at line 47 of file goal_tool.h.

Constructor & Destructor Documentation

◆ GoalTool()

rviz::GoalTool::GoalTool ( )

Definition at line 42 of file goal_tool.cpp.

◆ ~GoalTool()

rviz::GoalTool::~GoalTool ( )
inlineoverride

Definition at line 52 of file goal_tool.h.

Member Function Documentation

◆ onInitialize()

void rviz::GoalTool::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 51 of file goal_tool.cpp.

◆ onPoseSet()

void rviz::GoalTool::onPoseSet ( double  x,
double  y,
double  theta 
)
overrideprotectedvirtual

Implements rviz::PoseTool.

Definition at line 71 of file goal_tool.cpp.

◆ updateTopic

void rviz::GoalTool::updateTopic ( )
privateslot

Definition at line 59 of file goal_tool.cpp.

Member Data Documentation

◆ nh_

ros::NodeHandle rviz::GoalTool::nh_
private

Definition at line 64 of file goal_tool.h.

◆ pub_

ros::Publisher rviz::GoalTool::pub_
private

Definition at line 65 of file goal_tool.h.

◆ topic_property_

StringProperty* rviz::GoalTool::topic_property_
private

Definition at line 67 of file goal_tool.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Mon Aug 15 2022 02:05:17