Picture.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2017 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_PICTURE_HPP
#define TGUI_PICTURE_HPP


#include <TGUI/Widgets/ClickableWidget.hpp>


namespace tgui
{
 class TGUI_API Picture : public ClickableWidget
 {
 public:

 typedef std::shared_ptr<Picture> Ptr; 
 typedef std::shared_ptr<const Picture> ConstPtr; 


 Picture();


 Picture(const sf::String& filename, bool fullyClickable = true);


 Picture(const Texture& texture, bool fullyClickable = true);


 void setTexture(const sf::String& filename, bool fullyClickable = true);


 void setTexture(const Texture& texture, bool fullyClickable = true);


 static Picture::Ptr create(const char* filename, bool fullyClickable = true);


 static Picture::Ptr create(const Texture& texture = {}, bool fullyClickable = true);


 static Picture::Ptr copy(Picture::ConstPtr picture);


 const sf::String& getLoadedFilename() const
 {
 return m_loadedFilename;
 }


 virtual void setPosition(const Layout2d& position) override;
 using Transformable::setPosition;


 virtual void setSize(const Layout2d& size) override;
 using Transformable::setSize;


 void setSmooth(bool smooth = true);


 bool isSmooth() const
 {
 return m_texture.isSmooth();
 }


 virtual void setOpacity(float opacity) override;


 virtual bool mouseOnWidget(float x, float y) const override;


 virtual void leftMouseReleased(float x, float y) override;


 protected:

 // Makes a copy of the widget
 virtual Widget::Ptr clone() const override
 {
 return std::make_shared<Picture>(*this);
 }


 // This function is called every frame with the time passed since the last frame.
 virtual void update(sf::Time elapsedTime) override;


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


 protected:

 sf::String m_loadedFilename;

 Texture m_texture;

 // Set to false when clicks on transparent parts of the picture should go to the widgets behind the picture
 bool m_fullyClickable = true;

 // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
 bool m_possibleDoubleClick = false;
 };

}


#endif // TGUI_PICTURE_HPP