TmxTile.h

//-----------------------------------------------------------------------------
// Copyright (c) 2010-2014, Tamir Atias
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL TAMIR ATIAS BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
#pragma once

#include <vector>

#include "TmxPropertySet.h"
#include "TmxImage.h"
#include "TmxObjectGroup.h"
#include <stdexcept>
#include <string>

namespace tinyxml2
{
    class XMLNode;
}

namespace Tmx
{
    class AnimationFrame;
    class Object;

    //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------
    class Tile
    {
    public:
        Tile(int id);
        Tile();
        ~Tile();

        void Parse(const tinyxml2::XMLNode *tileNode);

        int GetId() const
        {
            return id;
        }

        bool IsAnimated() const
        {
            return isAnimated;
        }

        int GetFrameCount() const
        {
            return frames.size();
        }

        unsigned int GetTotalDuration() const
        {
            return totalDuration;
        }

        const Tmx::Image* GetImage() const
        {
            return image;
        }

        std::string GetType() const
        {
            return type;
        }

        const std::vector<AnimationFrame> &GetFrames() const
        {
            return frames;
        }

        const Tmx::PropertySet &GetProperties() const
        {
            return properties;
        }

                const Tmx::ObjectGroup *GetObjectGroup() const
                {
                        return objectGroup;
                }

                const Tmx::PropertySet &GetObjectGroupProperties() const
                {
                        if (!objectGroup) throw std::runtime_error ("Tile has no ObjectGroup on attempt to get ObjectGroup properties.  Cannot return null ref.");
                        return objectGroup->GetProperties();
                }

        std::vector<Tmx::Object*> GetObjects() const
        {
                        if (!objectGroup) throw std::out_of_range ("Tile has no objectGroup");
            return objectGroup->GetObjects();
        }

        bool HasObjects() const
        {
            return hasObjects;
        }

        const Tmx::Object *GetObject(int index) const
        {
                        if (!objectGroup) throw std::out_of_range ("Tile has no objectGroup");
            return objectGroup->GetObject(index);
        }

        int GetNumObjects() const
        {
                        if (!objectGroup) throw std::out_of_range ("Tile has no objectGroup");
            return objectGroup->GetNumObjects();
        }

    private:
        int id;

        Tmx::PropertySet properties;

        bool isAnimated;
        bool hasObjects;
                bool hasObjectGroup;
                Tmx::ObjectGroup *objectGroup;
        unsigned int totalDuration;
        std::vector<AnimationFrame> frames;
        Tmx::Image* image;
        std::string type;
    };

    //-------------------------------------------------------------------------
    //-------------------------------------------------------------------------
    class AnimationFrame
    {
    public:
        AnimationFrame() :
                tileID(-1), duration(0)
        {
        }

        AnimationFrame(int tileID, unsigned int duration) :
                tileID(tileID), duration(duration)
        {
        }

        int GetTileID() const
        {
            return tileID;
        }

        unsigned int GetDuration() const
        {
            return duration;
        }

    private:
        int tileID;
        unsigned int duration;
    };
}