Ogre::Root Class Reference
[General]

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

#include <OgreRoot.h>

Inheritance diagram for Ogre::Root:

Public Types
typedef vector< DynLib * >::type	PluginLibList
typedef vector< Plugin * >::type	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.
const 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.
bool	getRemoveRenderQueueStructuresOnClear () const
	Get whether the entire render queue structure should be emptied on clearing, or whether just the objects themselves should be cleared.
void	setRemoveRenderQueueStructuresOnClear (bool r)
	Set whether the entire render queue structure should be emptied on clearing, or whether just the objects themselves should be cleared.
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.
bool	hasSceneManager (const String &instanceName) const
	Determines if a given SceneManager already exists.
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.
bool	renderOneFrame (Real timeSinceLastFrame)
	Render one frame, with custom frame time information.
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.
DataStreamPtr	createFileStream (const String &filename, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, bool overwrite=false, const String &locationPattern=StringUtil::BLANK)
	Helper method to assist you in creating writeable file streams.
DataStreamPtr	openFileStream (const String &filename, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, const String &locationPattern=StringUtil::BLANK)
	Helper method to assist you in accessing readable file streams.
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)
bool	createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows)
RenderTarget *	detachRenderTarget (RenderTarget *pWin)
	Detaches a RenderTarget from the active render system and returns a pointer to it.
RenderTarget *	detachRenderTarget (const String &name)
	Detaches a named RenderTarget from the active render system and returns a pointer to it.
void	destroyRenderTarget (RenderTarget *target)
	Destroys the given RenderTarget.
void	destroyRenderTarget (const String &name)
	Destroys the given named RenderTarget.
RenderTarget *	getRenderTarget (const String &name)
	Retrieves a pointer to a named render target.
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	_pushCurrentSceneManager (SceneManager *sm)
	Pushes the scene manager currently being used to render.
void	_popCurrentSceneManager (SceneManager *sm)
	Pops the scene manager currently being used to render.
bool	_updateAllRenderTargets (void)
	Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update.
bool	_updateAllRenderTargets (FrameEvent &evt)
	Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update, with a custom time passed to the frameRenderingQueued events.
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.
unsigned int	getDisplayMonitorCount () const
	Gets the number of display monitors.
WorkQueue *	getWorkQueue () const
	Get the WorkQueue for processing background tasks.
void	setWorkQueue (WorkQueue *queue)
	Replace the current work queue with an alternative.
void	setBlendIndicesGpuRedundant (bool redundant)
	Sets whether blend indices information needs to be passed to the GPU.
bool	isBlendIndicesGpuRedundant () const
	Returns whether blend indices information needs to be passed to the GPU see setBlendIndicesGpuRedundant() for more information.
void	setBlendWeightsGpuRedundant (bool redundant)
	Sets whether blend weights information needs to be passed to the GPU.
bool	isBlendWeightsGpuRedundant () const
	Returns whether blend weights information needs to be passed to the GPU see setBlendWeightsGpuRedundant() for more information.
void	setDefaultMinPixelSize (Real pixelSize)
	Set the default minimum pixel size for object to be rendered by.
Real	getDefaultMinPixelSize ()
	Get the default minimum pixel size for object to be rendered by.
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, void )
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 deque< SceneManager * > ::type	SceneManagerStack
typedef map< String, MovableObjectFactory * >::type	MovableObjectFactoryMap
typedef map< String, RenderQueueInvocationSequence * > ::type	RenderQueueInvocationSequenceMap
typedef deque< unsigned long > ::type	EventTimesQueue
	Contains the times of recently fired events.
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.
void	populateFrameEvent (FrameEventTimeType type, FrameEvent &evtToUpdate)
	Update a set of event times (note, progressive, only call once for each type per frame).
