00001 /* 00002 * Copyright (c) 2012, 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 <QString> 00034 #include <QIcon> 00035 #include <QCursor> 00036 #include <QObject> 00037 00038 #include "rviz/config.h" 00039 00040 class QMouseEvent; 00041 class QKeyEvent; 00042 00043 namespace Ogre 00044 { 00045 class SceneManager; 00046 } 00047 00048 namespace rviz 00049 { 00050 class DisplayContext; 00051 class Property; 00052 class RenderPanel; 00053 class ViewportMouseEvent; 00054 00055 class Tool : public QObject 00056 { 00057 Q_OBJECT 00058 public: 00067 Tool(); 00068 virtual ~Tool(); 00069 00072 void initialize( DisplayContext* context ); 00073 00075 virtual Property* getPropertyContainer() const { return property_container_; } 00076 00077 char getShortcutKey() { return shortcut_key_; } 00078 00079 bool accessAllKeys() { return access_all_keys_; } 00080 00081 virtual void activate() = 0; 00082 virtual void deactivate() = 0; 00083 00084 virtual void update(float wall_dt, float ros_dt) {} 00085 00086 enum { 00087 Render = 1, 00088 Finished = 2 00089 }; 00090 00093 virtual int processMouseEvent( ViewportMouseEvent& event ) { return 0; } 00094 00098 virtual int processKeyEvent( QKeyEvent* event, RenderPanel* panel ) { return 0; } 00099 00100 QString getName() const { return name_; } 00101 00107 void setName( const QString& name ); 00108 00111 QString getDescription() const { return description_; } 00112 void setDescription( const QString& description ); 00113 00117 virtual QString getClassId() const { return class_id_; } 00118 00121 virtual void setClassId( const QString& class_id ) { class_id_ = class_id; } 00122 00128 virtual void load( const Config& config ); 00129 00135 virtual void save( Config config ) const; 00136 00138 void setIcon( const QIcon& icon ); 00139 00141 const QIcon& getIcon() { return icon_; } 00142 00144 void setCursor( const QCursor& cursor ); 00145 00147 const QCursor& getCursor() { return cursor_; } 00148 00149 void setStatus( const QString & message ); 00150 00151 protected: 00156 virtual void onInitialize() {} 00157 00158 Ogre::SceneManager* scene_manager_; 00159 DisplayContext* context_; 00160 00161 char shortcut_key_; 00162 bool access_all_keys_; 00163 00164 QIcon icon_; 00165 00166 QCursor cursor_; 00167 00168 private: 00169 QString class_id_; 00170 Property* property_container_; 00171 QString name_; 00172 QString description_; 00173 }; 00174 00175 } 00176 00177 #endif