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

Arrowarrow_
Ogre::Vector3 pos_
State state_

Detailed Description

Definition at line 49 of file pose_tool.h.


Member Enumeration Documentation

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

Definition at line 67 of file pose_tool.h.


Constructor & Destructor Documentation

rviz::PoseTool::PoseTool (  ) 

Definition at line 42 of file pose_tool.cpp.

rviz::PoseTool::~PoseTool (  )  [virtual]

Definition at line 48 of file pose_tool.cpp.


Member Function Documentation

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

Implements rviz::Tool.

Definition at line 60 of file pose_tool.cpp.

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

Implements rviz::Tool.

Definition at line 65 of file pose_tool.cpp.

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

Override onInitialize to do any setup needed after the VisualizationManager 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 53 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.

int rviz::PoseTool::processMouseEvent ( ViewportMouseEvent event  )  [virtual]

Process a mouse event. This is the central function of all the tools, as it defines how the mouse is used.

Implements rviz::Tool.

Definition at line 70 of file pose_tool.cpp.


Member Data Documentation

Definition at line 65 of file pose_tool.h.

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

Definition at line 74 of file pose_tool.h.

Definition at line 72 of file pose_tool.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Wed Jun 6 11:25:48 2012