TGUI  1.0-alpha

Knob widget. More...

#include <TGUI/Widgets/Knob.hpp>

Inheritance diagram for tgui::Knob:
tgui::Widget

Public Types

typedef std::shared_ptr< KnobPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const KnobConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 Knob (const char *typeName="Knob", bool initRenderer=true)
 
KnobRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const KnobRenderergetSharedRenderer () const
 
KnobRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the knob. More...
 
void setStartRotation (float startRotation)
 Sets the start rotation, which is the place where the value should be minimal. More...
 
float getStartRotation () const
 Returns the start rotation, which is the place where the value should be minimal. More...
 
void setEndRotation (float endRotation)
 Sets the end rotation, which is the place where the value should be maximal. More...
 
float getEndRotation () const
 Sets the end rotation, which is the place where the value should be maximal. More...
 
void setMinimum (float minimum)
 Sets the value for when the knob would be rotated in the direction of StartRotation. More...
 
float getMinimum () const
 Returns the value when the knob would be rotated in the direction of StartRotation. More...
 
void setMaximum (float maximum)
 Sets the value for when the knob would be rotated in the direction of EndRotation. More...
 
float getMaximum () const
 Returns the value when the knob would be rotated in the direction of EndRotation. More...
 
void setValue (float value)
 Changes the current value. More...
 
float getValue () const
 Returns the current value. More...
 
void setClockwiseTurning (bool clockwise)
 Should the value increase when turning the knob clockwise? More...
 
bool getClockwiseTurning () const
 Returns whether the value increases when turning the knob clockwise? More...
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void leftMousePressed (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget to a render target. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&) noexcept
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const WidgetRenderergetSharedRenderer () const
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the top-left point of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration. More...
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
bool hasUserData () const
 Returns whether data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text. More...
 
unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
virtual SignalgetSignal (String signalName)
 Retrieves a signal based on its name. More...
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
virtual bool isMouseOnWidget (Vector2f pos) const =0
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
virtual void leftMousePressed (Vector2f pos)
 
virtual void leftMouseReleased (Vector2f pos)
 
