Ogre::Root

Ogre::Root Class Reference

The root class of the Ogre system. More...

#include <OgreRoot.h>

Inheritance diagram for Ogre::Root:

Inheritance graph
[legend]

List of all members.

Public Types

typedef std::vector
< DynLib * > 		PluginLibList
typedef std::vector
< Plugin * > 		PluginInstanceList
typedef
ConstMapIterator
< MovableObjectFactoryMap > 		MovableObjectFactoryIterator

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.
RenderSystemList * getAvailableRenderers (void)
 Retrieve a list of the available render systems.
RenderSystem * getRenderSystemByName (const String &name)
 Retrieve a pointer to the render system by the given name.
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", const String &customCapabilitiesConfig=StringUtil::BLANK)
 Initialises the renderer.
bool isInitialised (void) const
 Returns whether the system is initialised or not.
void useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities)
 Requests active RenderSystem to use custom RenderSystemCapabilities.
void addSceneManagerFactory (SceneManagerFactory *fact)
 Register a new SceneManagerFactory, a factory object for creating instances of specific SceneManagers.
void removeSceneManagerFactory (SceneManagerFactory *fact)
 Unregister a SceneManagerFactory.
const
SceneManagerMetaData * 		getSceneManagerMetaData (const String &typeName) const
 Get more information about a given type of SceneManager.
SceneManagerEnumerator::MetaDataIterator getSceneManagerMetaDataIterator (void) const
 Iterate over all types of SceneManager available for construction, providing some information about each one.
SceneManager * createSceneManager (const String &typeName, const String &instanceName=StringUtil::BLANK)
 Create a SceneManager instance of a given type.
SceneManager * createSceneManager (SceneTypeMask typeMask, const String &instanceName=StringUtil::BLANK)
 Create a SceneManager instance based on scene type support.
void destroySceneManager (SceneManager *sm)
 Destroy an instance of a SceneManager.
SceneManager * getSceneManager (const String &instanceName) const
 Get an existing SceneManager instance that has already been created, identified by the instance name.
SceneManagerEnumerator::SceneManagerIterator getSceneManagerIterator (void)
 Get an iterator over all the existing SceneManager instances.
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)
 Creates a new rendering window.

Remarks:
This method creates a new rendering window as specified by the paramteters. The rendering system could be responible for only a single window (e.g. in the case of a game), or could be in charge of multiple ones (in the case of a level editor). The option to create the window as a child of another is therefore given. This method will create an appropriate subclass of RenderWindow depending on the API and platform implementation.
After creation, this window can be retrieved using getRenderTarget().
Parameters:
name The name of the window. Used in other methods later like setRenderTarget and getRenderWindow.
width The width of the new window.
height The height of the new window.
fullScreen Specify true to make the window full screen without borders, title bar or menu bar.
miscParams A NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platforms unless indicated otherwise:
Key: "title" Description: The title of the window that will appear in the title bar Values: string Default: RenderTarget name

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: "externalGLControl" [Win32 OpenGL specific] Description: Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls. The Ogre OpenGL context can be retrieved after Ogre initialisation by calling wglGetCurrentDC() and wglGetCurrentContext(). It is only used when the externalWindowHandle parameter is used. Values: true, false Default: false

Key: "externalGLContext" [Win32 OpenGL specific] Description: Use an externally created GL context Values: <Context as="" unsigned="" long>=""> Default: 0 (create own context)

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

Key: "useNVPerfHUD" [DX9 specific] Description: Enable the use of nVidia NVPerfHUD Values: true, false Default: false

Key: "gamma" Description: Enable hardware conversion from linear colour space to gamma colour space on rendering to the window. 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 contained in a DLL / DSO.
void unloadPlugin (const String &pluginName)
 Manually unloads a Plugin contained in a DLL / DSO.
void installPlugin (Plugin *plugin)
 Install a new plugin.
void uninstallPlugin (Plugin *plugin)
 Uninstall an existing plugin.
const
PluginInstanceList & 		getInstalledPlugins () const
 Gets a read-only list of the currently installed plugins.
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 _fireFrameRenderingQueued (FrameEvent &evt)
 Method for raising frame rendering queued events.
bool _fireFrameEnded (FrameEvent &evt)
 Method for raising frame ended events.
bool _fireFrameStarted ()
 Method for raising frame started events.
bool _fireFrameRenderingQueued ()
 Method for raising frame rendering queued events.
bool _fireFrameEnded ()
 Method for raising frame ended events.
unsigned long getNextFrameNumber (void) const
 Gets the number of the next frame to be rendered.
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.
bool _updateAllRenderTargets (void)
 Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update.
RenderQueueInvocationSequence * createRenderQueueInvocationSequence (const String &name)
 Create a new RenderQueueInvocationSequence, useful for linking to Viewport instances to perform custom rendering.
RenderQueueInvocationSequence * getRenderQueueInvocationSequence (const String &name)
 Get a RenderQueueInvocationSequence.
void destroyRenderQueueInvocationSequence (const String &name)
 Destroy a RenderQueueInvocationSequence.
void destroyAllRenderQueueInvocationSequences (void)
 Destroy all RenderQueueInvocationSequences.
void clearEventTimes (void)
 Clears the history of all event times.
void setFrameSmoothingPeriod (Real period)
 Sets the period over which OGRE smooths out fluctuations in frame times.
Real getFrameSmoothingPeriod (void) const
 Gets the period over which OGRE smooths out fluctuations in frame times.
void addMovableObjectFactory (MovableObjectFactory *fact, bool overrideExisting=false)
 Register a new MovableObjectFactory which will create new MovableObject instances of a particular type, as identified by the getType() method.
void removeMovableObjectFactory (MovableObjectFactory *fact)
 Removes a previously registered MovableObjectFactory.
bool hasMovableObjectFactory (const String &typeName) const
 Checks whether a factory is registered for a given MovableObject type.
MovableObjectFactory * getMovableObjectFactory (const String &typeName)
 Get a MovableObjectFactory for the given type.
uint32 _allocateNextMovableObjectTypeFlag (void)
 Allocate the next MovableObject type flag.
MovableObjectFactoryIterator getMovableObjectFactoryIterator (void) const
 Return an iterator over all the MovableObjectFactory instances currently registered.
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
void * operator new (size_t sz)
void * operator new (size_t sz, void *ptr)
 placement operator new
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
void * operator new[] (size_t sz)
void operator delete (void *ptr)
void operator delete (void *ptr, const char *, int, const char *)
void operator delete[] (void *ptr)
void operator delete[] (void *ptr, const char *, int, const char *)

Static Public Member Functions

static Root & getSingleton (void)
 Override standard Singleton retrieval.
static Root * getSingletonPtr (void)
 Override standard Singleton retrieval.

Protected Types

enum  FrameEventTimeType {
  FETT_ANY = 0, FETT_STARTED = 1, FETT_QUEUED = 2, FETT_ENDED = 3,
  FETT_COUNT = 4
}
 Indicates the type of event to be considered by calculateEventTime(). More...
typedef std::map
< String,
MovableObjectFactory * > 		MovableObjectFactoryMap
typedef std::map
< String,
RenderQueueInvocationSequence * > 		RenderQueueInvocationSequenceMap

Protected Member Functions

void loadPlugins (const String &pluginsfile="plugins.cfg")
 Method reads a plugins configuration file and instantiates all plugins.
void initialisePlugins ()
 Initialise all loaded plugins - allows plugins to perform actions once the renderer is initialised.
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.

Protected Attributes

PluginLibList mPluginLibs
 List of plugin DLLs loaded.
PluginInstanceList mPlugins
 List of Plugin instances registered.
MovableObjectFactoryMap mMovableObjectFactoryMap
uint32 mNextMovableObjectTypeFlag
MovableObjectFactory * mEntityFactory
MovableObjectFactory * mLightFactory
MovableObjectFactory * mBillboardSetFactory
MovableObjectFactory * mManualObjectFactory
MovableObjectFactory * mBillboardChainFactory
MovableObjectFactory * mRibbonTrailFactory
RenderQueueInvocationSequenceMap mRQSequenceMap
bool mIsInitialised
 Are we initialised yet?
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 [FETT_COUNT]
 Contains the times of recently fired events.

Static Protected Attributes

static T * ms_Singleton

Private Attributes

