Canvas.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2020 Bruno Van de Velde (vdv_b@tgui.eu)
//
// 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 TGUI_CANVAS_HPP
#define TGUI_CANVAS_HPP
 
 
#include <TGUI/Widgets/ClickableWidget.hpp>
#include <SFML/Graphics/RenderTexture.hpp>
#include <SFML/Graphics/Sprite.hpp>
 
 
namespace tgui
{
 
    class TGUI_API Canvas : public ClickableWidget
    {
    public:
 
        typedef std::shared_ptr<Canvas> Ptr; 
        typedef std::shared_ptr<const Canvas> ConstPtr; 
 
 
        Canvas(const Layout2d& size = {"100%", "100%"});
 
 
        Canvas(const Canvas& copy);
 
 
        Canvas(Canvas&& copy);
 
 
        Canvas& operator= (const Canvas& right);
 
 
        Canvas& operator= (Canvas&& right);
 
 
        static Canvas::Ptr create(Layout2d size = {"100%", "100%"});
 
 
        static Canvas::Ptr copy(Canvas::ConstPtr canvas);
 
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
 
        void setView(const sf::View& view);
 
 
        const sf::View& getView() const;
 
 
        const sf::View& getDefaultView() const;
 
 
        sf::IntRect getViewport() const;
 
 
        void clear(Color color = Color::Black);
 
 
        void draw(const sf::Drawable& drawable, const sf::RenderStates& states = sf::RenderStates::Default);
 
 
        void draw(const sf::Vertex* vertices, std::size_t vertexCount,
                  sf::PrimitiveType type, const sf::RenderStates& states = sf::RenderStates::Default);
 
 
        void draw(const tgui::Sprite& sprite, const sf::RenderStates& states = sf::RenderStates::Default);
 
 
        void display();
 
 
        void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
        bool canGainFocus() const override;
 
 
        sf::RenderTexture& getRenderTexture()
        {
            return m_renderTexture;
        }
 
 
    protected:
 
        void rendererChanged(const std::string& property) override;
 
 
        // Makes a copy of the widget
        Widget::Ptr clone() const override
        {
            return std::make_shared<Canvas>(*this);
        }
 
 
    protected:
 
        sf::RenderTexture m_renderTexture;
        sf::Sprite        m_sprite;
    };
 
}
 
 
#endif // TGUI_CANVAS_HPP