Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
rviz::PoseTool Class Reference

#include <pose_tool.h>

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

List of all members.

Public Member Functions

virtual void activate ()
virtual void deactivate ()
virtual void onInitialize ()
 PoseTool ()
virtual int processMouseEvent (ViewportMouseEvent &event)
virtual ~PoseTool ()

Protected Types

enum  State { Position, Orientation }

Protected Member Functions

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

Protected Attributes

Arrow * arrow_
Ogre::Vector3 pos_
State state_

Detailed Description

Definition at line 46 of file pose_tool.h.


Member Enumeration Documentation

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

Definition at line 64 of file pose_tool.h.


Constructor & Destructor Documentation

Definition at line 46 of file pose_tool.cpp.

Definition at line 52 of file pose_tool.cpp.


Member Function Documentation

void rviz::PoseTool::activate ( ) [virtual]

Implements rviz::Tool.

Definition at line 64 of file pose_tool.cpp.

void rviz::PoseTool::deactivate ( ) [virtual]

Implements rviz::Tool.

Definition at line 70 of file pose_tool.cpp.

void rviz::PoseTool::onInitialize ( ) [virtual]

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.

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

Definition at line 57 of file pose_tool.cpp.

virtual void rviz::PoseTool::onPoseSet ( double  x,
double  y,
double  theta 
) [protected, pure virtual]

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

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 75 of file pose_tool.cpp.


Member Data Documentation

Arrow* rviz::PoseTool::arrow_ [protected]

Definition at line 62 of file pose_tool.h.

Ogre::Vector3 rviz::PoseTool::pos_ [protected]

Definition at line 71 of file pose_tool.h.

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 Thu Aug 27 2015 15:02:29