Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

USynthKnob

A simple widget that shows a sliding bar with a handle that allows you to control the value between 0..1.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

USynthKnob

References

Module	Synthesis
Header	/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Public/UI/SynthKnob.h
Include	#include "UI/SynthKnob.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class USynthKnob : public UWidget

Remarks

A simple widget that shows a sliding bar with a handle that allows you to control the value between 0..1.

Variables

	Name	Description
bool	IsFocusable	Should the slider be focusable?
float	K2_Cache_Value
bool	Locked	Whether the handle is interactive or fixed.
float	MouseFineTuneSpeed	The speed of the mouse knob control when fine-tuning the knob
float	MouseSpeed	The speed of the mouse knob control
TSharedPtr< SSy...	MySynthKnob	Native Slate Widget
FOnControllerCa...	OnControllerCaptureBegin	Invoked when the controller capture begins.
FOnControllerCa...	OnControllerCaptureEnd	Invoked when the controller capture ends.
FOnMouseCapture...	OnMouseCaptureBegin	Invoked when the mouse is pressed and a capture begins.
FOnMouseCapture...	OnMouseCaptureEnd	Invoked when the mouse is released and a capture ends.
FOnFloatValueCh...	OnValueChanged	Called when the value is changed by slider or typing.
FText	ParameterName	The name of the pararameter. Will show when knob turns.
FText	ParameterUnits	The parameter units (e.g. hz). Will append to synth tooltip info.
uint32: 1	ShowTooltipInfo	Enable tool tip window to show parameter information while knob turns
float	StepSize	The amount to adjust the value by, when using a controller or keyboard
float	Value	The volume value to display.
FGetFloat	ValueDelegate	A bindable delegate to allow logic to drive the value of the widget
FSynthKnobStyle	WidgetStyle	The synth knob style

Constructors

	Name	Description
	USynthKnob ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
float	GetValue()	Gets the current value of the slider.
void	HandleOnControllerCaptureBegin()
void	HandleOnControllerCaptureEnd()
void	HandleOnMouseCaptureBegin()
void	HandleOnMouseCaptureEnd()
void	HandleOnValueChanged ( float InValue )
float	K2_Gate_Value()
void	SetLocked ( bool InValue )	Sets the handle to be interactive or fixed
void	SetStepSize ( float InValue )	Sets the amount to adjust the value by, when using a controller or keyboard
void	SetValue ( float InValue )	Sets the current value of the slider.

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss