#include <OgreMaterialManager.h>
Public Types | |
typedef std::pair < ResourcePtr, bool > | ResourceCreateOrRetrieveResult |
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 unsigned short | _getSchemeIndex (const String &name) |
Internal method - returns index for a given material scheme name. | |
virtual const String & | _getSchemeName (unsigned short index) |
Internal method - returns name for a given material scheme index. | |
virtual unsigned short | _getActiveSchemeIndex (void) const |
Internal method - returns the active scheme index. | |
virtual const String & | getActiveScheme (void) const |
Returns the name of the active material scheme. | |
virtual void | setActiveScheme (const String &schemeName) |
Sets the name of the active material scheme. | |
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 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. | |
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 size_t | getMemoryUsage (void) const |
Gets the current memory usage, in bytes. | |
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 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 | |
static MaterialManager & | getSingleton (void) |
Override standard Singleton retrieval. | |
static MaterialManager * | getSingletonPtr (void) |
Override standard Singleton retrieval. | |
Static Public Attributes | |
static String | DEFAULT_SCHEME_NAME |
Default material scheme. | |
Protected Types | |
typedef std::map < String, unsigned short > | SchemeMap |
Scheme name -> index. Never shrinks! Should be pretty static anyway. | |
Protected Member Functions | |
OGRE_THREAD_POINTER (MaterialScriptCompiler, mScriptCompiler) | |
New material compiler. Hold instance per thread if necessary. | |
OGRE_THREAD_POINTER (MaterialSerializer, mSerializer) | |
Serializer - Hold instance per thread if necessary. | |
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. | |
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. | |
MaterialPtr | mDefaultSettings |
Default settings. | |
SchemeMap | mSchemes |
List of material schemes. | |
String | mActiveSchemeName |
Current material scheme. | |
unsigned short | mActiveSchemeIndex |
Current material scheme. | |
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 | |
static T * | ms_Singleton |
Definition at line 66 of file OgreMaterialManager.h.
typedef std::map<String, unsigned short> Ogre::MaterialManager::SchemeMap [protected] |
Scheme name -> index. Never shrinks! Should be pretty static anyway.
Definition at line 90 of file OgreMaterialManager.h.
typedef std::pair<ResourcePtr, bool> Ogre::ResourceManager::ResourceCreateOrRetrieveResult [inherited] |
Definition at line 98 of file OgreResourceManager.h.
typedef HashMap< String, ResourcePtr > Ogre::ResourceManager::ResourceMap [inherited] |
Definition at line 411 of file OgreResourceManager.h.
typedef std::map<ResourceHandle, ResourcePtr> Ogre::ResourceManager::ResourceHandleMap [inherited] |
Definition at line 412 of file OgreResourceManager.h.
typedef MapIterator<ResourceHandleMap> Ogre::ResourceManager::ResourceMapIterator [inherited] |
Definition at line 430 of file OgreResourceManager.h.
Ogre::MaterialManager::MaterialManager | ( | ) |
Default constructor.
virtual Ogre::MaterialManager::~MaterialManager | ( | ) | [virtual] |
Default destructor.
Ogre::MaterialManager::OGRE_THREAD_POINTER | ( | MaterialScriptCompiler | , | |
mScriptCompiler | ||||
) | [protected] |
New material compiler. Hold instance per thread if necessary.
Ogre::MaterialManager::OGRE_THREAD_POINTER | ( | MaterialSerializer | , | |
mSerializer | ||||
) | [protected] |
Serializer - Hold instance per thread if necessary.
Resource* Ogre::MaterialManager::createImpl | ( | const String & | name, | |
ResourceHandle | handle, | |||
const String & | group, | |||
bool | isManual, | |||
ManualResourceLoader * | loader, | |||
const NameValuePairList * | params | |||
) | [protected, virtual] |
void Ogre::MaterialManager::initialise | ( | void | ) |
Intialises the material manager, which also triggers it to parse all available .program and .material scripts.
void Ogre::MaterialManager::parseScript | ( | DataStreamPtr & | stream, | |
const String & | groupName | |||
) | [virtual] |
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.
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 | ( | 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 FilterOptions Ogre::MaterialManager::getDefaultTextureFiltering | ( | FilterType | ftype | ) | const [virtual] |
get the default texture filtering
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.
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.
Definition at line 180 of file OgreMaterialManager.h.
virtual unsigned short Ogre::MaterialManager::_getSchemeIndex | ( | const String & | name | ) | [virtual] |
virtual const String& Ogre::MaterialManager::_getSchemeName | ( | unsigned short | index | ) | [virtual] |
virtual unsigned short Ogre::MaterialManager::_getActiveSchemeIndex | ( | void | ) | const [virtual] |
virtual const String& Ogre::MaterialManager::getActiveScheme | ( | void | ) | const [virtual] |
virtual void Ogre::MaterialManager::setActiveScheme | ( | const String & | schemeName | ) | [virtual] |
static MaterialManager& Ogre::MaterialManager::getSingleton | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< T >.
static MaterialManager* Ogre::MaterialManager::getSingletonPtr | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< T >.
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.
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 |
virtual ResourceCreateOrRetrieveResult Ogre::ResourceManager::createOrRetrieve | ( | const String & | name, | |
const String & | group, | |||
bool | isManual = false , |
|||
ManualResourceLoader * | loader = 0 , |
|||
const NameValuePairList * | createParams = 0 | |||
) | [virtual, inherited] |
Create a new resource, or retrieve an existing one with the same name if it already exists.
virtual void Ogre::ResourceManager::setMemoryBudget | ( | size_t | bytes | ) | [virtual, inherited] |
Set a limit on the amount of memory this resource handler may use.
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 [virtual, inherited] |
virtual void Ogre::ResourceManager::unload | ( | const String & | name | ) | [virtual, inherited] |
Unloads a single resource by name.
virtual void Ogre::ResourceManager::unload | ( | ResourceHandle | handle | ) | [virtual, inherited] |
Unloads a single resource by handle.
virtual void Ogre::ResourceManager::unloadAll | ( | bool | reloadableOnly = true |
) | [virtual, inherited] |
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. |
virtual void Ogre::ResourceManager::reloadAll | ( | bool | reloadableOnly = true |
) | [virtual, inherited] |
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. |
virtual void Ogre::ResourceManager::unloadUnreferencedResources | ( | bool | reloadableOnly = true |
) | [virtual, inherited] |
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. |
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.
reloadableOnly | If true (the default), only reloads resources which can be subsequently automatically reloaded. |
virtual void Ogre::ResourceManager::remove | ( | ResourcePtr & | r | ) | [virtual, inherited] |
Remove a single resource.
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.
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 | ( | ResourceHandle | handle | ) | [virtual, inherited] |
Remove a single resource by handle.
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.
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.
Reimplemented in Ogre::CompositorManager.
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.
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 bool Ogre::ResourceManager::resourceExists | ( | const String & | name | ) | [virtual, inherited] |
Returns whether the named resource exists in this manager.
Definition at line 287 of file OgreResourceManager.h.
virtual bool Ogre::ResourceManager::resourceExists | ( | ResourceHandle | handle | ) | [virtual, inherited] |
Returns whether a resource with the given handle exists in this manager.
Definition at line 292 of file OgreResourceManager.h.
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::_notifyResourceLoaded | ( | Resource * | res | ) | [virtual, inherited] |
Notify this manager that a resource which it manages has been loaded.
virtual void Ogre::ResourceManager::_notifyResourceUnloaded | ( | Resource * | res | ) | [virtual, inherited] |
Notify this manager that a resource which it manages has been unloaded.
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).
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. |
virtual const StringVector& Ogre::ResourceManager::getScriptPatterns | ( | void | ) | const [virtual, inherited] |
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader.
Definition at line 344 of file OgreResourceManager.h.
virtual Real Ogre::ResourceManager::getLoadingOrder | ( | void | ) | const [virtual, inherited] |
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader.
Definition at line 367 of file OgreResourceManager.h.
const String& Ogre::ResourceManager::getResourceType | ( | void | ) | const [inherited] |
Gets a string identifying the type of resource this manager handles.
Definition at line 370 of file OgreResourceManager.h.
ResourceHandle Ogre::ResourceManager::getNextHandle | ( | void | ) | [protected, inherited] |
Allocates the next handle.
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::removeImpl | ( | ResourcePtr & | res | ) | [protected, virtual, inherited] |
Remove a resource from this manager; remove it from the lists.
virtual void Ogre::ResourceManager::checkUsage | ( | void | ) | [protected, virtual, inherited] |
Checks memory usage and pages out if required.
ResourceMapIterator Ogre::ResourceManager::getResourceIterator | ( | void | ) | [inherited] |
Returns an iterator over all resources in this manager.
Definition at line 435 of file OgreResourceManager.h.
unsigned int Ogre::MaterialManager::mDefaultMaxAniso [protected] |
MaterialPtr Ogre::MaterialManager::mDefaultSettings [protected] |
SchemeMap Ogre::MaterialManager::mSchemes [protected] |
String Ogre::MaterialManager::mActiveSchemeName [protected] |
unsigned short Ogre::MaterialManager::mActiveSchemeIndex [protected] |
ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle [protected, inherited] |
Definition at line 414 of file OgreResourceManager.h.
ResourceMap Ogre::ResourceManager::mResources [protected, inherited] |
Definition at line 415 of file OgreResourceManager.h.
ResourceHandle Ogre::ResourceManager::mNextHandle [protected, inherited] |
Definition at line 416 of file OgreResourceManager.h.
size_t Ogre::ResourceManager::mMemoryBudget [protected, inherited] |
Definition at line 417 of file OgreResourceManager.h.
size_t Ogre::ResourceManager::mMemoryUsage [protected, inherited] |
Definition at line 418 of file OgreResourceManager.h.
StringVector Ogre::ResourceManager::mScriptPatterns [protected, inherited] |
Patterns to use to look for scripts if supported (e.g. *.overlay).
Definition at line 423 of file OgreResourceManager.h.
Real Ogre::ResourceManager::mLoadOrder [protected, inherited] |
Loading order relative to other managers, higher is later.
Definition at line 425 of file OgreResourceManager.h.
String Ogre::ResourceManager::mResourceType [protected, inherited] |
String identifying the resource type this manager handles.
Definition at line 427 of file OgreResourceManager.h.
T* Ogre::Singleton< T >::ms_Singleton [static, protected, inherited] |
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:50:28 2008