OpenWalnut 1.3.1
|
00001 //--------------------------------------------------------------------------- 00002 // 00003 // Project: OpenWalnut ( http://www.openwalnut.org ) 00004 // 00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS 00006 // For more information see http://www.openwalnut.org/copying 00007 // 00008 // This file is part of OpenWalnut. 00009 // 00010 // OpenWalnut is free software: you can redistribute it and/or modify 00011 // it under the terms of the GNU Lesser General Public License as published by 00012 // the Free Software Foundation, either version 3 of the License, or 00013 // (at your option) any later version. 00014 // 00015 // OpenWalnut is distributed in the hope that it will be useful, 00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00018 // GNU Lesser General Public License for more details. 00019 // 00020 // You should have received a copy of the GNU Lesser General Public License 00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>. 00022 // 00023 //--------------------------------------------------------------------------- 00024 00025 #ifndef WCUSTOMWIDGET_H 00026 #define WCUSTOMWIDGET_H 00027 00028 #include <string> 00029 00030 #include <boost/shared_ptr.hpp> 00031 00032 #include <osg/ref_ptr> 00033 00034 #include "../graphicsEngine/WGEViewer.h" 00035 00036 class WGEGroupNode; 00037 00038 /** 00039 * Custom widget which is created by a module to display custom information. 00040 */ 00041 class WCustomWidget 00042 { 00043 public: 00044 /** 00045 * Abbreviation for a shared pointer on a instance of this class. 00046 */ 00047 typedef boost::shared_ptr< WCustomWidget > SPtr; 00048 00049 /** 00050 * Abbreviation for a const shared pointer on a instance of this class. 00051 */ 00052 typedef boost::shared_ptr< const WCustomWidget > ConstSPtr; 00053 00054 /** 00055 * Constructor. Create a custom widget instance. 00056 * 00057 * \param title the title of the widget 00058 */ 00059 explicit WCustomWidget( std::string title ); 00060 00061 /** 00062 * Destructor 00063 */ 00064 virtual ~WCustomWidget(); 00065 00066 /** 00067 * Get the scene which is displayed 00068 * 00069 * \return the scene as osg::ref_ptr 00070 */ 00071 virtual osg::ref_ptr< WGEGroupNode > getScene() const = 0; 00072 00073 /** 00074 * Get the viewer which is used 00075 * 00076 * \return the viewer as boost::shard_ptr 00077 */ 00078 virtual boost::shared_ptr< WGEViewer > getViewer() const = 0; 00079 00080 /** 00081 * Get the title of the widget. 00082 * 00083 * \return title as string 00084 */ 00085 virtual std::string getTitle() const; 00086 00087 protected: 00088 private: 00089 /** 00090 * The widget's title string. 00091 */ 00092 std::string m_title; 00093 }; 00094 00095 #endif // WCUSTOMWIDGET_H