OgreMaterialManager.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __MATERIALMANAGER_H__
#define __MATERIALMANAGER_H__

#include "OgrePrerequisites.h"

#include "OgreSingleton.h"
#include "OgreResourceManager.h"
#include "OgreMaterial.h"
#include "OgreStringVector.h"
#include "OgreMaterialSerializer.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {


    class _OgreExport MaterialManager : public ResourceManager, public Singleton<MaterialManager>
    {
    public:
        class Listener
        {
        public:
            virtual ~Listener() { }
            virtual Technique* handleSchemeNotFound(unsigned short schemeIndex, 
                const String& schemeName, Material* originalMaterial, unsigned short lodIndex, 
                const Renderable* rend) = 0;

        };

    protected:

        FilterOptions mDefaultMinFilter;
        FilterOptions mDefaultMagFilter;
        FilterOptions mDefaultMipFilter;
        FilterOptions mDefaultCompare;

        bool            mDefaultCompareEnabled;
        CompareFunction mDefaultCompareFunction;

        unsigned int mDefaultMaxAniso;
        OGRE_THREAD_POINTER(MaterialSerializer, mSerializer);
        MaterialPtr mDefaultSettings;

        Resource* createImpl(const String& name, ResourceHandle handle, 
            const String& group, bool isManual, ManualResourceLoader* loader,
            const NameValuePairList* params);

        typedef map<String, unsigned short>::type SchemeMap;
        SchemeMap mSchemes;
        String mActiveSchemeName;
        unsigned short mActiveSchemeIndex;

        typedef list<Listener*>::type ListenerList;
        typedef map<String, ListenerList>::type ListenerMap;
        ListenerMap mListenerMap;

    public:
        static String DEFAULT_SCHEME_NAME;

        MaterialPtr create (const String& name, const String& group,
                            bool isManual = false, ManualResourceLoader* loader = 0,
                            const NameValuePairList* createParams = 0);
        
        MaterialPtr getByName(const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME);

        MaterialManager();

        virtual ~MaterialManager();

        void initialise(void);
        
        void parseScript(DataStreamPtr& stream, const String& groupName);


        virtual void setDefaultTextureFiltering(TextureFilterOptions fo);
        virtual void setDefaultTextureFiltering(FilterType ftype, FilterOptions opts);
        virtual void setDefaultTextureFiltering(FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter);

        virtual FilterOptions getDefaultTextureFiltering(FilterType ftype) const;

        void setDefaultAnisotropy(unsigned int maxAniso);
        unsigned int getDefaultAnisotropy() const;

        virtual MaterialPtr getDefaultSettings(void) const { return mDefaultSettings; }

        virtual unsigned short _getSchemeIndex(const String& name);
        virtual const String& _getSchemeName(unsigned short index);
        virtual unsigned short _getActiveSchemeIndex(void) const;

        virtual const String& getActiveScheme(void) const;
        
        virtual void setActiveScheme(const String& schemeName);

        virtual void addListener(Listener* l, const Ogre::String& schemeName = StringUtil::BLANK);

        virtual void removeListener(Listener* l, const Ogre::String& schemeName = StringUtil::BLANK);

        virtual Technique* _arbitrateMissingTechniqueForActiveScheme(
            Material* mat, unsigned short lodIndex, const Renderable* rend);

        static MaterialManager& getSingleton(void);
        static MaterialManager* getSingletonPtr(void);

    };
}

#include "OgreHeaderSuffix.h"

#endif