Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/GraphicsEngine.h @ 1742

Last change on this file since 1742 was 1625, checked in by rgrieder, 16 years ago

merged hud branch back to trunk

  • Property svn:eol-style set to native
File size: 4.7 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Reto Grieder
24 *   Co-authors:
25 *      Benjamin Knecht <beni_at_orxonox.net>, (C) 2007, Felix Schulthess
26 *
27 */
28
29/**
30  @file
31  @brief Declaration of GraphicsEngine Singleton.
32  @author Benjamin Knecht <beni_at_orxonox.net>
33 */
34
35#ifndef _GraphicsEngine_H__
36#define _GraphicsEngine_H__
37
38#include "OrxonoxPrereqs.h"
39
40#include <string>
41
42#include <OgrePrerequisites.h>
43#include <OgreLog.h>
44#include <OgreRenderWindow.h>
45#include <OgreWindowEventUtilities.h>
46#include "core/OrxonoxClass.h"
47
48
49namespace orxonox
50{
51    /**
52    @brief Graphics engine manager class
53    */
54    class _OrxonoxExport GraphicsEngine : public Ogre::WindowEventListener, public Ogre::LogListener, public OrxonoxClass
55    {
56        public:
57            void setConfigValues();
58            bool setup();
59            bool declareRessourceLocations();
60            bool loadRenderer();
61            bool initialiseResources();
62            bool createNewScene();
63
64            void destroy();
65
66            Ogre::SceneManager* getSceneManager() { return scene_; }
67
68            // several window properties
69            Ogre::RenderWindow* getRenderWindow() { return this->renderWindow_; }
70            size_t getWindowHandle();
71            int getWindowWidth() const;
72            int getWindowHeight() const;
73            float getWindowAspectRatio() const;
74            float getAverageFramesPerSecond() const { return this->avgFramesPerSecond_; }
75            float getAverageTickTime() const { return this->avgTickTime_; }
76            void setAverageTickTime(float tickTime) { this->avgTickTime_ = tickTime; }
77            void setAverageFramesPerSecond(float fps) { this->avgFramesPerSecond_ = fps; }
78
79            void setWindowActivity(bool activity)
80            { if (this->renderWindow_) this->renderWindow_->setActive(activity); }
81
82            void windowMoved       (Ogre::RenderWindow* rw);
83            void windowResized     (Ogre::RenderWindow* rw);
84            void windowFocusChanged(Ogre::RenderWindow* rw);
85            void windowClosed      (Ogre::RenderWindow* rw);
86
87            inline unsigned int getDetailLevelParticle() const
88              { return this->detailLevelParticle_; }
89
90            static GraphicsEngine& getSingleton();
91            static GraphicsEngine* getSingletonPtr() { return &getSingleton(); }
92
93
94        private:
95            // don't mess with singletons
96            GraphicsEngine();
97            ~GraphicsEngine();
98            GraphicsEngine(GraphicsEngine&) { }
99
100            //! Method called by the LogListener from Ogre
101            void messageLogged(const std::string&, Ogre::LogMessageLevel,
102                             bool, const std::string&);
103
104            Ogre::Root*         root_;                  //!< Ogre's root
105            Ogre::SceneManager* scene_;                 //!< scene manager of the game
106            Ogre::RenderWindow* renderWindow_;          //!< the current render window
107            std::string         resourceFile_;          //!< resources file name
108            std::string         ogreConfigFile_;        //!< ogre config file name
109            std::string         ogrePluginsFile_;       //!< ogre plugins file name
110            std::string         ogreLogFile_;           //!< log file name for Ogre log messages
111            int                 ogreLogLevelTrivial_;   //!< Corresponding Orxonx debug level for LL_TRIVIAL
112            int                 ogreLogLevelNormal_;    //!< Corresponding Orxonx debug level for LL_NORMAL
113            int                 ogreLogLevelCritical_;  //!< Corresponding Orxonx debug level for LL_CRITICAL
114            unsigned int        detailLevelParticle_;   //!< Detail level of particle effects (0: off, 1: low, 2: normal, 3: high)
115            float               avgTickTime_;           //!< time in ms to tick() one frame
116            float               avgFramesPerSecond_;    //!< number of frames processed in one second
117    };
118}
119
120#endif /* _GraphicsEngine_H__ */
Note: See TracBrowser for help on using the repository browser.