#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
std::shared_ptr< KnobRenderer >	getRenderer () const
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

virtual void	setPosition (const Layout2d &position) override
	Set the position of the knob. More...

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

virtual sf::Vector2f	getFullSize () const override
	Returns the full size of the knob. More...

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

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

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

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

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

virtual void	setMaximum (int maximum)
	Sets the value for when the knob would be rotated in the direction of EndRotation. More...

virtual void	setValue (int value)
	Changes the current value. More...

int	getMinimum () const
	Returns the value when the knob would be rotated in the direction of StartRotation. More...

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

int	getValue () const
	Returns the current value. More...

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

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

virtual void	setOpacity (float opacity) override
	Changes the opacity of the widget. More...

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

virtual void	setPosition (const Layout2d &position)
	set the position of the widget More...

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

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

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

Public Member Functions inherited from tgui::Widget
	Widget ()
	Default constructor.

	Widget (const Widget &copy)
	Copy constructor. More...

	~Widget ()
	Destructor.

Widget &	operator= (const Widget &right)
	Overload of assignment operator. More...

std::shared_ptr< WidgetRenderer >	getRenderer () const
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

virtual sf::Vector2f	getAbsolutePosition () const
	Get the absolute position of the widget instead of the relative position to its parent. More...

virtual void	show ()
	Shows the widget. More...

virtual void	showWithEffect (ShowAnimationType type, sf::Time duration)
	Shows the widget by introducing it with an animation. More...

virtual void	hide ()
	Hides the widget. More...

virtual void	hideWithEffect (ShowAnimationType type, sf::Time duration)
	Hides the widget by making it leave with an animation. More...

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

virtual void	enable ()
	Enables the widget. More...

virtual void	disable (bool blockMouseEvents=true)
	Disables the widget. More...

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

virtual void	focus ()
	Focus the widget. More...

virtual void	unfocus ()
	Unfocus the widget. More...

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

const std::string &	getWidgetType () const
	Returns the type of the widget. More...

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

float	getOpacity () const
	Returns the opacity of the widget. More...

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

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

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

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

virtual void	setFont (const Font &font)
	Changes the font of the text in the widget. More...

std::shared_ptr< sf::Font >	getFont () const
	Returns the font associated with the widget (if any) More...

void	detachTheme ()
	Detach the theme from the widget. More...

std::shared_ptr< BaseTheme >	getTheme () const
	Returns the theme to which the widget is currently connected. More...

std::string	getPrimaryLoadingParameter () const
	Returns the primary parameter that was passed to the loader to load this widget. More...

std::string	getSecondaryLoadingParameter () const
	Returns the secondary parameter that was passed to the loader to load this widget. More...

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

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

Public Member Functions inherited from tgui::Transformable
virtual	~Transformable ()
	Virtual destructor.

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

sf::Vector2f	getPosition () const
	get the position of the widget More...

void	move (const Layout2d &offset)
	Move the widget by a given offset. More...

void	move (const Layout &x, const Layout &y)
	Move the widget by a given offset. More...

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

virtual sf::Vector2f	getSize () const
	Returns the size of the widget. More...

void	scale (const Layout2d &factors)
	Scale the widget. More...

void	scale (const Layout &x, const Layout &y)
	Scale the widget. More...

Public Member Functions inherited from tgui::SignalWidgetBase
	SignalWidgetBase ()=default
	Default constructor.

	SignalWidgetBase (const SignalWidgetBase &copy)
	Copy constructor. More...

SignalWidgetBase &	operator= (const SignalWidgetBase &right)
	Overload of assignment operator. More...