Protected Attributes
RenderSystemList	mRenderers
RenderSystem *	mActiveRenderer
String	mVersion
String	mConfigFileName
bool	mQueuedEnd
bool	mFirstTimePostWindowInit
LogManager *	mLogManager
ControllerManager *	mControllerManager
SceneManagerEnumerator *	mSceneManagerEnum
SceneManagerStack	mSceneManagerStack
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 *	mEmbeddedZipArchiveFactory
ArchiveFactory *	mFileSystemArchiveFactory
ResourceGroupManager *	mResourceGroupManager
ResourceBackgroundQueue *	mResourceBackgroundQueue
ShadowTextureManager *	mShadowTextureManager
RenderSystemCapabilitiesManager *	mRenderSystemCapabilitiesManager
ScriptCompilerManager *	mCompilerManager
LodStrategyManager *	mLodStrategyManager
Timer *	mTimer
RenderWindow *	mAutoWindow
Profiler *	mProfiler
HighLevelGpuProgramManager *	mHighLevelGpuProgramManager
ExternalTextureSourceManager *	mExternalTextureSourceManager
CompositorManager *	mCompositorManager
unsigned long	mNextFrame
Real	mFrameSmoothingTime
bool	mRemoveQueueStructuresOnClear
Real	mDefaultMinPixelSize
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?
WorkQueue *	mWorkQueue
bool	mIsBlendIndicesGpuRedundant
	Tells whether blend indices information needs to be passed to the GPU.
bool	mIsBlendWeightsGpuRedundant
	Tells whether blend weights information needs to be passed to the GPU.
set< FrameListener * >::type	mFrameListeners
	Set of registered frame listeners.
set< FrameListener * >::type	mRemovedFrameListeners
	Set of frame listeners marked for removal.
EventTimesQueue	mEventTimes [FETT_COUNT]
Static Protected Attributes
static Root *	msSingleton
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 67 of file OgreRoot.h.

Member Typedef Documentation

typedef deque<unsigned long>::type Ogre::Root::EventTimesQueue [protected]

Contains the times of recently fired events.

Definition at line 191 of file OgreRoot.h.

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

Definition at line 1007 of file OgreRoot.h.

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

Definition at line 128 of file OgreRoot.h.

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

Definition at line 121 of file OgreRoot.h.

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

Definition at line 120 of file OgreRoot.h.

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

Definition at line 139 of file OgreRoot.h.

typedef deque<SceneManager*>::type Ogre::Root::SceneManagerStack [protected]

Definition at line 85 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 182 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

uint32 Ogre::Root::_allocateNextMovableObjectTypeFlag ( void )

Allocate the next MovableObject type flag.

Remarks:: This is done automatically if MovableObjectFactory::requestTypeFlags returns true; don't call this manually unless you're sure you need to.

bool Ogre::Root::_fireFrameEnded ( )

Method for raising frame ended events.

Remarks:: This method is only for internal use when you use OGRE's inbuilt rendering loop (Root::startRendering). However, if you run your own rendering loop then you should call this method to ensure that FrameListener objects are notified of frame events; processes like texture animation and particle systems rely on this.

Note:: This method calculates the frame timing information for you based on the elapsed time. If you want to specify elapsed times yourself you should call the other version of this method which takes event details as a parameter.

Returns:: False if one or more frame listeners elected that the rendering loop should be terminated, true otherwise.

bool Ogre::Root::_fireFrameEnded ( FrameEvent & evt )

Method for raising frame ended events.

Remarks:: This method is only for internal use when you use OGRE's inbuilt rendering loop (Root::startRendering). However, if you run your own rendering loop then you should call this method to ensure that FrameListener objects are notified of frame events; processes like texture animation and particle systems rely on this.

Note:: This method takes an event object as a parameter, so you can specify the times yourself. If you are happy for OGRE to automatically calculate the frame time for you, then call the other version of this method with no parameters.

Parameters:

evt

Event object which includes all the timing information which you have calculated for yourself

Returns:: False if one or more frame listeners elected that the rendering loop should be terminated, true otherwise.

bool Ogre::Root::_fireFrameRenderingQueued ( )

Method for raising frame rendering queued events.

