OpenWalnut  1.2.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
WCustomWidget.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WCUSTOMWIDGET_H
26 #define WCUSTOMWIDGET_H
27 
28 #include <boost/shared_ptr.hpp>
29 
30 #include <osg/ref_ptr>
31 
32 #include "../graphicsEngine/WGEViewer.h"
33 class WGEGroupNode;
34 
35 /**
36  * Custom widget which is created by a module to display custom information.
37  */
39 {
40 public:
41  /**
42  * Destructor
43  */
44  virtual ~WCustomWidget();
45 
46  /**
47  * Get the scene which is displayed
48  *
49  * \return the scene as osg::ref_ptr
50  */
51  virtual osg::ref_ptr< WGEGroupNode > getScene() const = 0;
52 
53  /**
54  * Get the viewer which is used
55  *
56  * \return the viewer as boost::shard_ptr
57  */
58  virtual boost::shared_ptr< WGEViewer > getViewer() const = 0;
59 
60 protected:
61 private:
62 };
63 
64 #endif // WCUSTOMWIDGET_H