Ogre::CompositorManager Class Reference

Class for managing Compositor settings for Ogre. More...

#include <OgreCompositorManager.h>

Inheritance diagram for Ogre::CompositorManager:

List of all members.


Public Types
typedef HashMap< String, ResourcePtr >	ResourceMap
typedef std::map< ResourceHandle, ResourcePtr >	ResourceHandleMap
typedef MapIterator< ResourceHandleMap >	ResourceMapIterator
Public Member Functions
	CompositorManager ()
virtual	~CompositorManager ()
Resource *	createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader loader, const NameValuePairList params)
	Overridden from ResourceManager.
void	initialise (void)
	Intialises the Compositor manager, which also triggers it to parse all available .compositor scripts.
void	parseScript (DataStreamPtr &stream, const String &groupName)
CompositorChain *	getCompositorChain (Viewport *vp)
	Get the compositor chain for a Viewport.
bool	hasCompositorChain (Viewport *vp) const
	Returns whether exists compositor chain for a viewport.
void	removeCompositorChain (Viewport *vp)
	Remove the compositor chain from a viewport if exists.
CompositorInstance *	addCompositor (Viewport *vp, const String &compositor, int addPosition=-1)
	Add a compositor to a viewport.
void	removeCompositor (Viewport *vp, const String &compositor)
	Remove a compositor from a viewport.
void	setCompositorEnabled (Viewport *vp, const String &compositor, bool value)
	Set the state of a compositor on a viewport to enabled or disabled.
Renderable *	_getTexturedRectangle2D ()
	Get a textured fullscreen 2D rectangle, for internal use.
void	removeAll (void)
	Overridden from ResourceManager since we have to clean up chains too.
virtual ResourcePtr	create (const String &name, const String &group, bool isManual=false, ManualResourceLoader loader=0, const NameValuePairList createParams=0)
	Creates a new blank resource, but does not immediately load it.
virtual void	setMemoryBudget (size_t bytes)
	Set a limit on the amount of memory this resource handler may use.
virtual size_t	getMemoryBudget (void) const
	Get the limit on the amount of memory this resource handler may use.
virtual void	unload (const String &name)
	Unloads a single resource by name.
virtual void	unload (ResourceHandle handle)
	Unloads a single resource by handle.
virtual void	unloadAll (bool reloadableOnly=true)
	Unloads all resources.
virtual void	reloadAll (bool reloadableOnly=true)
	Caused all currently loaded resources to be reloaded.
virtual void	unloadUnreferencedResources (bool reloadableOnly=true)
	Unload all resources which are not referenced by any other object.
virtual void	reloadUnreferencedResources (bool reloadableOnly=true)
	Caused all currently loaded but not referenced by any other object resources to be reloaded.
virtual void	remove (ResourcePtr &r)
	Remove a single resource.
virtual void	remove (const String &name)
	Remove a single resource by name.
virtual void	remove (ResourceHandle handle)
	Remove a single resource by handle.
virtual ResourcePtr	getByName (const String &name)
	Retrieves a pointer to a resource by name, or null if the resource does not exist.
virtual ResourcePtr	getByHandle (ResourceHandle handle)
	Retrieves a pointer to a resource by handle, or null if the resource does not exist.
virtual bool	resourceExists (const String &name)
	Returns whether the named resource exists in this manager.
virtual bool	resourceExists (ResourceHandle handle)
	Returns whether a resource with the given handle exists in this manager.
virtual void	_notifyResourceTouched (Resource *res)
	Notify this manager that a resource which it manages has been 'touched', ie used.
virtual void	_notifyResourceLoaded (Resource *res)
	Notify this manager that a resource which it manages has been loaded.
virtual void	_notifyResourceUnloaded (Resource *res)
	Notify this manager that a resource which it manages has been unloaded.
virtual ResourcePtr	load (const String &name, const String &group, bool isManual=false, ManualResourceLoader loader=0, const NameValuePairList loadParams=0)
	Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters).
virtual const StringVector &	getScriptPatterns (void) const
	Gets the file patterns which should be used to find scripts for this ResourceManager.
virtual Real	getLoadingOrder (void) const
	Gets the relative loading order of resources of this type.
