ObjectGroup.hpp

/*********************************************************************
Matt Marchant 2016
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.
*********************************************************************/

#ifndef TMXLITE_OBJECTGROUP_HPP_
#define TMXLITE_OBJECTGROUP_HPP_

#include <tmxlite/Config.hpp>
#include <tmxlite/Layer.hpp>
#include <tmxlite/Object.hpp>

#include <vector>

namespace tmx
{
    class TMXLITE_EXPORT_API ObjectGroup final : public Layer
    {
    public:
        enum class DrawOrder
        {
            Index, //< objects should be drawn in the order in which they appear
            TopDown //< objects should be drawn sorted by their Y position
        };

        ObjectGroup();
        ~ObjectGroup() = default;

        Type getType() const override { return Layer::Type::Object; }
        void parse(const pugi::xml_node&) override;

        const Colour& getColour() const { return m_colour; }
        DrawOrder getDrawOrder() const { return m_drawOrder; }
        const std::vector<Property>& getProperties() const { return m_properties; }
        const std::vector<Object>& getObjects() const { return m_objects; }

    private:
        Colour m_colour;
        DrawOrder m_drawOrder;

        std::vector<Property> m_properties;
        std::vector<Object> m_objects;
    };
}

#endif //TMXLITE_OBJECTGROUP_HPP_