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 > VirtualCamera > Widgets > Input > SRadialSlider

Light Theme

Dark Theme

SRadialSlider

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SLeafWidget

SRadialSlider

References

Module	VirtualCamera
Header	/Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/Widgets/Input/SRadialSlider.h
Include	#include "Widgets/Input/SRadialSlider.h"

Syntax

class SRadialSlider : public SLeafWidget

Variables

	Name	Description
float	AngularOffset	The angle at which the radial slider should be offset by
bool	bControllerInputCaptured	Holds a flag indicating whether a controller/keyboard is manipulating the slider's value.
bool	bIsFocusable	When true, this slider will be keyboard focusable. Defaults to false.
bool	bMouseUsesStep	Sets new value if mouse position is greater/less than half the step size.
bool	bRequiresControllerLock	Sets whether we have to lock input to change the slider value.
TAttribute< boo...	bUseCustomDefaultValue	Whether the slider should draw it's progress bar from a custom value on the slider.
EMouseCursor::T...	CachedCursor	Holds the initial cursor in case a custom cursor has been specified, so we can restore it after dragging the slider.
TAttribute< flo...	CustomDefaultValue	The value where the slider should draw it's progress bar from, independent of direction.
TAttribute< boo...	LockedAttribute	Holds a flag indicating whether the slider is locked.
FVector2D	PressedScreenSpaceTouchDownPosition	The location in screenspace the slider was pressed by a touch
TAttribute< FSl...	SliderBarColor	Holds the color of the slider bar.
TAttribute< FSl...	SliderHandleColor	Holds the color of the slider handle.
float	SliderHandleEndAngle	The angle at which the radial slider should end
float	SliderHandleStartAngle	The angle at which the radial slider should begin
TAttribute< FSl...	SliderProgressColor	Holds the color for the completed progress of the slider bar.
FRuntimeFloatCu...	SliderRange	A curve that defines how the slider should be sampled. Default is linear.
TAttribute< flo...	StepSize	Holds the amount to adjust the value by when using a controller or keyboard
const FSliderSt...	Style	Holds the style passed to the widget upon construction.
TAttribute< flo...	ValueAttribute	Holds the slider's current value.
TArray< float >	ValueTags	The values that should be drawn around the radial slider

Constructors

	Name	Description
	SRadialSlider()

Functions

	Name	Description
void	CommitValue ( float NewValue )	Commits the specified slider value.
void	Construct ( const SRadialSlider::FArguments& I... )	Construct the widget.
float	GetAngularOffset()	Get the AngularOffset attribute
const FSlate...	GetBarImage()
float	GetCustomDefaultValue()	Get ths CustomDefaultValue attribute
float	GetMaxValue()	Get the maximum value in Slider Range
float	GetMinValue()	Get the minumum value in Slider Range
float	GetNormalizedSliderHandlePosition()	Get the Slider's Handle position scaled from 0 to 1
float	GetNormalizedValue ( float RawValue )	Get the Value attribute scaled from 0 to 1
float	GetSliderHandleEndAngle()	Get the MaxSliderHandleAngle attribute
float	GetSliderHandleStartAngle()	Get the MinSliderHandleAngle attribute
FRuntimeFloa...	GetSliderRange()	Get the SliderRange attribute
float	GetStepSize()	Get the StepSize attribute
const FSlate...	GetThumbImage()
bool	GetUseCustomDefaultValue()	Get the bUseCustomDefaultValue attribute
float	GetValue()	Get the Value attribute
TArray< floa...	GetValueTags()	Get the ValueTags attribute
bool	IsLocked()
float	PositionToValue ( const FGeometry& MyGeometry, const FVector2D& AbsolutePosition )	Calculates the new value based on the given absolute coordinates.
void	SetAngularOffset ( float InAngularOffset )	Set the AngularOffset attribute
void	SetCustomDefaultValue ( const TAttribute< float >& InValue... )	Set the CustomDefaultValue attribute
void	SetLocked ( const TAttribute< bool >& InLocked )	Set the Locked attribute
void	SetMouseUsesStep ( bool MouseUsesStep )	Set the MouseUsesStep attribute
void	SetRequiresControllerLock ( bool RequiresControllerLock )	Set the RequiresControllerLock attribute
void	SetSliderBarColor ( FSlateColor InSliderBarColor )	Set the SliderBarColor attribute
void	SetSliderHandleColor ( FSlateColor InSliderHandleColor )	Set the SliderHandleColor attribute
void	SetSliderHandleStartAngleAndSliderHandleEndAngle ( float InSliderHandleStartAngle, float InSliderHandleEndAngle )	Set the SliderHandleStartAngle and SliderHandleEndAngle attributes.
void	SetSliderProgressColor ( FSlateColor InSliderProgressColor )	Set the SliderProgressColor attribute
void	SetSliderRange ( const FRuntimeFloatCurve& InSlider... )	Set the SliderRange attribute
void	SetStepSize ( const TAttribute< float >& InStepS... )	Set the StepSize attribute
void	SetUseCustomDefaultValue ( const TAttribute< bool >& InValueA... )	Set the bUseCustomDefaultValue attribute
void	SetValue ( const TAttribute< float >& InValue... )	Set the Value attribute
void	SetValueTags ( const TArray< float >& InValueTags )	Set the ValueTags attribute

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float )	Overwritten from SWidget.
TSharedRef< ...	CreateAccessibleWidget()
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.
FNavigationR...	OnNavigation ( const FGeometry& MyGeometry, const FNavigationEvent& InNavigati... )	Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	Overwritten from SWidget.
FReply	OnTouchEnded ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is ended (finger lifted)
FReply	OnTouchMoved ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is moved (finger moved)
FReply	OnTouchStarted ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is started (finger down)
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

	Name	Description
	FArguments

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

Take our survey

Dismiss