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 00035 class QMouseEvent; 00036 class QKeyEvent; 00037 00038 namespace Ogre 00039 { 00040 class SceneManager; 00041 } 00042 00043 namespace rviz 00044 { 00045 00046 class VisualizationManager; 00047 class ViewportMouseEvent; 00048 class RenderPanel; 00049 00050 class Tool 00051 { 00052 public: 00056 Tool() {} 00057 virtual ~Tool() {} 00058 00061 void initialize( VisualizationManager* manager ); 00062 00067 virtual void onInitialize() {} 00068 00069 const std::string& getName() { return name_; } 00070 char getShortcutKey() { return shortcut_key_; } 00071 00072 virtual void activate() = 0; 00073 virtual void deactivate() = 0; 00074 00075 virtual void update(float wall_dt, float ros_dt) {} 00076 std::string getClassLookupName() { return class_lookup_name_; } 00077 00078 enum Flags 00079 { 00080 Render = 1 << 0, 00081 Finished = 1 << 1 00082 }; 00083 00086 virtual int processMouseEvent( ViewportMouseEvent& event ) = 0; 00087 00091 virtual int processKeyEvent( QKeyEvent* event, RenderPanel* panel ) { return 0; } 00092 00096 virtual bool hasProperties() { return false; } 00097 00098 protected: 00099 Ogre::SceneManager* scene_manager_; 00100 VisualizationManager* manager_; 00101 00102 std::string name_; 00103 char shortcut_key_; 00104 00105 private: 00106 std::string class_lookup_name_; 00107 }; 00108 00109 } 00110 00111 #endif