OpenWalnut  1.2.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
WCustomWidget.h
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 <boost/shared_ptr.hpp>
00029 
00030 #include <osg/ref_ptr>
00031 
00032 #include "../graphicsEngine/WGEViewer.h"
00033 class WGEGroupNode;
00034 
00035 /**
00036  * Custom widget which is created by a module to display custom information.
00037  */
00038 class WCustomWidget
00039 {
00040 public:
00041     /**
00042      * Destructor
00043      */
00044     virtual ~WCustomWidget();
00045 
00046     /**
00047      * Get the scene which is displayed
00048      *
00049      * \return the scene as osg::ref_ptr
00050      */
00051     virtual osg::ref_ptr< WGEGroupNode > getScene() const = 0;
00052 
00053     /**
00054      * Get the viewer which is used
00055      *
00056      * \return the viewer as boost::shard_ptr
00057      */
00058     virtual boost::shared_ptr< WGEViewer > getViewer() const = 0;
00059 
00060 protected:
00061 private:
00062 };
00063 
00064 #endif  // WCUSTOMWIDGET_H
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends