TGUI  0.8.9
Picture.hpp
1 //
3 // TGUI - Texus' Graphical User Interface
4 // Copyright (C) 2012-2020 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 
52 
53 
61  Picture(const Texture& texture, bool transparentTexture = false);
62 
63 
83  static Picture::Ptr create(const Texture& texture = {}, bool transparentTexture = false);
84 
85 
95 
96 
102  const PictureRenderer* getSharedRenderer() const;
103 
110  const PictureRenderer* getRenderer() const;
111 
112 
121  void setSize(const Layout2d& size) override;
122  using Widget::setSize;
123 
124 
132  void ignoreMouseEvents(bool ignore = true);
133 
134 
140  bool isIgnoringMouseEvents() const;
141 
142 
149  bool canGainFocus() const override;
150 
151 
158  bool mouseOnWidget(Vector2f pos) const override;
159 
160 
164  void leftMouseReleased(Vector2f pos) override;
165 
166 
174  void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
175 
176 
178  protected:
179 
189  Signal& getSignal(std::string signalName) override;
190 
191 
193  public:
194 
195  SignalVector2f onDoubleClick = {"DoubleClicked"};
196 
197 
199  protected:
200 
207  void rendererChanged(const std::string& property) override;
208 
209 
213  std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
214 
215 
219  void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
220 
221 
223  // This function is called every frame with the time passed since the last frame.
225  bool update(sf::Time elapsedTime) override;
226 
227 
229  // Makes a copy of the widget
231  Widget::Ptr clone() const override
232  {
233  return std::make_shared<Picture>(*this);
234  }
235 
236 
238  protected:
239 
240  Sprite m_sprite;
241 
242  bool m_ignoringMouseEvents = false;
243 
244  // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
245  bool m_possibleDoubleClick = false;
246  };
247 
249 }
250 
252 
253 #endif // TGUI_PICTURE_HPP
Clickable widget.
Definition: ClickableWidget.hpp:40
Class to store the position or size of a widget.
Definition: Layout.hpp:260
Definition: PictureRenderer.hpp:37
Picture widget.
Definition: Picture.hpp:41
PictureRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void rendererChanged(const std::string &property) override
Function called when one of the properties of the renderer is changed.
Picture()
Default constructor.
bool canGainFocus() const override
Returns whether the widget can gain focus.
static Picture::Ptr create(const Texture &texture={}, bool transparentTexture=false)
Creates a new picture widget.
void draw(sf::RenderTarget &target, sf::RenderStates states) const override
Draw the widget to a render target.
std::shared_ptr< const Picture > ConstPtr
Shared constant widget pointer.
Definition: Picture.hpp:45
bool isIgnoringMouseEvents() const
Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.
PictureRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
std::shared_ptr< Picture > Ptr
Shared widget pointer.
Definition: Picture.hpp:44
std::unique_ptr< DataIO::Node > save(SavingRenderersMap &renderers) const override
Saves the widget as a tree node in order to save it to a file.
Picture(const Texture &texture, bool transparentTexture=false)
Constructor to create the picture from a texture.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Definition: Picture.hpp:231
void setSize(const Layout2d &size) override
Changes the size of the picture.
Signal & getSignal(std::string signalName) override
Retrieves a signal based on its name.
void ignoreMouseEvents(bool ignore=true)
Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind...
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
static Picture::Ptr copy(Picture::ConstPtr picture)
Makes a copy of another picture.
bool mouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:231
Definition: Sprite.hpp:46
Definition: Texture.hpp:42
Definition: Vector2f.hpp:39
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:77
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:37