imagemanager.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE 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 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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 this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_IMAGE_MANAGER_H
#define FIFE_IMAGE_MANAGER_H

// Standard C++ library includes
#include <map>
#include <string>
#include <vector>

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/singleton.h"
#include "util/resource/resource.h"
#include "util/resource/resourcemanager.h"

#include "image.h"

namespace FIFE {

    class ImageManager : public IResourceManager, public DynamicSingleton<ImageManager> {
    public:

        ImageManager() : IResourceManager() { }

        virtual ~ImageManager();

        virtual size_t getMemoryUsed() const;
        virtual size_t getTotalResourcesCreated() const;
        virtual size_t getTotalResourcesLoaded() const;
        virtual size_t getTotalResources() const;

        virtual ImagePtr create(IResourceLoader* loader = 0);

        virtual ImagePtr create(const std::string& name, IResourceLoader* loader = 0);

        virtual ImagePtr load(const std::string& name, IResourceLoader* loader = 0);

        virtual ImagePtr loadBlank(uint32_t width, uint32_t height);

        virtual ImagePtr loadBlank(const std::string& name, uint32_t width, uint32_t height);

        virtual ImagePtr add(Image* res);

        virtual bool exists(const std::string& name);

        virtual bool exists(ResourceHandle handle);

        virtual void reload(const std::string& name);

        virtual void reload(ResourceHandle handle);

        virtual void reloadAll();

        virtual void loadUnreferenced();

        virtual void free(const std::string& name);

        virtual void free(ResourceHandle handle);

        virtual void freeAll();

        virtual void freeUnreferenced();

        virtual void remove(ImagePtr& resource);

        virtual void remove(const std::string& name);

        virtual void remove(ResourceHandle handle);

        virtual void removeAll();

        virtual void removeUnreferenced();

        virtual ImagePtr get(const std::string& name);

        virtual ImagePtr get(ResourceHandle handle);

        virtual ImagePtr getPtr(const std::string& name);
        virtual ImagePtr getPtr(ResourceHandle handle);

        virtual ResourceHandle getResourceHandle(const std::string& name);

        virtual void invalidate(const std::string& name);
        virtual void invalidate(ResourceHandle handle);
        virtual void invalidateAll();

    private:
        typedef std::map< ResourceHandle, ImagePtr > ImageHandleMap;
        typedef std::map< ResourceHandle, ImagePtr >::iterator ImageHandleMapIterator;
        typedef std::map< ResourceHandle, ImagePtr >::const_iterator ImageHandleMapConstIterator;
        typedef std::pair< ResourceHandle, ImagePtr > ImageHandleMapPair;

        typedef std::map< std::string, ImagePtr > ImageNameMap;
        typedef std::map< std::string, ImagePtr >::iterator ImageNameMapIterator;
        typedef std::map< std::string, ImagePtr >::const_iterator ImageNameMapConstIterator;
        typedef std::pair< std::string, ImagePtr > ImageNameMapPair;

        ImageHandleMap m_imgHandleMap;

        ImageNameMap m_imgNameMap;
    };

} //FIFE

#endif //FIFE_IMAGE_MANAGER_H