Canvas.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2015 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/ClickableWidget.hpp>


namespace tgui
{

 class TGUI_API Canvas : public ClickableWidget
 {
 public:

 typedef SharedWidgetPtr<Canvas> Ptr;


 Canvas();


 Canvas(const Canvas& copy);


 virtual ~Canvas();


 Canvas& operator= (const Canvas& right);


 // Makes a copy of the widget by calling the copy constructor.
 // This function calls new and if you use this function then you are responsible for calling delete.
 virtual Canvas* clone();


 virtual void setPosition(float x, float y);
 using Transformable::setPosition;


 virtual void setSize(float width, float height);


 virtual sf::Vector2f getSize() const;


 void clear(const sf::Color& color = sf::Color(0, 0, 0, 255));


 void draw(const sf::Drawable& drawable, const sf::RenderStates& states = sf::RenderStates::Default);


 void draw(const sf::Vertex* vertices, unsigned int vertexCount,
 sf::PrimitiveType type, const sf::RenderStates& states = sf::RenderStates::Default);


 void display();


 protected:

 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 public:

 enum CanvasCallbacks
 {
 AllCanvasCallbacks = ClickableWidgetCallbacksCount - 1, 
 CanvasCallbacksCount = ClickableWidgetCallbacksCount
 };


 protected:

 sf::RenderTexture m_renderTexture;
 sf::Sprite m_sprite;
 };

}


#endif // TGUI_CANVAS_HPP