const String &	getResourceType (void) const
	Gets a string identifying the type of resource this manager handles.
ResourceMapIterator	getResourceIterator (void)
	Returns an iterator over all resources in this manager.
Static Public Member Functions
CompositorManager &	getSingleton (void)
CompositorManager *	getSingletonPtr (void)
Protected Member Functions
ResourceHandle	getNextHandle (void)
	Allocates the next handle.
virtual void	addImpl (ResourcePtr &res)
	Add a newly created resource to the manager (note weak reference).
virtual void	removeImpl (ResourcePtr &res)
	Remove a resource from this manager; remove it from the lists.
virtual void	checkUsage (void)
	Checks memory usage and pages out if required.
virtual size_t	getMemoryUsage (void) const
	Gets the current memory usage, in bytes.
Protected Attributes
ResourceHandleMap	mResourcesByHandle
ResourceMap	mResources
ResourceHandle	mNextHandle
size_t	mMemoryBudget
size_t	mMemoryUsage
StringVector	mScriptPatterns
	Patterns to use to look for scripts if supported (e.g. *.overlay).
Real	mLoadOrder
	Loading order relative to other managers, higher is later.
String	mResourceType
	String identifying the resource type this manager handles.
Static Protected Attributes
CompositorManager *	ms_Singleton
Private Types
typedef std::map< Viewport , CompositorChain >	Chains
Private Member Functions
void	freeChains ()
	Clear composition chains for all viewports.
Private Attributes
Chains	mChains
CompositorSerializer	mSerializer
	Serializer.
Rectangle2D *	mRectangle

Detailed Description

Class for managing Compositor settings for Ogre.

Compositors provide the means to flexibly "composite" the final rendering result from multiple scene renders and intermediate operations like rendering fullscreen quads. This makes it possible to apply postfilter effects, HDRI postprocessing, and shadow effects to a Viewport.

: When loaded from a script, a Compositor is in an 'unloaded' state and only stores the settings required. It does not at that stage load any textures. This is because the material settings may be loaded 'en masse' from bulk material script files, but only a subset will actually be required.

: Because this is a subclass of ResourceManager, any files loaded will be searched for in any path or archive added to the resource paths/archives. See ResourceManager for details.

Definition at line 48 of file OgreCompositorManager.h.

Member Typedef Documentation

typedef std::map<Viewport*, CompositorChain*> Ogre::CompositorManager::Chains [private]

Definition at line 110 of file OgreCompositorManager.h.

typedef std::map<ResourceHandle, ResourcePtr> Ogre::ResourceManager::ResourceHandleMap [inherited]

Definition at line 387 of file OgreResourceManager.h.

typedef HashMap< String, ResourcePtr > Ogre::ResourceManager::ResourceMap [inherited]

Definition at line 386 of file OgreResourceManager.h.

typedef MapIterator<ResourceHandleMap> Ogre::ResourceManager::ResourceMapIterator [inherited]

Definition at line 405 of file OgreResourceManager.h.
Referenced by Ogre::ResourceManager::getResourceIterator().

Constructor & Destructor Documentation

Ogre::CompositorManager::CompositorManager ( )

virtual Ogre::CompositorManager::~CompositorManager ( ) [virtual]

Member Function Documentation

Renderable* Ogre::CompositorManager::_getTexturedRectangle2D ( )

Get a textured fullscreen 2D rectangle, for internal use.

virtual void Ogre::ResourceManager::_notifyResourceLoaded ( Resource * res ) [virtual, inherited]

Notify this manager that a resource which it manages has been loaded.

virtual void Ogre::ResourceManager::_notifyResourceTouched ( Resource * res ) [virtual, inherited]

Notify this manager that a resource which it manages has been 'touched', ie used.

virtual void Ogre::ResourceManager::_notifyResourceUnloaded ( Resource * res ) [virtual, inherited]

Notify this manager that a resource which it manages has been unloaded.

CompositorInstance* Ogre::CompositorManager::addCompositor ( Viewport * vp,

const String & compositor,

int addPosition = -1

)

Add a compositor to a viewport.
By default, it is added to end of the chain, after the other compositors.
Parameters:

