Class for managing Material settings for Ogre. More...
#include <OgreMaterialManager.h>
Classes | |
class | Listener |
Listener on any general material events. More... | |
Public Types | |
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult |
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap |
typedef HashMap< String, ResourcePtr > | ResourceMap |
typedef MapIterator < ResourceHandleMap > | ResourceMapIterator |
typedef HashMap< String, ResourceMap > | ResourceWithGroupMap |
Public Member Functions | |
MaterialManager () | |
Default constructor. More... | |
virtual | ~MaterialManager () |
Default destructor. More... | |
virtual Technique * | _arbitrateMissingTechniqueForActiveScheme (Material *mat, unsigned short lodIndex, const Renderable *rend) |
Internal method for sorting out missing technique for a scheme. More... | |
virtual unsigned short | _getActiveSchemeIndex (void) const |
Internal method - returns the active scheme index. More... | |
virtual unsigned short | _getSchemeIndex (const String &name) |
Internal method - returns index for a given material scheme name. More... | |
virtual const String & | _getSchemeName (unsigned short index) |
Internal method - returns name for a given material scheme index. More... | |
virtual void | _notifyResourceLoaded (Resource *res) |
Notify this manager that a resource which it manages has been loaded. More... | |
virtual void | _notifyResourceTouched (Resource *res) |
Notify this manager that a resource which it manages has been 'touched', i.e. More... | |
virtual void | _notifyResourceUnloaded (Resource *res) |
Notify this manager that a resource which it manages has been unloaded. More... | |
virtual void | addListener (Listener *l, const Ogre::String &schemeName=StringUtil::BLANK) |
Add a listener to handle material events. More... | |
MaterialPtr | create (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0) |
Create a new material. More... | |
virtual ResourceCreateOrRetrieveResult | createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0) |
Create a new resource, or retrieve an existing one with the same name if it already exists. More... | |
virtual ResourcePtr | createResource (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. More... | |
void | destroyAllResourcePools () |
destroy all pools More... | |
void | destroyResourcePool (ResourcePool *pool) |
Destroy a resource pool. More... | |
void | destroyResourcePool (const String &name) |
Destroy a resource pool. More... | |
virtual const String & | getActiveScheme (void) const |
Returns the name of the active material scheme. More... | |
virtual ResourcePtr | getByHandle (ResourceHandle handle) |
Retrieves a pointer to a resource by handle, or null if the resource does not exist. More... | |
MaterialPtr | getByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME) |
Get a resource by name. More... | |
unsigned int | getDefaultAnisotropy () const |
Get the default maxAnisotropy. More... | |
virtual MaterialPtr | getDefaultSettings (void) const |
Returns a pointer to the default Material settings. More... | |
virtual FilterOptions | getDefaultTextureFiltering (FilterType ftype) const |
Get the default texture filtering. More... | |
virtual Real | getLoadingOrder (void) const |
Gets the relative loading order of resources of this type. More... | |
virtual size_t | getMemoryBudget (void) const |
Get the limit on the amount of memory this resource handler may use. More... | |
virtual size_t | getMemoryUsage (void) const |
Gets the current memory usage, in bytes. More... | |
virtual ResourcePtr | getResourceByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME) |
Retrieves a pointer to a resource by name, or null if the resource does not exist. More... | |
ResourceMapIterator | getResourceIterator (void) |
Returns an iterator over all resources in this manager. More... | |
ResourcePool * | getResourcePool (const String &name) |
Create a resource pool, or reuse one that already exists. More... | |
const String & | getResourceType (void) const |
Gets a string identifying the type of resource this manager handles. More... | |
virtual const StringVector & | getScriptPatterns (void) const |
Gets the file patterns which should be used to find scripts for this ResourceManager. More... | |
virtual bool | getVerbose (void) |
Gets whether this manager and its resources habitually produce log output. More... | |
void | initialise (void) |
Initialises the material manager, which also triggers it to parse all available .program and .material scripts. More... | |
virtual ResourcePtr | load (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false) |
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). More... | |
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 *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
void | parseScript (DataStreamPtr &stream, const String &groupName) |
virtual ResourcePtr | prepare (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false) |
Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type parameters). More... | |
virtual void | reloadAll (bool reloadableOnly=true) |
Caused all currently loaded resources to be reloaded. More... | |
virtual void | reloadUnreferencedResources (bool reloadableOnly=true) |
Caused all currently loaded but not referenced by any other object resources to be reloaded. More... | |
virtual void | remove (ResourcePtr &r) |
Remove a single resource. More... | |
virtual void | remove (const String &name) |
Remove a single resource by name. More... | |
virtual void | remove (ResourceHandle handle) |
Remove a single resource by handle. More... | |
virtual void | removeAll (void) |
Removes all resources. More... | |
virtual void | removeListener (Listener *l, const Ogre::String &schemeName=StringUtil::BLANK) |
Remove a listener handling material events. More... | |
virtual void | removeUnreferencedResources (bool reloadableOnly=true) |
Remove all resources which are not referenced by any other object. More... | |
virtual bool | resourceExists (const String &name) |
Returns whether the named resource exists in this manager. More... | |
virtual bool | resourceExists (ResourceHandle handle) |
Returns whether a resource with the given handle exists in this manager. More... | |
virtual void | setActiveScheme (const String &schemeName) |
Sets the name of the active material scheme. More... | |
void | setDefaultAnisotropy (unsigned int maxAniso) |
Sets the default anisotropy level to be used for loaded textures, for when textures are loaded automatically (e.g. More... | |
virtual void | setDefaultTextureFiltering (TextureFilterOptions fo) |
Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g. More... | |
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. More... | |
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. More... | |
virtual void | setMemoryBudget (size_t bytes) |
Set a limit on the amount of memory this resource handler may use. More... | |
virtual void | setVerbose (bool v) |
Sets whether this manager and its resources habitually produce log output. More... | |
virtual void | unload (const String &name) |
Unloads a single resource by name. More... | |
virtual void | unload (ResourceHandle handle) |
Unloads a single resource by handle. More... | |
virtual void | unloadAll (bool reloadableOnly=true) |
Unloads all resources. More... | |
virtual void | unloadUnreferencedResources (bool reloadableOnly=true) |
Unload all resources which are not referenced by any other object. More... | |
Static Public Member Functions | |
static MaterialManager & | getSingleton (void) |
Override standard Singleton retrieval. More... | |
static MaterialManager * | getSingletonPtr (void) |
Override standard Singleton retrieval. More... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
Static Public Attributes | |
static String | DEFAULT_SCHEME_NAME |
Default material scheme. More... | |
Protected Types | |
typedef list< Listener * >::type | ListenerList |
The list of per-scheme (and general) material listeners. More... | |
typedef map< String, ListenerList >::type | ListenerMap |
typedef map< String, ResourcePool * >::type | ResourcePoolMap |
typedef map< String, unsigned short >::type | SchemeMap |
Scheme name -> index. Never shrinks! Should be pretty static anyway. More... | |
Protected Member Functions | |
virtual void | addImpl (ResourcePtr &res) |
Add a newly created resource to the manager (note weak reference) More... | |
virtual void | checkUsage (void) |
Checks memory usage and pages out if required. More... | |
Resource * | createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *params) |
Overridden from ResourceManager. More... | |
ResourceHandle | getNextHandle (void) |
Allocates the next handle. More... | |
OGRE_THREAD_POINTER (MaterialSerializer, mSerializer) | |
Serializer - Hold instance per thread if necessary. More... | |
virtual void | removeImpl (ResourcePtr &res) |
Remove a resource from this manager; remove it from the lists. More... | |
Static Protected Attributes | |
static MaterialManager * | msSingleton |
Class for managing Material settings for Ogre.
Definition at line 64 of file OgreMaterialManager.h.
|
protected |
The list of per-scheme (and general) material listeners.
Definition at line 146 of file OgreMaterialManager.h.
|
protected |
Definition at line 147 of file OgreMaterialManager.h.
|
inherited |
Definition at line 152 of file OgreResourceManager.h.
|
inherited |
Definition at line 543 of file OgreResourceManager.h.
|
inherited |
Definition at line 541 of file OgreResourceManager.h.
|
inherited |
Definition at line 564 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 575 of file OgreResourceManager.h.
|
inherited |
Definition at line 542 of file OgreResourceManager.h.
|
protected |
Scheme name -> index. Never shrinks! Should be pretty static anyway.
Definition at line 137 of file OgreMaterialManager.h.
Ogre::MaterialManager::MaterialManager | ( | ) |
Default constructor.
|
virtual |
Default destructor.
|
virtual |
Internal method for sorting out missing technique for a scheme.
|
virtual |
Internal method - returns the active scheme index.
|
virtual |
Internal method - returns index for a given material scheme name.
|
virtual |
Internal method - returns name for a given material scheme index.
|
virtualinherited |
Notify this manager that a resource which it manages has been loaded.
|
virtualinherited |
Notify this manager that a resource which it manages has been 'touched', i.e.
used.
|
virtualinherited |
Notify this manager that a resource which it manages has been unloaded.
|
protectedvirtualinherited |
Add a newly created resource to the manager (note weak reference)
|
virtual |
Add a listener to handle material events.
If schemeName is supplied, the listener will only receive events for that certain scheme.
|
protectedvirtualinherited |
Checks memory usage and pages out if required.
This is automatically done after a new resource is loaded.
MaterialPtr Ogre::MaterialManager::create | ( | const String & | name, |
const String & | group, | ||
bool | isManual = false , |
||
ManualResourceLoader * | loader = 0 , |
||
const NameValuePairList * | createParams = 0 |
||
) |
Create a new material.
|
protectedvirtual |
Overridden from ResourceManager.
Implements Ogre::ResourceManager.
|
virtualinherited |
Create a new resource, or retrieve an existing one with the same name if it already exists.
|
virtualinherited |
Creates a new blank resource, but does not immediately load it.
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 |
|
inherited |
destroy all pools
|
inherited |
Destroy a resource pool.
|
inherited |
Destroy a resource pool.
|
virtual |
Returns the name of the active material scheme.
|
virtualinherited |
Retrieves a pointer to a resource by handle, or null if the resource does not exist.
MaterialPtr Ogre::MaterialManager::getByName | ( | const String & | name, |
const String & | groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME |
||
) |
Get a resource by name.
unsigned int Ogre::MaterialManager::getDefaultAnisotropy | ( | ) | const |
Get the default maxAnisotropy.
|
inlinevirtual |
Returns a pointer to the default Material settings.
Definition at line 242 of file OgreMaterialManager.h.
|
virtual |
Get the default texture filtering.
|
inlinevirtualinherited |
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader.
Definition at line 461 of file OgreResourceManager.h.
|
virtualinherited |
Get the limit on the amount of memory this resource handler may use.
|
inlinevirtualinherited |
Gets the current memory usage, in bytes.
Definition at line 185 of file OgreResourceManager.h.
|
protectedinherited |
Allocates the next handle.
|
virtualinherited |
Retrieves a pointer to a resource by name, or null if the resource does not exist.
|
inlineinherited |
Returns an iterator over all resources in this manager.
Definition at line 569 of file OgreResourceManager.h.
|
inherited |
Create a resource pool, or reuse one that already exists.
|
inlineinherited |
Gets a string identifying the type of resource this manager handles.
Definition at line 464 of file OgreResourceManager.h.
|
inlinevirtualinherited |
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader.
Definition at line 437 of file OgreResourceManager.h.
|
static |
Override standard Singleton retrieval.
|
static |
Override standard Singleton retrieval.
|
inlinevirtualinherited |
Gets whether this manager and its resources habitually produce log output.
Definition at line 470 of file OgreResourceManager.h.
void Ogre::MaterialManager::initialise | ( | void | ) |
Initialises the material manager, which also triggers it to parse all available .program and .material scripts.
|
virtualinherited |
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).
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. |
backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread |
|
protected |
Serializer - Hold instance per thread if necessary.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
virtual |
Reimplemented from Ogre::ResourceManager.
|
virtualinherited |
Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type 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. |
backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread |
|
virtualinherited |
Caused all currently loaded resources to be reloaded.
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. |
|
virtualinherited |
Caused all currently loaded but not referenced by any other object resources to be reloaded.
reloadableOnly | If true (the default), only reloads resources which can be subsequently automatically reloaded. |
|
virtualinherited |
Remove a single resource.
|
virtualinherited |
Remove a single resource by name.
|
virtualinherited |
Remove a single resource by handle.
|
virtualinherited |
Removes all resources.
Reimplemented in Ogre::CompositorManager.
|
protectedvirtualinherited |
Remove a resource from this manager; remove it from the lists.
|
virtual |
Remove a listener handling material events.
If the listener was added with a custom scheme name, it needs to be supplied here as well.
|
virtualinherited |
Remove all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only removes resources which can be subsequently automatically reloaded. |
|
inlinevirtualinherited |
Returns whether the named resource exists in this manager.
Definition at line 357 of file OgreResourceManager.h.
|
inlinevirtualinherited |
Returns whether a resource with the given handle exists in this manager.
Definition at line 362 of file OgreResourceManager.h.
|
virtual |
Sets the name of the active material scheme.
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.
|
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 |
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 |
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.
|
virtualinherited |
Set a limit on the amount of memory this resource handler may use.
|
inlinevirtualinherited |
Sets whether this manager and its resources habitually produce log output.
Definition at line 467 of file OgreResourceManager.h.
|
virtualinherited |
Unloads a single resource by name.
|
virtualinherited |
Unloads a single resource by handle.
|
virtualinherited |
Unloads all resources.
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. |
|
virtualinherited |
Unload all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only unloads resources which can be subsequently automatically reloaded. |
|
static |
Default material scheme.
Definition at line 152 of file OgreMaterialManager.h.
|
protected |
Current material scheme.
Definition at line 143 of file OgreMaterialManager.h.
|
protected |
Current material scheme.
Definition at line 141 of file OgreMaterialManager.h.
|
protected |
Default Texture filtering - comparison.
Definition at line 119 of file OgreMaterialManager.h.
|
protected |
Definition at line 121 of file OgreMaterialManager.h.
|
protected |
Definition at line 122 of file OgreMaterialManager.h.
|
protected |
Default Texture filtering - magnification.
Definition at line 115 of file OgreMaterialManager.h.
|
protected |
Default Texture anisotropy.
Definition at line 125 of file OgreMaterialManager.h.
|
protected |
Default Texture filtering - minification.
Definition at line 113 of file OgreMaterialManager.h.
|
protected |
Default Texture filtering - mipmapping.
Definition at line 117 of file OgreMaterialManager.h.
|
protected |
Default settings.
Definition at line 129 of file OgreMaterialManager.h.
|
protected |
Definition at line 148 of file OgreMaterialManager.h.
|
protectedinherited |
Loading order relative to other managers, higher is later.
Definition at line 559 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 548 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 550 of file OgreResourceManager.h.
|
protectedinherited |
In bytes.
Definition at line 549 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 576 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 546 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 545 of file OgreResourceManager.h.
|
protectedinherited |
Definition at line 547 of file OgreResourceManager.h.
|
protectedinherited |
String identifying the resource type this manager handles.
Definition at line 561 of file OgreResourceManager.h.
|
protected |
List of material schemes.
Definition at line 139 of file OgreMaterialManager.h.
|
protectedinherited |
Patterns to use to look for scripts if supported (e.g. *.overlay)
Definition at line 557 of file OgreResourceManager.h.
|
staticprotectedinherited |
Definition at line 75 of file OgreSingleton.h.
|
protectedinherited |
In bytes.
Definition at line 552 of file OgreResourceManager.h.
|
inherited |
Definition at line 125 of file OgreResourceManager.h.