Remarks:: This method is only for internal use when you use OGRE's inbuilt rendering loop (Root::startRendering). However, if you run your own rendering loop then you you may want to call this method too, although nothing in OGRE relies on this particular event. Really if you're running your own rendering loop at this level of detail then you can get the same effect as doing your updates in a frameRenderingQueued callback by just calling RenderWindow::update with the 'swapBuffers' option set to false.

bool Ogre::Root::_fireFrameRenderingQueued ( FrameEvent & evt )

Method for raising frame rendering queued events.

Remarks:: This method is only for internal use when you use OGRE's inbuilt rendering loop (Root::startRendering). However, if you run your own rendering loop then you should call this method too, to ensure that all state is updated correctly. You should call it after the windows have been updated but before the buffers are swapped, or if you are not separating the update and buffer swap, then after the update just before _fireFrameEnded.

bool Ogre::Root::_fireFrameStarted ( )

Method for raising frame started events.

Remarks:: This method is only for internal use when you use OGRE's inbuilt rendering loop (Root::startRendering). However, if you run your own rendering loop then you should call this method to ensure that FrameListener objects are notified of frame events; processes like texture animation and particle systems rely on this.

: Calling this method also increments the frame number, which is important for keeping some elements of the engine up to date.

Note:: This method calculates the frame timing information for you based on the elapsed time. If you want to specify elapsed times yourself you should call the other version of this method which takes event details as a parameter.

Returns:: False if one or more frame listeners elected that the rendering loop should be terminated, true otherwise.

bool Ogre::Root::_fireFrameStarted ( FrameEvent & evt )

Method for raising frame started events.

Remarks:: This method is only for internal use when you use OGRE's inbuilt rendering loop (Root::startRendering). However, if you run your own rendering loop then you should call this method to ensure that FrameListener objects are notified of frame events; processes like texture animation and particle systems rely on this.

: Calling this method also increments the frame number, which is important for keeping some elements of the engine up to date.

Note:: This method takes an event object as a parameter, so you can specify the times yourself. If you are happy for OGRE to automatically calculate the frame time for you, then call the other version of this method with no parameters.

Parameters:

evt

Event object which includes all the timing information which you have calculated for yourself

Returns:: False if one or more frame listeners elected that the rendering loop should be terminated, true otherwise.

SceneManager* Ogre::Root::_getCurrentSceneManager ( void ) const

Returns the scene manager currently being used to render a frame.

Remarks:: This is only intended for internal use; it is only valid during the rendering of a frame.

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

Pops the scene manager currently being used to render.

Remarks:: This is only intended for internal use.

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

Pushes the scene manager currently being used to render.

Remarks:: This is only intended for internal use.

bool Ogre::Root::_updateAllRenderTargets ( FrameEvent & evt )

Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update, with a custom time passed to the frameRenderingQueued events.

Remarks:: You don't need to use this method if you're using Ogre's own internal rendering loop (Root::startRendering). If you're running your own loop you may wish to call it to update all the render targets which are set to auto update (RenderTarget::setAutoUpdated). You can also update individual RenderTarget instances using their own update() method.

Returns:: false if a FrameListener indicated it wishes to exit the render loop

bool Ogre::Root::_updateAllRenderTargets ( void )

Internal method used for updating all RenderTarget objects (windows, renderable textures etc) which are set to auto-update.

Remarks:: You don't need to use this method if you're using Ogre's own internal rendering loop (Root::startRendering). If you're running your own loop you may wish to call it to update all the render targets which are set to auto update (RenderTarget::setAutoUpdated). You can also update individual RenderTarget instances using their own update() method.

Returns:: false if a FrameListener indicated it wishes to exit the render loop

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::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.

Remarks:: Plugin creators can create subclasses of MovableObjectFactory which construct custom subclasses of MovableObject for insertion in the scene. This is the primary way that plugins can make custom objects available.

Parameters:

	fact	Pointer to the factory instance
	overrideExisting	Set this to true to override any existing factories which are registered for the same type. You should only change this if you are very sure you know what you're doing.

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.