vp Viewport to modify

compositor The name of the compositor to apply

addPosition At which position to add, defaults to the end (-1).

Returns:
pointer to instance, or 0 if it failed.

virtual void Ogre::ResourceManager::addImpl ( ResourcePtr & res ) [protected, virtual, inherited]

Add a newly created resource to the manager (note weak reference).

virtual void Ogre::ResourceManager::checkUsage ( void ) [protected, virtual, inherited]

Checks memory usage and pages out if required.

virtual ResourcePtr Ogre::ResourceManager::create ( const String & name,

const String & group,

bool isManual = false,

ManualResourceLoader * loader = 0,

const NameValuePairList * createParams = 0

) [virtual, inherited]

Creates a new blank resource, but does not immediately load it.

Remarks:
Resource managers handle disparate types of resources, so if you want to get at the detailed interface of this resource, you'll have to cast the result to the subclass you know you're creating.

Parameters:

name The unique name of the resource

group The name of the resource group to attach this new resource to

isManual Is this resource manually loaded? If so, you should really populate the loader parameter in order that the load process can call the loader back when loading is required.

loader Pointer to a ManualLoader implementation which will be called when the Resource wishes to load (should be supplied if you set isManual to true). You can in fact leave this parameter null if you wish, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualLoader instance is strongly recommended.

createParams If any parameters are required to create an instance, they should be supplied here as name / value pairs

Resource* Ogre::CompositorManager::createImpl ( const String & name,

ResourceHandle handle,

const String & group,

bool isManual,

ManualResourceLoader * loader,

const NameValuePairList * params

) [virtual]

Overridden from ResourceManager.

Implements Ogre::ResourceManager.

void Ogre::CompositorManager::freeChains ( ) [private]

Clear composition chains for all viewports.

virtual ResourcePtr Ogre::ResourceManager::getByHandle ( ResourceHandle handle ) [virtual, inherited]

Retrieves a pointer to a resource by handle, or null if the resource does not exist.

virtual ResourcePtr Ogre::ResourceManager::getByName ( const String & name ) [virtual, inherited]

Retrieves a pointer to a resource by name, or null if the resource does not exist.

CompositorChain* Ogre::CompositorManager::getCompositorChain ( Viewport * vp )

Get the compositor chain for a Viewport.
If there is none yet, a new compositor chain is registered. XXX We need a _notifyViewportRemoved to find out when this viewport disappears, so we can destroy its chain as well.

virtual Real Ogre::ResourceManager::getLoadingOrder ( void ) const [virtual, inherited]

Gets the relative loading order of resources of this type.

Remarks:
There are dependencies between some kinds of resource in terms of loading order, and this value enumerates that. Higher values load later during bulk loading tasks.

Implements Ogre::ScriptLoader.
Definition at line 340 of file OgreResourceManager.h.
References Ogre::Real.

virtual size_t Ogre::ResourceManager::getMemoryBudget ( void ) const [virtual, inherited]

Get the limit on the amount of memory this resource handler may use.

virtual size_t Ogre::ResourceManager::getMemoryUsage ( void ) const [protected, virtual, inherited]

Gets the current memory usage, in bytes.

Definition at line 382 of file OgreResourceManager.h.

ResourceHandle Ogre::ResourceManager::getNextHandle ( void ) [protected, inherited]

Allocates the next handle.

ResourceMapIterator Ogre::ResourceManager::getResourceIterator ( void ) [inherited]

Returns an iterator over all resources in this manager.

Note:
Use of this iterator is NOT thread safe!

Definition at line 410 of file OgreResourceManager.h.
References Ogre::ResourceManager::ResourceMapIterator.

const String& Ogre::ResourceManager::getResourceType ( void ) const [inherited]

Gets a string identifying the type of resource this manager handles.

Definition at line 343 of file OgreResourceManager.h.
References Ogre::String.

virtual const StringVector& Ogre::ResourceManager::getScriptPatterns ( void ) const [virtual, inherited]

Gets the file patterns which should be used to find scripts for this ResourceManager.

Remarks:
Some resource managers can read script files in order to define resources ahead of time. These resources are added to the available list inside the manager, but none are loaded initially. This allows you to load the items that are used on demand, or to load them all as a group if you wish (through ResourceGroupManager).

This method lets you determine the file pattern which will be used to identify scripts intended for this manager.

Returns:
A list of file patterns, in the order they should be searched in.

See also:
isScriptingSupported, parseScript

Implements Ogre::ScriptLoader.
Definition at line 317 of file OgreResourceManager.h.
References Ogre::StringVector.

CompositorManager & Ogre::Singleton< CompositorManager >::getSingleton ( void ) [static, inherited]

Definition at line 69 of file OgreSingleton.h.

CompositorManager * Ogre::Singleton< CompositorManager >::getSingletonPtr ( void ) [static, inherited]

Definition at line 71 of file OgreSingleton.h.

bool Ogre::CompositorManager::hasCompositorChain ( Viewport * vp ) const

Returns whether exists compositor chain for a viewport.

void Ogre::CompositorManager::initialise ( void )

Intialises the Compositor manager, which also triggers it to parse all available .compositor scripts.

virtual ResourcePtr Ogre::ResourceManager::load ( const String & name,

const String & group,

bool isManual = false,

ManualResourceLoader * loader = 0,

const NameValuePairList * loadParams = 0

) [virtual, inherited]

Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters).

Parameters:

name The name of the Resource

group The resource group to which this resource will belong

isManual Is the resource to be manually loaded? If so, you should provide a value for the loader parameter

loader The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter

loadParams Optional pointer to a list of name/value pairs containing loading parameters for this type of resource.

Reimplemented in Ogre::BspResourceManager.

void Ogre::CompositorManager::parseScript ( DataStreamPtr & stream,

const String & groupName

) [virtual]

See also:
ScriptLoader::parseScript

Reimplemented from Ogre::ResourceManager.

virtual void Ogre::ResourceManager::reloadAll ( bool reloadableOnly = true ) [virtual, inherited]

Caused all currently loaded resources to be reloaded.

Remarks:
All resources currently being held in this manager which are also marked as currently loaded will be unloaded, then loaded again.

Parameters:

reloadableOnly If true (the default), only reload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't loaded again. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

See also:
Resource::isReloadable for resource is reloadable.

virtual void Ogre::ResourceManager::reloadUnreferencedResources ( bool reloadableOnly = true ) [virtual, inherited]

Caused all currently loaded but not referenced by any other object resources to be reloaded.

Remarks:
This method behaves like reloadAll, except that it only reloads resources which are not in use, ie not referenced by other objects.

Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, unload or reload that resource will cause dangerous pointer access. Use this function instead of reloadAll allows you avoid fail in those situations.

Parameters:

reloadableOnly If true (the default), only reloads resources which can be subsequently automatically reloaded.

virtual void Ogre::ResourceManager::remove ( ResourceHandle handle ) [virtual, inherited]

Remove a single resource by handle.

Remarks:
Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note:
The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

virtual void Ogre::ResourceManager::remove ( const String & name ) [virtual, inherited]

Remove a single resource by name.

Remarks:
Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note:
The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

virtual void Ogre::ResourceManager::remove ( ResourcePtr & r ) [virtual, inherited]

Remove a single resource.

Remarks:
Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note:
The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

void Ogre::CompositorManager::removeAll ( void ) [virtual]

Overridden from ResourceManager since we have to clean up chains too.

Reimplemented from Ogre::ResourceManager.

void Ogre::CompositorManager::removeCompositor ( Viewport * vp,

const String & compositor

)

Remove a compositor from a viewport.

void Ogre::CompositorManager::removeCompositorChain ( Viewport * vp )

Remove the compositor chain from a viewport if exists.

virtual void Ogre::ResourceManager::removeImpl ( ResourcePtr & res ) [protected, virtual, inherited]

Remove a resource from this manager; remove it from the lists.

virtual bool Ogre::ResourceManager::resourceExists ( ResourceHandle handle ) [virtual, inherited]

Returns whether a resource with the given handle exists in this manager.

Definition at line 265 of file OgreResourceManager.h.
References Ogre::SharedPtr< T >::isNull(), and Ogre::ResourceHandle.

