#include <OgreRoot.h>
Inheritance diagram for Ogre::Root:
Public Methods | |
Root (const String &pluginFileName="plugins.cfg", const String &configFileName="ogre.cfg", const String &logFileName="Ogre.log") | |
Constructor. | |
~Root () | |
void | saveConfig (void) |
Saves the details of the current configuration. | |
bool | restoreConfig (void) |
Checks for saved video/sound/etc settings. | |
bool | showConfigDialog (void) |
Displays a dialog asking the user to choose system settings. | |
void | addRenderSystem (RenderSystem *newRend) |
Adds a new rendering subsystem to the list of available renderers. | |
void | setSceneManager (SceneType sType, SceneManager *sm) |
Sets the passed in SceneManager to be the one responsible for the indicated type of scene. | |
RenderSystemList * | getAvailableRenderers (void) |
Retrieve a list of the available render systems. | |
void | setRenderSystem (RenderSystem *system) |
Sets the rendering subsystem to be used. | |
RenderSystem * | getRenderSystem (void) |
Retrieve a pointer to the currently selected render system. | |
RenderWindow * | initialise (bool autoCreateWindow) |
Initialises the renderer. | |
SceneManager * | getSceneManager (SceneType sceneType) |
Gets a reference to a SceneManager object. | |
TextureManager * | getTextureManager (void) |
Retrieves a reference to the current TextureManager. | |
MeshManager * | getMeshManager (void) |
Retrieves a reference to the current MeshManager. | |
String | getErrorDescription (long errorNumber) |
Utility function for getting a better description of an error code. | |
void | addFrameListener (FrameListener *newListener) |
Registers a FrameListener which will be called back every frame. | |
void | removeFrameListener (FrameListener *oldListener) |
Removes a FrameListener from the list of listening classes. | |
void | startRendering (void) |
Starts / restarts the automatic rendering cycle. | |
void | shutdown (void) |
Shuts down the system manually. | |
void | addResourceLocation (const String &name, const String &locType, ResourceType resType=RESTYPE_ALL) |
Adds a location to the list of searchable locations for a Resource type. | |
void | convertColourValue (const ColourValue &colour, unsigned long *pDest) |
Generates a packed data version of the passed in ColourValue suitable for use with the current RenderSystem. | |
RenderWindow * | getAutoCreatedWindow (void) |
Retrieves a pointer to the window that was created automatically. | |
RenderWindow * | createRenderWindow (const String &name, unsigned int width, unsigned int height, unsigned int colourDepth, bool fullScreen, int left=0, int top=0, bool depthBuffer=true, RenderWindow *parentWindowHandle=0) |
Creates a new rendering window. | |
void | detachRenderTarget (RenderTarget *pWin) |
Destroys a rendering window. | |
void | detachRenderTarget (const String &name) |
Destroys a named rendering window. | |
RenderTarget * | getRenderTarget (const String &name) |
Retrieves a pointer to the a named render window. | |
void | loadPlugin (const String &pluginName) |
Manually load a plugin. | |
void | unloadPlugin (const String &pluginName) |
Manually unloads a plugin. | |
Timer * | getTimer (void) |
Gets a pointer to the central timer used for all OGRE timings. | |
bool | _fireFrameStarted (FrameEvent &evt) |
Method for raising frame started events. | |
bool | _fireFrameEnded (FrameEvent &evt) |
Method for raising frame ended events. | |
bool | _fireFrameStarted () |
Method for raising frame started events. | |
bool | _fireFrameEnded () |
Method for raising frame ended events. | |
Static Public Methods | |
void | termHandler () |
Root & | getSingleton (void) |
Override standard Singleton retrieval. | |
Root * | getSingletonPtr (void) |
Static Protected Attributes | |
Root * | ms_Singleton = 0 |
Private Types | |
enum | FrameEventTimeType { FETT_ANY, FETT_STARTED, FETT_ENDED } |
Indicates the type of event to be considered by calculateEventTime(). More... | |
Private Methods | |
void | loadPlugins (const String &pluginsfile="plugins.cfg") |
Method reads a plugins configuration file and instantiates all plugins. | |
void | unloadPlugins () |
Unloads all loaded plugins. | |
void | oneTimePostWindowInit (void) |
Real | calculateEventTime (unsigned long now, FrameEventTimeType type) |
Internal method for calculating the average time between recently fired events. | |
Private Attributes | |
RenderSystemList | mRenderers |
RenderSystem * | mActiveRenderer |
String | mVersion |
String | mConfigFileName |
LogManager * | mLogManager |
ControllerManager * | mControllerManager |
SceneManagerEnumerator * | mSceneManagerEnum |
DynLibManager * | mDynLibManager |
PlatformManager * | mPlatformManager |
ArchiveManager * | mArchiveManager |
MaterialManager * | mMaterialManager |
MeshManager * | mMeshManager |
ParticleSystemManager * | mParticleManager |
SkeletonManager * | mSkeletonManager |
GuiManager * | mGuiManager |
OverlayManager * | mOverlayManager |
FontManager * | mFontManager |
ArchiveFactory * | mZipArchiveFactory |
Codec * | mPNGCodec |
Codec * | mJPGCodec |
Codec * | mJPEGCodec |
Codec * | mTGACodec |
Codec * | mDDSCodec |
Codec * | mBMPCodec |
Timer * | mTimer |
RenderWindow * | mAutoWindow |
Profiler * | mProfiler |
HighLevelGpuProgramManager * | mHighLevelGpuProgramManager |
std::vector< DynLib * > | mPluginLibs |
std::set< FrameListener * > | mFrameListeners |
Set of registered frame listeners. | |
std::deque< unsigned long > | mEventTimes [3] |
Contains the times of recently fired events. | |
Friends | |
class | RenderSystem |
Definition at line 65 of file OgreRoot.h.
|
Indicates the type of event to be considered by calculateEventTime().
Definition at line 117 of file OgreRoot.h. |
|
Constructor.
Definition at line 107 of file OgreRoot.cpp. References Ogre::LogManager::createLog(), Ogre::PlatformManager::createTimer(), loadPlugins(), Ogre::LogManager::logMessage(), mActiveRenderer, mArchiveManager, mAutoWindow, mBMPCodec, mConfigFileName, mControllerManager, mDDSCodec, mDynLibManager, mFontManager, mGuiManager, mHighLevelGpuProgramManager, mJPEGCodec, mJPGCodec, mLogManager, mMaterialManager, mMeshManager, mOverlayManager, mParticleManager, mPlatformManager, mPNGCodec, mProfiler, mSceneManagerEnum, mSkeletonManager, mTGACodec, mTimer, mVersion, mZipArchiveFactory, and SET_TERM_HANDLER. |
|
Definition at line 223 of file OgreRoot.cpp. References Ogre::PlatformManager::destroyTimer(), mArchiveManager, mBMPCodec, mControllerManager, mDDSCodec, mDynLibManager, mFontManager, mGuiManager, mHighLevelGpuProgramManager, mJPEGCodec, mJPGCodec, mLogManager, mMaterialManager, mMeshManager, mOverlayManager, mParticleManager, mPlatformManager, mPNGCodec, mProfiler, mSceneManagerEnum, mSkeletonManager, mTGACodec, mTimer, mZipArchiveFactory, shutdown(), and unloadPlugins(). |
|
Method for raising frame ended events.
Definition at line 527 of file OgreRoot.cpp. References calculateEventTime(), FETT_ANY, FETT_ENDED, Ogre::Timer::getMilliseconds(), mTimer, Ogre::FrameEvent::timeSinceLastEvent, and Ogre::FrameEvent::timeSinceLastFrame. Referenced by startRendering(). |
|
Method for raising frame ended events.
Definition at line 505 of file OgreRoot.cpp. References mFrameListeners. |
|
Method for raising frame started events.
Definition at line 517 of file OgreRoot.cpp. References calculateEventTime(), FETT_ANY, FETT_STARTED, Ogre::Timer::getMilliseconds(), mTimer, Ogre::FrameEvent::timeSinceLastEvent, and Ogre::FrameEvent::timeSinceLastFrame. Referenced by startRendering(). |
|
Method for raising frame started events.
Definition at line 491 of file OgreRoot.cpp. References mFrameListeners. |
|
Registers a FrameListener which will be called back every frame.
Definition at line 477 of file OgreRoot.cpp. References mFrameListeners. |
|
Adds a new rendering subsystem to the list of available renderers.
Definition at line 409 of file OgreRoot.cpp. References mRenderers. |
|
Adds a location to the list of searchable locations for a Resource type.
Definition at line 679 of file OgreRoot.cpp. References Ogre::ResourceType, Ogre::RESTYPE_ALL, Ogre::RESTYPE_MODELS, and Ogre::RESTYPE_TEXTURES. |
|
Internal method for calculating the average time between recently fired events.
Definition at line 537 of file OgreRoot.cpp. References mEventTimes, and Ogre::Real. Referenced by _fireFrameEnded(), and _fireFrameStarted(). |
|
Generates a packed data version of the passed in ColourValue suitable for use with the current RenderSystem.
Definition at line 696 of file OgreRoot.cpp. References Ogre::RenderSystem::convertColourValue(), and mActiveRenderer. |
|
Creates a new rendering window.
Definition at line 707 of file OgreRoot.cpp. References Ogre::RenderSystem::createRenderWindow(), Except, mActiveRenderer, and oneTimePostWindowInit(). |
|
Destroys a named rendering window.
Definition at line 739 of file OgreRoot.cpp. References Ogre::RenderSystem::detachRenderTarget(), Except, and mActiveRenderer. |
|
Destroys a rendering window.
Definition at line 727 of file OgreRoot.cpp. References Ogre::RenderSystem::detachRenderTarget(), Except, Ogre::RenderTarget::getName(), and mActiveRenderer. |
|
Retrieves a pointer to the window that was created automatically.
Definition at line 702 of file OgreRoot.cpp. References mAutoWindow. |
|
Retrieve a list of the available render systems.
Definition at line 381 of file OgreRoot.cpp. References mRenderers, and Ogre::RenderSystemList. Referenced by restoreConfig(). |
|
Utility function for getting a better description of an error code.
Definition at line 450 of file OgreRoot.cpp. References Ogre::RenderSystem::getErrorDescription(), and mActiveRenderer. |
|
Retrieves a reference to the current MeshManager.
Definition at line 472 of file OgreRoot.cpp. |
|
Retrieve a pointer to the currently selected render system.
Definition at line 420 of file OgreRoot.cpp. References mActiveRenderer. |
|
Retrieves a pointer to the a named render window.
Definition at line 751 of file OgreRoot.cpp. References Except, Ogre::RenderSystem::getRenderTarget(), and mActiveRenderer. |
|
Gets a reference to a SceneManager object.
Definition at line 461 of file OgreRoot.cpp. References Ogre::SceneManagerEnumerator::getSceneManager(), mSceneManagerEnum, and Ogre::SceneType. |
|
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< Root >. Definition at line 619 of file OgreRoot.cpp. |
|
Definition at line 71 of file OgreSingleton.h. |
|
Retrieves a reference to the current TextureManager.
Definition at line 467 of file OgreRoot.cpp. |
|
Gets a pointer to the central timer used for all OGRE timings.
Definition at line 819 of file OgreRoot.cpp. References mTimer. |
|
Initialises the renderer.
Definition at line 428 of file OgreRoot.cpp. References Except, Ogre::RenderSystem::initialise(), mActiveRenderer, mAutoWindow, mControllerManager, mTimer, oneTimePostWindowInit(), and Ogre::Timer::reset(). |
|
Manually load a plugin.
Definition at line 782 of file OgreRoot.cpp. References Ogre::DLL_START_PLUGIN, Except, Ogre::DynLib::getSymbol(), and mPluginLibs. Referenced by loadPlugins(). |
|
Method reads a plugins configuration file and instantiates all plugins.
Definition at line 624 of file OgreRoot.cpp. References Ogre::ConfigFile::getMultiSetting(), Ogre::ConfigFile::getSetting(), Ogre::ConfigFile::load(), loadPlugin(), and Ogre::StringVector. Referenced by Root(). |
|
Definition at line 824 of file OgreRoot.cpp. References Ogre::ParticleSystemManager::_initialise(), Ogre::MaterialManager::initialise(), mFontManager, mMaterialManager, mOverlayManager, mParticleManager, Ogre::OverlayManager::parseAllSources(), and Ogre::FontManager::parseAllSources(). Referenced by createRenderWindow(), and initialise(). |
|
Removes a FrameListener from the list of listening classes.
Definition at line 485 of file OgreRoot.cpp. References mFrameListeners. |
|
Checks for saved video/sound/etc settings.
Definition at line 294 of file OgreRoot.cpp. References getAvailableRenderers(), Ogre::ConfigFile::getSetting(), Ogre::ConfigFile::getSettingsIterator(), Ogre::ConfigFile::load(), mActiveRenderer, mConfigFileName, Ogre::RenderSystem::setConfigOption(), and setRenderSystem(). |
|
Saves the details of the current configuration.
Definition at line 261 of file OgreRoot.cpp. References Ogre::ConfigOptionMap, Except, Ogre::RenderSystem::getConfigOptions(), Ogre::RenderSystem::getName(), mActiveRenderer, and mConfigFileName. |
|
Sets the rendering subsystem to be used.
Definition at line 390 of file OgreRoot.cpp. References mActiveRenderer, and Ogre::RenderSystem::shutdown(). Referenced by restoreConfig(). |
|
Sets the passed in SceneManager to be the one responsible for the indicated type of scene.
Definition at line 414 of file OgreRoot.cpp. References Ogre::SceneType. |
|
Displays a dialog asking the user to choose system settings.
Definition at line 363 of file OgreRoot.cpp. References Ogre::PlatformManager::createConfigDialog(), Ogre::PlatformManager::destroyConfigDialog(), Ogre::ConfigDialog::display(), Ogre::dlg, and mPlatformManager. |
|
Shuts down the system manually.
Definition at line 603 of file OgreRoot.cpp. References Ogre::LogManager::logMessage(), mActiveRenderer, mLogManager, and Ogre::RenderSystem::shutdown(). Referenced by ~Root(). |
|
Starts / restarts the automatic rendering cycle.
Definition at line 568 of file OgreRoot.cpp. References _fireFrameEnded(), _fireFrameStarted(), Ogre::RenderSystem::_initRenderTargets(), Ogre::RenderSystem::_updateAllRenderTargets(), mActiveRenderer, and mEventTimes. |
|
Definition at line 99 of file OgreRoot.cpp. References Ogre::handleTerminate(). |
|
Manually unloads a plugin.
Definition at line 798 of file OgreRoot.cpp. References Ogre::DLL_STOP_PLUGIN, and mPluginLibs. |
|
Unloads all loaded plugins.
Definition at line 659 of file OgreRoot.cpp. References Ogre::DLL_STOP_PLUGIN, and mPluginLibs. Referenced by ~Root(). |
|
Definition at line 69 of file OgreRoot.h. |
|
Definition at line 72 of file OgreRoot.h. Referenced by convertColourValue(), createRenderWindow(), detachRenderTarget(), getErrorDescription(), getRenderSystem(), getRenderTarget(), initialise(), restoreConfig(), Root(), saveConfig(), setRenderSystem(), shutdown(), and startRendering(). |
|
Definition at line 82 of file OgreRoot.h. |
|
Definition at line 93 of file OgreRoot.h. Referenced by getAutoCreatedWindow(), initialise(), and Root(). |
|
Definition at line 91 of file OgreRoot.h. |
|
Definition at line 74 of file OgreRoot.h. Referenced by restoreConfig(), Root(), and saveConfig(). |
|
Definition at line 78 of file OgreRoot.h. Referenced by initialise(), Root(), and ~Root(). |
|
Definition at line 91 of file OgreRoot.h. |
|
Definition at line 80 of file OgreRoot.h. |
|
Contains the times of recently fired events.
Definition at line 122 of file OgreRoot.h. Referenced by calculateEventTime(), and startRendering(). |
|
Definition at line 89 of file OgreRoot.h. Referenced by oneTimePostWindowInit(), Root(), and ~Root(). |
|
Set of registered frame listeners.
Definition at line 113 of file OgreRoot.h. Referenced by _fireFrameEnded(), _fireFrameStarted(), addFrameListener(), and removeFrameListener(). |
|
Definition at line 87 of file OgreRoot.h. |
|
Definition at line 95 of file OgreRoot.h. |
|
Definition at line 91 of file OgreRoot.h. |
|
Definition at line 91 of file OgreRoot.h. |
|
Definition at line 77 of file OgreRoot.h. |
|
Definition at line 83 of file OgreRoot.h. Referenced by oneTimePostWindowInit(), Root(), and ~Root(). |
|
Definition at line 84 of file OgreRoot.h. |
|
Definition at line 88 of file OgreRoot.h. Referenced by oneTimePostWindowInit(), Root(), and ~Root(). |
|
Definition at line 85 of file OgreRoot.h. Referenced by oneTimePostWindowInit(), Root(), and ~Root(). |
|
Definition at line 81 of file OgreRoot.h. Referenced by Root(), showConfigDialog(), and ~Root(). |
|
Definition at line 97 of file OgreRoot.h. Referenced by loadPlugin(), unloadPlugin(), and unloadPlugins(). |
|
Definition at line 91 of file OgreRoot.h. |
|
Definition at line 94 of file OgreRoot.h. |
|
Definition at line 71 of file OgreRoot.h. Referenced by addRenderSystem(), and getAvailableRenderers(). |
|
Definition at line 105 of file OgreRoot.cpp. |
|
Definition at line 79 of file OgreRoot.h. Referenced by getSceneManager(), Root(), and ~Root(). |
|
Definition at line 86 of file OgreRoot.h. |
|
Definition at line 91 of file OgreRoot.h. |
|
Definition at line 92 of file OgreRoot.h. Referenced by _fireFrameEnded(), _fireFrameStarted(), getTimer(), initialise(), Root(), and ~Root(). |
|
Definition at line 73 of file OgreRoot.h. Referenced by Root(). |
|
Definition at line 90 of file OgreRoot.h. |
Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:19:52 2004