OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::MaterialManager Class Reference

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

#include <OgreMaterialManager.h>

+ Inheritance diagram for Ogre::MaterialManager:
+ Collaboration diagram for Ogre::MaterialManager:

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=BLANKSTRING)
 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 StringgetActiveScheme (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...
 
ResourcePoolgetResourcePool (const String &name)
 Create a resource pool, or reuse one that already exists. More...
 
const StringgetResourceType (void) const
 Gets a string identifying the type of resource this manager handles. More...
 
virtual const StringVectorgetScriptPatterns (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=BLANKSTRING)
 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 MaterialManagergetSingleton (void)
 Override standard Singleton retrieval. More...
 
static MaterialManagergetSingletonPtr (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...
 
ResourcecreateImpl (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...
 

Protected Attributes

unsigned short mActiveSchemeIndex
 Current material scheme. More...
 
String mActiveSchemeName
 Current material scheme. More...
 
FilterOptions mDefaultCompare
 Default Texture filtering - comparison. More...
 
bool mDefaultCompareEnabled
 
CompareFunction mDefaultCompareFunction
 
FilterOptions mDefaultMagFilter
 Default Texture filtering - magnification. More...
 
unsigned int mDefaultMaxAniso
 Default Texture anisotropy. More...
 
FilterOptions mDefaultMinFilter
 Default Texture filtering - minification. More...
 
FilterOptions mDefaultMipFilter
 Default Texture filtering - mipmapping. More...
 
MaterialPtr mDefaultSettings
 Default settings. More...
 
ListenerMap mListenerMap
 
Real mLoadOrder
 Loading order relative to other managers, higher is later. More...
 
size_t mMemoryBudget
 
AtomicScalar< size_t > mMemoryUsage
 
AtomicScalar< ResourceHandlemNextHandle
 In bytes. More...
 
ResourcePoolMap mResourcePoolMap
 
ResourceMap mResources
 
ResourceHandleMap mResourcesByHandle
 
ResourceWithGroupMap mResourcesWithGroup
 
String mResourceType
 String identifying the resource type this manager handles. More...
 
SchemeMap mSchemes
 List of material schemes. More...
 
StringVector mScriptPatterns
 Patterns to use to look for scripts if supported (e.g. *.overlay) More...
 
bool mVerbose
 In bytes. More...
 

Static Protected Attributes

static MaterialManagermsSingleton
 

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

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

Definition at line 145 of file OgreMaterialManager.h.

Definition at line 146 of file OgreMaterialManager.h.

Definition at line 150 of file OgreResourceManager.h.

Definition at line 539 of file OgreResourceManager.h.

typedef map<String, ResourcePool*>::type Ogre::ResourceManager::ResourcePoolMap
protectedinherited

Definition at line 573 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 136 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)
virtualinherited

Notify this manager that a resource which it manages has been loaded.

virtual void Ogre::ResourceManager::_notifyResourceTouched ( Resource res)
virtualinherited

Notify this manager that a resource which it manages has been 'touched', i.e.

used.

virtual void Ogre::ResourceManager::_notifyResourceUnloaded ( Resource res)
virtualinherited

Notify this manager that a resource which it manages has been unloaded.

virtual void Ogre::ResourceManager::addImpl ( ResourcePtr res)
protectedvirtualinherited

Add a newly created resource to the manager (note weak reference)

virtual void Ogre::MaterialManager::addListener ( Listener l,
const Ogre::String schemeName = BLANKSTRING 
)
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  )
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.

See also
ResourceManager::createResource
Resource* Ogre::MaterialManager::createImpl ( const String name,
ResourceHandle  handle,
const String group,
bool  isManual,
ManualResourceLoader loader,
const NameValuePairList params 
)
protectedvirtual

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

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::createResource
ResourceManager::getResourceByName
Returns
A pair, the first element being the pointer, and the second being an indicator specifying whether the resource was newly created.
virtual ResourcePtr Ogre::ResourceManager::createResource ( const String name,
const String group,
bool  isManual = false,
ManualResourceLoader loader = 0,
const NameValuePairList createParams = 0 
)
virtualinherited

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
nameThe unique name of the resource
groupThe name of the resource group to attach this new resource to
isManualIs 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.
loaderPointer 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.
createParamsIf any parameters are required to create an instance, they should be supplied here as name / value pairs
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)
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.

See also
ResourceManager::getResourceByName
unsigned int Ogre::MaterialManager::getDefaultAnisotropy ( ) const

Get the default maxAnisotropy.

virtual MaterialPtr Ogre::MaterialManager::getDefaultSettings ( void  ) const
inlinevirtual

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 241 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
inlinevirtualinherited

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

virtual size_t Ogre::ResourceManager::getMemoryBudget ( void  ) const
virtualinherited

Get the limit on the amount of memory this resource handler may use.

virtual size_t Ogre::ResourceManager::getMemoryUsage ( void  ) const
inlinevirtualinherited

Gets the current memory usage, in bytes.

Definition at line 183 of file OgreResourceManager.h.

ResourceHandle Ogre::ResourceManager::getNextHandle ( void  )
protectedinherited

Allocates the next handle.

virtual ResourcePtr Ogre::ResourceManager::getResourceByName ( const String name,
const String groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME 
)
virtualinherited

Retrieves a pointer to a resource by name, or null if the resource does not exist.

ResourceMapIterator Ogre::ResourceManager::getResourceIterator ( void  )
inlineinherited

Returns an iterator over all resources in this manager.

Note
Use of this iterator is NOT thread safe!

Definition at line 567 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
inlineinherited

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

Definition at line 462 of file OgreResourceManager.h.

virtual const StringVector& Ogre::ResourceManager::getScriptPatterns ( void  ) const
inlinevirtualinherited

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 435 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.
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.
virtual bool Ogre::ResourceManager::getVerbose ( void  )
inlinevirtualinherited

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

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

Parameters
nameThe name of the Resource
groupThe resource group to which this resource will belong
isManualIs the resource to be manually loaded? If so, you should provide a value for the loader parameter
loaderThe manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter
loadParamsOptional pointer to a list of name/value pairs containing loading parameters for this type of resource.
backgroundThreadOptional 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)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

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

Parameters
nameThe name of the Resource
groupThe resource group to which this resource will belong
isManualIs the resource to be manually loaded? If so, you should provide a value for the loader parameter
loaderThe manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter
loadParamsOptional pointer to a list of name/value pairs containing loading parameters for this type of resource.
backgroundThreadOptional 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)
virtualinherited

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
reloadableOnlyIf 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)
virtualinherited

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
reloadableOnlyIf true (the default), only reloads resources which can be subsequently automatically reloaded.
virtual void Ogre::ResourceManager::remove ( ResourcePtr r)
virtualinherited

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

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

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

Removes all resources.

Note
The word 'Destroy' is not used here, since if any other pointers are referring to these resources, they will persist until they have been finished with; however to all intents and purposes the resources no longer exist and will get destroyed imminently.
If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.
virtual void Ogre::ResourceManager::removeImpl ( ResourcePtr res)
protectedvirtualinherited

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

virtual void Ogre::MaterialManager::removeListener ( Listener l,
const Ogre::String schemeName = BLANKSTRING 
)
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)
virtualinherited

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
reloadableOnlyIf true (the default), only removes resources which can be subsequently automatically reloaded.
virtual bool Ogre::ResourceManager::resourceExists ( const String name)
inlinevirtualinherited

Returns whether the named resource exists in this manager.

Definition at line 355 of file OgreResourceManager.h.

virtual bool Ogre::ResourceManager::resourceExists ( ResourceHandle  handle)
inlinevirtualinherited

Returns whether a resource with the given handle exists in this manager.

Definition at line 360 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)
virtualinherited

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

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

Definition at line 465 of file OgreResourceManager.h.

virtual void Ogre::ResourceManager::unload ( const String name)
virtualinherited

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

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

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
reloadableOnlyIf 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)
virtualinherited

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
reloadableOnlyIf 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 151 of file OgreMaterialManager.h.

unsigned short Ogre::MaterialManager::mActiveSchemeIndex
protected

Current material scheme.

Definition at line 142 of file OgreMaterialManager.h.

String Ogre::MaterialManager::mActiveSchemeName
protected

Current material scheme.

Definition at line 140 of file OgreMaterialManager.h.

FilterOptions Ogre::MaterialManager::mDefaultCompare
protected

Default Texture filtering - comparison.

Definition at line 118 of file OgreMaterialManager.h.

bool Ogre::MaterialManager::mDefaultCompareEnabled
protected

Definition at line 120 of file OgreMaterialManager.h.

CompareFunction Ogre::MaterialManager::mDefaultCompareFunction
protected

Definition at line 121 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 124 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 128 of file OgreMaterialManager.h.

ListenerMap Ogre::MaterialManager::mListenerMap
protected

Definition at line 147 of file OgreMaterialManager.h.

Real Ogre::ResourceManager::mLoadOrder
protectedinherited

Loading order relative to other managers, higher is later.

Definition at line 557 of file OgreResourceManager.h.

size_t Ogre::ResourceManager::mMemoryBudget
protectedinherited

Definition at line 546 of file OgreResourceManager.h.

AtomicScalar<size_t> Ogre::ResourceManager::mMemoryUsage
protectedinherited

Definition at line 548 of file OgreResourceManager.h.

AtomicScalar<ResourceHandle> Ogre::ResourceManager::mNextHandle
protectedinherited

In bytes.

Definition at line 547 of file OgreResourceManager.h.

ResourcePoolMap Ogre::ResourceManager::mResourcePoolMap
protectedinherited

Definition at line 574 of file OgreResourceManager.h.

ResourceMap Ogre::ResourceManager::mResources
protectedinherited

Definition at line 544 of file OgreResourceManager.h.

ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle
protectedinherited

Definition at line 543 of file OgreResourceManager.h.

ResourceWithGroupMap Ogre::ResourceManager::mResourcesWithGroup
protectedinherited

Definition at line 545 of file OgreResourceManager.h.

String Ogre::ResourceManager::mResourceType
protectedinherited

String identifying the resource type this manager handles.

Definition at line 559 of file OgreResourceManager.h.

SchemeMap Ogre::MaterialManager::mSchemes
protected

List of material schemes.

Definition at line 138 of file OgreMaterialManager.h.

StringVector Ogre::ResourceManager::mScriptPatterns
protectedinherited

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

Definition at line 555 of file OgreResourceManager.h.

MaterialManager * Ogre::Singleton< MaterialManager >::msSingleton
staticprotectedinherited

Definition at line 75 of file OgreSingleton.h.

bool Ogre::ResourceManager::mVerbose
protectedinherited

In bytes.

Definition at line 550 of file OgreResourceManager.h.

Ogre::ResourceManager::OGRE_AUTO_MUTEX
inherited

Definition at line 123 of file OgreResourceManager.h.


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