virtual void rightMousePressed (Vector2f pos)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mousePressed (Event::MouseButton button, Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void mouseMoved (Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual void textEntered (char32_t key)
 
virtual bool mouseWheelScrolled (float delta, Vector2f pos)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void leftMouseButtonNoLongerDown ()
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual Widget::Ptr askToolTip (Vector2f mousePos)
 
const Layout2dgetPositionLayout () const
 
const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
virtual void draw (BackendRenderTarget &target, RenderStates states) const =0
 Draw the widget to a render target. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
virtual Widget::Ptr clone () const =0
 Makes a copy of the widget if you don't know its exact type. More...
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static Knob::Ptr create ()
 Creates a new knob widget. More...
 
static Knob::Ptr copy (Knob::ConstPtr knob)
 Makes a copy of another knob. More...
 

Public Attributes

SignalFloat onValueChange = {"ValueChanged"}
 The value of the knob changed. Optional parameter: new value.
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 
SignalShowEffect onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.
 
SignalAnimationType onAnimationFinish = {"AnimationFinished"}
 An animation has finished. More...
 

Protected Member Functions

SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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. More...
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes. More...
 
Vector2f getInnerSize () const
 
void recalculateRotation ()
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::Widget
virtual void rendererChanged (const String &property)
 Function called when one of the properties of the renderer is changed. More...
 
virtual std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const
 Saves the widget as a tree node in order to save it to a file. More...
 
virtual void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
 Loads the widget from a tree of nodes. More...
 
virtual void updateTextSize ()
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget. More...
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget. More...
 

Protected Attributes

bool m_clockwiseTurning = true
 
float m_startRotation = 270
 
float m_endRotation = 270
 
float m_minimum = 0
 
float m_value = 0
 
float m_maximum = 360
 
float m_angle = 270
 
Sprite m_spriteBackground
 
Sprite m_spriteForeground
 
Borders m_bordersCached
 
Color m_borderColorCached
 
Color m_backgroundColorCached
 
Color m_thumbColorCached
 
float m_imageRotationCached = 0
 
- Protected Attributes inherited from tgui::Widget
String m_type
 
String m_name
 
Layout2d m_position
 
Layout2d m_size
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_scaleOrigin
 
Vector2f m_scaleFactors = {1, 1}
 
float m_rotationDeg = 0
 
Vector2f m_prevPosition
 
Vector2f m_prevSize
 
std::unordered_set< Layout * > m_boundPositionLayouts
 
std::unordered_set< Layout * > m_boundSizeLayouts
 
bool m_enabled = true
 
bool m_visible = true
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
Duration m_animationTimeElapsed
 
bool m_draggableWidget = false
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::shared_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 

Additional Inherited Members

- Protected Types inherited from tgui::Widget
using SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > >
 
using LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > >
 

Detailed Description

Knob widget.

Member Function Documentation

◆ clone()

Widget::Ptr tgui::Knob::clone ( ) const
overrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns
Copy of the widget

Implements tgui::Widget.

◆ copy()

static Knob::Ptr tgui::Knob::copy ( Knob::ConstPtr  knob)
static

Makes a copy of another knob.

Parameters
knobThe other knob
Returns
The new knob

◆ create()

static Knob::Ptr tgui::Knob::create ( )
static

Creates a new knob widget.

Returns
The new knob

◆ draw()

void tgui::Knob::draw ( BackendRenderTarget target,
RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getClockwiseTurning()

bool tgui::Knob::getClockwiseTurning ( ) const

Returns whether the value increases when turning the knob clockwise?

Returns
Does the value increase when turning clockwise?

◆ getEndRotation()

float tgui::Knob::getEndRotation ( ) const

Sets the end rotation, which is the place where the value should be maximal.

Returns
number in the interval [0,360[, for which 0 to to the right and the rotation goes counter-clockwise

◆ getMaximum()

float tgui::Knob::getMaximum ( ) const

Returns the value when the knob would be rotated in the direction of EndRotation.

Returns
The current maximum value

The default maximum value is 360.

See also
getEndRotation

◆ getMinimum()

float tgui::Knob::getMinimum ( ) const

Returns the value when the knob would be rotated in the direction of StartRotation.

Returns
The current minimum value

The default minimum value is 0.

See also
getStartRotation

◆ getRenderer()

KnobRenderer * tgui::Knob::getRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSharedRenderer()

KnobRenderer * tgui::Knob::getSharedRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getSignal()

Signal & tgui::Knob::getSignal ( String  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

◆ getStartRotation()

float tgui::Knob::getStartRotation ( ) const

Returns the start rotation, which is the place where the value should be minimal.

Returns
number in the interval [0,360[, for which 0 to to the right and the rotation goes counter-clockwise

◆ getValue()

float tgui::Knob::getValue ( ) const

Returns the current value.

Returns
The current value, determined by the Minimum, Maximum, StartRotation and EndRotation

The default value is 0.

◆ isMouseOnWidget()

bool tgui::Knob::isMouseOnWidget ( Vector2f  pos) const
overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns
Is the mouse on top of the widget?

Implements tgui::Widget.

◆ leftMousePressed()

void tgui::Knob::leftMousePressed ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ load()

void tgui::Knob::load ( const std::unique_ptr< DataIO::Node > &  node,
const LoadingRenderersMap &  renderers 
)
overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::Knob::mouseMoved ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ rendererChanged()

void tgui::Knob::rendererChanged ( const String property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

std::unique_ptr< DataIO::Node > tgui::Knob::save ( SavingRenderersMap &  renderers) const
overrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ setClockwiseTurning()

void tgui::Knob::setClockwiseTurning ( bool  clockwise)

Should the value increase when turning the knob clockwise?

Parameters
clockwiseDoes the value increase when turning clockwise?

◆ setEndRotation()

void tgui::Knob::setEndRotation ( float  endRotation)

Sets the end rotation, which is the place where the value should be maximal.

Parameters
endRotationNew end rotation

The rotation is a number in the interval [0,360[, for which 0 to to the right and the rotation goes counter-clockwise.

◆ setMaximum()

void tgui::Knob::setMaximum ( float  maximum)

Sets the value for when the knob would be rotated in the direction of EndRotation.

Parameters
maximumThe new maximum value

The knob will be rotated to keep representing the value correctly.

When the value is too big then it will be changed to this maximum. When the minimum value is higher than the new maximum then it will be changed to this new maximum value. The default maximum value is 360.

See also
setEndRotation

◆ setMinimum()

void tgui::Knob::setMinimum ( float  minimum)

Sets the value for when the knob would be rotated in the direction of StartRotation.

Parameters
minimumThe new minimum value

The knob will be rotated to keep representing the value correctly.

When the value is too small then it will be changed to this minimum. When the maximum value is lower than the new minimum then it will be changed to this new minimum value. The default minimum value is 0.

See also
setStartRotation

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d size)
virtual

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the widget.

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

void tgui::Knob::setSize ( const Layout2d size)
overridevirtual

Changes the size of the knob.

Parameters
sizeThe new size of the knob

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

void tgui::Widget::setSize ( Layout  width,
Layout  height 
)
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setStartRotation()

void tgui::Knob::setStartRotation ( float  startRotation)

Sets the start rotation, which is the place where the value should be minimal.

Parameters
startRotationNew start rotation

The rotation is a number in the interval [0,360[, for which 0 to to the right and the rotation goes counter-clockwise.

◆ setValue()

void tgui::Knob::setValue ( float  value)

Changes the current value.

Parameters
valueThe new value

The knob will be rotated to correctly represent this new value.

The value can't be smaller than the minimum or bigger than the maximum. The default value is 0.


The documentation for this class was generated from the following file: