TGUI  0.8.8
Knob.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_KNOB_HPP
27 #define TGUI_KNOB_HPP
28 
29 
30 #include <TGUI/Widget.hpp>
31 #include <TGUI/Renderers/KnobRenderer.hpp>
32 
34 
35 namespace tgui
36 {
40  class TGUI_API Knob : public Widget
41  {
42  public:
43 
44  typedef std::shared_ptr<Knob> Ptr;
45  typedef std::shared_ptr<const Knob> ConstPtr;
46 
47 
49  // Default constructor
51  Knob();
52 
53 
60  static Knob::Ptr create();
61 
62 
72 
73 
79  const KnobRenderer* getSharedRenderer() const;
80 
87  const KnobRenderer* getRenderer() const;
88 
89 
96  void setSize(const Layout2d& size) override;
97  using Widget::setSize;
98 
99 
108  void setStartRotation(float startRotation);
109 
110 
117  float getStartRotation() const;
118 
119 
128  void setEndRotation(float endRotation);
129 
130 
137  float getEndRotation() const;
138 
139 
154  void setMinimum(int minimum);
155 
156 
167  int getMinimum() const;
168 
169 
184  void setMaximum(int maximum);
185 
186 
197  int getMaximum() const;
198 
199 
211  void setValue(int value);
212 
213 
222  int getValue() const;
223 
224 
231  void setClockwiseTurning(bool clockwise);
232 
233 
240  bool getClockwiseTurning() const;
241 
242 
249  bool mouseOnWidget(Vector2f pos) const override;
250 
254  void leftMousePressed(Vector2f pos) override;
255 
259  void leftMouseReleased(Vector2f pos) override;
260 
264  void mouseMoved(Vector2f pos) override;
265 
266 
274  void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
275 
276 
278  protected:
279 
289  Signal& getSignal(std::string signalName) override;
290 
291 
298  void rendererChanged(const std::string& property) override;
299 
300 
304  std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
305 
306 
310  void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
311 
312 
314  // Returns the size without the borders
316  Vector2f getInnerSize() const;
317 
318 
320  // Recalculates the rotation of the knob.
322  void recalculateRotation();
323 
324 
326  // Makes a copy of the widget
328  Widget::Ptr clone() const override
329  {
330  return std::make_shared<Knob>(*this);
331  }
332 
333 
335  public:
336 
337  SignalInt onValueChange = {"ValueChanged"};
338 
339 
341  protected:
342 
343  bool m_clockwiseTurning = true; // Does rotating clockwise increment the value?
344  float m_startRotation = 270;
345  float m_endRotation = 270;
346 
347  int m_minimum = 0;
348  int m_value = 0;
349  int m_maximum = 360;
350 
351  float m_angle = 270;
352 
353  Sprite m_spriteBackground;
354  Sprite m_spriteForeground;
355 
356  // Cached renderer properties
357  Borders m_bordersCached;
358  Color m_borderColorCached;
359  Color m_backgroundColorCached;
360  Color m_thumbColorCached;
361  float m_imageRotationCached = 0;
362  };
363 
365 }
366 
368 
369 #endif // TGUI_KNOB_HPP
370 
KnobRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
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:224
void setMaximum(int maximum)
Sets the value for when the knob would be rotated in the direction of EndRotation.
Signal & getSignal(std::string signalName) override
Retrieves a signal based on its name.
std::shared_ptr< const Knob > ConstPtr
Shared constant widget pointer.
Definition: Knob.hpp:45
int getMinimum() const
Returns the value when the knob would be rotated in the direction of StartRotation.
Definition: KnobRenderer.hpp:37
void setEndRotation(float endRotation)
Sets the end rotation, which is the place where the value should be maximal.
KnobRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
int getValue() const
Returns the current value.
void setClockwiseTurning(bool clockwise)
Should the value increase when turning the knob clockwise?
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:77
Knob widget.
Definition: Knob.hpp:41
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:37
void setMinimum(int minimum)
Sets the value for when the knob would be rotated in the direction of StartRotation.
Class to store the position or size of a widget.
Definition: Layout.hpp:260
void rendererChanged(const std::string &property) override
Function called when one of the properties of the renderer is changed.
Wrapper for colors.
Definition: Color.hpp:49
float getStartRotation() const
Returns the start rotation, which is the place where the value should be minimal.
void setSize(const Layout2d &size) override
Changes the size of the knob.
void draw(sf::RenderTarget &target, sf::RenderStates states) const override
Draw the widget to a render target.
std::shared_ptr< Knob > Ptr
Shared widget pointer.
Definition: Knob.hpp:44
static Knob::Ptr create()
Creates a new knob widget.
Definition: Sprite.hpp:46
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
Definition: Knob.hpp:328
void setValue(int value)
Changes the current value.
bool getClockwiseTurning() const
Returns whether the value increases when turning the knob clockwise?
Definition: Vector2f.hpp:39
void setStartRotation(float startRotation)
Sets the start rotation, which is the place where the value should be minimal.
Definition: Outline.hpp:39
The parent class for every widget.
Definition: Widget.hpp:74
float getEndRotation() const
Sets the end rotation, which is the place where the value should be maximal.
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
int getMaximum() const
Returns the value when the knob would be rotated in the direction of EndRotation.
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.
static Knob::Ptr copy(Knob::ConstPtr knob)
Makes a copy of another knob.