TGUI  0.8-dev

Knob widget. More...

#include <Knob.hpp>

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

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

KnobRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
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 (int minimum)
 Sets the value for when the knob would be rotated in the direction of StartRotation. More...
 
int getMinimum () const
 Returns the value when the knob would be rotated in the direction of StartRotation. More...
 
void setMaximum (int maximum)
 Sets the value for when the knob would be rotated in the direction of EndRotation. More...
 
int getMaximum () const
 Returns the value when the knob would be rotated in the direction of EndRotation. More...
 
void setValue (int value)
 Changes the current value. 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 () const
 Returns whether the value increases when turning the knob clockwise? More...
 
bool mouseOnWidget (sf::Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 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...
 
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...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. 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 ()
 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...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. 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 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...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, const Args &... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if< std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)>>::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs>
unsigned int connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args)
 Connect a signal handler to multiple signals. More...
 
bool disconnect (unsigned int id)
 Disconnects a signal handler. More...
 
void disconnectAll (std::string signalName)
 Disconnects all signal handler from a certain signal. More...
 
void disconnectAll ()
 Disconnects all signal handlers from 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...
 

Public Attributes

SignalInt onValueChange = {"ValueChanged"}
 The value of the know 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.
 

Protected Member Functions

SignalgetSignal (std::string signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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 mouseEnteredWidget ()
 This function is called when the mouse enters the widget.
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget.
 

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
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 ( sf::RenderTarget &  target,
sf::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()

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

int 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 ( std::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()

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

◆ mouseOnWidget()

bool tgui::Knob::mouseOnWidget ( sf::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.

◆ rendererChanged()

void tgui::Knob::rendererChanged ( const std::string &  property)
overrideprotectedvirtual

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

Parameters
propertyLowercase name of the property that was changed

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

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.

◆ 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 ( int  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: