Ogre::Compositor Class Reference

Class representing a Compositor object. More...

#include <OgreCompositor.h>

Inheritance diagram for Ogre::Compositor:

List of all members.


Public Types
typedef std::vector< CompositionTechnique * >	Techniques
	Data types for internal lists.
typedef VectorIterator< Techniques >	TechniqueIterator
Public Member Functions
	Compositor (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)
	~Compositor ()
CompositionTechnique *	createTechnique ()
	Create a new technique, and return a pointer to it.
void	removeTechnique (size_t idx)
	Remove a technique.
CompositionTechnique *	getTechnique (size_t idx)
	Get a technique.
size_t	getNumTechniques ()
	Get the number of techniques.
void	removeAllTechniques ()
	Remove all techniques.
TechniqueIterator	getTechniqueIterator (void)
	Get an iterator over the Techniques in this compositor.
CompositionTechnique *	getSupportedTechnique (size_t idx)
	Get a supported technique.
size_t	getNumSupportedTechniques ()
	Get the number of supported techniques.
TechniqueIterator	getSupportedTechniqueIterator (void)
	Gets an iterator over all the Techniques which are supported by the current card.
virtual void	load (void)
	Loads the resource, if it is not already.
virtual void	reload (void)
	Reloads the resource, if it is already loaded.
bool	isReloadable (void) const
	Returns true if the Resource is reloadable, false otherwise.
bool	isManuallyLoaded (void) const
	Is this resource manually loaded?
virtual void	unload (void)
	Unloads the resource; this is not permanent, the resource can be reloaded later if required.
size_t	getSize (void) const
	Retrieves info about the size of the resource.
virtual void	touch (void)
	'Touches' the resource to indicate it has been used.
const String &	getName (void) const
	Gets resource name.
ResourceHandle	getHandle (void) const
bool	isLoaded (void) const
	Returns true if the Resource has been loaded, false otherwise.
const String &	getGroup (void)
	Gets the group which this resource is a member of.
void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource.
ResourceManager *	getCreator (void)
	Gets the manager which created this resource.
const String &	getOrigin (void) const
	Get the origin of this resource, e.g.
void	_notifyOrigin (const String &origin)
	Notify this resource of it's origin.
ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class.
const ParamDictionary *	getParamDictionary (void) const
const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object.
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method.
virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method.
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method.
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object.
Static Public Member Functions
void	cleanupDictionary ()
	Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
Protected Member Functions
void	loadImpl (void)

void	unloadImpl (void)

size_t	calculateSize (void) const

void	compile ()
	Check supportedness of techniques.
bool	createParamDictionary (const String &className)
	Internal method for creating a parameter dictionary for the class, if it does not already exist.
Protected Attributes
ResourceManager *	mCreator
	Creator.
String	mName
	Unique name of the resource.
String	mGroup
	The name of the resource group.
ResourceHandle	mHandle
	Numeric handle for more efficient look up than name.
bool	mIsLoaded
	Is the resource currently loaded?
size_t	mSize
	The size of the resource in bytes.
bool	mIsManual
	Is this file manually loaded?
String	mOrigin
	Origin of this resource (e.g. script name) - optional.
ManualResourceLoader *	mLoader
	Optional manual loader; if provided, data is loaded from here instead of a file.
String	mParamDictName
	Class name for this instance to be used as a lookup (must be initialised by subclasses).
Static Protected Attributes
ParamDictionaryMap	msDictionary
	Dictionary of parameters.
Private Attributes
Techniques	mTechniques
Techniques	mSupportedTechniques
bool	mCompilationRequired
	Compilation required This is set if the techniques change and the supportedness of techniques has to be re-evaluated.

Detailed Description

Class representing a Compositor object.

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.

Definition at line 39 of file OgreCompositor.h.

Member Typedef Documentation

typedef VectorIterator<Techniques> Ogre::Compositor::TechniqueIterator

Definition at line 48 of file OgreCompositor.h.

typedef std::vector<CompositionTechnique *> Ogre::Compositor::Techniques

Data types for internal lists.

Definition at line 47 of file OgreCompositor.h.

