tool.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2008, Willow Garage, Inc.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  *     * Redistributions of source code must retain the above copyright
00009  *       notice, this list of conditions and the following disclaimer.
00010  *     * Redistributions in binary form must reproduce the above copyright
00011  *       notice, this list of conditions and the following disclaimer in the
00012  *       documentation and/or other materials provided with the distribution.
00013  *     * Neither the name of the Willow Garage, Inc. nor the names of its
00014  *       contributors may be used to endorse or promote products derived from
00015  *       this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 #ifndef RVIZ_TOOL_H
00031 #define RVIZ_TOOL_H
00032 
00033 #include <string>
00034 #include "properties/forwards.h"
00035 
00036 class QMouseEvent;
00037 class QKeyEvent;
00038 
00039 namespace Ogre
00040 {
00041 class SceneManager;
00042 }
00043 
00044 namespace rviz
00045 {
00046 
00047 class VisualizationManager;
00048 class PropertyManager;
00049 class ViewportMouseEvent;
00050 class RenderPanel;
00051 
00052 class Tool
00053 {
00054 public:
00055   Tool( const std::string& name, char shortcut_key, VisualizationManager* manager );
00056   virtual ~Tool() {}
00057 
00058   const std::string& getName() { return name_; }
00059   char getShortcutKey() { return shortcut_key_; }
00060 
00061   virtual void activate() = 0;
00062   virtual void deactivate() = 0;
00063 
00064   virtual void update(float wall_dt, float ros_dt) {}
00065 
00066   enum Flags
00067   {
00068     Render = 1 << 0,
00069     Finished = 1 << 1
00070   };
00071   virtual int processMouseEvent( ViewportMouseEvent& event ) = 0;
00072   virtual int processKeyEvent( QKeyEvent* event, RenderPanel* panel ) { return 0; }
00073 
00074   virtual bool hasProperties() { return false; }
00075   virtual void enumerateProperties(PropertyManager* property_manager, const CategoryPropertyWPtr& parent) {}
00076 
00077 protected:
00078   Ogre::SceneManager* scene_manager_;
00079   VisualizationManager* manager_;
00080 
00081   std::string name_;
00082   char shortcut_key_;
00083 };
00084 
00085 }
00086 
00087 #endif


rviz
Author(s): Dave Hershberger, Josh Faust
autogenerated on Mon Jan 6 2014 11:54:33