atlasloader.h

/***************************************************************************
 *   Copyright (C) 2005-2011 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_ATLAS_LOADER_H
#define FIFE_ATLAS_LOADER_H

// Standard C++ library includes

// 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/structures/rect.h" 
#include "video/image.h" 
#include "video/imagemanager.h" 

#include "iatlasloader.h"

class TiXmlElement;

namespace FIFE {
    class VFS;
    class ImageManager;

    struct AtlasData {
        Rect rect;
        ImagePtr image;
    };

    class Atlas {
    public:
        Atlas(const std::string& name)
            : m_name(name) {;}
        ~Atlas() {;}


        size_t getImageCount() const;

        ImagePtr& getPackedImage();

        ImagePtr getImage(const std::string& id);

        ImagePtr getImage(uint32_t index);

        bool addImage(const std::string& imagename, const AtlasData& data);

        void setPackedImage(const ImagePtr& image);

        const std::string& getName() const;
    protected:
        typedef std::map<std::string, AtlasData> SubimageMap;
        SubimageMap m_subimages;
        ImagePtr m_image;

        // Unique atlas name
        std::string m_name;
    };

    class AtlasLoader : public IAtlasLoader {
    public:
        AtlasLoader(Model* model, VFS* vfs, ImageManager* imageManager);

        virtual ~AtlasLoader();

        virtual bool isLoadable(const std::string& filename);

        virtual AtlasPtr load(const std::string& filename);

    private:
        Model* m_model;
        VFS* m_vfs;
        ImageManager* m_imageManager;
        std::string m_atlasFilename;

        void parseObject(Atlas* atlas, TiXmlElement* root, bool exists);
    };

    AtlasLoader* createDefaultAtlasLoader(Model* model, VFS* vfs, ImageManager* imageManager);
}

#endif