MaterialManager.h

Go to the documentation of this file.

/*********************************************************\
 *  File: MaterialManager.h                              *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLRENDERER_MATERIAL_MANAGER_H__
#define __PLRENDERER_MATERIAL_MANAGER_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLCore/Container/ResourceManager.h>
#include "PLRenderer/Material/Material.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLRenderer {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class RendererContext;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    This is a manager for the material resource
*
*  @note
*    - Unloads unused resources automatically by default
*/
class MaterialManager : public PLCore::ResourceManager<Material> {


    //[-------------------------------------------------------]
    //[ Friends                                               ]
    //[-------------------------------------------------------]
    friend class RendererContext;


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Returns the owner renderer context of this manager
        *
        *  @return
        *    Reference to the owner renderer context of this manager
        */
        inline RendererContext &GetRendererContext() const;

        /**
        *  @brief
        *    Reloads all materials
        *
        *  @return
        *    'true' if all went fine, else 'false'
        */
        PLRENDERER_API bool ReloadMaterials();


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] cRendererContext
        *    Owner renderer context
        */
        MaterialManager(RendererContext &cRendererContext);

        /**
        *  @brief
        *    Destructor
        */
        virtual ~MaterialManager();


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        RendererContext *m_pRendererContext;    /**< Owner renderer context of this manager, always valid! */


    //[-------------------------------------------------------]
    //[ Private virtual PLCore::ResourceManager functions     ]
    //[-------------------------------------------------------]
    private:
        virtual Material *CreateResource(const PLCore::String &sName) override;


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLRenderer


//[-------------------------------------------------------]
//[ Implementation                                        ]
//[-------------------------------------------------------]
#include "PLRenderer/Material/MaterialManager.inl"


#endif // __PLRENDERER_MATERIAL_MANAGER_H__