Ogre::MaterialManager Class Reference

Class for managing Material settings for Ogre. More...

#include <OgreMaterialManager.h>

Inheritance diagram for Ogre::MaterialManager:

List of all members.


Public Types
typedef HashMap< String, ResourcePtr >	ResourceMap
typedef std::map< ResourceHandle, ResourcePtr >	ResourceHandleMap
typedef MapIterator< ResourceHandleMap >	ResourceMapIterator
Public Member Functions
	MaterialManager ()
	Default constructor.
virtual	~MaterialManager ()
	Default destructor.
void	initialise (void)
	Intialises the material manager, which also triggers it to parse all available .program and .material scripts.
void	parseScript (DataStreamPtr &stream, const String &groupName)
virtual void	setDefaultTextureFiltering (TextureFilterOptions fo)
	Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g.
virtual void	setDefaultTextureFiltering (FilterType ftype, FilterOptions opts)
	Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g.
virtual void	setDefaultTextureFiltering (FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
	Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g.
virtual FilterOptions	getDefaultTextureFiltering (FilterType ftype) const
	get the default texture filtering
void	setDefaultAnisotropy (unsigned int maxAniso)
	Sets the default anisotropy level to be used for loaded textures, for when textures are loaded automatically (e.g.
unsigned int	getDefaultAnisotropy () const
	get the default maxAnisotropy
virtual MaterialPtr	getDefaultSettings (void) const
	Returns a pointer to the default Material settings.
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 (void)
	Unloads all resources.
virtual void	reloadAll (void)
	Caused all currently loaded 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 void	removeAll (void)
	Removes all resources.
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
MaterialManager &	getSingleton (void)
	Override standard Singleton retrieval.
MaterialManager *	getSingletonPtr (void)
	Override standard Singleton retrieval.
Protected Member Functions
Resource *	createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader loader, const NameValuePairList params)
	Overridden from ResourceManager.
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
FilterOptions	mDefaultMinFilter
	Default Texture filtering - minification.
FilterOptions	mDefaultMagFilter
	Default Texture filtering - magnification.
FilterOptions	mDefaultMipFilter
	Default Texture filtering - mipmapping.
unsigned int	mDefaultMaxAniso
	Default Texture anisotropy.
MaterialSerializer	mSerializer
	Serializer.
MaterialPtr	mDefaultSettings
	Default settings.
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
MaterialManager *	ms_Singleton

Detailed Description

Class for managing Material settings for Ogre.

Remarks:: Materials control the eventual surface rendering properties of geometry. This class manages the library of materials, dealing with programmatic registrations and lookups, as well as loading predefined Material settings from scripts.

: When loaded from a script, a Material 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.

: For a definition of the material script format, see the Tutorials/MaterialScript.html file.

Definition at line 54 of file OgreMaterialManager.h.

Member Typedef Documentation

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

Definition at line 343 of file OgreResourceManager.h.

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

Definition at line 342 of file OgreResourceManager.h.

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

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

Constructor & Destructor Documentation

Ogre::MaterialManager::MaterialManager ( )

Default constructor.

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

Default destructor.

Member Function Documentation

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.

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::MaterialManager::createImpl ( const String & name,

ResourceHandle handle,

const String & group,

bool isManual,

ManualResourceLoader * loader,

const NameValuePairList * params

) [protected, virtual]

Overridden from ResourceManager.

Implements Ogre::ResourceManager.

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.

unsigned int Ogre::MaterialManager::getDefaultAnisotropy ( ) const

get the default maxAnisotropy

virtual MaterialPtr Ogre::MaterialManager::getDefaultSettings ( void ) const [virtual]

Returns a pointer to the default Material settings.

Remarks:
Ogre comes configured with a set of defaults for newly created materials. If you wish to have a different set of defaults, simply call this method and change the returned Material's settings. All materials created from then on will be configured with the new defaults you have specified.

The default settings begin as a single Technique with a single, non-programmable Pass:

ambient = ColourValue::White

diffuse = ColourValue::White

specular = ColourValue::Black

emmissive = ColourValue::Black

shininess = 0

No texture unit settings (& hence no textures)

SourceBlendFactor = SBF_ONE

DestBlendFactor = SBF_ZERO (no blend, replace with new colour)

Depth buffer checking on

Depth buffer writing on

Depth buffer comparison function = CMPF_LESS_EQUAL

Colour buffer writing on for all channels

Culling mode = CULL_CLOCKWISE

Ambient lighting = ColourValue(0.5, 0.5, 0.5) (mid-grey)

Dynamic lighting enabled

Gourad shading mode

Bilinear texture filtering

Definition at line 155 of file OgreMaterialManager.h.

virtual FilterOptions Ogre::MaterialManager::getDefaultTextureFiltering ( FilterType ftype ) const [virtual]

get the default texture filtering

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 296 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 338 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 366 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 299 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 273 of file OgreResourceManager.h.
References Ogre::StringVector.

MaterialManager& Ogre::MaterialManager::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< MaterialManager >.

MaterialManager* Ogre::MaterialManager::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< MaterialManager >.

void Ogre::MaterialManager::initialise ( void )

Intialises the material manager, which also triggers it to parse all available .program and .material 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::MaterialManager::parseScript ( DataStreamPtr & stream,

const String & groupName

) [virtual]

See also:
ScriptLoader::parseScript

Reimplemented from Ogre::ResourceManager.

virtual void Ogre::ResourceManager::reloadAll ( void ) [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.

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.

virtual void Ogre::ResourceManager::removeAll ( void ) [virtual, inherited]

Removes all resources.

Note:
The word 'Destroy' is not used here, since if any other pointers are referring to these resources, they will persist until they have been finished with; however to all intents and purposes the resources no longer exist and will 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::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 221 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 216 of file OgreResourceManager.h.
References Ogre::SharedPtr< T >::isNull(), and Ogre::String.

void Ogre::MaterialManager::setDefaultAnisotropy ( unsigned int maxAniso )

Sets the default anisotropy level to be used for loaded textures, for when textures are loaded automatically (e.g.
by Material class) or when 'load' is called with the default parameters by the application.
Note:
The default value is 1 (no anisotropy).

virtual void Ogre::MaterialManager::setDefaultTextureFiltering ( FilterOptions minFilter,

FilterOptions magFilter,

FilterOptions mipFilter

) [virtual]

Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g.
by Material class) or when 'load' is called with the default parameters by the application.

virtual void Ogre::MaterialManager::setDefaultTextureFiltering ( FilterType ftype,

FilterOptions opts

) [virtual]

Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g.
by Material class) or when 'load' is called with the default parameters by the application.

