Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OgreRoot.h

Go to the documentation of this file.
00001 /*
00002 -----------------------------------------------------------------------------
00003 This source file is part of OGRE
00004     (Object-oriented Graphics Rendering Engine)
00005 For the latest info, see http://www.ogre3d.org/
00006 
00007 Copyright (c) 2000-2005 The OGRE Team
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 -----------------------------------------------------------------------------
00024 */
00025 #ifndef __ROOT__
00026 #define __ROOT__
00027 
00028 // Precompiler options
00029 #include "OgrePrerequisites.h"
00030 
00031 #include "OgreSingleton.h"
00032 #include "OgreString.h"
00033 #include "OgreSceneManagerEnumerator.h"
00034 #include "OgreResourceGroupManager.h"
00035 
00036 #include <exception>
00037 
00038 #if OGRE_COMPILER == OGRE_COMPILER_MSVC || OGRE_COMPILER == OGRE_COMPILER_BORL
00039 #   define SET_TERM_HANDLER { set_terminate( &Ogre::Root::termHandler ); }
00040 #else
00041 #   define SET_TERM_HANDLER { std::set_terminate( &Ogre::Root::termHandler ); }
00042 #endif
00043 
00044 namespace Ogre
00045 {
00046     typedef std::vector<RenderSystem*> RenderSystemList;
00047 
00061     class _OgreExport Root : public Singleton<Root>
00062     {
00063         // To allow update of active renderer if
00064         // RenderSystem::initialise is used directly
00065         friend class RenderSystem;
00066     private:
00067         RenderSystemList mRenderers;
00068         RenderSystem* mActiveRenderer;
00069         String mVersion;
00070         String mConfigFileName;
00071         bool mQueuedEnd;
00072         // In case multiple render windows are created, only once are the resources loaded.
00073         bool mFirstTimePostWindowInit;
00074 
00075         // Singletons
00076         LogManager* mLogManager;
00077         ControllerManager* mControllerManager;
00078         SceneManagerEnumerator* mSceneManagerEnum;
00079         SceneManager* mCurrentSceneManager;
00080         DynLibManager* mDynLibManager;
00081         PlatformManager* mPlatformManager;
00082         ArchiveManager* mArchiveManager;
00083         MaterialManager* mMaterialManager;
00084         MeshManager* mMeshManager;
00085         ParticleSystemManager* mParticleManager;
00086         SkeletonManager* mSkeletonManager;
00087         OverlayElementFactory* mPanelFactory;
00088         OverlayElementFactory* mBorderPanelFactory;
00089         OverlayElementFactory* mTextAreaFactory;
00090         OverlayManager* mOverlayManager;
00091         FontManager* mFontManager;
00092         ArchiveFactory *mZipArchiveFactory;
00093         ArchiveFactory *mFileSystemArchiveFactory;
00094         ResourceGroupManager* mResourceGroupManager;
00095         ResourceBackgroundQueue* mResourceBackgroundQueue;
00096 
00097         Timer* mTimer;
00098         RenderWindow* mAutoWindow;
00099         Profiler* mProfiler;
00100         HighLevelGpuProgramManager* mHighLevelGpuProgramManager;
00101         ExternalTextureSourceManager* mExternalTextureSourceManager;
00102         unsigned long mCurrentFrame;
00103 
00104         std::vector<DynLib*> mPluginLibs;
00111         void loadPlugins( const String& pluginsfile = "plugins.cfg" );
00114         void unloadPlugins();
00115 
00116         // Internal method for one-time tasks after first window creation
00117         void oneTimePostWindowInit(void);
00118 
00120         std::set<FrameListener*> mFrameListeners;
00121 
00122 
00124         enum FrameEventTimeType {
00125             FETT_ANY, FETT_STARTED, FETT_ENDED
00126         };
00127 
00129         std::deque<unsigned long> mEventTimes[3];
00130 
00135         Real calculateEventTime(unsigned long now, FrameEventTimeType type);
00136     public:
00137 
00138         static void termHandler();
00139 
00145         Root(const String& pluginFileName = "plugins.cfg", const String& configFileName = "ogre.cfg", const String& logFileName = "Ogre.log");
00146         ~Root();
00147 
00153         void saveConfig(void);
00154 
00167         bool restoreConfig(void);
00168 
00185         bool showConfigDialog(void);
00186 
00198         void addRenderSystem(RenderSystem* newRend);
00199 
00207         void setSceneManager(SceneType sType, SceneManager* sm);
00208 
00215         RenderSystemList* getAvailableRenderers(void);
00216 
00234         void setRenderSystem(RenderSystem* system);
00235 
00238         RenderSystem* getRenderSystem(void);
00239 
00255         RenderWindow* initialise(bool autoCreateWindow, const String& windowTitle = "OGRE Render Window");
00256 
00283         SceneManager* getSceneManager(SceneType sceneType);
00284 
00300         TextureManager* getTextureManager(void);
00301 
00307         MeshManager* getMeshManager(void);
00308 
00312         String getErrorDescription(long errorNumber);
00313 
00330         void addFrameListener(FrameListener* newListener);
00331 
00336         void removeFrameListener(FrameListener* oldListener);
00337 
00346         void queueEndRendering(void);
00347 
00373         void startRendering(void);
00374 
00380         bool renderOneFrame(void);
00388         void shutdown(void);
00389 
00436         void addResourceLocation(const String& name, const String& locType, 
00437             const String& groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, 
00438             bool recursive = false);
00439 
00446         void removeResourceLocation(const String& name, 
00447             const String& groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME);
00448 
00457         void convertColourValue(const ColourValue& colour, uint32* pDest);
00458 
00467         RenderWindow* getAutoCreatedWindow(void);
00468 
00471         RenderWindow* createRenderWindow(const String &name, unsigned int width, unsigned int height, 
00472             bool fullScreen, const NameValuePairList *miscParams = 0) ;
00473 
00476         void detachRenderTarget( RenderTarget* pWin );
00477 
00480         void detachRenderTarget( const String & name );
00481 
00484         RenderTarget * getRenderTarget(const String &name);
00485 
00502         void loadPlugin(const String& pluginName);
00503 
00511         void unloadPlugin(const String& pluginName);
00512 
00514         Timer* getTimer(void);
00515 
00535         bool _fireFrameStarted(FrameEvent& evt);
00552         bool _fireFrameEnded(FrameEvent& evt);
00570         bool _fireFrameStarted();
00585         bool _fireFrameEnded();
00586 
00588         unsigned long getCurrentFrameNumber(void) { return mCurrentFrame; }
00589 
00595         SceneManager* _getCurrentSceneManager(void) { return mCurrentSceneManager; }
00600         void _setCurrentSceneManager(SceneManager* sm) { mCurrentSceneManager = sm; }
00601 
00611         void _updateAllRenderTargets(void);
00612 
00628         static Root& getSingleton(void);
00644         static Root* getSingletonPtr(void);
00645 
00654         void clearEventTimes(void);
00655 
00656     };
00657 } // Namespace Ogre
00658 #endif

Copyright © 2000-2005 by The OGRE Team
Last modified Wed Feb 23 00:19:12 2005