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

> Unreal Engine API Reference > Plugins > Synthesis > UI > SSynthKnob

Light Theme

Dark Theme

SSynthKnob

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SLeafWidget

SSynthKnob

References

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

Syntax

class SSynthKnob : public SLeafWidget

Functions

		Name	Description
	void	CommitValue ( float NewValue )	Commits the specified slider value.
	void	Construct ( const SSynthKnob::FArguments& InDe... )	Construct the widget.
	FVector2D	GetMouseDownPosition()	Return the last mouse down position.
	float	GetValue()	See the Value attribute
	bool	IsLocked()
	void	SetLocked ( const TAttribute< bool >& InLocked )	See the Locked attribute
	void	SetMouseFineTuneSpeed ( const float InMouseFineTuneSpeed )	See the MousePeed attribute
	void	SetMouseSpeed ( const float InMouseSpeed )	See the MousePeed attribute
	void	SetStepSize ( const float InStepSize )	See the StepSize attribute
	void	SetValue ( const TAttribute< float >& InValue... )	See the Value attribute

Overridden from SWidget

		Name	Description
	FVector2D	ComputeDesiredSize ( float )	Overwritten from SWidget.
	bool	IsInteractable()
	void	OnFocusLost ( const FFocusEvent& InFocusEvent )	Called when this widget loses focus. This event does not bubble.
	FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
	FReply	OnKeyUp ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is released when this widget has focus
	FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
	FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was release within it.
	FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse moved within it.
	int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	Overwritten from SWidget.
	bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

	Name	Description
	FArguments