RenderSystemList mRenderers
RenderSystem * mActiveRenderer
String mVersion
String mConfigFileName
bool mQueuedEnd
bool mFirstTimePostWindowInit
LogManager * mLogManager
ControllerManager * mControllerManager
SceneManagerEnumerator * mSceneManagerEnum
SceneManager * mCurrentSceneManager
DynLibManager * mDynLibManager
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
ShadowTextureManager * mShadowTextureManager
RenderSystemCapabilitiesManager * mRenderSystemCapabilitiesManager
ScriptCompilerManager * mCompilerManager
Timer * mTimer
RenderWindow * mAutoWindow
Profiler * mProfiler
HighLevelGpuProgramManager * mHighLevelGpuProgramManager
ExternalTextureSourceManager * mExternalTextureSourceManager
CompositorManager * mCompositorManager
unsigned long mNextFrame
Real mFrameSmoothingTime

Friends

class RenderSystem

Detailed Description

The root class of the Ogre system.

Remarks:
The Ogre::Root class represents a starting point for the client application. From here, the application can gain access to the fundamentals of the system, namely the rendering systems available, management of saved configurations, logging, and access to other classes in the system. Acts as a hub from which all other objects may be reached. An instance of Root must be created before any other Ogre operations are called. Once an instance has been created, the same instance is accessible throughout the life of that object by using Root::getSingleton (as a reference) or Root::getSingletonPtr (as a pointer).

Definition at line 59 of file OgreRoot.h.

Member Typedef Documentation

typedef std::vector<DynLib*> Ogre::Root::PluginLibList

Definition at line 107 of file OgreRoot.h.

typedef std::vector<Plugin*> Ogre::Root::PluginInstanceList

Definition at line 108 of file OgreRoot.h.

typedef std::map<String, MovableObjectFactory*> Ogre::Root::MovableObjectFactoryMap [protected]

Definition at line 115 of file OgreRoot.h.

typedef std::map<String, RenderQueueInvocationSequence*> Ogre::Root::RenderQueueInvocationSequenceMap [protected]

Definition at line 126 of file OgreRoot.h.

typedef ConstMapIterator<MovableObjectFactoryMap> Ogre::Root::MovableObjectFactoryIterator

Definition at line 881 of file OgreRoot.h.

Member Enumeration Documentation

enum Ogre::Root::FrameEventTimeType [protected]

Indicates the type of event to be considered by calculateEventTime().

Enumerator:
FETT_ANY 
FETT_STARTED 
FETT_QUEUED 
FETT_ENDED 
FETT_COUNT 

Definition at line 162 of file OgreRoot.h.

Constructor & Destructor Documentation

Ogre::Root::Root ( const String &  pluginFileName = "plugins.cfg",
const String &  configFileName = "ogre.cfg",
const String &  logFileName = "Ogre.log" 
)

Constructor.

Parameters:
pluginFileName The file that contains plugins information. Defaults to "plugins.cfg", may be left blank to ignore.
configFileName The file that contains the configuration to be loaded. Defaults to "ogre.cfg", may be left blank to load nothing.
logFileName The logfile to create, defaults to Ogre.log, may be left blank if you've already set up LogManager & Log yourself

Ogre::Root::~Root (  ) 

Member Function Documentation

void Ogre::Root::loadPlugins ( const String &  pluginsfile = "plugins.cfg"  )  [protected]

Method reads a plugins configuration file and instantiates all plugins.

Parameters:
pluginsfile The file that contains plugins information. Defaults to "plugins.cfg".

void Ogre::Root::initialisePlugins (  )  [protected]

Initialise all loaded plugins - allows plugins to perform actions once the renderer is initialised.

void Ogre::Root::shutdownPlugins (  )  [protected]

Shuts down all loaded plugins - allows things to be tidied up whilst all plugins are still loaded.

void Ogre::Root::unloadPlugins (  )  [protected]

Unloads all loaded plugins.

void Ogre::Root::oneTimePostWindowInit ( void   )  [protected]

Real Ogre::Root::calculateEventTime ( unsigned long  now,
FrameEventTimeType  type 
) [protected]

Internal method for calculating the average time between recently fired events.

Parameters:
now The current time in ms.
type The type of event to be considered.

void Ogre::Root::saveConfig ( void   ) 

Saves the details of the current configuration.

Remarks:
Stores details of the current configuration so it may be restored later on.

bool Ogre::Root::restoreConfig ( void   ) 

Checks for saved video/sound/etc settings.

