texture_group.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  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.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Kenneth Gangstoe
**    Magnus Norddahl
*/

#pragma once

#include <memory>
#include "../../Core/Math/size.h"
#include "../../Core/Math/rect.h"

namespace uicore
{
    class Texture2D;
    typedef std::shared_ptr<Texture2D> Texture2DPtr;
    class GraphicContext;
    typedef std::shared_ptr<GraphicContext> GraphicContextPtr;

    class TextureGroupImage
    {
    public:
        TextureGroupImage() { }
        TextureGroupImage(const Texture2DPtr &texture, const Rect &geometry) : _texture(texture), _geometry(geometry) { }

        explicit operator bool() { return (bool)texture(); }

        const Texture2DPtr &texture() const { return _texture; }
        const Rect &geometry() const { return _geometry; }

    private:
        Texture2DPtr _texture;
        Rect _geometry;
    };

    enum class TextureGroupAllocationPolicy
    {
        create_new_texture,
        search_previous_textures
    };

    class TextureGroup
    {
    public:
        static std::shared_ptr<TextureGroup> create(const Size &texture_size);

        virtual int subtexture_count() const = 0;

        virtual int subtexture_count(unsigned int texture_index) const = 0;

        virtual int texture_count() const = 0;

        virtual TextureGroupAllocationPolicy allocation_policy() const = 0;

        virtual Size texture_size() const = 0;

        virtual std::vector<Texture2DPtr> textures() const = 0;

        virtual TextureGroupImage add(const GraphicContextPtr &context, const Size &size) = 0;

        virtual void remove(const TextureGroupImage &subtexture) = 0;

        virtual void set_allocation_policy(TextureGroupAllocationPolicy policy) = 0;

        virtual void insert_texture(const Texture2DPtr &texture, const Rect &texture_rect) = 0;
    };

    typedef std::shared_ptr<TextureGroup> TextureGroupPtr;
}