#include <TGUI/Widgets/Knob.hpp>

Inheritance diagram for tgui::Knob:

Public Types
typedef std::shared_ptr< Knob >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Knob >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
	Knob (const char *typeName="Knob", bool initRenderer=true)

KnobRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const KnobRenderer *	getSharedRenderer () const

KnobRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const KnobRenderer *	getRenderer () const

void	setSize (const Layout2d &size) override
	Changes the size of the knob.

void	setStartRotation (float startRotation)
	Sets the start rotation, which is the place where the value should be minimal.

float	getStartRotation () const
	Returns the start rotation, which is the place where the value should be minimal.

void	setEndRotation (float endRotation)
	Sets the end rotation, which is the place where the value should be maximal.

float	getEndRotation () const
	Sets the end rotation, which is the place where the value should be maximal.

void	setMinimum (float minimum)
	Sets the value for when the knob would be rotated in the direction of StartRotation.

float	getMinimum () const
	Returns the value 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.

float	getMaximum () const
	Returns the value when the knob would be rotated in the direction of EndRotation.

void	setValue (float value)
	Changes the current value.

float	getValue () const
	Returns the current value.

void	setClockwiseTurning (bool clockwise)
	Should the value increase when turning the knob clockwise?

bool	getClockwiseTurning () const
	Returns whether the value increases when turning the knob clockwise?

bool	isMouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

void	leftMousePressed (Vector2f pos) override

void	mouseMoved (Vector2f pos) override

void	draw (BackendRenderTargetBase &target, RenderStates states) const override
	Draw the widget to a render target.

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&)
	Move constructor.

virtual	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&)
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.

WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const WidgetRenderer *	getSharedRenderer () const

WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

const WidgetRenderer *	getRenderer () const

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

Vector2f	getPosition () const
	Gets the position of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

void	setWidth (Layout width)
	Changes the width of the widget.

void	setHeight (Layout height)
	Changes the height of the widget.

Vector2f	getSize () const
	Returns the size of the widget.

virtual Vector2f	getFullSize () const
	Returns the entire size that the widget is using.

virtual Vector2f	getAbsolutePosition () const
	Get the absolute position of the top-left point of the widget instead of the relative position to its parent.

virtual Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed.

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.

Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.

Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.

void	setRotation (float angle)
	Sets the rotation to be applied to the widget.

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.

float	getRotation () const
	Returns the rotation to be applied to the widget.

Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.

virtual void	setVisible (bool visible)
	Shows or hides a widget.

bool	isVisible () const
	Returns true when the widget is visible.

virtual void	setEnabled (bool enabled)
	Enables or disables the widget.

bool	isEnabled () const
	Returns true when the widget is enabled.

virtual void	setFocused (bool focused)
	Focus or unfocus the widget.

bool	isFocused () const
	Returns true when the widget is focused and false otherwise.

const String &	getWidgetType () const
	Returns the type of the widget.

Container *	getParent () const
	Returns a pointer to the parent widget.

GuiBase *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect)

void	moveToFront ()
	Places the widget before all other widgets.

void	moveToBack ()
	Places the widget behind all other widgets.

void	setUserData (Any userData)
	Stores some data into the widget.

template<typename T >
T	getUserData () const
	Returns data stored in the widget.

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.

const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.

float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

virtual void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.

virtual unsigned int	getTextSize () const
	Returns the character size of text in this widget.

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget.

Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget.

void	setWidgetName (const String &name)
	Changes the name of a widget.

String	getWidgetName () const
	Returns the name of a widget.

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.

Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.

void	setFocusable (bool focusable)
	Changes whether a widget could be focused.

bool	isFocusable () const
	Returns whether a widget could be focused.

virtual bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

bool	isContainer () const
	Returns whether the widget is a container widget or not.

bool	isDraggableWidget () const
	Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)

bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

virtual void	setParent (Container *parent)

virtual bool	updateTime (Duration elapsedTime)

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	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 Layout2d &	getPositionLayout () const

const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

Static Public Member Functions
static Knob::Ptr	create ()
	Creates a new knob widget.

static Knob::Ptr	copy (Knob::ConstPtr knob)
	Makes a copy of another knob.

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	onAnimationFinish = {"AnimationFinished"}

SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.

Protected Member Functions
Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.

void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

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	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes.

Vector2f	getInnerSize () const

void	recalculateRotation ()

Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.

Protected Member Functions inherited from tgui::Widget
virtual void	mouseEnteredWidget ()
	This function is called when the mouse enters the widget.

virtual void	mouseLeftWidget ()
	This function is called when the mouse leaves the widget.

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< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_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

Container *	m_parent = nullptr

GuiBase *	m_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< WidgetRenderer >	m_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

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

std::function< void(const String &property)>	m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }

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

inlineoverrideprotectedvirtual

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

knob	The 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	(	BackendRenderTargetBase &	target,
		RenderStates	states
	)		const

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current 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

signalName Name of the signal

Returns: Signal that corresponds to the name

Exceptions

Exception when 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

property Name 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

clockwise Does 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

endRotation New 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

maximum The 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

minimum The 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

size	Size 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});

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

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

overridevirtual

Changes the size of the knob.

Parameters

size	The 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

width	Width of the widget
height	Height 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

startRotation New 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

value The 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:

include/TGUI/Widgets/Knob.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ draw()

◆ getClockwiseTurning()

◆ getEndRotation()

◆ getMaximum()

◆ getMinimum()

◆ getRenderer()

◆ getSharedRenderer()

◆ getSignal()

◆ getStartRotation()

◆ getValue()

◆ isMouseOnWidget()

◆ leftMousePressed()

◆ load()

◆ mouseMoved()

◆ rendererChanged()

◆ save()

◆ setClockwiseTurning()

◆ setEndRotation()

◆ setMaximum()

◆ setMinimum()

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setStartRotation()

◆ setValue()