Constructor & Destructor Documentation

Ogre::Compositor::Compositor ( ResourceManager * creator,

const String & name,

ResourceHandle handle,

const String & group,

bool isManual = false,

ManualResourceLoader * loader = 0

)

Ogre::Compositor::~Compositor ( )

Member Function Documentation

void Ogre::Resource::_notifyOrigin ( const String & origin ) [inherited]

Notify this resource of it's origin.

Definition at line 223 of file OgreResource.h.
References Ogre::String.

size_t Ogre::Compositor::calculateSize ( void ) const [protected, virtual]

Implements Ogre::Resource.

void Ogre::Resource::changeGroupOwnership ( const String & newGroup ) [inherited]

Change the resource group ownership of a Resource.

Remarks:
This method is generally reserved for internal use, although if you really know what you're doing you can use it to move this resource from one group to another.

Parameters:

newGroup Name of the new group

void Ogre::StringInterface::cleanupDictionary ( ) [static, inherited]

Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.

void Ogre::Compositor::compile ( ) [protected]

Check supportedness of techniques.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface * dest ) const [virtual, inherited]

Method for copying this object's parameters to another object.

Remarks:
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

Any unrecognised parameters will be ignored as with setParameter method.

Parameters:

dest Pointer to object to have it's parameters set the same as this object.

Definition at line 296 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

bool Ogre::StringInterface::createParamDictionary ( const String & className ) [protected, inherited]

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks:
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters:

className the name of the class using the dictionary

Returns:
true if a new dictionary was created, false if it was already there

Definition at line 172 of file OgreStringInterface.h.
References Ogre::String.

CompositionTechnique* Ogre::Compositor::createTechnique ( )

Create a new technique, and return a pointer to it.

ResourceManager* Ogre::Resource::getCreator ( void ) [inherited]

Gets the manager which created this resource.

Definition at line 214 of file OgreResource.h.

const String& Ogre::Resource::getGroup ( void ) [inherited]

Gets the group which this resource is a member of.

Definition at line 202 of file OgreResource.h.
References Ogre::String.

ResourceHandle Ogre::Resource::getHandle ( void ) const [inherited]

Definition at line 188 of file OgreResource.h.
References Ogre::ResourceHandle.

const String& Ogre::Resource::getName ( void ) const [inherited]

Gets resource name.

Definition at line 183 of file OgreResource.h.
References Ogre::String.

size_t Ogre::Compositor::getNumSupportedTechniques ( )

Get the number of supported techniques.

Remarks:
The supported technique list is only available after this compositor has been compiled, which typically happens on loading it. Therefore, if this method returns an empty list, try calling Compositor::load.

size_t Ogre::Compositor::getNumTechniques ( )

Get the number of techniques.

const String& Ogre::Resource::getOrigin ( void ) const [inherited]

Get the origin of this resource, e.g.
a script file name.
Remarks:
This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

Definition at line 221 of file OgreResource.h.
References Ogre::String.

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void ) const [inherited]

Definition at line 209 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void ) [inherited]

Retrieves the parameter dictionary for this class.

Remarks:
Only valid to call this after createParamDictionary.

Returns:
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 196 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String & name ) const [virtual, inherited]

Generic parameter retrieval method.

Remarks:
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters:

name The name of the parameter to get

Returns:
String value of parameter, blank if not found

Definition at line 265 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::String.

const ParameterList& Ogre::StringInterface::getParameters ( void ) const [inherited]

Retrieves a list of parameters valid for this object.

Returns:
A reference to a static list of ParameterDef objects.

size_t Ogre::Resource::getSize ( void ) const [inherited]

Retrieves info about the size of the resource.

Definition at line 172 of file OgreResource.h.

CompositionTechnique* Ogre::Compositor::getSupportedTechnique ( size_t idx )

Get a supported technique.

Remarks:
The supported technique list is only available after this compositor has been compiled, which typically happens on loading it. Therefore, if this method returns an empty list, try calling Compositor::load.

TechniqueIterator Ogre::Compositor::getSupportedTechniqueIterator ( void )

Gets an iterator over all the Techniques which are supported by the current card.

Remarks:
The supported technique list is only available after this compositor has been compiled, which typically happens on loading it. Therefore, if this method returns an empty list, try calling Compositor::load.

CompositionTechnique* Ogre::Compositor::getTechnique ( size_t idx )

Get a technique.

TechniqueIterator Ogre::Compositor::getTechniqueIterator ( void )

Get an iterator over the Techniques in this compositor.

bool Ogre::Resource::isLoaded ( void ) const [inherited]

Returns true if the Resource has been loaded, false otherwise.

Definition at line 195 of file OgreResource.h.
References OGRE_LOCK_AUTO_MUTEX.

bool Ogre::Resource::isManuallyLoaded ( void ) const [inherited]

Is this resource manually loaded?

Definition at line 160 of file OgreResource.h.

bool Ogre::Resource::isReloadable ( void ) const [inherited]

Returns true if the Resource is reloadable, false otherwise.

Definition at line 153 of file OgreResource.h.

virtual void Ogre::Resource::load ( void ) [virtual, inherited]

Loads the resource, if it is not already.

Remarks:
If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own

Reimplemented in Ogre::Mesh, and Ogre::GLSLGpuProgram.

void Ogre::Compositor::loadImpl ( void ) [protected, virtual]

Implements Ogre::Resource.

virtual void Ogre::Resource::reload ( void ) [virtual, inherited]

Reloads the resource, if it is already loaded.

Remarks:
Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

void Ogre::Compositor::removeAllTechniques ( )

Remove all techniques.

void Ogre::Compositor::removeTechnique ( size_t idx )

Remove a technique.
It will also be destroyed.

virtual bool Ogre::StringInterface::setParameter ( const String & name,

const String & value

) [virtual, inherited]

Generic parameter setting method.

Remarks:
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

name The name of the parameter to set

value String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.

Returns:
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList & paramList ) [virtual, inherited]

Generic multiple parameter setting method.

Remarks:
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

paramList Name/value pair list

virtual void Ogre::Resource::touch ( void ) [virtual, inherited]

'Touches' the resource to indicate it has been used.

Reimplemented in Ogre::Material.

virtual void Ogre::Resource::unload ( void ) [virtual, inherited]

Unloads the resource; this is not permanent, the resource can be reloaded later if required.

Reimplemented in Ogre::GLSLGpuProgram.

void Ogre::Compositor::unloadImpl ( void ) [protected, virtual]

Implements Ogre::Resource.

Member Data Documentation

bool Ogre::Compositor::mCompilationRequired [private]

Compilation required This is set if the techniques change and the supportedness of techniques has to be re-evaluated.

Definition at line 115 of file OgreCompositor.h.

ResourceManager* Ogre::Resource::mCreator [protected, inherited]

Creator.

Definition at line 73 of file OgreResource.h.

String Ogre::Resource::mGroup [protected, inherited]

The name of the resource group.

Definition at line 77 of file OgreResource.h.

ResourceHandle Ogre::Resource::mHandle [protected, inherited]

Numeric handle for more efficient look up than name.

Definition at line 79 of file OgreResource.h.

bool Ogre::Resource::mIsLoaded [protected, inherited]

Is the resource currently loaded?

Definition at line 81 of file OgreResource.h.

bool Ogre::Resource::mIsManual [protected, inherited]

Is this file manually loaded?

Definition at line 85 of file OgreResource.h.

ManualResourceLoader* Ogre::Resource::mLoader [protected, inherited]

Optional manual loader; if provided, data is loaded from here instead of a file.

Definition at line 89 of file OgreResource.h.

String Ogre::Resource::mName [protected, inherited]

Unique name of the resource.

Definition at line 75 of file OgreResource.h.

String Ogre::Resource::mOrigin [protected, inherited]

Origin of this resource (e.g. script name) - optional.

Definition at line 87 of file OgreResource.h.

String Ogre::StringInterface::mParamDictName [protected, inherited]

Class name for this instance to be used as a lookup (must be initialised by subclasses).

Definition at line 160 of file OgreStringInterface.h.