void Ogre::Root::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.

Remarks:: Resource files (textures, models etc) need to be loaded from specific locations. By calling this method, you add another search location to the list. Locations added first are preferred over locations added later.

: Locations can be folders, compressed archives, even perhaps remote locations. Facilities for loading from different locations are provided by plugins which provide implementations of the Archive class. All the application user has to do is specify a 'loctype' string in order to indicate the type of location, which should map onto one of the provided plugins. Ogre comes configured with the 'FileSystem' (folders) and 'Zip' (archive compressed with the pkzip / WinZip etc utilities) types.

: You can also supply the name of a resource group which should have this location applied to it. The ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME group is the default, and one resource group which will always exist. You should consider defining resource groups for your more specific resources (e.g. per level) so that you can control loading / unloading better.

Parameters:

	name	The name of the location, e.g. './data' or '/compressed/gamedata.zip'
	locType	A string identifying the location type, e.g. 'FileSystem' (for folders), 'Zip' etc. Must map to a registered plugin which deals with this type (FileSystem and Zip should always be available)
	groupName	Type of name of the resource group which this location should apply to; defaults to the General group which applies to all non-specific resources.
	recursive	If the resource location has a concept of recursive directory traversal, enabling this option will mean you can load resources in subdirectories using only their unqualified name. The default is to disable this so that resources in subdirectories with the same name are still unique.

See also:: Archive

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.

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::clearEventTimes ( void )

Clears the history of all event times.

Remarks:: OGRE stores a history of the last few event times in order to smooth out any inaccuracies and temporary fluctuations. However, if you pause or don't render for a little while this can cause a lurch, so if you're resuming rendering after a break, call this method to reset the stored times

void Ogre::Root::convertColourValue	(	const ColourValue &	colour,
		uint32 *	pDest
	)

Generates a packed data version of the passed in ColourValue suitable for use with the current RenderSystem.

Remarks:: Since different render systems have different colour data formats (eg RGBA for GL, ARGB for D3D) this method allows you to use 1 method for all.

Parameters:

	colour	The colour to convert
	pDest	Pointer to location to put the result.

DataStreamPtr Ogre::Root::createFileStream	(	const String &	filename,
		const String &	groupName = `ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME`,
		bool	overwrite = `false`,
		const String &	locationPattern = `StringUtil::BLANK`
	)

Helper method to assist you in creating writeable file streams.

Remarks:: This is a high-level utility method which you can use to find a place to save a file more easily. If the filename you specify is either an absolute or relative filename (ie it includes path separators), then the file will be created in the normal filesystem using that specification. If it doesn't, then the method will look for a writeable resource location via ResourceGroupManager::createResource using the other params provided.

Parameters:

	filename	The name of the file to create. If it includes path separators, the filesystem will be accessed direct. If no path separators are present the resource system is used, falling back on the raw filesystem after.
	groupName	The name of the group in which to create the file, if the resource system is used
	overwrite	If true, an existing file will be overwritten, if false an error will occur if the file already exists
	locationPattern	If the resource group contains multiple locations, then usually the file will be created in the first writable location. If you want to be more specific, you can include a location pattern here and only locations which match that pattern (as determined by StringUtil::match) will be considered candidates for creation.

RenderQueueInvocationSequence* Ogre::Root::createRenderQueueInvocationSequence ( const String & name )

Create a new RenderQueueInvocationSequence, useful for linking to Viewport instances to perform custom rendering.

Parameters:

name

The name to give the new sequence