Remarks:
This method checks to see if there is a valid saved configuration from a previous run. If there is, the state of the system will be restored to that configuration.
Returns:
If a valid configuration was found, true is returned.
If there is no saved configuration, or if the system failed with the last config settings, false is returned.

bool Ogre::Root::showConfigDialog ( void   ) 

Displays a dialog asking the user to choose system settings.

Remarks:
This method displays the default dialog allowing the user to choose the rendering system, video mode etc. If there is are any settings saved already, they will be restored automatically before displaying the dialogue. When the user accepts a group of settings, this will automatically call Root::setRenderSystem, RenderSystem::setConfigOption and Root::saveConfig with the user's choices. This is the easiest way to get the system configured.
Returns:
If the user clicked 'Ok', true is returned.
If they clicked 'Cancel' (in which case the app should strongly consider terminating), false is returned.

void Ogre::Root::addRenderSystem ( RenderSystem *  newRend  ) 

Adds a new rendering subsystem to the list of available renderers.

Remarks:
Intended for use by advanced users and plugin writers only! Calling this method with a pointer to a valid RenderSystem (subclass) adds a rendering API implementation to the list of available ones. Typical examples would be an OpenGL implementation and a Direct3D implementation.
Note:

This should usually be called from the dllStartPlugin() function of an extension plug-in.

RenderSystemList* Ogre::Root::getAvailableRenderers ( void   ) 

Retrieve a list of the available render systems.

Remarks:
Retrieves a pointer to the list of available renderers as a list of RenderSystem subclasses. Can be used to build a custom settings dialog.

RenderSystem* Ogre::Root::getRenderSystemByName ( const String &  name  ) 

Retrieve a pointer to the render system by the given name.

Parameters:
name Name of the render system intend to retrieve.
Returns:
A pointer to the render system, NULL if no found.

void Ogre::Root::setRenderSystem ( RenderSystem *  system  ) 

Sets the rendering subsystem to be used.

Remarks:
This method indicates to OGRE which rendering system is to be used (e.g. Direct3D, OpenGL etc). This is called automatically by the default config dialog, and when settings are restored from a previous configuraion. If used manually it could be used to set the renderer from a custom settings dialog. Once this has been done, the renderer can be initialised using Root::initialise.
This method is also called by render systems if they are initialised directly.
Parameters:
system Pointer to the render system to use.
See also:
RenderSystem

RenderSystem* Ogre::Root::getRenderSystem ( void   ) 

Retrieve a pointer to the currently selected render system.

RenderWindow* Ogre::Root::initialise ( bool  autoCreateWindow,
const String &  windowTitle = "OGRE Render Window",
const String &  customCapabilitiesConfig = StringUtil::BLANK 
)

Initialises the renderer.

Remarks:
This method can only be called after a renderer has been selected with Root::setRenderSystem, and it will initialise the selected rendering system ready for use.
Parameters:
autoCreateWindow If true, a rendering window will automatically be created (saving a call to Root::createRenderWindow). The window will be created based on the options currently set on the render system.
Returns:
A pointer to the automatically created window, if requested, otherwise NULL.

bool Ogre::Root::isInitialised ( void   )  const

Returns whether the system is initialised or not.

Definition at line 303 of file OgreRoot.h.

void Ogre::Root::useCustomRenderSystemCapabilities ( RenderSystemCapabilities *  capabilities  ) 

Requests active RenderSystem to use custom RenderSystemCapabilities.

Remarks:
This is useful for testing how the RenderSystem would behave on a machine with less advanced GPUs. This method MUST be called before creating the first RenderWindow

void Ogre::Root::addSceneManagerFactory ( SceneManagerFactory *  fact  ) 

Register a new SceneManagerFactory, a factory object for creating instances of specific SceneManagers.

Remarks:
Plugins should call this to register as new SceneManager providers.

void Ogre::Root::removeSceneManagerFactory ( SceneManagerFactory *  fact  ) 

Unregister a SceneManagerFactory.

const SceneManagerMetaData* Ogre::Root::getSceneManagerMetaData ( const String &  typeName  )  const

Get more information about a given type of SceneManager.

Remarks:
The metadata returned tells you a few things about a given type of SceneManager, which can be created using a factory that has been registered already.
Parameters:
typeName The type name of the SceneManager you want to enquire on. If you don't know the typeName already, you can iterate over the metadata for all types using getMetaDataIterator.