virtual void Ogre::MaterialManager::setDefaultTextureFiltering ( TextureFilterOptions fo ) [virtual]

Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g.
by Material class) or when 'load' is called with the default parameters by the application.
Note:
The default value is TFO_BILINEAR.

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 ( void ) [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.

Member Data Documentation

FilterOptions Ogre::MaterialManager::mDefaultMagFilter [protected]

Default Texture filtering - magnification.

Definition at line 61 of file OgreMaterialManager.h.

unsigned int Ogre::MaterialManager::mDefaultMaxAniso [protected]

Default Texture anisotropy.

Definition at line 65 of file OgreMaterialManager.h.

FilterOptions Ogre::MaterialManager::mDefaultMinFilter [protected]

Default Texture filtering - minification.

Definition at line 59 of file OgreMaterialManager.h.

FilterOptions Ogre::MaterialManager::mDefaultMipFilter [protected]

Default Texture filtering - mipmapping.

Definition at line 63 of file OgreMaterialManager.h.

MaterialPtr Ogre::MaterialManager::mDefaultSettings [protected]

Default settings.

Definition at line 70 of file OgreMaterialManager.h.

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

Loading order relative to other managers, higher is later.

Definition at line 356 of file OgreResourceManager.h.

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

Definition at line 348 of file OgreResourceManager.h.

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

Definition at line 349 of file OgreResourceManager.h.

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

Definition at line 347 of file OgreResourceManager.h.

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

Definition at line 346 of file OgreResourceManager.h.

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

Definition at line 345 of file OgreResourceManager.h.

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

String identifying the resource type this manager handles.

Definition at line 358 of file OgreResourceManager.h.

MaterialManager * Ogre::Singleton< MaterialManager >::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 354 of file OgreResourceManager.h.