OGRE  1.8
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 
119  unsigned int mDefaultMaxAniso;
125  Resource* createImpl(const String& name, ResourceHandle handle,
126  const String& group, bool isManual, ManualResourceLoader* loader,
127  const NameValuePairList* params);
128 
136  unsigned short mActiveSchemeIndex;
137 
140  typedef std::map<String, ListenerList> ListenerMap;
142 
143  public:
146 
149  MaterialManager();
150 
153  virtual ~MaterialManager();
154 
157  void initialise(void);
158 
161  void parseScript(DataStreamPtr& stream, const String& groupName);
162 
163 
170  virtual void setDefaultTextureFiltering(TextureFilterOptions fo);
175  virtual void setDefaultTextureFiltering(FilterType ftype, FilterOptions opts);
180  virtual void setDefaultTextureFiltering(FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter);
181 
183  virtual FilterOptions getDefaultTextureFiltering(FilterType ftype) const;
184 
191  void setDefaultAnisotropy(unsigned int maxAniso);
193  unsigned int getDefaultAnisotropy() const;
194 
225  virtual MaterialPtr getDefaultSettings(void) const { return mDefaultSettings; }
226 
230  virtual unsigned short _getSchemeIndex(const String& name);
234  virtual const String& _getSchemeName(unsigned short index);
238  virtual unsigned short _getActiveSchemeIndex(void) const;
239 
243  virtual const String& getActiveScheme(void) const;
244 
248  virtual void setActiveScheme(const String& schemeName);
249 
254  virtual void addListener(Listener* l, const Ogre::String& schemeName = StringUtil::BLANK);
255 
260  virtual void removeListener(Listener* l, const Ogre::String& schemeName = StringUtil::BLANK);
261 
263  virtual Technique* _arbitrateMissingTechniqueForActiveScheme(
264  Material* mat, unsigned short lodIndex, const Renderable* rend);
265 
281  static MaterialManager& getSingleton(void);
297  static MaterialManager* getSingletonPtr(void);
298 
299  };
303 }
304 
305 #include "OgreHeaderSuffix.h"
306 
307 #endif
#define _OgreExport
Definition: OgrePlatform.h:233
Listener on any general material events.
String mActiveSchemeName
Current material scheme.
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:553
Template class for creating single-instance global classes.
Definition: OgreSingleton.h:64
Class encapsulates rendering properties of an object.
Definition: OgreMaterial.h:89
FilterType
Definition: OgreCommon.h:93
Interface describing a manual resource loader.
Definition: OgreResource.h:513
FilterOptions mDefaultMipFilter
Default Texture filtering - mipmapping.
map< String, unsigned short >::type SchemeMap
Scheme name -> index. Never shrinks! Should be pretty static anyway.
Class representing an approach to rendering this particular Material.
Definition: OgreTechnique.h:53
MaterialPtr mDefaultSettings
Default settings.
FilterOptions mDefaultMinFilter
Default Texture filtering - minification.
Abstract class defining the interface all renderable objects must implement.
#define OGRE_THREAD_POINTER(T, var)
Class for managing Material settings for Ogre.
Class for serializing Materials to / from a .material script.
std::map< String, ListenerList > ListenerMap
unsigned short mActiveSchemeIndex
Current material scheme.
unsigned int mDefaultMaxAniso
Default Texture anisotropy.
FilterOptions mDefaultMagFilter
Default Texture filtering - magnification.
Abstract class representing a loadable resource (e.g.
Definition: OgreResource.h:78
unsigned long long int ResourceHandle
Definition: OgreResource.h:40
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
Definition: OgreString.h:196
virtual ~Listener()
Virtual destructor needed as class has virtual methods.
Defines a generic resource handler.
_StringBase String
static String DEFAULT_SCHEME_NAME
Default material scheme.
Specialisation of SharedPtr to allow SharedPtr to be assigned to MaterialPtr.
Definition: OgreMaterial.h:688
list< Listener * >::type ListenerList
The list of per-scheme (and general) material listeners.
SchemeMap mSchemes
List of material schemes.
FilterOptions
Filtering options for textures / mipmaps.
Definition: OgreCommon.h:103
virtual MaterialPtr getDefaultSettings(void) const
Returns a pointer to the default Material settings.
TextureFilterOptions
High-level filtering options providing shortcuts to settings the minification, magnification and mip ...
Definition: OgreCommon.h:81