i_gradient_manager.hpp

Go to the documentation of this file.

// i_gradient_manager.hpp
/*
  neogfx C++ App/Game Engine
  Copyright (c) 2020 Leigh Johnston.  All Rights Reserved.
  
  This program is free software: you can redistribute it and / or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  
  This program 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 General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include <neogfx/neogfx.hpp>
#include <neolib/core/jar.hpp>
#include <neogfx/gfx/i_gradient.hpp>
 
namespace neogfx
{
    class i_gradient_manager : public neolib::i_cookie_consumer, public i_service
    {
        friend class gradient_object;
        // exceptions
    public:
        struct gradient_not_found : std::logic_error { gradient_not_found() : std::logic_error("neogfx::i_gradient_manager::gradient_not_found") {} };
        // types
    public:
        typedef i_gradient_manager abstract_type;
        // operations
    public:
        virtual void clear_gradients() = 0;
        virtual i_gradient_sampler const& sampler(i_gradient const& aGradient) = 0;
        virtual i_gradient_filter const& filter(i_gradient const& aGradient) = 0;
        // helpers
    public:
        neolib::ref_ptr<i_gradient> find_gradient(gradient_id aId) const
        {
            neolib::ref_ptr<i_gradient> result;
            do_find_gradient(aId, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient()
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(i_gradient const& aOther)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aOther, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(i_string const& aCssDeclaration)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aCssDeclaration, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(sRGB_color const& aColor)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aColor, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(sRGB_color const& aColor, gradient_direction aDirection)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aColor, aDirection, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(sRGB_color const& aColor1, sRGB_color const& aColor2, gradient_direction aDirection = gradient_direction::Vertical)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aColor1, aColor2, aDirection, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(i_gradient::color_stop_list const& aColorStops, gradient_direction aDirection = gradient_direction::Vertical)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aColorStops, aDirection, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(i_gradient::color_stop_list const& aColorStops, i_gradient::alpha_stop_list const& aAlphaStops, gradient_direction aDirection = gradient_direction::Vertical)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aColorStops, aAlphaStops, aDirection, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(i_gradient const& aOther, i_gradient::color_stop_list const& aColorStops)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aOther, aColorStops, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(i_gradient const& aOther, i_gradient::color_stop_list const& aColorStops, i_gradient::alpha_stop_list const& aAlphaStops)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aOther, aColorStops, aAlphaStops, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(neolib::i_vector<sRGB_color::abstract_type> const& aColors, gradient_direction aDirection = gradient_direction::Vertical)
        {
            neolib::ref_ptr<i_gradient> result;
            do_create_gradient(aColors, aDirection, result);
            return result;
        }
        neolib::ref_ptr<i_gradient> create_gradient(std::initializer_list<sRGB_color> const& aColors, gradient_direction aDirection = gradient_direction::Vertical)
        {
            return create_gradient(neolib::vector<sRGB_color>{aColors}, aDirection);
        }
        // implementation
    private:
        virtual void do_find_gradient(gradient_id aId, neolib::i_ref_ptr<i_gradient>& aResult) const = 0;
        virtual void do_create_gradient(neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(i_gradient const& aOther, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(i_string const& aCssDeclaration, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(sRGB_color const& aColor, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(sRGB_color const& aColor, gradient_direction aDirection, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(sRGB_color const& aColor1, sRGB_color const& aColor2, gradient_direction aDirection, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(i_gradient::color_stop_list const& aColorStops, gradient_direction aDirection, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(i_gradient::color_stop_list const& aColorStops, i_gradient::alpha_stop_list const& aAlphaStops, gradient_direction aDirection, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(i_gradient const& aOther, i_gradient::color_stop_list const& aColorStops, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(i_gradient const& aOther, i_gradient::color_stop_list const& aColorStops, i_gradient::alpha_stop_list const& aAlphaStops, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
        virtual void do_create_gradient(neolib::i_vector<sRGB_color::abstract_type> const& aColors, gradient_direction aDirection, neolib::i_ref_ptr<i_gradient>& aResult) = 0;
    public:
        static uuid const& iid() { static uuid const sIid{ 0x15d5c3b1, 0x195e, 0x4e90, 0x9b65, { 0x46, 0x70, 0x7e, 0xb9, 0x6e, 0xd5 } }; return sIid; }
    };
}