TGUI  0.8-dev
Picture.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2017 Bruno Van de Velde (vdv_b@tgui.eu)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 
26 #ifndef TGUI_PICTURE_HPP
27 #define TGUI_PICTURE_HPP
28 
29 
30 #include <TGUI/Widgets/ClickableWidget.hpp>
31 #include <TGUI/Renderers/PictureRenderer.hpp>
32 
34 
35 namespace tgui
36 {
40  class TGUI_API Picture : public ClickableWidget
41  {
42  public:
43 
44  typedef std::shared_ptr<Picture> Ptr;
45  typedef std::shared_ptr<const Picture> ConstPtr;
46 
47 
51  Picture();
52 
53 
72  Picture(const Texture& texture, bool fullyClickable = true);
73 
74 
95  static Picture::Ptr create(const Texture& texture = {}, bool fullyClickable = true);
96 
97 
106  static Picture::Ptr copy(Picture::ConstPtr picture);
107 
108 
113  PictureRenderer* getSharedRenderer();
114  const PictureRenderer* getSharedRenderer() const;
115 
121  PictureRenderer* getRenderer();
122  const PictureRenderer* getRenderer() const;
123 
124 
133  void setSize(const Layout2d& size) override;
134  using Widget::setSize;
135 
136 
144  void ignoreMouseEvents(bool ignore = true);
145 
146 
152  bool isIgnoringMouseEvents() const;
153 
154 
161  bool mouseOnWidget(sf::Vector2f pos) const override;
162 
163 
167  void leftMouseReleased(sf::Vector2f pos) override;
168 
169 
177  void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
178 
179 
181  protected:
182 
192  Signal& getSignal(std::string signalName) override;
193 
194 
196  public:
197 
198  SignalVector2f onDoubleClick = {"DoubleClicked"};
199 
200 
202  protected:
203 
210  void rendererChanged(const std::string& property) override;
211 
212 
214  // This function is called every frame with the time passed since the last frame.
216  void update(sf::Time elapsedTime) override;
217 
218 
220  // Makes a copy of the widget
222  Widget::Ptr clone() const override
223  {
224  return std::make_shared<Picture>(*this);
225  }
226 
227 
229  protected:
230 
231  Sprite m_sprite;
232 
233  bool m_ignoringMouseEvents = false;
234 
235  // Set to true when clicks on transparent parts of the picture should go to the widgets behind the picture
236  bool m_ignoreTransparentParts = true;
237 
238  // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
239  bool m_possibleDoubleClick = false;
240  };
241 
243 }
244 
246 
247 #endif // TGUI_PICTURE_HPP
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Definition: Sprite.hpp:40
Class to store the position or size of a widget.
Definition: Layout.hpp:243
Clickable widget.
Definition: ClickableWidget.hpp:39
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:66
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:59
std::shared_ptr< const Picture > ConstPtr
Shared constant widget pointer.
Definition: Picture.hpp:45
Definition: Texture.hpp:39
Definition: PictureRenderer.hpp:36
Widget::Ptr clone() const override
Makes a copy of the widget if you don&#39;t know its exact type.
Definition: Picture.hpp:222
std::shared_ptr< Picture > Ptr
Shared widget pointer.
Definition: Picture.hpp:44
Picture widget.
Definition: Picture.hpp:40