TGUI  0.8-dev
tgui::KnobRenderer Class Reference
Inheritance diagram for tgui::KnobRenderer:
tgui::WidgetRenderer

Public Member Functions

void setBorders (const Borders &borders)
 Changes the size of the borders. More...
 
Borders getBorders () const
 Returns the size of the borders. More...
 
void setBackgroundColor (Color color)
 Changes the background color of the knob. More...
 
Color getBackgroundColor () const
 Returns the background color of the knob. More...
 
void setThumbColor (Color color)
 Changes the color of the thumb which you can move around the circle. More...
 
Color getThumbColor () const
 Returns the thumb color of the thumb which you can move around the circle. More...
 
void setBorderColor (Color color)
 Changes the border color. More...
 
Color getBorderColor () const
 Returns the border color. More...
 
void setTextureBackground (const Texture &texture)
 Changes the background image of the knob. More...
 
TexturegetTextureBackground () const
 Returns the background image. More...
 
void setTextureForeground (const Texture &texture)
 Changes the foreground image of the knob. More...
 
TexturegetTextureForeground () const
 Returns the foreground image. More...
 
void setImageRotation (float rotation)
 Changes the default rotation of the foreground texture. More...
 
float getImageRotation () const
 Returns the default rotation of the foreground texture. More...
 
- Public Member Functions inherited from tgui::WidgetRenderer
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. More...
 
virtual ~WidgetRenderer ()=default
 Virtual destructor.
 
void setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
void setFont (Font font)
 Changes the font used for the text in the widget. More...
 
Font getFont () const
 Returns the font associated with the widget (if any) More...
 
void setProperty (const std::string &property, ObjectConverter &&value)
 Changes a property of the renderer. More...
 
ObjectConverter getProperty (const std::string &property) const
 Retrieves the value of a certain property. More...
 
const std::map< std::string, ObjectConverter > & getPropertyValuePairs () const
 Gets a map with all properties and their values. More...
 
void subscribe (const void *id, const std::function< void(const std::string &property)> &function)
 Subscribes a callback function to changes in the renderer. More...
 
void unsubscribe (const void *id)
 Subscribes a callback function to changes in the renderer. More...
 
std::shared_ptr< RendererDatagetData () const
 Returns the renderer data. More...
 
std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data. More...
 

Member Function Documentation

◆ getBackgroundColor()

Color tgui::KnobRenderer::getBackgroundColor ( ) const

Returns the background color of the knob.

Returns
Background color

◆ getBorderColor()

Color tgui::KnobRenderer::getBorderColor ( ) const

Returns the border color.

Returns
Border color

◆ getBorders()

Borders tgui::KnobRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getImageRotation()

float tgui::KnobRenderer::getImageRotation ( ) const

Returns the default rotation of the foreground texture.

Returns
Rotation of the foreground image, which is a value between 0 and 360

This property defines in which direction the foreground image is pointing. The rotation is in degrees, starts from the right side and increases when going counter-clockwise.

◆ getTextureBackground()

Texture& tgui::KnobRenderer::getTextureBackground ( ) const

Returns the background image.

Returns
Background texture

◆ getTextureForeground()

Texture& tgui::KnobRenderer::getTextureForeground ( ) const

Returns the foreground image.

Returns
Foreground texture

◆ getThumbColor()

Color tgui::KnobRenderer::getThumbColor ( ) const

Returns the thumb color of the thumb which you can move around the circle.

Returns
Thumb color

◆ setBackgroundColor()

void tgui::KnobRenderer::setBackgroundColor ( Color  color)

Changes the background color of the knob.

Parameters
colorThe new background color

Note that this color is ignored when you set a background image.

◆ setBorderColor()

void tgui::KnobRenderer::setBorderColor ( Color  color)

Changes the border color.

Parameters
colorThe color that is used for the borders that are optionally drawn around the knob

◆ setBorders()

void tgui::KnobRenderer::setBorders ( const Borders borders)

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setImageRotation()

void tgui::KnobRenderer::setImageRotation ( float  rotation)

Changes the default rotation of the foreground texture.

Parameters
rotationRotation of the foreground image, which is a value between 0 and 360

This property defines in which direction the foreground image is pointing. The rotation is in degrees, starts from the right side and increases when going counter-clockwise.

This property has no effect when

◆ setTextureBackground()

void tgui::KnobRenderer::setTextureBackground ( const Texture texture)

Changes the background image of the knob.

Parameters
textureThe new background texture

When this image is set then the background color property will be ignored.

◆ setTextureForeground()

void tgui::KnobRenderer::setTextureForeground ( const Texture texture)

Changes the foreground image of the knob.

Parameters
textureThe new foreground texture

The foreground image is the part that is rotated around the center when the value changes.

When this image is set then the thumb color property will be ignored.

◆ setThumbColor()

void tgui::KnobRenderer::setThumbColor ( Color  color)

Changes the color of the thumb which you can move around the circle.

Parameters
colorThe new thumb color

Note that this color is ignored when you set a foreground image.


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