TGUI  1.3.0
Loading...
Searching...
No Matches
Knob.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 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
35TGUI_MODULE_EXPORT namespace tgui
36{
40 class TGUI_API Knob : public Widget
41 {
42 public:
43
44 using Ptr = std::shared_ptr<Knob>;
45 using ConstPtr = std::shared_ptr<const Knob>;
46
47 static constexpr const char StaticWidgetType[] = "Knob";
48
49
57 Knob(const char* typeName = StaticWidgetType, bool initRenderer = true);
58
59
66 TGUI_NODISCARD static Knob::Ptr create();
67
68
77 TGUI_NODISCARD static Knob::Ptr copy(const Knob::ConstPtr& knob);
78
79
84 TGUI_NODISCARD KnobRenderer* getSharedRenderer() override;
85 TGUI_NODISCARD const KnobRenderer* getSharedRenderer() const override;
86
92 TGUI_NODISCARD KnobRenderer* getRenderer() override;
93
94
101 void setSize(const Layout2d& size) override;
102 using Widget::setSize;
103
104
113 void setStartRotation(float startRotation);
114
115
122 TGUI_NODISCARD float getStartRotation() const;
123
124
133 void setEndRotation(float endRotation);
134
135
142 TGUI_NODISCARD float getEndRotation() const;
143
144
159 void setMinimum(float minimum);
160
161
172 TGUI_NODISCARD float getMinimum() const;
173
174
189 void setMaximum(float maximum);
190
191
202 TGUI_NODISCARD float getMaximum() const;
203
204
216 void setValue(float value);
217
218
227 TGUI_NODISCARD float getValue() const;
228
229
236 void setClockwiseTurning(bool clockwise);
237
238
245 TGUI_NODISCARD bool getClockwiseTurning() const;
246
247
254 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
255
259 bool leftMousePressed(Vector2f pos) override;
260
264 void mouseMoved(Vector2f pos) override;
265
266
274 void draw(BackendRenderTarget& target, RenderStates states) const override;
275
276
278 protected:
279
289 TGUI_NODISCARD Signal& getSignal(String signalName) override;
290
291
298 void rendererChanged(const String& property) override;
299
300
304 TGUI_NODISCARD 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 TGUI_NODISCARD 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 TGUI_NODISCARD Widget::Ptr clone() const override;
329
330
332 public:
333
334 SignalFloat onValueChange = {"ValueChanged"};
335
336
338 protected:
339
340 bool m_clockwiseTurning = true; // Does rotating clockwise increment the value?
341 float m_startRotation = 270;
342 float m_endRotation = 270;
343
344 float m_minimum = 0;
345 float m_value = 0;
346 float m_maximum = 360;
347
348 float m_angle = 270;
349
350 Sprite m_spriteBackground;
351 Sprite m_spriteForeground;
352
353 // Cached renderer properties
354 Borders m_bordersCached;
355 Color m_borderColorCached;
356 Color m_backgroundColorCached;
357 Color m_thumbColorCached;
358 float m_imageRotationCached = 0;
359 };
360
362}
363
365
366#endif // TGUI_KNOB_HPP
367
Base class for render targets.
Definition BackendRenderTarget.hpp:48
Wrapper for colors.
Definition Color.hpp:74
Definition KnobRenderer.hpp:37
Knob widget.
Definition Knob.hpp:41
TGUI_NODISCARD float getMinimum() const
Returns the value when the knob would be rotated in the direction of StartRotation.
TGUI_NODISCARD bool getClockwiseTurning() const
Returns whether the value increases when turning the knob clockwise?
static TGUI_NODISCARD Knob::Ptr copy(const Knob::ConstPtr &knob)
Makes a copy of another knob.
void setValue(float value)
Changes the current value.
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
TGUI_NODISCARD KnobRenderer * getSharedRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
TGUI_NODISCARD float getEndRotation() const
Sets the end rotation, which is the place where the value should be maximal.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
bool leftMousePressed(Vector2f pos) override
Called by the parent when the left mouse button goes down on top of the widget.
void setEndRotation(float endRotation)
Sets the end rotation, which is the place where the value should be maximal.
TGUI_NODISCARD 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.
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
TGUI_NODISCARD KnobRenderer * getRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void setClockwiseTurning(bool clockwise)
Should the value increase when turning the knob clockwise?
static TGUI_NODISCARD Knob::Ptr create()
Creates a new knob widget.
TGUI_NODISCARD Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
TGUI_NODISCARD float getValue() const
Returns the current value.
TGUI_NODISCARD Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
TGUI_NODISCARD 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.
std::shared_ptr< const Knob > ConstPtr
Shared constant widget pointer.
Definition Knob.hpp:45
void setStartRotation(float startRotation)
Sets the start rotation, which is the place where the value should be minimal.
void setMinimum(float minimum)
Sets the value for when the knob would be rotated in the direction of StartRotation.
void setMaximum(float maximum)
Sets the value for when the knob would be rotated in the direction of EndRotation.
TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
TGUI_NODISCARD float getMaximum() const
Returns the value when the knob would be rotated in the direction of EndRotation.
std::shared_ptr< Knob > Ptr
Shared widget pointer.
Definition Knob.hpp:44
Class to store the position or size of a widget.
Definition Layout.hpp:328
Definition Outline.hpp:39
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:62
Definition Sprite.hpp:48
Wrapper class to store strings.
Definition String.hpp:101
The parent class for every widget.
Definition Widget.hpp:84
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:87
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
States used for drawing.
Definition RenderStates.hpp:39