SceneManagerEnumerator::MetaDataIterator Ogre::Root::getSceneManagerMetaDataIterator ( void   )  const

Iterate over all types of SceneManager available for construction, providing some information about each one.

SceneManager* Ogre::Root::createSceneManager ( const String &  typeName,
const String &  instanceName = StringUtil::BLANK 
)

Create a SceneManager instance of a given type.

Remarks:
You can use this method to create a SceneManager instance of a given specific type. You may know this type already, or you may have discovered it by looking at the results from getMetaDataIterator.
Note:
This method throws an exception if the named type is not found.
Parameters:
typeName String identifying a unique SceneManager type
instanceName Optional name to given the new instance that is created. If you leave this blank, an auto name will be assigned.

SceneManager* Ogre::Root::createSceneManager ( SceneTypeMask  typeMask,
const String &  instanceName = StringUtil::BLANK 
)

Create a SceneManager instance based on scene type support.

Remarks:
Creates an instance of a SceneManager which supports the scene types identified in the parameter. If more than one type of SceneManager has been registered as handling that combination of scene types, in instance of the last one registered is returned.
Note:
This method always succeeds, if a specific scene manager is not found, the default implementation is always returned.
Parameters:
typeMask A mask containing one or more SceneType flags
instanceName Optional name to given the new instance that is created. If you leave this blank, an auto name will be assigned.

void Ogre::Root::destroySceneManager ( SceneManager *  sm  ) 

Destroy an instance of a SceneManager.

SceneManager* Ogre::Root::getSceneManager ( const String &  instanceName  )  const

Get an existing SceneManager instance that has already been created, identified by the instance name.

Parameters:
instanceName The name of the instance to retrieve.

SceneManagerEnumerator::SceneManagerIterator Ogre::Root::getSceneManagerIterator ( void   ) 

Get an iterator over all the existing SceneManager instances.

TextureManager* Ogre::Root::getTextureManager ( void   ) 

Retrieves a reference to the current TextureManager.

Remarks:
This performs the same function as TextureManager::getSingleton, but is provided for convenience particularly to scripting engines.
Note that a TextureManager will NOT be available until the Ogre system has been initialised by selecting a RenderSystem, calling Root::initialise and a window having been created (this may have been done by initialise if required). This is because the exact runtime subclass which will be implementing the calls will differ depending on the rendering engine selected, and these typically require a window upon which to base texture format decisions.

MeshManager* Ogre::Root::getMeshManager ( void   ) 

Retrieves a reference to the current MeshManager.

Remarks:
This performs the same function as MeshManager::getSingleton and is provided for convenience to scripting engines.

String Ogre::Root::getErrorDescription ( long  errorNumber  ) 

Utility function for getting a better description of an error code.

void Ogre::Root::addFrameListener ( FrameListener *  newListener  ) 

Registers a FrameListener which will be called back every frame.

Remarks:
A FrameListener is a class which implements methods which will be called every frame.
See the FrameListener class for more details on the specifics It is imperitive that the instance passed to this method is not destroyed before either the rendering loop ends, or the class is removed from the listening list using removeFrameListener.
Note:

This method can only be called after Root::initialise has been called.
See also:
FrameListener, Root::removeFrameListener

void Ogre::Root::removeFrameListener ( FrameListener *  oldListener  ) 

Removes a FrameListener from the list of listening classes.

See also:
FrameListener, Root::addFrameListener

void Ogre::Root::queueEndRendering ( void   ) 

Queues the end of rendering.

Remarks:
This method will do nothing unless startRendering() has been called, in which case before the next frame is rendered the rendering loop will bail out.
See also:
Root, Root::startRendering

void Ogre::Root::startRendering ( void   ) 

Starts / restarts the automatic rendering cycle.

Remarks:
This method begins the automatic rendering of the scene. It will NOT return until the rendering cycle is halted.
During rendering, any FrameListener classes registered using addFrameListener will be called back for each frame that is to be rendered, These classes can tell OGRE to halt the rendering if required, which will cause this method to return.
Note:

Users of the OGRE library do not have to use this automatic rendering loop. It is there as a convenience and is most useful for high frame rate applications e.g. games. For applications that don't need to constantly refresh the rendering targets (e.g. an editor utility), it is better to manually refresh each render target only when required by calling RenderTarget::update, or if you want to run your own render loop you can update all targets on demand using