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 > Runtime > AdvancedWidgets > Components > URadialSlider

Light Theme

Dark Theme

URadialSlider

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

URadialSlider

References

Module	AdvancedWidgets
Header	/Engine/Source/Runtime/AdvancedWidgets/Public/Components/RadialSlider.h
Include	#include "Components/RadialSlider.h"

Syntax

class URadialSlider : 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
float	AngularOffset	Rotates radial slider by arbitrary offset to support full gamut of configurations.
bool	bUseCustomDefaultValue	Whether the slider should draw it's progress bar from a custom value on the slider
FLinearColor	CenterBackgroundColor	The color to draw the center background in.
float	CustomDefaultValue	The value where the slider should draw it's progress bar from, independent of direction
FVector2D	HandStartEndRatio	Start and end of the hand as a ratio to the slider radius (so 0.0 to 1.0 is from the slider center to the handle).
bool	IsFocusable	Should the slider be focusable?
float	K2_Cache_Value
bool	Locked	Whether the handle is interactive or fixed.
bool	MouseUsesStep	Sets new value if mouse position is greater/less than half the step size.
TSharedPtr< SRa...	MyRadialSlider	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.
bool	RequiresControllerLock	Sets whether we have to lock input to change the slider value.
bool	ShowSliderHand	Whether to show the slider hand.
bool	ShowSliderHandle	Whether to show the slider handle (thumb).
FLinearColor	SliderBarColor	The color to draw the slider bar in.
FLinearColor	SliderHandleColor	The color to draw the slider handle in.
float	SliderHandleEndAngle	The angle at which the Slider Handle will end.
float	SliderHandleStartAngle	The angle at which the Slider Handle will start.
FLinearColor	SliderProgressColor	The color to draw the completed progress of the slider bar in.
FRuntimeFloatCu...	SliderRange	A curve that defines how the slider should be sampled. Default is linear.
float	StepSize	The amount to adjust the value by, when using a controller or keyboard
bool	UseVerticalDrag	Whether the value is changed when dragging vertically as opposed to along the radial curve.
float	Value	The slider value to display.
FGetFloat	ValueDelegate	A bindable delegate to allow logic to drive the value of the widget
TArray< float >	ValueTags	Adds text tags to the radial slider at the value's position.
FSliderStyle	WidgetStyle	The progress bar style

Constructors

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

Functions

	Name	Description
float	GetCustomDefaultValue()	Gets the current custom default value of the slider.
float	GetNormalizedSliderHandlePosition()	Get the current raw slider alpha from 0 to 1
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	SetAngularOffset ( float InValue )	Sets the Angular Offset for the slider.
void	SetCenterBackgroundColor ( FLinearColor InValue )	Sets the color of the slider bar
void	SetCustomDefaultValue ( float InValue )	Sets the current custom default value of the slider.
void	SetHandStartEndRatio ( FVector2D InValue )	Sets the start and end of the hand as a ratio to the slider radius (so 0.0 to 1.0 is from the slider center to the handle).
void	SetLocked ( bool InValue )	Sets the handle to be interactive or fixed
void	SetShowSliderHand ( bool InShowSliderHand )	Whether to show the slider hand.
void	SetShowSliderHandle ( bool InShowSliderHandle )	Whether to show the slider handle (thumb).
void	SetSliderBarColor ( FLinearColor InValue )	Sets the color of the slider bar
void	SetSliderHandleColor ( FLinearColor InValue )	Sets the color of the handle bar
void	SetSliderHandleEndAngle ( float InValue )	Sets the maximum angle of the slider.
void	SetSliderHandleStartAngle ( float InValue )	Sets the minimum angle of the slider.
void	SetSliderProgressColor ( FLinearColor InValue )	Sets the progress color of the slider bar
void	SetSliderRange ( const FRuntimeFloatCurve& InSlider... )	Sets the curve for the slider range
void	SetStepSize ( float InValue )	Sets the amount to adjust the value by, when using a controller or keyboard
void	SetUseVerticalDrag ( bool InUseVerticalDrag )	Set whether the value is changed when dragging vertically as opposed to along the radial curve.
void	SetValue ( float InValue )	Sets the current value of the slider.
void	SetValueTags ( const TArray< float >& InValueTags )	Adds value tags to the slider.

Overridden from UWidget

	Name	Description
TSharedPtr< ...	GetAccessibleWidget()	Gets the widget that accessibility properties should synchronize to.
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 )