#include <OgreRoot.h>
Inheritance diagram for Ogre::Root:

Public Member Functions | |||||||||||
| 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, const String &windowTitle="OGRE Render Window") | ||||||||||
| 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 | queueEndRendering (void) | ||||||||||
| Queues the end of rendering. | |||||||||||
| void | startRendering (void) | ||||||||||
| Starts / restarts the automatic rendering cycle. | |||||||||||
| bool | renderOneFrame (void) | ||||||||||
| Render one frame. | |||||||||||
| void | shutdown (void) | ||||||||||
| Shuts down the system manually. | |||||||||||
| void | addResourceLocation (const String &name, const String &locType, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, bool recursive=false) | ||||||||||
| Adds a location to the list of searchable locations for a Resource type. | |||||||||||
| void | removeResourceLocation (const String &name, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) | ||||||||||
| Removes a resource location from the list. | |||||||||||
| void | convertColourValue (const ColourValue &colour, uint32 *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, bool fullScreen, const NameValuePairList *miscParams=0) | ||||||||||
Key: "colourDepth" Description: Colour depth of the resulting rendering window; only applies if fullScreen is set. Values: 16 or 32 Default: desktop depth Notes: [W32 specific] Key: "left" Description: screen x coordinate from left Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen Key: "top" Description: screen y coordinate from top Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen Key: "depthBuffer" [DX9 specific] Description: Use depth buffer Values: false or true Default: true Key: "externalWindowHandle" [API specific] Description: External window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) for GLX Default: 0 (None) Key: "parentWindowHandle" [API specific] Description: Parent window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong for GLX (display*:screen:windowHandle) Default: 0 (None) Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0 Key: "displayFrequency" Description: Display frequency rate, for fullscreen mode Values: 60...? Default: Desktop vsync rate Key: "vsync" Description: Synchronize buffer swaps to vsync Values: true, false Default: 0 Key: "border" Description: The type of window border (in windowed mode) Values: none, fixed, resize Default: resize
Key: "outerDimensions" Description: Whether the width/height is expressed as the size of the outer window, rather than the content area Values: true, false Default: false | |||||||||||
| 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. | |||||||||||
| unsigned long | getCurrentFrameNumber (void) const | ||||||||||
| Gets the number of the current frame. | |||||||||||
| SceneManager * | _getCurrentSceneManager (void) const | ||||||||||
| Returns the scene manager currently being used to render a frame. | |||||||||||
| void | _setCurrentSceneManager (SceneManager *sm) | ||||||||||
| Sets the scene manager currently being used to render a frame. | |||||||||||
| void | _updateAllRenderTargets (void) | ||||||||||
| Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update. | |||||||||||
| void | clearEventTimes (void) | ||||||||||
| Clears the history of all event times. | |||||||||||
Static Public Member Functions | |||||||||||
| void | termHandler () | ||||||||||
| Root & | getSingleton (void) | ||||||||||
| Override standard Singleton retrieval. | |||||||||||
| Root * | getSingletonPtr (void) | ||||||||||
| Override standard Singleton retrieval. | |||||||||||
Static Protected Attributes | |||||||||||
| Root * | ms_Singleton | ||||||||||
Private Types | |||||||||||
| enum | FrameEventTimeType { FETT_ANY, FETT_STARTED, FETT_ENDED } | ||||||||||
| Indicates the type of event to be considered by calculateEventTime(). More... | |||||||||||
Private Member Functions | |||||||||||
| void | loadPlugins (const String &pluginsfile="plugins.cfg") | ||||||||||
| Method reads a plugins configuration file and instantiates all plugins. | |||||||||||
| void | shutdownPlugins () | ||||||||||
| Shuts down all loaded plugins - allows things to be tidied up whilst all plugins are still loaded. | |||||||||||
| 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 | ||||||||||
| bool | mQueuedEnd | ||||||||||
| bool | mFirstTimePostWindowInit | ||||||||||
| LogManager * | mLogManager | ||||||||||
| ControllerManager * | mControllerManager | ||||||||||
| SceneManagerEnumerator * | mSceneManagerEnum | ||||||||||
| SceneManager * | mCurrentSceneManager | ||||||||||
| DynLibManager * | mDynLibManager | ||||||||||
| PlatformManager * | mPlatformManager | ||||||||||
| ArchiveManager * | mArchiveManager | ||||||||||
| MaterialManager * | mMaterialManager | ||||||||||
| MeshManager * | mMeshManager | ||||||||||
| ParticleSystemManager * | mParticleManager | ||||||||||
| SkeletonManager * | mSkeletonManager | ||||||||||
| OverlayElementFactory * | mPanelFactory | ||||||||||
| OverlayElementFactory * | mBorderPanelFactory | ||||||||||
| OverlayElementFactory * | mTextAreaFactory | ||||||||||
| OverlayManager * | mOverlayManager | ||||||||||
| FontManager * | mFontManager | ||||||||||
| ArchiveFactory * | mZipArchiveFactory | ||||||||||
| ArchiveFactory * | mFileSystemArchiveFactory | ||||||||||
| ResourceGroupManager * | mResourceGroupManager | ||||||||||
| ResourceBackgroundQueue * | mResourceBackgroundQueue | ||||||||||
| Timer * | mTimer | ||||||||||
| RenderWindow * | mAutoWindow | ||||||||||
| Profiler * | mProfiler | ||||||||||
| HighLevelGpuProgramManager * | mHighLevelGpuProgramManager | ||||||||||
| ExternalTextureSourceManager * | mExternalTextureSourceManager | ||||||||||
| unsigned long | mCurrentFrame | ||||||||||
| std::vector< DynLib * > | mPluginLibs | ||||||||||
| std::set< FrameListener * > | mFrameListeners | ||||||||||
| Set of registered frame listeners. | |||||||||||
| std::set< FrameListener * > | mRemovedFrameListeners | ||||||||||
| Set of frame listeners marked for removal. | |||||||||||
| std::deque< unsigned long > | mEventTimes [3] | ||||||||||
| Contains the times of recently fired events. | |||||||||||
Friends | |||||||||||
| class | RenderSystem | ||||||||||
Definition at line 61 of file OgreRoot.h.
|
|
Indicates the type of event to be considered by calculateEventTime().
Definition at line 131 of file OgreRoot.h. |
|
||||||||||||||||
|
Constructor.
|
|
|
|
|
|
Method for raising frame ended events.
|
|
|
Method for raising frame ended events.
|
|
|
Method for raising frame started events.
|
|
|
Method for raising frame started events.
|
|
|
Returns the scene manager currently being used to render a frame.
Definition at line 602 of file OgreRoot.h. |
|
|
Sets the scene manager currently being used to render a frame.
Definition at line 607 of file OgreRoot.h. |
|
|
Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update.
|
|
|
Registers a FrameListener which will be called back every frame.
|
|
|
Adds a new rendering subsystem to the list of available renderers.
|
|
||||||||||||||||||||
|
Adds a location to the list of searchable locations for a Resource type.
|
|
||||||||||||
|
Internal method for calculating the average time between recently fired events.
|
|
|
Clears the history of all event times.
|
|
||||||||||||
|
Generates a packed data version of the passed in ColourValue suitable for use with the current RenderSystem.
|
|
||||||||||||||||||||||||
|
Key: "colourDepth" Description: Colour depth of the resulting rendering window; only applies if fullScreen is set. Values: 16 or 32 Default: desktop depth Notes: [W32 specific] Key: "left" Description: screen x coordinate from left Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen Key: "top" Description: screen y coordinate from top Values: positive integers Default: 'center window on screen' Notes: Ignored in case of full screen Key: "depthBuffer" [DX9 specific] Description: Use depth buffer Values: false or true Default: true Key: "externalWindowHandle" [API specific] Description: External window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) for GLX Default: 0 (None) Key: "parentWindowHandle" [API specific] Description: Parent window handle, for embedding the OGRE context Values: positive integer for W32 (HWND handle) poslong:posint:poslong for GLX (display*:screen:windowHandle) Default: 0 (None) Key: "FSAA" Description: Full screen antialiasing factor Values: 0,2,4,6,... Default: 0 Key: "displayFrequency" Description: Display frequency rate, for fullscreen mode Values: 60...? Default: Desktop vsync rate Key: "vsync" Description: Synchronize buffer swaps to vsync Values: true, false Default: 0 Key: "border" Description: The type of window border (in windowed mode) Values: none, fixed, resize Default: resize Key: "outerDimensions" Description: Whether the width/height is expressed as the size of the outer window, rather than the content area Values: true, false Default: false
|
|
|
Destroys a named rendering window.
|
|
|
Destroys a rendering window.
|
|
|
Retrieves a pointer to the window that was created automatically.
|
|
|
Retrieve a list of the available render systems.
|
|
|
Gets the number of the current frame.
Definition at line 595 of file OgreRoot.h. |
|
|
Utility function for getting a better description of an error code.
|
|
|
Retrieves a reference to the current MeshManager.
|
|
|
Retrieve a pointer to the currently selected render system.
|
|
|
Retrieves a pointer to the a named render window.
|
|
|
Gets a reference to a SceneManager object.
|
|
|
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< Root >. |
|
|
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< Root >. |
|
|
Retrieves a reference to the current TextureManager.
|
|
|
Gets a pointer to the central timer used for all OGRE timings.
|
|
||||||||||||
|
Initialises the renderer.
|
|
|
Manually load a plugin.
|
|
|
Method reads a plugins configuration file and instantiates all plugins.
|
|
|
|
|
|
Queues the end of rendering.
|
|
|
Removes a FrameListener from the list of listening classes.
|
|
||||||||||||
|
Removes a resource location from the list.
|
|
|
Render one frame.
|
|
|
Checks for saved video/sound/etc settings.
|
|
|
Saves the details of the current configuration.
|
|
|
Sets the rendering subsystem to be used.
|
|
||||||||||||
|
Sets the passed in SceneManager to be the one responsible for the indicated type of scene.
|
|
|
Displays a dialog asking the user to choose system settings.
|
|
|
Shuts down the system manually.
|
|
|
Shuts down all loaded plugins - allows things to be tidied up whilst all plugins are still loaded.
|
|
|
Starts / restarts the automatic rendering cycle.
|
|
|
|
|
|
Manually unloads a plugin.
|
|
|
Unloads all loaded plugins.
|
|
|
Definition at line 65 of file OgreRoot.h. |
|
|
Definition at line 68 of file OgreRoot.h. |
|
|
Definition at line 82 of file OgreRoot.h. |
|
|
Definition at line 98 of file OgreRoot.h. |
|
|
Definition at line 88 of file OgreRoot.h. |
|
|
Definition at line 70 of file OgreRoot.h. |
|
|
Definition at line 77 of file OgreRoot.h. |
|
|
Definition at line 102 of file OgreRoot.h. |
|
|
Definition at line 79 of file OgreRoot.h. |
|
|
Definition at line 80 of file OgreRoot.h. |
|
|
Contains the times of recently fired events.
Definition at line 136 of file OgreRoot.h. |
|
|
Definition at line 101 of file OgreRoot.h. |
|
|
Definition at line 93 of file OgreRoot.h. |
|
|
Definition at line 73 of file OgreRoot.h. |
|
|
Definition at line 91 of file OgreRoot.h. |
|
|
Set of registered frame listeners.
Definition at line 125 of file OgreRoot.h. |
|
|
Definition at line 100 of file OgreRoot.h. |
|
|
Definition at line 76 of file OgreRoot.h. |
|
|
Definition at line 83 of file OgreRoot.h. |
|
|
Definition at line 84 of file OgreRoot.h. |
|
|
Definition at line 90 of file OgreRoot.h. |
|
|
Definition at line 87 of file OgreRoot.h. |
|
|
Definition at line 85 of file OgreRoot.h. |
|
|
Definition at line 81 of file OgreRoot.h. |
|
|
Definition at line 104 of file OgreRoot.h. |
|
|
Definition at line 99 of file OgreRoot.h. |
|
|
Definition at line 71 of file OgreRoot.h. |
|
|
Set of frame listeners marked for removal.
Definition at line 128 of file OgreRoot.h. |
|
|
Definition at line 67 of file OgreRoot.h. |
|
|
Definition at line 95 of file OgreRoot.h. |
|
|
Definition at line 94 of file OgreRoot.h. |
|
|
Definition at line 54 of file OgreSingleton.h. |
|
|
Definition at line 78 of file OgreRoot.h. |
|
|
Definition at line 86 of file OgreRoot.h. |
|
|
Definition at line 89 of file OgreRoot.h. |
|
|
Definition at line 97 of file OgreRoot.h. |
|
|
Definition at line 69 of file OgreRoot.h. |
|
|
Definition at line 92 of file OgreRoot.h. |
Copyright © 2000-2005 by The OGRE Team
Last modified Sun Nov 20 12:39:11 2005