template<typename Func , typename... Args>
unsigned int	connect (const std::string &signalNames, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

template<typename Func , typename... Args>
unsigned int	connectEx (const std::string &signalName, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

void	disconnect (unsigned int id)
	Disconnects a connection. More...

void	disconnectAll (const std::string &signalName)
	Disconnect all connections from a certain signal. More...

void	disconnectAll ()
	Disconnect all connections from a all signals.

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...

Protected Member Functions
virtual void	reload (const std::string &primary="", const std::string &secondary="", bool force=false) override
	Reload the widget. More...

virtual 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
void	attachTheme (std::shared_ptr< BaseTheme > theme)
	Attach a theme to the widget. More...

Detailed Description

Knob widget.

Signals:

ValueChanged
- Optional parameter int: new value of the knob
- Uses Callback member 'value'
Inherited signals from Widget

Member Function Documentation

◆ clone()

virtual 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

◆ getClockwiseTurning()

bool tgui::Knob::getClockwiseTurning ( )

inline

Returns whether the value increases when turning the knob clockwise?

Returns: Does the value increase when turning clockwise?

◆ getEndRotation()

float tgui::Knob::getEndRotation ( )

inline

Set 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.

◆ getFullSize()

virtual sf::Vector2f tgui::Knob::getFullSize ( ) const

overridevirtual

Returns the full size of the knob.

The size returned by this function includes the borders.

Returns: Full size of the knob

Reimplemented from tgui::Transformable.

◆ getMaximum()

int tgui::Knob::getMaximum ( ) const

inline

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()

int tgui::Knob::getMinimum ( ) const

inline

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()

std::shared_ptr< KnobRenderer > tgui::Knob::getRenderer ( ) const

inline

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

Returns: Reference to the renderer

◆ getStartRotation()

float tgui::Knob::getStartRotation ( )

inline

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()

int tgui::Knob::getValue ( ) const

inline

Returns the current value.

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

The default value is 0.

◆ getWidgetOffset()

virtual sf::Vector2f tgui::Knob::getWidgetOffset ( ) const

overridevirtual

Returns the distance between the position where the widget is drawn and where the widget is placed.

This is basically the width and height of the optional borders drawn around widgets.

Returns: Offset of the widget

Reimplemented from tgui::Widget.

◆ reload()

virtual void tgui::Knob::reload	(	const std::string &	primary = `""`,
		const std::string &	secondary = `""`,
		bool	force = `false`
	)

overrideprotectedvirtual

Reload the widget.

Parameters

primary	Primary parameter for the loader
secondary	Secondary parameter for the loader
force	Try to only change the looks of the widget and not alter the widget itself when false

Exceptions

Exception when the connected theme could not create the widget

When primary is an empty string the built-in white theme will be used.

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 )

Set 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()

virtual void tgui::Knob::setMaximum ( int maximum )

virtual

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()

virtual void tgui::Knob::setMinimum ( int minimum )

virtual

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

◆ setOpacity()

virtual void tgui::Knob::setOpacity ( float opacity )

overridevirtual

Changes the opacity of the widget.

Parameters

opacity The opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque.

Reimplemented from tgui::Widget.

◆ setPosition() [1/3]

void tgui::Transformable::setPosition	(	const Layout &	x,
		const Layout &	y
	)

inline

set the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

x	New x coordinate
y	New y coordinate

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition(40, 30);
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition().x, otherWidget->getPosition().y + otherWidget->getSize().y + 50);
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition(tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50);

◆ setPosition() [2/3]

virtual void tgui::Transformable::setPosition ( const Layout2d & position )

virtual

set the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position New position

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition({40, 30});
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition() + sf::Vector2f{0, otherWidget->getSize().y + 50});
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition({tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setPosition() [3/3]

virtual void tgui::Knob::setPosition ( const Layout2d & position )

overridevirtual

Set the position of the knob.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position Coordinate of the new position

See also: move, getPosition

Reimplemented from tgui::Widget.

◆ setSize() [1/3]

void tgui::Transformable::setSize	(	const Layout &	width,
		const Layout &	height
	)

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Usage examples:

// Give the widget an exact size
widget->setSize(40, 30);
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize().x, otherWidget->getSize().y + 50);
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindWidth(otherWidget), tgui::bindHeight(otherWidget) + 50);

◆ setSize() [2/3]

virtual void tgui::Transformable::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});
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize() + sf::Vector2f{0, 50});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindSize(otherWidget) + sf::Vector2f{0, 50});

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

virtual 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.

◆ setStartRotation()

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

Set 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()

virtual void tgui::Knob::setValue ( int value )

virtual

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

Protected Member Functions

Detailed Description

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ getClockwiseTurning()

◆ getEndRotation()

◆ getFullSize()

◆ getMaximum()

◆ getMinimum()

◆ getRenderer()

◆ getStartRotation()

◆ getValue()

◆ getWidgetOffset()

◆ reload()

◆ setClockwiseTurning()

◆ setEndRotation()

◆ setMaximum()

◆ setMinimum()

◆ setOpacity()

◆ setPosition() [1/3]

◆ setPosition() [2/3]

◆ setPosition() [3/3]

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setStartRotation()

◆ setValue()