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

USynth2DSlider

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

USynth2DSlider

References

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

Syntax

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

Remarks

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

No Children

Variables

	Name	Description
bool	IndentHandle	Whether the slidable area should be indented to fit the handle.
bool	IsFocusable	Should the slider be focusable?
float	K2_Cache_ValueX
float	K2_Cache_ValueY
bool	Locked	Whether the handle is interactive or fixed.
TSharedPtr< SSy...	MySlider	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...	OnValueChangedX	Called when the value is changed by slider or typing.
FOnFloatValueCh...	OnValueChangedY	Called when the value is changed by slider or typing.
FLinearColor	SliderHandleColor	The color to draw the slider handle in.
float	StepSize	The amount to adjust the value by, when using a controller or keyboard
float	ValueX
FGetFloat	ValueXDelegate	A bindable delegate to allow logic to drive the value of the widget
float	ValueY
FGetFloat	ValueYDelegate	A bindable delegate to allow logic to drive the value of the widget
FSynth2DSliderS...	WidgetStyle	The progress bar style

Constructors

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

Functions

	Name	Description
FVector2D	GetValue()	Gets the current value of the slider.
void	HandleOnControllerCaptureBegin()
void	HandleOnControllerCaptureEnd()
void	HandleOnMouseCaptureBegin()
void	HandleOnMouseCaptureEnd()
void	HandleOnValueChangedX ( float InValue )
void	HandleOnValueChangedY ( float InValue )
float	K2_Gate_ValueX()
float	K2_Gate_ValueY()
void	SetIndentHandle ( bool InValue )	Sets if the slidable area should be indented to fit the handle
void	SetLocked ( bool InValue )	Sets the handle to be interactive or fixed
void	SetSliderHandleColor ( FLinearColor InValue )	Sets the color of the handle bar
void	SetStepSize ( float InValue )	Sets the amount to adjust the value by, when using a controller or keyboard
void	SetValue ( FVector2D 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