Inheritance diagram for tgui::KnobRenderer:

Public Member Functions
void	setBorders (const Borders &borders)
	Changes the size of the borders.

Borders	getBorders () const
	Returns the size of the borders.

void	setBackgroundColor (Color color)
	Changes the background color of the knob.

Color	getBackgroundColor () const
	Returns the background color of the knob.

void	setThumbColor (Color color)
	Changes the color of the thumb which you can move around the circle.

Color	getThumbColor () const
	Returns the thumb color of the thumb which you can move around the circle.

void	setBorderColor (Color color)
	Changes the border color.

Color	getBorderColor () const
	Returns the border color.

void	setTextureBackground (const Texture &texture)
	Changes the background image of the knob.

const Texture &	getTextureBackground () const
	Returns the background image.

void	setTextureForeground (const Texture &texture)
	Changes the foreground image of the knob.

const Texture &	getTextureForeground () const
	Returns the foreground image.

void	setImageRotation (float rotation)
	Changes the default rotation of the foreground texture.

float	getImageRotation () const
	Returns the default rotation of the foreground texture.

	WidgetRenderer ()=default
	Default constructor.

	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.

	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.

	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.

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

	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.

	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.

WidgetRenderer &	operator= (const WidgetRenderer &)
	Copy assignment operator.

WidgetRenderer &	operator= (WidgetRenderer &&)=default
	Default move assignment operator.

	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.

virtual	~WidgetRenderer ()=default
	Virtual destructor.

void	setOpacity (float opacity)
	Changes the opacity of the widget.

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

void	setOpacityDisabled (float opacity)
	Changes the opacity of the widget when it is disabled.

float	getOpacityDisabled () const
	Returns the opacity of the widget when it is disabled.

void	setFont (const Font &font)
	Changes the font used for the text in the widget.

Font	getFont () const
	Returns the font associated with the widget (if any)

void	setTextSize (unsigned int size)
	Changes the text size of the widget that is specified by the renderer.

unsigned int	getTextSize () const
	Returns text size of the widget that is specified by the renderer.

void	setTransparentTexture (bool ignoreTransparentParts)
	Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state.

bool	getTransparentTexture () const
	Returns whether mouse events should be ignored on transparent parts of the texture of the widget.

void	setProperty (const String &property, ObjectConverter &&value)
	Changes a property of the renderer.

ObjectConverter	getProperty (const String &property) const
	Retrieves the value of a certain property.

const std::map< String, ObjectConverter > &	getPropertyValuePairs () const
	Gets a map with all properties and their values.

void	subscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.

void	unsubscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.

void	setData (std::shared_ptr< RendererData > data)

std::shared_ptr< RendererData >	getData () const
	Returns the renderer data.

std::shared_ptr< RendererData >	clone () const
	Gets a clone of the renderer data.

Additional Inherited Members
Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererData >	m_data = RendererData::create()

Member Function Documentation

◆ getBackgroundColor()

Color tgui::KnobRenderer::getBackgroundColor ( ) const

nodiscard

Returns the background color of the knob.

Returns: Background color

◆ getBorderColor()

Color tgui::KnobRenderer::getBorderColor ( ) const

nodiscard

Returns the border color.

Returns: Border color

◆ getBorders()

Borders tgui::KnobRenderer::getBorders ( ) const

nodiscard

Returns the size of the borders.

Returns: border size

◆ getImageRotation()

float tgui::KnobRenderer::getImageRotation ( ) const

nodiscard

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

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

nodiscard

Returns the background image.

Returns: Background texture

◆ getTextureForeground()

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

nodiscard

Returns the foreground image.

Returns: Foreground texture

◆ getThumbColor()

Color tgui::KnobRenderer::getThumbColor ( ) const

nodiscard

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

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

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

borders Size of the borders

◆ setImageRotation()

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

Changes the default rotation of the foreground texture.

Parameters

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

This property has no effect when TextureForeground isn't set.

◆ setTextureBackground()

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

Changes the background image of the knob.

Parameters

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

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

color The new thumb color

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

◆ WidgetRenderer()

tgui::WidgetRenderer::WidgetRenderer ( const std::shared_ptr< RendererData > & data )

inline

Construct the renderer from renderer data.

Parameters

data	Renderer data to initialize the renderer with

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

include/TGUI/Renderers/KnobRenderer.hpp

TGUI

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getBackgroundColor()

◆ getBorderColor()

◆ getBorders()

◆ getImageRotation()

◆ getTextureBackground()

◆ getTextureForeground()

◆ getThumbColor()

◆ setBackgroundColor()

◆ setBorderColor()

◆ setBorders()

◆ setImageRotation()

◆ setTextureBackground()

◆ setTextureForeground()

◆ setThumbColor()

◆ WidgetRenderer()