virtual bool Ogre::ResourceManager::resourceExists ( const String & name ) [virtual, inherited]

Returns whether the named resource exists in this manager.

Definition at line 260 of file OgreResourceManager.h.
References Ogre::SharedPtr< T >::isNull(), and Ogre::String.

void Ogre::CompositorManager::setCompositorEnabled ( Viewport * vp,

const String & compositor,

bool value

)

Set the state of a compositor on a viewport to enabled or disabled.
Disabling a compositor stops it from rendering but does not free any resources. This can be more efficient than using removeCompositor and addCompositor in cases the filter is switched on and off a lot.

virtual void Ogre::ResourceManager::setMemoryBudget ( size_t bytes ) [virtual, inherited]

Set a limit on the amount of memory this resource handler may use.

Remarks:
If, when asked to load a new resource, the manager believes it will exceed this memory budget, it will temporarily unload a resource to make room for the new one. This unloading is not permanent and the Resource is not destroyed; it simply needs to be reloaded when next used.

virtual void Ogre::ResourceManager::unload ( ResourceHandle handle ) [virtual, inherited]

Unloads a single resource by handle.

Remarks:
Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also:
ResourceGroupManager for unloading of resource groups.

virtual void Ogre::ResourceManager::unload ( const String & name ) [virtual, inherited]

Unloads a single resource by name.

Remarks:
Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also:
ResourceGroupManager for unloading of resource groups.

virtual void Ogre::ResourceManager::unloadAll ( bool reloadableOnly = true ) [virtual, inherited]

Unloads all resources.

Remarks:
Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also:
ResourceGroupManager for unloading of resource groups.

Parameters:

reloadableOnly If true (the default), only unload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't load them later. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

See also:
Resource::isReloadable for resource is reloadable.

virtual void Ogre::ResourceManager::unloadUnreferencedResources ( bool reloadableOnly = true ) [virtual, inherited]

Unload all resources which are not referenced by any other object.

Remarks:
This method behaves like unloadAll, except that it only unloads resources which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory).

Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, unload or reload that resource will cause dangerous pointer access. Use this function instead of unloadAll allows you avoid fail in those situations.

Parameters:

reloadableOnly If true (the default), only unloads resources which can be subsequently automatically reloaded.

Member Data Documentation

Chains Ogre::CompositorManager::mChains [private]

Definition at line 111 of file OgreCompositorManager.h.

Real Ogre::ResourceManager::mLoadOrder [protected, inherited]

Loading order relative to other managers, higher is later.

Definition at line 400 of file OgreResourceManager.h.

size_t Ogre::ResourceManager::mMemoryBudget [protected, inherited]

Definition at line 392 of file OgreResourceManager.h.

size_t Ogre::ResourceManager::mMemoryUsage [protected, inherited]

Definition at line 393 of file OgreResourceManager.h.

ResourceHandle Ogre::ResourceManager::mNextHandle [protected, inherited]

Definition at line 391 of file OgreResourceManager.h.

Rectangle2D* Ogre::CompositorManager::mRectangle [private]

Definition at line 120 of file OgreCompositorManager.h.

ResourceMap Ogre::ResourceManager::mResources [protected, inherited]

Definition at line 390 of file OgreResourceManager.h.

ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle [protected, inherited]

Definition at line 389 of file OgreResourceManager.h.

String Ogre::ResourceManager::mResourceType [protected, inherited]

String identifying the resource type this manager handles.

Definition at line 402 of file OgreResourceManager.h.

CompositorManager * Ogre::Singleton< CompositorManager >::ms_Singleton [static, protected, inherited]

Definition at line 54 of file OgreSingleton.h.

StringVector Ogre::ResourceManager::mScriptPatterns [protected, inherited]

Patterns to use to look for scripts if supported (e.g. *.overlay).

Definition at line 398 of file OgreResourceManager.h.

CompositorSerializer Ogre::CompositorManager::mSerializer [private]

Serializer.

Definition at line 114 of file OgreCompositorManager.h.

The documentation for this class was generated from the following file:

OgreCompositorManager.h

Ogre::CompositorManager Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation