OgreMaterialManager.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __MATERIALMANAGER_H__
29 #define __MATERIALMANAGER_H__
30 
31 #include "OgrePrerequisites.h"
32 
33 #include "OgreSingleton.h"
34 #include "OgreResourceManager.h"
35 #include "OgreMaterial.h"
36 #include "OgreStringVector.h"
37 #include "OgreMaterialSerializer.h"
38 #include "OgreHeaderPrefix.h"
39 
40 namespace Ogre {
41 
42 
64  class _OgreExport MaterialManager : public ResourceManager, public Singleton<MaterialManager>
65  {
66  public:
70  class Listener
71  {
72  public:
74  virtual ~Listener() { }
104  virtual Technique* handleSchemeNotFound(unsigned short schemeIndex,
105  const String& schemeName, Material* originalMaterial, unsigned short lodIndex,
106  const Renderable* rend) = 0;
107 
108  };
109 
110  protected:
111 
120 
123 
125  unsigned int mDefaultMaxAniso;
130 
132  Resource* createImpl(const String& name, ResourceHandle handle,
133  const String& group, bool isManual, ManualResourceLoader* loader,
134  const NameValuePairList* params);
135 
143  unsigned short mActiveSchemeIndex;
144 
149 
150  public:
153 
156  MaterialPtr create (const String& name, const String& group,
157  bool isManual = false, ManualResourceLoader* loader = 0,
158  const NameValuePairList* createParams = 0);
159 
163 
167 
170  virtual ~MaterialManager();
171 
174  void initialise(void);
175 
178  void parseScript(DataStreamPtr& stream, const String& groupName);
179 
180 
197  virtual void setDefaultTextureFiltering(FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter);
198 
201 
208  void setDefaultAnisotropy(unsigned int maxAniso);
210  unsigned int getDefaultAnisotropy() const;
211 
242  virtual MaterialPtr getDefaultSettings(void) const { return mDefaultSettings; }
243 
247  virtual unsigned short _getSchemeIndex(const String& name);
251  virtual const String& _getSchemeName(unsigned short index);
255  virtual unsigned short _getActiveSchemeIndex(void) const;
256 
260  virtual const String& getActiveScheme(void) const;
261 
265  virtual void setActiveScheme(const String& schemeName);
266 
271  virtual void addListener(Listener* l, const Ogre::String& schemeName = StringUtil::BLANK);
272 
277  virtual void removeListener(Listener* l, const Ogre::String& schemeName = StringUtil::BLANK);
278 
281  Material* mat, unsigned short lodIndex, const Renderable* rend);
282 
315 
316  };
320 }
321 
322 #include "OgreHeaderSuffix.h"
323 
324 #endif
OgreHeaderSuffix.h
Ogre::MaterialManager::OGRE_THREAD_POINTER
OGRE_THREAD_POINTER(MaterialSerializer, mSerializer)
Serializer - Hold instance per thread if necessary.
Ogre::ResourceHandle
unsigned long long int ResourceHandle
Definition: OgreResource.h:41
Ogre::MaterialManager::addListener
virtual void addListener(Listener *l, const Ogre::String &schemeName=StringUtil::BLANK)
Add a listener to handle material events.
Ogre::MaterialManager::mDefaultMaxAniso
unsigned int mDefaultMaxAniso
Default Texture anisotropy.
Definition: OgreMaterialManager.h:125
Ogre::MaterialManager::getDefaultAnisotropy
unsigned int getDefaultAnisotropy() const
Get the default maxAnisotropy.
Ogre::MaterialManager::removeListener
virtual void removeListener(Listener *l, const Ogre::String &schemeName=StringUtil::BLANK)
Remove a listener handling material events.
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::MaterialManager::mDefaultCompare
FilterOptions mDefaultCompare
Default Texture filtering - comparison.
Definition: OgreMaterialManager.h:119
Ogre::MaterialManager::ListenerMap
map< String, ListenerList >::type ListenerMap
Definition: OgreMaterialManager.h:147
Ogre::map
Definition: OgrePrerequisites.h:534
OgreSingleton.h
Ogre::MaterialManager::setActiveScheme
virtual void setActiveScheme(const String &schemeName)
Sets the name of the active material scheme.
Ogre::MaterialManager::getByName
MaterialPtr getByName(const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
Get a resource by name.
Ogre::MaterialManager::getDefaultSettings
virtual MaterialPtr getDefaultSettings(void) const
Returns a pointer to the default Material settings.
Definition: OgreMaterialManager.h:242
Ogre::MaterialManager::ListenerList
list< Listener * >::type ListenerList
The list of per-scheme (and general) material listeners.
Definition: OgreMaterialManager.h:146
Ogre::MaterialManager
Class for managing Material settings for Ogre.
Definition: OgreMaterialManager.h:65
Ogre::MaterialManager::Listener
Listener on any general material events.
Definition: OgreMaterialManager.h:71
Ogre::Material
Class encapsulates rendering properties of an object.
Definition: OgreMaterial.h:89
Ogre::MaterialManager::mListenerMap
ListenerMap mListenerMap
Definition: OgreMaterialManager.h:148
Ogre::MaterialManager::_getSchemeName
virtual const String & _getSchemeName(unsigned short index)
Internal method - returns name for a given material scheme index.
Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME
static String AUTODETECT_RESOURCE_GROUP_NAME
Special resource group name which causes resource group to be automatically determined based on searc...
Definition: OgreResourceGroupManager.h:270
Ogre::MaterialManager::_arbitrateMissingTechniqueForActiveScheme
virtual Technique * _arbitrateMissingTechniqueForActiveScheme(Material *mat, unsigned short lodIndex, const Renderable *rend)
Internal method for sorting out missing technique for a scheme.
Ogre::TextureFilterOptions
TextureFilterOptions
High-level filtering options providing shortcuts to settings the minification, magnification and mip ...
Definition: OgreCommon.h:79
Ogre::MaterialManager::create
MaterialPtr create(const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
Create a new material.
OgreMaterialSerializer.h
Ogre::MaterialManager::mDefaultCompareFunction
CompareFunction mDefaultCompareFunction
Definition: OgreMaterialManager.h:122
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::MaterialManager::DEFAULT_SCHEME_NAME
static String DEFAULT_SCHEME_NAME
Default material scheme.
Definition: OgreMaterialManager.h:152
Ogre::MaterialManager::Listener::~Listener
virtual ~Listener()
Virtual destructor needed as class has virtual methods.
Definition: OgreMaterialManager.h:74
Ogre::Technique
Class representing an approach to rendering this particular Material.
Definition: OgreTechnique.h:54
Ogre::NameValuePairList
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:550
Ogre::MaterialManager::setDefaultAnisotropy
void setDefaultAnisotropy(unsigned int maxAniso)
Sets the default anisotropy level to be used for loaded textures, for when textures are loaded automa...
OgreMaterial.h
Ogre::MaterialManager::setDefaultTextureFiltering
virtual void setDefaultTextureFiltering(TextureFilterOptions fo)
Sets the default texture filtering to be used for loaded textures, for when textures are loaded autom...
Ogre::CompareFunction
CompareFunction
Comparison functions used for the depth/stencil buffer operations and others.
Definition: OgreCommon.h:65
Ogre::MaterialManager::setDefaultTextureFiltering
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 autom...
Ogre::StringUtil::BLANK
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
Definition: OgreString.h:196
OgreHeaderPrefix.h
Ogre::MaterialManager::SchemeMap
map< String, unsigned short >::type SchemeMap
Scheme name -> index. Never shrinks! Should be pretty static anyway.
Definition: OgreMaterialManager.h:137
Ogre::list
Definition: OgrePrerequisites.h:506
Ogre::MaterialManager::_getSchemeIndex
virtual unsigned short _getSchemeIndex(const String &name)
Internal method - returns index for a given material scheme name.
OgrePrerequisites.h
Ogre::MaterialManager::createImpl
Resource * createImpl(const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *params)
Overridden from ResourceManager.
Ogre::MaterialSerializer
Class for serializing Materials to / from a .material script.
Definition: OgreMaterialSerializer.h:107
Ogre::Singleton
Template class for creating single-instance global classes.
Definition: OgreSingleton.h:65
Ogre::FilterOptions
FilterOptions
Filtering options for textures / mipmaps.
Definition: OgreCommon.h:101
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::ResourceManager
Defines a generic resource handler.
Definition: OgreResourceManager.h:123
Ogre::MaterialManager::mDefaultSettings
MaterialPtr mDefaultSettings
Default settings.
Definition: OgreMaterialManager.h:129
Ogre::MaterialManager::mDefaultMagFilter
FilterOptions mDefaultMagFilter
Default Texture filtering - magnification.
Definition: OgreMaterialManager.h:115
Ogre::MaterialManager::getSingleton
static MaterialManager & getSingleton(void)
Override standard Singleton retrieval.
Ogre::SharedPtr< Material >
Ogre::MaterialManager::~MaterialManager
virtual ~MaterialManager()
Default destructor.
Ogre::Resource
Abstract class representing a loadable resource (e.g.
Definition: OgreResource.h:80
Ogre::MaterialManager::getActiveScheme
virtual const String & getActiveScheme(void) const
Returns the name of the active material scheme.
Ogre::MaterialManager::mSchemes
SchemeMap mSchemes
List of material schemes.
Definition: OgreMaterialManager.h:139
Ogre::MaterialManager::Listener::handleSchemeNotFound
virtual Technique * handleSchemeNotFound(unsigned short schemeIndex, const String &schemeName, Material *originalMaterial, unsigned short lodIndex, const Renderable *rend)=0
Called if a technique for a given scheme is not found within a material, allows the application to sp...
Ogre::MaterialManager::parseScript
void parseScript(DataStreamPtr &stream, const String &groupName)
Ogre::MaterialManager::mActiveSchemeName
String mActiveSchemeName
Current material scheme.
Definition: OgreMaterialManager.h:141
Ogre::MaterialManager::_getActiveSchemeIndex
virtual unsigned short _getActiveSchemeIndex(void) const
Internal method - returns the active scheme index.
Ogre::MaterialManager::getSingletonPtr
static MaterialManager * getSingletonPtr(void)
Override standard Singleton retrieval.
Ogre::Renderable
Abstract class defining the interface all renderable objects must implement.
Definition: OgreRenderable.h:64
Ogre::MaterialManager::mActiveSchemeIndex
unsigned short mActiveSchemeIndex
Current material scheme.
Definition: OgreMaterialManager.h:143
Ogre::MaterialManager::mDefaultCompareEnabled
bool mDefaultCompareEnabled
Definition: OgreMaterialManager.h:121
OgreStringVector.h
Ogre::MaterialManager::mDefaultMinFilter
FilterOptions mDefaultMinFilter
Default Texture filtering - minification.
Definition: OgreMaterialManager.h:113
Ogre::ManualResourceLoader
Interface describing a manual resource loader.
Definition: OgreResource.h:515
Ogre::MaterialManager::MaterialManager
MaterialManager()
Default constructor.
Ogre::MaterialManager::getDefaultTextureFiltering
virtual FilterOptions getDefaultTextureFiltering(FilterType ftype) const
Get the default texture filtering.
Ogre::FilterType
FilterType
Definition: OgreCommon.h:91
OgreResourceManager.h
Ogre::MaterialManager::initialise
void initialise(void)
Initialises the material manager, which also triggers it to parse all available .program and ....
Ogre::MaterialManager::setDefaultTextureFiltering
virtual void setDefaultTextureFiltering(FilterType ftype, FilterOptions opts)
Sets the default texture filtering to be used for loaded textures, for when textures are loaded autom...
Ogre::MaterialManager::mDefaultMipFilter
FilterOptions mDefaultMipFilter
Default Texture filtering - mipmapping.
Definition: OgreMaterialManager.h:117

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.