Tileset.hpp

/*********************************************************************
Matt Marchant (and contributors) 2016 - 2026
http://trederia.blogspot.com
 
tmxlite - Zlib license.
 
This software is provided 'as-is', without any express or
implied warranty. In no event will the authors be held
liable for any damages arising from the use of this software.
 
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute
it freely, subject to the following restrictions:
 
1. The origin of this software must not be misrepresented;
you must not claim that you wrote the original software.
If you use this software in a product, an acknowledgment
in the product documentation would be appreciated but
is not required.
 
2. Altered source versions must be plainly marked as such,
and must not be misrepresented as being the original software.
 
3. This notice may not be removed or altered from any
source distribution.
*********************************************************************/
 
#pragma once
 
#include <tmxlite/Config.hpp>
#include <tmxlite/ObjectGroup.hpp>
#include <tmxlite/Property.hpp>
 
#include <array>
#include <limits>
#include <string>
#include <vector>
 
namespace pugi
{
    class xml_node;
}
 
namespace tmx
{
    class Map;

    class TMXLITE_EXPORT_API Tileset final
    {
    public:
        explicit Tileset(const std::string& workingDir = "");

        struct Tile final
        {
            std::uint32_t ID = 0;
            std::array<std::int32_t, 4u> terrainIndices{};
            std::uint32_t probability = 100;

            struct Animation final
            {
                struct Frame final
                {
                    std::uint32_t tileID = 0;

                    std::uint32_t duration = 0;
 
                    bool operator == (const Frame& other) const
                    {
                        return (this == &other) ||
                            (tileID == other.tileID && duration == other.duration);
                    }
 
                    bool operator != (const Frame& other) const
                    {
                        return !(*this == other);
                    }
                };
                std::vector<Frame> frames;
            }animation;
            std::vector<Property> properties;
            ObjectGroup objectGroup;
            std::string imagePath;
            Vector2u imageSize;
            Vector2u imagePosition;
            std::string className;
        };

        struct Terrain final
        {
            std::string name;
            std::uint32_t tileID = std::numeric_limits<uint32_t>::max();
            std::vector<Property> properties;
        };

        enum class ObjectAlignment
        {
            Unspecified,
            TopLeft,
            Top,
            TopRight,
            Left,
            Center,
            Right,
            BottomLeft,
            Bottom,
            BottomRight
        };

        bool loadWithoutMap(const std::string& path);

        bool loadWithoutMapFromString(const std::string& xmlStr);

        bool parse(pugi::xml_node, Map*);

        std::uint32_t getFirstGID() const { return m_firstGID; }

        void setFirstGID(std::uint32_t firstGID) { m_firstGID = firstGID; }

        std::uint32_t getLastGID() const;

        const std::string& getName() const { return m_name; }

        const std::string& getClass() const { return m_class; }

        const Vector2u& getTileSize() const { return m_tileSize; }

        std::uint32_t getSpacing() const { return m_spacing; }

        std::uint32_t getMargin() const { return m_margin; }

        std::uint32_t getTileCount() const { return m_tileCount; }

        std::uint32_t getColumnCount() const { return m_columnCount; }

        ObjectAlignment getObjectAlignment() const { return m_objectAlignment; }

        const Vector2u& getTileOffset() const { return m_tileOffset; }

        const std::vector<Property>& getProperties() const { return m_properties; }

        const std::string& getImagePath() const { return m_imagePath; }

        const Vector2u& getImageSize() const { return m_imageSize; }

        const Colour& getTransparencyColour() const { return m_transparencyColour; }

        bool hasTransparency() const { return m_hasTransparency; }

        const std::vector<Terrain>& getTerrainTypes() const { return m_terrainTypes; }

        const std::vector<Tile>& getTiles() const { return m_tiles; }

        bool hasTile(std::uint32_t id) const { return id >= m_firstGID && id <= getLastGID(); };

        const Tile* getTile(std::uint32_t id) const;
 
    private:
 
        std::string m_workingDir;
 
        std::uint32_t m_firstGID;
        std::string m_source;
        std::string m_name;
        std::string m_class;
        Vector2u m_tileSize;
        std::uint32_t m_spacing;
        std::uint32_t m_margin;
        std::uint32_t m_tileCount;
        std::uint32_t m_columnCount;
        ObjectAlignment m_objectAlignment;
        Vector2u m_tileOffset;
 
        std::vector<Property> m_properties;
        std::string m_imagePath;
        Vector2u m_imageSize;
        Colour m_transparencyColour;
        bool m_hasTransparency;
 
        std::vector<Terrain> m_terrainTypes;
        std::vector<std::uint32_t> m_tileIndex;
        std::vector<Tile> m_tiles;
 
        //always returns false so we can return this
        //on load failure
        bool reset();
 
        void parseOffsetNode(const pugi::xml_node&);
        void parsePropertyNode(const pugi::xml_node&);
        void parseTerrainNode(const pugi::xml_node&);
        Tile& newTile(std::uint32_t ID);
        void parseTileNode(const pugi::xml_node&, Map*);
        void createMissingTile(std::uint32_t ID);
    };
}