Ogre::MaterialManager Class Reference
Materials

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

`#include <OgreMaterialManager.h>`

Inheritance diagram for Ogre::MaterialManager:
[legend]

List of all members.

## Classes

class | Listener
| Listener on any general material events. More...

## Public Types

typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult
typedef HashMap< String, ResourcePtr > | ResourceMap
typedef HashMap< String, ResourceMap > | ResourceWithGroupMap
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap
typedef MapIterator < ResourceHandleMap > | ResourceMapIterator

## Public Member Functions

| MaterialManager ()
| Default constructor.
virtual | ~MaterialManager ()
| Default destructor.
void | initialise (void)
| Initialises 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 void | addListener (Listener *l, const Ogre::String &schemeName=StringUtil::BLANK)
| Add a listener to handle material events.
virtual void | removeListener (Listener *l, const Ogre::String &schemeName=StringUtil::BLANK)
| Remove a listener handling material events.
virtual Technique * | _arbitrateMissingTechniqueForActiveScheme (Material *mat, unsigned short lodIndex, const Renderable *rend)
| Internal method for sorting out missing technique for a 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 void | removeUnreferencedResources (bool reloadableOnly=true)
| Remove all resources which are not referenced by any other object.
virtual ResourcePtr | getByName (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.
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', i.e.
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 | 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).
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).
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.
virtual void | setVerbose (bool v)
| Sets whether this manager and its resources habitually produce log output.
virtual bool | getVerbose (void)
| Gets whether this manager and its resources habitually produce log output.
ResourcePool * | getResourcePool (const String &name)
| Create a resource pool, or reuse one that already exists.
void | destroyResourcePool (ResourcePool *pool)
| Destroy a resource pool.
void | destroyResourcePool (const String &name)
| Destroy a resource pool.
void | destroyAllResourcePools ()
| destroy all pools
ResourceMapIterator | getResourceIterator (void)
| Returns an iterator over all resources in this manager.
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
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 *)

## 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 map< String, unsigned short >::type | SchemeMap
| Scheme name -> index. Never shrinks! Should be pretty static anyway.
typedef list< Listener * >::type | ListenerList
| The list of per-scheme (and general) material listeners.
typedef std::map< String, ListenerList > | ListenerMap
typedef map< String, ResourcePool * >::type | ResourcePoolMap

## Protected Member Functions

| 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.
ListenerMap | mListenerMap
ResourceHandleMap | mResourcesByHandle
ResourceMap | mResources
ResourceWithGroupMap | mResourcesWithGroup
ResourceHandle | mNextHandle
size_t | mMemoryBudget
AtomicScalar< size_t > | mMemoryUsage
bool | mVerbose
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.
ResourcePoolMap | mResourcePoolMap

## Static Protected Attributes

static MaterialManager * | msSingleton

## 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 63 of file OgreMaterialManager.h.

## Member Typedef Documentation

typedef list<Listener*>::type Ogre::MaterialManager::ListenerList `[protected]`

The list of per-scheme (and general) material listeners.

Definition at line 138 of file OgreMaterialManager.h.

typedef std::map<String, ListenerList> Ogre::MaterialManager::ListenerMap `[protected]`

Definition at line 139 of file OgreMaterialManager.h.

typedef std::pair<ResourcePtr, bool> Ogre::ResourceManager::ResourceCreateOrRetrieveResult `[inherited]`

Definition at line 103 of file OgreResourceManager.h.

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

Definition at line 494 of file OgreResourceManager.h.

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

Definition at line 492 of file OgreResourceManager.h.

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

Definition at line 515 of file OgreResourceManager.h.

typedef map<String, ResourcePool*>::type Ogre::ResourceManager::ResourcePoolMap `[protected, inherited]`

Definition at line 526 of file OgreResourceManager.h.

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

Definition at line 493 of file OgreResourceManager.h.

typedef map<String, unsigned short>::type Ogre::MaterialManager::SchemeMap `[protected]`

Scheme name -> index. Never shrinks! Should be pretty static anyway.

Definition at line 129 of file OgreMaterialManager.h.

## Constructor & Destructor Documentation

Ogre::MaterialManager::MaterialManager | ( |  | ) |

Default constructor.

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

Default destructor.

## Member Function Documentation

virtual Technique* Ogre::MaterialManager::_arbitrateMissingTechniqueForActiveScheme | ( | Material * | mat,
|  | unsigned short | lodIndex,
|  | const Renderable * | rend
| ) |  | `[virtual]`

Internal method for sorting out missing technique for a scheme.

virtual unsigned short Ogre::MaterialManager::_getActiveSchemeIndex | ( | void |  | ) | const`[virtual]`

Internal method - returns the active scheme index.

See also:
  Technique::setSchemeName

virtual unsigned short Ogre::MaterialManager::_getSchemeIndex | ( | const String & | name | ) | `[virtual]`

Internal method - returns index for a given material scheme name.

See also:
  Technique::setSchemeName

virtual const String& Ogre::MaterialManager::_getSchemeName | ( | unsigned short | index | ) | `[virtual]`

Internal method - returns name for a given material scheme index.

See also:
  Technique::setSchemeName

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', i.e.

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::MaterialManager::addListener | ( | Listener * | l,
|  | const Ogre::String & | schemeName = `StringUtil::BLANK`
| ) |  | `[virtual]`

Add a listener to handle material events.

If schemeName is supplied, the listener will only receive events for that certain scheme.

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 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.

Remarks:
  This method performs the same task as calling getByName() followed by create() if that returns null. The advantage is that it does it in one call so there are no race conditions if using multiple threads that could cause getByName() to return null, but create() to fail because another thread created a resource in between.

See also:
  ResourceManager::create
  ResourceManager::getByName

Returns:
  A pair, the first element being the pointer, and the second being an indicator specifying whether the resource was newly created.

void Ogre::ResourceManager::destroyAllResourcePools | ( |  | ) | `[inherited]`

destroy all pools

void Ogre::ResourceManager::destroyResourcePool | ( | ResourcePool * | pool | ) | `[inherited]`

Destroy a resource pool.

void Ogre::ResourceManager::destroyResourcePool | ( | const String & | name | ) | `[inherited]`

Destroy a resource pool.

virtual const String& Ogre::MaterialManager::getActiveScheme | ( | void |  | ) | const`[virtual]`

Returns the name of the active material scheme.

See also:
  Technique::setSchemeName

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,
|  | const String & | groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_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 224 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 412 of file OgreResourceManager.h.

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]`

Gets the current memory usage, in bytes.

Definition at line 136 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 520 of file OgreResourceManager.h.

ResourcePool* Ogre::ResourceManager::getResourcePool | ( | const String & | name | ) | `[inherited]`

Create a resource pool, or reuse one that already exists.

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

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

Definition at line 415 of file OgreResourceManager.h.

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 388 of file OgreResourceManager.h.

static 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 >.

static 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 >.

virtual bool Ogre::ResourceManager::getVerbose | ( | void |  | ) | `[virtual, inherited]`

Gets whether this manager and its resources habitually produce log output.

Definition at line 421 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.

virtual ResourcePtr Ogre::ResourceManager::load | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | loadParams = `0`,
|  | bool | backgroundThread = `false`
| ) |  | `[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.
  backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread

Ogre::MaterialManager::OGRE_THREAD_POINTER | ( | MaterialSerializer | ,
|  | mSerializer |
| ) |  | `[protected]`

Serializer - Hold instance per thread if necessary.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | `[inherited]`

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  | `[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  | `[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | `[inherited]`

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  | `[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  | `[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | `[inherited]`

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  | `[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  | `[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | `[inherited]`

Definition at line 90 of file OgreMemoryAllocatedObject.h.

void Ogre::MaterialManager::parseScript | ( | DataStreamPtr & | stream,
|  | const String & | groupName
| ) |  | `[virtual]`

See also:
  ScriptLoader::parseScript

Reimplemented from Ogre::ResourceManager.

virtual ResourcePtr Ogre::ResourceManager::prepare | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | loadParams = `0`,
|  | bool | backgroundThread = `false`
| ) |  | `[virtual, inherited]`

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).

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

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

Caused all currently loaded resources to be reloaded.

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

Parameters:

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

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

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

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

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

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

Parameters:

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

virtual void Ogre::ResourceManager::remove | ( | 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::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 | ( | 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::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.

Reimplemented in Ogre::CompositorManager.

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

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

virtual void Ogre::MaterialManager::removeListener | ( | Listener * | l,
|  | const Ogre::String & | schemeName = `StringUtil::BLANK`
| ) |  | `[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.

virtual void Ogre::ResourceManager::removeUnreferencedResources | ( | bool | reloadableOnly = `true` | ) | `[virtual, inherited]`

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

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

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

Parameters:

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

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

Returns whether the named resource exists in this manager.

Definition at line 308 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 313 of file OgreResourceManager.h.

virtual void Ogre::MaterialManager::setActiveScheme | ( | const String & | schemeName | ) | `[virtual]`

Sets the name of the active material scheme.

See also:
  Technique::setSchemeName

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 | ( | 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::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 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::setVerbose | ( | bool | v | ) | `[virtual, inherited]`

Sets whether this manager and its resources habitually produce log output.

Definition at line 418 of file OgreResourceManager.h.

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::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::unloadAll | ( | bool | reloadableOnly = `true` | ) | `[virtual, inherited]`

Unloads all resources.

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

See also:
  ResourceGroupManager for unloading of resource groups.

Parameters:

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

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

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

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

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

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

Parameters:

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

## Member Data Documentation

String Ogre::MaterialManager::DEFAULT_SCHEME_NAME `[static]`

Default material scheme.

Definition at line 144 of file OgreMaterialManager.h.

unsigned short Ogre::MaterialManager::mActiveSchemeIndex `[protected]`

Current material scheme.

Definition at line 135 of file OgreMaterialManager.h.

String Ogre::MaterialManager::mActiveSchemeName `[protected]`

Current material scheme.

Definition at line 133 of file OgreMaterialManager.h.

FilterOptions Ogre::MaterialManager::mDefaultMagFilter `[protected]`

Default Texture filtering - magnification.

Definition at line 114 of file OgreMaterialManager.h.

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

Default Texture anisotropy.

Definition at line 118 of file OgreMaterialManager.h.

FilterOptions Ogre::MaterialManager::mDefaultMinFilter `[protected]`

Default Texture filtering - minification.

Definition at line 112 of file OgreMaterialManager.h.

FilterOptions Ogre::MaterialManager::mDefaultMipFilter `[protected]`

Default Texture filtering - mipmapping.

Definition at line 116 of file OgreMaterialManager.h.

MaterialPtr Ogre::MaterialManager::mDefaultSettings `[protected]`

Default settings.

Definition at line 122 of file OgreMaterialManager.h.

ListenerMap Ogre::MaterialManager::mListenerMap `[protected]`

Definition at line 140 of file OgreMaterialManager.h.

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

Loading order relative to other managers, higher is later.

Definition at line 510 of file OgreResourceManager.h.

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

Definition at line 500 of file OgreResourceManager.h.

AtomicScalar<size_t> Ogre::ResourceManager::mMemoryUsage `[protected, inherited]`

Definition at line 501 of file OgreResourceManager.h.

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

Definition at line 499 of file OgreResourceManager.h.

ResourcePoolMap Ogre::ResourceManager::mResourcePoolMap `[protected, inherited]`

Definition at line 527 of file OgreResourceManager.h.

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

Definition at line 497 of file OgreResourceManager.h.

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

Definition at line 496 of file OgreResourceManager.h.

ResourceWithGroupMap Ogre::ResourceManager::mResourcesWithGroup `[protected, inherited]`

Definition at line 498 of file OgreResourceManager.h.

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

String identifying the resource type this manager handles.

Definition at line 512 of file OgreResourceManager.h.

SchemeMap Ogre::MaterialManager::mSchemes `[protected]`

List of material schemes.

Definition at line 131 of file OgreMaterialManager.h.

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

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

Definition at line 508 of file OgreResourceManager.h.

MaterialManager * Ogre::Singleton< MaterialManager >::msSingleton `[static, protected, inherited]`

Definition at line 75 of file OgreSingleton.h.

bool Ogre::ResourceManager::mVerbose `[protected, inherited]`

Definition at line 503 of file OgreResourceManager.h.

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

- OgreMaterialManager.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:30