RenderWindow* Ogre::Root::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 getRenderTarget.

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	Type/Values	Default	Description	Notes
title	Any string	RenderTarget name	The title of the window that will appear in the title bar
colourDepth	16, 32	Desktop depth	Colour depth of the resulting rendering window; only applies if fullScreen	Win32 Specific
left	Positive integers	Centred	Screen x coordinate from left
top	Positive integers	Centred	Screen y coordinate from left
depthBuffer	true, false	true	Use depth buffer	DirectX9 specific
externalWindowHandle	Win32: HWND as integer GLX: poslong:posint:poslong (display:screen:windowHandle) or poslong:posint:poslong:poslong (display:screen:windowHandle:XVisualInfo*) OS X: WindowRef for Carbon or NSWindow for Cocoa address as an integer iOS: UIWindow address as an integer	0 (none)	External window handle, for embedding the OGRE render in an existing window
externalGLControl	true, false	false	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.	OpenGL specific
externalGLContext	Context as Unsigned Long	0 (create own context)	Use an externally created GL context	OpenGL Specific
parentWindowHandle	Win32: HWND as integer GLX: poslong:posint:poslong (display:screen:windowHandle) or poslong:posint:poslong:poslong (display:screen:windowHandle:XVisualInfo*)	0 (none)	Parent window handle, for embedding the OGRE in a child of an external window
macAPI	String: "cocoa" or "carbon"	"carbon"	Specifies the type of rendering window on the Mac Platform.	Mac OS X Specific
macAPICocoaUseNSView	bool "true" or "false"	"false"	On the Mac platform the most diffused method to embed OGRE in a custom application is to use Interface Builder and add to the interface an instance of OgreView. The pointer to this instance is then used as "externalWindowHandle". However, there are cases where you are NOT using Interface Builder and you get the Cocoa NSView* of an existing interface. For example, this is happens when you want to render into a Java/AWT interface. In short, by setting this flag to "true" the Ogre::Root::createRenderWindow interprets the "externalWindowHandle" as a NSView* instead of an OgreView*. See OgreOSXCocoaView.h/mm.	Mac OS X Specific
contentScalingFactor	Positive Float greater than 1.0	The default content scaling factor of the screen	Specifies the CAEAGLLayer content scaling factor. Only supported on iOS 4 or greater. This can be useful to limit the resolution of the OpenGL ES backing store. For example, the iPhone 4's native resolution is 960 x 640. Windows are always 320 x 480, if you would like to limit the display to 720 x 480, specify 1.5 as the scaling factor.	iOS Specific
externalViewHandle	UIView pointer as an integer	0	External view handle, for rendering OGRE render in an existing view	iOS Specific
externalViewControllerHandle	UIViewController pointer as an integer	0	External view controller handle, for embedding OGRE in an existing view controller	iOS Specific
FSAA	Positive integer (usually 0, 2, 4, 8, 16)	0	Full screen antialiasing factor
FSAAHint	Depends on RenderSystem and hardware. Currently supports: "Quality": on systems that have an option to prefer higher AA quality over speed, use it	Blank	Full screen antialiasing hint
displayFrequency	Refresh rate in Hertz (e.g. 60, 75, 100)	Desktop vsync rate	Display frequency rate, for fullscreen mode
vsync	true, false	false	Synchronize buffer swaps to monitor vsync, eliminating tearing at the expense of a fixed frame rate
vsyncInterval	1, 2, 3, 4	1	If vsync is enabled, the minimum number of vertical blanks that should occur between renders. For example if vsync is enabled, the refresh rate is 60 and this is set to 2, then the frame rate will be locked at 30.
border	none, fixed, resize	resize	The type of window border (in windowed mode)
outerDimensions	true, false	false	Whether the width/height is expressed as the size of the outer window, rather than the content area
useNVPerfHUD	true, false	false	Enable the use of nVidia NVPerfHUD
gamma	true, false	false	Enable hardware conversion from linear colour space to gamma colour space on rendering to the window.
enableDoubleClick	true, false	false	Enable the window to keep track and transmit double click messages.	Win32 Specific

bool Ogre::Root::createRenderWindows	(	const RenderWindowDescriptionList &	renderWindowDescriptions,
		RenderWindowList &	createdWindows
	)

Creates multiple rendering windows.

Parameters:

	renderWindowDescriptions	Array of structures containing the descriptions of each render window. The structure's members are the same as the parameters of _createRenderWindow: name width height fullScreen miscParams See _createRenderWindow for details about each member.
	createdWindows	This array will hold the created render windows.

Returns:: true on success.

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.

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.

void Ogre::Root::destroyAllRenderQueueInvocationSequences ( void )

Destroy all RenderQueueInvocationSequences.

Remarks:: You must ensure that no Viewports are using custom sequences.

Parameters:

name

The name to identify the sequence

void Ogre::Root::destroyRenderQueueInvocationSequence ( const String & name )

Destroy a RenderQueueInvocationSequence.

Remarks:: You must ensure that no Viewports are using this sequence.

Parameters:

name

The name to identify the sequence

void Ogre::Root::destroyRenderTarget ( const String & name )

Destroys the given named RenderTarget.

void Ogre::Root::destroyRenderTarget ( RenderTarget * target )

Destroys the given RenderTarget.

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

Destroy an instance of a SceneManager.

RenderTarget* Ogre::Root::detachRenderTarget ( const String & name )

Detaches a named RenderTarget from the active render system and returns a pointer to it.

Note:: If the render target cannot be found, NULL is returned.

RenderTarget* Ogre::Root::detachRenderTarget ( RenderTarget * pWin )

Detaches a RenderTarget from the active render system and returns a pointer to it.

Note:: If the render target cannot be found, NULL is returned.

RenderWindow* Ogre::Root::getAutoCreatedWindow ( void )

Retrieves a pointer to the window that was created automatically.

Remarks:: When Root is initialised an optional window is created. This method retreives a pointer to that window.

Note:: returns a null pointer when Root has not been initialised with the option of creating a window.

const 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.

Real Ogre::Root::getDefaultMinPixelSize ( )

Get the default minimum pixel size for object to be rendered by.

Definition at line 1068 of file OgreRoot.h.

unsigned int Ogre::Root::getDisplayMonitorCount ( ) const

Gets the number of display monitors.

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

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

Real Ogre::Root::getFrameSmoothingPeriod ( void ) const

Gets the period over which OGRE smooths out fluctuations in frame times.

Definition at line 972 of file OgreRoot.h.

const PluginInstanceList& Ogre::Root::getInstalledPlugins ( ) const

Gets a read-only list of the currently installed plugins.

Definition at line 737 of file OgreRoot.h.

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.

MovableObjectFactory* Ogre::Root::getMovableObjectFactory ( const String & typeName )

Get a MovableObjectFactory for the given type.

MovableObjectFactoryIterator Ogre::Root::getMovableObjectFactoryIterator ( void ) const

Return an iterator over all the MovableObjectFactory instances currently registered.

unsigned long Ogre::Root::getNextFrameNumber ( void ) const

Gets the number of the next frame to be rendered.

Remarks:: Note that this is 'next frame' rather than 'current frame' because it indicates the frame number that current changes made to the scene will take effect. It is incremented after all rendering commands for the current frame have been queued, thus reflecting that if you start performing changes then, you will actually see them in the next frame.

Definition at line 843 of file OgreRoot.h.

bool Ogre::Root::getRemoveRenderQueueStructuresOnClear ( ) const

Get whether the entire render queue structure should be emptied on clearing, or whether just the objects themselves should be cleared.

Definition at line 340 of file OgreRoot.h.

RenderQueueInvocationSequence* Ogre::Root::getRenderQueueInvocationSequence ( const String & name )

Get a RenderQueueInvocationSequence.

Parameters:

name

The name to identify the sequence

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

Retrieve a pointer to the currently selected render system.

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.

RenderTarget* Ogre::Root::getRenderTarget ( const String & name )

Retrieves a pointer to a named render target.

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.

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.

static Root& Ogre::Root::getSingleton ( void ) [static]

Override standard Singleton retrieval.

Remarks:: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< Root >.

static Root* Ogre::Root::getSingletonPtr ( void ) [static]

Override standard Singleton retrieval.

Remarks:: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< Root >.

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.

Timer* Ogre::Root::getTimer ( void )

Gets a pointer to the central timer used for all OGRE timings.

WorkQueue* Ogre::Root::getWorkQueue ( ) const

Get the WorkQueue for processing background tasks.

You are free to add new requests and handlers to this queue to process your custom background tasks using the shared thread pool. However, you must remember to assign yourself a new channel through which to process your tasks.

Definition at line 1024 of file OgreRoot.h.

bool Ogre::Root::hasMovableObjectFactory ( const String & typeName ) const

Checks whether a factory is registered for a given MovableObject type.

bool Ogre::Root::hasSceneManager ( const String & instanceName ) const

Determines if a given SceneManager already exists.

Parameters:

instanceName

The name of the instance to retrieve.

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.

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

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

void Ogre::Root::installPlugin ( Plugin * plugin )

Install a new plugin.

Remarks:: This installs a new extension to OGRE. The plugin itself may be loaded from a DLL / DSO, or it might be statically linked into your own application. Either way, something has to call this method to get it registered and functioning. You should only call this method directly if your plugin is not in a DLL that could otherwise be loaded with loadPlugin, since the DLL function dllStartPlugin should call this method when the DLL is loaded.

bool Ogre::Root::isBlendIndicesGpuRedundant ( ) const

Returns whether blend indices information needs to be passed to the GPU see setBlendIndicesGpuRedundant() for more information.

Definition at line 1046 of file OgreRoot.h.

bool Ogre::Root::isBlendWeightsGpuRedundant ( ) const

Returns whether blend weights information needs to be passed to the GPU see setBlendWeightsGpuRedundant() for more information.

Definition at line 1058 of file OgreRoot.h.

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

Returns whether the system is initialised or not.

Definition at line 328 of file OgreRoot.h.

void Ogre::Root::loadPlugin ( const String & pluginName )

Manually load a Plugin contained in a DLL / DSO.

Remarks:: Plugins embedded in DLLs can be loaded at startup using the plugin configuration file specified when you create Root (default: plugins.cfg). This method allows you to load plugin DLLs directly in code. The DLL in question is expected to implement a dllStartPlugin method which instantiates a Plugin subclass and calls Root::installPlugin. It should also implement dllStopPlugin (see Root::unloadPlugin)

Parameters:

pluginName

Name of the plugin library to load

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::oneTimePostWindowInit ( void ) [protected]

DataStreamPtr Ogre::Root::openFileStream	(	const String &	filename,
		const String &	groupName = `ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME`,
		const String &	locationPattern = `StringUtil::BLANK`
	)

Helper method to assist you in accessing readable file streams.

Remarks:: This is a high-level utility method which you can use to find a place to open a file more easily. It checks the resource system first, and if that fails falls back on accessing the file system directly.

Parameters:

	filename	The name of the file to open.
	groupName	The name of the group in which to create the file, if the resource system is used
	locationPattern	If the resource group contains multiple locations, then usually the file will be created in the first writable location. If you want to be more specific, you can include a location pattern here and only locations which match that pattern (as determined by StringUtil::match) will be considered candidates for creation.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			`[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			`[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 90 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

void Ogre::Root::populateFrameEvent	(	FrameEventTimeType	type,
		FrameEvent &	evtToUpdate
	)			`[protected]`

Update a set of event times (note, progressive, only call once for each type per frame).

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::removeFrameListener ( FrameListener * oldListener )

Removes a FrameListener from the list of listening classes.

See also:: FrameListener, Root::addFrameListener

void Ogre::Root::removeMovableObjectFactory ( MovableObjectFactory * fact )

Removes a previously registered MovableObjectFactory.

Remarks:: All instances of objects created by this factory will be destroyed before removing the factory (by calling back the factories 'destroyInstance' method). The plugin writer is responsible for actually destroying the factory.

void Ogre::Root::removeResourceLocation	(	const String &	name,
		const String &	groupName = `ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME`
	)

Removes a resource location from the list.

See also:: addResourceLocation

Parameters:

	name	The name of the resource location as specified in addResourceLocation
	groupName	The name of the resource group to which this location was assigned.

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

Unregister a SceneManagerFactory.

bool Ogre::Root::renderOneFrame ( Real timeSinceLastFrame )

Render one frame, with custom frame time information.

Remarks:: Updates all the render targets automatically and then returns, raising frame events before and after - all per-frame times are based on the time value you pass in.

bool Ogre::Root::renderOneFrame ( void )

Render one frame.

Remarks:: Updates all the render targets automatically and then returns, raising frame events before and after.

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.

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.

void Ogre::Root::setBlendIndicesGpuRedundant ( bool redundant )

Sets whether blend indices information needs to be passed to the GPU.

When entities use software animation they remove blend information such as indices and weights from the vertex buffers sent to the graphic card. This function can be used to limit which information is removed.

Parameters:

redundant

Set to true to remove blend indices information.

Definition at line 1042 of file OgreRoot.h.

void Ogre::Root::setBlendWeightsGpuRedundant ( bool redundant )

Sets whether blend weights information needs to be passed to the GPU.

When entities use software animation they remove blend information such as indices and weights from the vertex buffers sent to the graphic card. This function can be used to limit which information is removed.

Parameters:

redundant

Set to true to remove blend weights information.

Definition at line 1054 of file OgreRoot.h.

void Ogre::Root::setDefaultMinPixelSize ( Real pixelSize )

Set the default minimum pixel size for object to be rendered by.

Note:: To use this feature see Camera::setUseMinPixelSize()

Definition at line 1064 of file OgreRoot.h.

void Ogre::Root::setFrameSmoothingPeriod ( Real period )

Sets the period over which OGRE smooths out fluctuations in frame times.

Remarks:: OGRE by default gives you the raw frame time, but can optionally smooths it out over several frames, in order to reduce the noticeable effect of occasional hiccups in framerate. These smoothed values are passed back as parameters to FrameListener calls.

: This method allow you to tweak the smoothing period, and is expressed in seconds. Setting it to 0 will result in completely unsmoothed frame times (the default).

Definition at line 970 of file OgreRoot.h.

void Ogre::Root::setRemoveRenderQueueStructuresOnClear ( bool r )

Set whether the entire render queue structure should be emptied on clearing, or whether just the objects themselves should be cleared.

Definition at line 345 of file OgreRoot.h.

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

void Ogre::Root::setWorkQueue ( WorkQueue * queue )

Replace the current work queue with an alternative.

You can use this method to replace the internal implementation of WorkQueue with your own, e.g. to externalise the processing of background events. Doing so will delete the existing queue and replace it with this one.

Parameters:

queue

The new WorkQueue instance. Root will delete this work queue at shutdown, so do not destroy it yourself.

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::shutdown ( void )

Shuts down the system manually.

Remarks:: This is normally done by Ogre automatically so don't think you have to call this yourself. However this is here for convenience, especially for dealing with unexpected errors or for systems which need to shut down Ogre on demand.

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::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 Root::renderOneFrame.; This frees up the CPU to do other things in between refreshes, since in this case frame rate is less important.; This method can only be called after Root::initialise has been called.

void Ogre::Root::uninstallPlugin ( Plugin * plugin )

Uninstall an existing plugin.

Remarks:: This uninstalls an extension to OGRE. Plugins are automatically uninstalled at shutdown but this lets you remove them early. If the plugin was loaded from a DLL / DSO you should call unloadPlugin which should result in this method getting called anyway (if the DLL is well behaved).

void Ogre::Root::unloadPlugin ( const String & pluginName )

Manually unloads a Plugin contained in a DLL / DSO.

Remarks:: Plugin DLLs are unloaded at shutdown automatically. This method allows you to unload plugins in code, but make sure their dependencies are decoupled first. This method will call the dllStopPlugin method defined in the DLL, which in turn should call Root::uninstallPlugin.

Parameters:

pluginName

Name of the plugin library to unload

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

Unloads all loaded plugins.

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