UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SRadialSlider Class Reference

#include <SRadialSlider.h>

+ Inheritance diagram for SRadialSlider:

Public Member Functions

 SLATE_BEGIN_ARGS (SRadialSlider)
 
ADVANCEDWIDGETS_API SRadialSlider ()
 
virtual ADVANCEDWIDGETS_API ~SRadialSlider ()
 
ADVANCEDWIDGETS_API void Construct (const SRadialSlider::FArguments &InDeclaration)
 
FRuntimeFloatCurve GetSliderRange () const
 
ADVANCEDWIDGETS_API float GetMinValue () const
 
ADVANCEDWIDGETS_API float GetMaxValue () const
 
float GetSliderHandleStartAngle () const
 
float GetSliderHandleEndAngle () const
 
float GetAngularOffset () const
 
TArray< floatGetValueTags () const
 
ADVANCEDWIDGETS_API float GetValue () const
 
ADVANCEDWIDGETS_API bool GetUseCustomDefaultValue () const
 
ADVANCEDWIDGETS_API float GetCustomDefaultValue () const
 
ADVANCEDWIDGETS_API float GetNormalizedValue (float RawValue) const
 
ADVANCEDWIDGETS_API float GetNormalizedSliderHandlePosition () const
 
ADVANCEDWIDGETS_API void SetValue (const TAttribute< float > &InValueAttribute)
 
ADVANCEDWIDGETS_API void SetUseCustomDefaultValue (const TAttribute< bool > &InValueAttribute)
 
ADVANCEDWIDGETS_API void SetCustomDefaultValue (const TAttribute< float > &InValueAttribute)
 
void SetSliderRange (const FRuntimeFloatCurve &InSliderRange)
 
ADVANCEDWIDGETS_API void SetSliderHandleStartAngleAndSliderHandleEndAngle (float InSliderHandleStartAngle, float InSliderHandleEndAngle)
 
void SetAngularOffset (float InAngularOffset)
 
ADVANCEDWIDGETS_API void SetHandStartEndRatio (FVector2D InHandStartEndRatio)
 
void SetValueTags (const TArray< float > &InValueTags)
 
ADVANCEDWIDGETS_API void SetLocked (const TAttribute< bool > &InLocked)
 
ADVANCEDWIDGETS_API void SetSliderBarColor (FSlateColor InSliderBarColor)
 
ADVANCEDWIDGETS_API void SetSliderProgressColor (FSlateColor InSliderProgressColor)
 
ADVANCEDWIDGETS_API void SetSliderHandleColor (FSlateColor InSliderHandleColor)
 
ADVANCEDWIDGETS_API void SetCenterBackgroundColor (FSlateColor InCenterHandleColor)
 
ADVANCEDWIDGETS_API void SetThickness (const float InThickness)
 
ADVANCEDWIDGETS_API float GetStepSize () const
 
ADVANCEDWIDGETS_API void SetStepSize (const TAttribute< float > &InStepSize)
 
ADVANCEDWIDGETS_API void SetMouseUsesStep (bool MouseUsesStep)
 
ADVANCEDWIDGETS_API void SetRequiresControllerLock (bool RequiresControllerLock)
 
ADVANCEDWIDGETS_API void SetUseVerticalDrag (bool UseVerticalDrag)
 
ADVANCEDWIDGETS_API void SetShowSliderHandle (bool ShowSliderHandle)
 
ADVANCEDWIDGETS_API void SetShowSliderHand (bool ShowSliderHand)
 
virtual ADVANCEDWIDGETS_API int32 OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
virtual ADVANCEDWIDGETS_API FVector2D ComputeDesiredSize (float) const override
 
virtual ADVANCEDWIDGETS_API FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual ADVANCEDWIDGETS_API FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual ADVANCEDWIDGETS_API FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual ADVANCEDWIDGETS_API FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) override
 
virtual ADVANCEDWIDGETS_API FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) override
 
virtual ADVANCEDWIDGETS_API FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) override
 
virtual ADVANCEDWIDGETS_API FReply OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent) override
 
virtual ADVANCEDWIDGETS_API FReply OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent) override
 
virtual ADVANCEDWIDGETS_API void OnFocusLost (const FFocusEvent &InFocusEvent) override
 
virtual ADVANCEDWIDGETS_API FNavigationReply OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent) override
 
virtual ADVANCEDWIDGETS_API bool SupportsKeyboardFocus () const override
 
virtual ADVANCEDWIDGETS_API bool IsInteractable () const override
 
ADVANCEDWIDGETS_API bool IsLocked () const
 
- Public Member Functions inherited from SLeafWidget
SLATECORE_API SLeafWidget ()
 
virtual SLATECORE_API ~SLeafWidget ()
 
virtual SLATECORE_API void SetVisibility (TAttribute< EVisibility > InVisibility) override final
 
- Public Member Functions inherited from SWidget
SLATECORE_API int32 Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const
 
virtual SLATECORE_API void Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)
 
virtual SLATECORE_API FReply OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API FReply OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)
 
virtual SLATECORE_API FReply OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)
 
virtual SLATECORE_API FReply OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseLeave (const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FCursorReply OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const
 
virtual SLATECORE_API TOptional< TSharedRef< SWidget > > OnMapCursor (const FCursorReply &CursorReply) const
 
virtual SLATECORE_API FReply OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)
 
virtual SLATECORE_API bool OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)
 
virtual SLATECORE_API TSharedPtr< FPopupLayerOnVisualizePopup (const TSharedRef< SWidget > &PopupContent)
 
virtual SLATECORE_API FReply OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API void OnDragLeave (const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)
 
virtual SLATECORE_API FReply OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)
 
virtual SLATECORE_API TOptional< boolOnQueryShowFocus (const EFocusCause InFocusCause) const
 
virtual SLATECORE_API FPopupMethodReply OnQueryPopupMethod () const
 
virtual SLATECORE_API TOptional< FVirtualPointerPositionTranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const
 
virtual SLATECORE_API void OnFinishedPointerInput ()
 
virtual SLATECORE_API void OnFinishedKeyInput ()
 
virtual SLATECORE_API EWindowZone::Type GetWindowZoneOverride () const
 
bool NeedsPrepass () const
 
SLATECORE_API void SlatePrepass ()
 
SLATECORE_API void SlatePrepass (float InLayoutScaleMultiplier)
 
void SetCanTick (bool bInCanTick)
 
bool GetCanTick () const
 
bool HasRegisteredSlateAttribute () const
 
bool IsAttributesUpdatesEnabled () const
 
const FSlateWidgetPersistentStateGetPersistentState () const
 
const FWidgetProxyHandle GetProxyHandle () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetDesiredSize () const
 
SLATECORE_API void AssignParentWidget (TSharedPtr< SWidget > InParent)
 
SLATECORE_API bool ConditionallyDetatchParentWidget (SWidget *InExpectedParent)
 
virtual bool ValidatePathToChild (SWidget *InChild)
 
bool IsParentValid () const
 
TSharedPtr< SWidgetGetParentWidget () const
 
TSharedPtr< SWidgetAdvanced_GetPaintParentWidget () const
 
SLATECORE_API FSlateRect CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const
 
bool HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
virtual SLATECORE_API float GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const
 
SLATECORE_API void ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const
 
virtual FChildrenGetAllChildren ()
 
virtual SLATECORE_API bool HasKeyboardFocus () const
 
SLATECORE_API TOptional< EFocusCauseHasUserFocus (int32 UserIndex) const
 
SLATECORE_API TOptional< EFocusCauseHasAnyUserFocus () const
 
SLATECORE_API bool HasUserFocusedDescendants (int32 UserIndex) const
 
SLATECORE_API bool HasFocusedDescendants () const
 
SLATECORE_API bool HasAnyUserFocusOrFocusedDescendants () const
 
SLATECORE_API bool HasMouseCapture () const
 
SLATECORE_API bool HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const
 
virtual SLATECORE_API void OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)
 
void SetEnabled (TAttribute< bool > InEnabledState)
 
bool IsEnabled () const
 
virtual SLATECORE_API TSharedPtr< IToolTipGetToolTip ()
 
virtual SLATECORE_API void OnToolTipClosing ()
 
SLATECORE_API void EnableToolTipForceField (const bool bEnableForceField)
 
bool HasToolTipForceField () const
 
bool IsHovered () const
 
SLATECORE_API bool IsDirectlyHovered () const
 
EVisibility GetVisibility () const
 
bool IsVolatile () const
 
bool IsVolatileIndirectly () const
 
void ForceVolatile (bool bForce)
 
bool ShouldInvalidatePrepassDueToVolatility ()
 
SLATECORE_API void Invalidate (EInvalidateWidgetReason InvalidateReason)
 
void CacheVolatility ()
 
void MarkPrepassAsDirty ()
 
float GetRenderOpacity () const
 
void SetRenderOpacity (float InRenderOpacity)
 
void SetTag (FName InTag)
 
const TOptional< FSlateRenderTransform > & GetRenderTransform () const
 
TOptional< FSlateRenderTransformGetRenderTransformWithRespectToFlowDirection () const
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivotWithRespectToFlowDirection () const
 
void SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivot () const
 
void SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)
 
SLATECORE_API void SetClipping (EWidgetClipping InClipping)
 
EWidgetClipping GetClipping () const
 
SLATECORE_API void SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)
 
EWidgetPixelSnapping GetPixelSnapping () const
 
void SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)
 
FMargin GetCullingBoundsExtension () const
 
void SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)
 
EFlowDirectionPreference GetFlowDirectionPreference () const
 
SLATECORE_API void SetToolTipText (const TAttribute< FText > &ToolTipText)
 
SLATECORE_API void SetToolTipText (const FText &InToolTipText)
 
SLATECORE_API void SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)
 
SLATECORE_API void SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)
 
template<typename MetaDataType >
TSharedPtr< MetaDataType > GetMetaData () const
 
template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > > GetAllMetaData () const
 
template<typename MetaDataType >
void AddMetadata (const TSharedRef< MetaDataType > &AddMe)
 
template<typename MetaDataType >
int32 RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)
 
SLATECORE_API void SetOnMouseButtonDown (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseButtonUp (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseMove (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseDoubleClick (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)
 
virtual SLATECORE_API FString ToString () const
 
SLATECORE_API FString GetTypeAsString () const
 
SLATECORE_API FName GetType () const
 
virtual SLATECORE_API FString GetReadableLocation () const
 
SLATECORE_API FName GetCreatedInLocation () const
 
virtual SLATECORE_API FName GetTag () const
 
virtual SLATECORE_API FSlateColor GetForegroundColor () const
 
virtual SLATECORE_API FSlateColor GetDisabledForegroundColor () const
 
SLATECORE_API const FGeometryGetCachedGeometry () const
 
SLATECORE_API const FGeometryGetTickSpaceGeometry () const
 
SLATECORE_API const FGeometryGetPaintSpaceGeometry () const
 
const TOptional< FSlateClippingState > & GetCurrentClippingState () const
 
virtual bool Advanced_IsWindow () const
 
virtual bool Advanced_IsInvalidationRoot () const
 
virtual const FSlateInvalidationRootAdvanced_AsInvalidationRoot () const
 
SLATECORE_API TSharedRef< FActiveTimerHandleRegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)
 
SLATECORE_API void UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)
 
bool HasActiveTimers () const
 
- Public Member Functions inherited from FSlateControlledConstruction
 FSlateControlledConstruction ()=default
 
virtual ~FSlateControlledConstruction ()=default
 
virtual const FSlateWidgetClassDataGetWidgetClass () const =0
 
void operator delete (void *mem)
 
- Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode > AsShared ()
 
TSharedRef< SWidget const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< SWidget, Mode > AsWeak ()
 
TWeakPtr< SWidget const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Member Functions

virtual ADVANCEDWIDGETS_API void CommitValue (float NewValue)
 
ADVANCEDWIDGETS_API float PositionToValue (const FGeometry &MyGeometry, const FVector2D &AbsolutePosition)
 
ADVANCEDWIDGETS_API const FSlateBrushGetBarImage () const
 
ADVANCEDWIDGETS_API const FSlateBrushGetThumbImage () const
 
- Protected Member Functions inherited from SWidget
void SetVolatilePrepass (bool bVolatile)
 
virtual bool CustomPrepass (float LayoutScaleMultiplier)
 
virtual SLATECORE_API void CacheDesiredSize (float InLayoutScaleMultiplier)
 
void SetHover (TAttribute< bool > InHovered)
 
bool IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const
 
SLATECORE_API void InvalidateChildRemovedFromTree (SWidget &Child)
 
bool Advanced_InvalidateVolatility ()
 
EFlowDirection ComputeFlowDirection () const
 
SLATECORE_API void SetDebugInfo (const ANSICHAR *InType, const ANSICHAR *InFile, int32 OnLine, size_t InAllocSize)
 
virtual SLATECORE_API TOptional< EMouseCursor::TypeGetCursor () const
 
SLATECORE_API SWidget ()
 
SLATECORE_API void SWidgetConstruct (const FSlateBaseNamedArgs &Args)
 
bool IsConstructed () const
 
SLATECORE_API bool FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API void FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API FGeometry FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const
 
bool ShouldBeEnabled (bool InParentEnabled) const
 
virtual SLATECORE_API const FSlateBrushGetFocusBrush () const
 
virtual bool ComputeVolatility () const
 
virtual SLATECORE_API void OnClippingChanged ()
 
float GetPrepassLayoutScaleMultiplier () const
 
SLATECORE_API void Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)
 
template<typename TargetValueType , typename SourceValueType >
bool SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 
TSlateAttributeRef< boolGetEnabledStateAttribute () const
 
TSlateAttributeRef< boolGetHoveredAttribute () const
 
TSlateAttributeRef< EVisibilityGetVisibilityAttribute () const
 
TSlateAttributeRef< TOptional< FSlateRenderTransform > > GetRenderTransformAttribute () const
 
TSlateAttributeRef< FVector2DGetRenderTransformPivotAttribute () const
 
virtual SLATECORE_API ~SWidget ()
 
- Protected Member Functions inherited from TSharedFromThis< SWidget >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Protected Attributes

const FSliderStyleStyle
 
TAttribute< boolLockedAttribute
 
TAttribute< FSlateColorSliderBarColor
 
TAttribute< FSlateColorSliderProgressColor
 
TAttribute< FSlateColorSliderHandleColor
 
TAttribute< FSlateColorCenterBackgroundColor
 
FSlateBrush CenterBackgroundBrush
 
TAttribute< TOptional< float > > Thickness
 
TAttribute< floatValueAttribute
 
TAttribute< boolbUseCustomDefaultValue
 
TAttribute< floatCustomDefaultValue
 
EMouseCursor::Type CachedCursor
 
FVector2D PressedScreenSpaceTouchDownPosition = FVector2D(0, 0)
 
TAttribute< floatStepSize
 
float SliderHandleStartAngle
 
float SliderHandleEndAngle
 
float AngularOffset
 
FVector2D HandStartEndRatio
 
TArray< floatValueTags
 
FRuntimeFloatCurve SliderRange
 
bool bControllerInputCaptured
 
bool bMouseUsesStep
 
bool bRequiresControllerLock
 
bool bIsFocusable
 
bool bUseVerticalDrag
 
bool bShowSliderHandle
 
bool bShowSliderHand
 
- Protected Attributes inherited from SWidget
uint8 bCanSupportFocus: 1
 
uint8 bCanHaveChildren: 1
 
uint8 bClippingProxy: 1
 
uint8 bHasCustomPrepass: 1
 
uint8 bHasRelativeLayoutScale: 1
 
uint8 bVolatilityAlwaysInvalidatesPrepass: 1
 
EWidgetClipping Clipping
 
EWidgetPixelSnapping PixelSnappingMethod
 
FMargin CullingBoundsExtension
 
float RenderOpacity
 

Additional Inherited Members

- Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassDataStaticWidgetClass ()
 
- Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32 FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)
 
static SLATECORE_API int32 FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)
 
static TAttribute< EVisibilityAccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)
 
- Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Constructor & Destructor Documentation

◆ SRadialSlider()

SRadialSlider::SRadialSlider ( )

Sets new value if mouse position is greater/less than half the step size. Sets whether we have to lock input to change the slider value. Whether the handle is interactive or fixed. The color to draw the slider bar in. The color to draw completed progress of the slider bar in. The color to draw the slider handle in. The color to draw the center background in. The thickness used for the slider bar. For backwards compatibility, this will only be used instead of the bar thickness from Style if it has been manually set with SetThickness. Center background image. The style used to draw the slider. The input mode while using the controller. A value that drives where the slider handle appears. Value is normalized between 0 and 1. Whether the slider should draw it's progress bar from a custom value on the slider The value where the slider should draw it's progress bar from, independent of direction A curve that defines how the slider should be sampled. Default is linear. The angle at which the Slider Handle will start. The angle at which the Slider Handle will end. Rotates radial slider by arbitrary offset to support full gamut of configurations 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). Distributes value tags along the slider Sometimes a slider should only be mouse-clickable and never keyboard focusable. Whether the value is changed when dragging vertically as opposed to along the radial curve.
Whether to show the slider thumb. Whether to show the slider hand. Invoked when the mouse is pressed and a capture begins. Invoked when the mouse is released and a capture ends. Invoked when the Controller is pressed and capture begins. Invoked when the controller capture is released.
Called when the value is changed by the slider.

◆ ~SRadialSlider()

SRadialSlider::~SRadialSlider ( )
virtualdefault

Member Function Documentation

◆ CommitValue()

void SRadialSlider::CommitValue ( float  NewValue)
protectedvirtual

Commits the specified slider value.

Parameters
NewValueThe value to commit.

◆ ComputeDesiredSize()

FVector2D SRadialSlider::ComputeDesiredSize ( float  ) const
overridevirtual

Overwritten from SWidget.

LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.

Implements SLeafWidget.

◆ Construct()

void SRadialSlider::Construct ( const SRadialSlider::FArguments &  InDeclaration)

Construct the widget.

Parameters
InDeclarationA declaration from which to construct the widget.

◆ GetAngularOffset()

float SRadialSlider::GetAngularOffset ( ) const
inline

Get the AngularOffset attribute

◆ GetBarImage()

const FSlateBrush * SRadialSlider::GetBarImage ( ) const
protected

◆ GetCustomDefaultValue()

float SRadialSlider::GetCustomDefaultValue ( ) const

Get ths CustomDefaultValue attribute

◆ GetMaxValue()

float SRadialSlider::GetMaxValue ( ) const

Get the maximum value in Slider Range

◆ GetMinValue()

float SRadialSlider::GetMinValue ( ) const

Get the minumum value in Slider Range

◆ GetNormalizedSliderHandlePosition()

float SRadialSlider::GetNormalizedSliderHandlePosition ( ) const

Get the Slider's Handle position scaled from 0 to 1

◆ GetNormalizedValue()

float SRadialSlider::GetNormalizedValue ( float  RawValue) const

Get the Value attribute scaled from 0 to 1

◆ GetSliderHandleEndAngle()

float SRadialSlider::GetSliderHandleEndAngle ( ) const
inline

Get the MaxSliderHandleAngle attribute

◆ GetSliderHandleStartAngle()

float SRadialSlider::GetSliderHandleStartAngle ( ) const
inline

Get the MinSliderHandleAngle attribute

◆ GetSliderRange()

FRuntimeFloatCurve SRadialSlider::GetSliderRange ( ) const
inline

Get the SliderRange attribute

◆ GetStepSize()

float SRadialSlider::GetStepSize ( ) const

Get the StepSize attribute

◆ GetThumbImage()

const FSlateBrush * SRadialSlider::GetThumbImage ( ) const
protected

◆ GetUseCustomDefaultValue()

bool SRadialSlider::GetUseCustomDefaultValue ( ) const

Get the bUseCustomDefaultValue attribute

◆ GetValue()

float SRadialSlider::GetValue ( ) const

Get the Value attribute

◆ GetValueTags()

TArray< float > SRadialSlider::GetValueTags ( ) const
inline

Get the ValueTags attribute

◆ IsInteractable()

bool SRadialSlider::IsInteractable ( ) const
overridevirtual
Returns
Is this widget interactive or not? Defaults to false

Reimplemented from SWidget.

◆ IsLocked()

bool SRadialSlider::IsLocked ( ) const
Returns
Is the handle locked or not? Defaults to false

◆ OnFocusLost()

void SRadialSlider::OnFocusLost ( const FFocusEvent InFocusEvent)
overridevirtual

Called when this widget loses focus. This event does not bubble.

Parameters
InFocusEventThe FocusEvent

Reimplemented from SWidget.

◆ OnKeyDown()

FReply SRadialSlider::OnKeyDown ( const FGeometry MyGeometry,
const FKeyEvent InKeyEvent 
)
overridevirtual

Called after a key is pressed when this widget has focus (this event bubbles if not handled)

Parameters
MyGeometryThe Geometry of the widget receiving the event
InKeyEventKey event
Returns
Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnKeyUp()

FReply SRadialSlider::OnKeyUp ( const FGeometry MyGeometry,
const FKeyEvent InKeyEvent 
)
overridevirtual

Called after a key is released when this widget has focus

Parameters
MyGeometryThe Geometry of the widget receiving the event
InKeyEventKey event
Returns
Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnMouseButtonDown()

FReply SRadialSlider::OnMouseButtonDown ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overridevirtual

The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.

Parameters
MyGeometryThe Geometry of the widget receiving the event
MouseEventInformation about the input event
Returns
Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnMouseButtonUp()

FReply SRadialSlider::OnMouseButtonUp ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overridevirtual

The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled.

Parameters
MyGeometryThe Geometry of the widget receiving the event
MouseEventInformation about the input event
Returns
Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnMouseMove()

FReply SRadialSlider::OnMouseMove ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overridevirtual

The system calls this method to notify the widget that a mouse moved within it. This event is bubbled.

Parameters
MyGeometryThe Geometry of the widget receiving the event
MouseEventInformation about the input event
Returns
Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnNavigation()

FNavigationReply SRadialSlider::OnNavigation ( const FGeometry MyGeometry,
const FNavigationEvent InNavigationEvent 
)
overridevirtual

Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.

Parameters
InNavigationEventThe navigation event generated

Reimplemented from SWidget.

◆ OnPaint()

int32 SRadialSlider::OnPaint ( const FPaintArgs Args,
const FGeometry AllottedGeometry,
const FSlateRect MyCullingRect,
FSlateWindowElementList OutDrawElements,
int32  LayerId,
const FWidgetStyle InWidgetStyle,
bool  bParentEnabled 
) const
overridevirtual

Overwritten from SWidget.

LeafWidgets provide a visual representation of themselves. They do so by adding DrawElement(s) to the OutDrawElements. DrawElements should have their positions set to absolute coordinates in Window space; for this purpose the Slate system provides the AllottedGeometry parameter. AllottedGeometry describes the space allocated for the visualization of this widget.

Whenever possible, LeafWidgets should avoid dealing with layout properties. See TextBlock for an example.

Implements SLeafWidget.

◆ OnTouchEnded()

FReply SRadialSlider::OnTouchEnded ( const FGeometry MyGeometry,
const FPointerEvent InTouchEvent 
)
overridevirtual

Called when a touchpad touch is ended (finger lifted)

Parameters
InTouchEventThe touch event generated

Reimplemented from SWidget.

◆ OnTouchMoved()

FReply SRadialSlider::OnTouchMoved ( const FGeometry MyGeometry,
const FPointerEvent InTouchEvent 
)
overridevirtual

Called when a touchpad touch is moved (finger moved)

Parameters
InTouchEventThe touch event generated

Reimplemented from SWidget.

◆ OnTouchStarted()

FReply SRadialSlider::OnTouchStarted ( const FGeometry MyGeometry,
const FPointerEvent InTouchEvent 
)
overridevirtual

Called when a touchpad touch is started (finger down)

Parameters
InTouchEventThe touch event generated

Reimplemented from SWidget.

◆ PositionToValue()

float SRadialSlider::PositionToValue ( const FGeometry MyGeometry,
const FVector2D AbsolutePosition 
)
protected

Calculates the new value based on the given absolute coordinates.

Parameters
MyGeometryThe slider's geometry.
AbsolutePositionThe absolute position of the slider.
Returns
The new value.

◆ SetAngularOffset()

void SRadialSlider::SetAngularOffset ( float  InAngularOffset)
inline

Set the AngularOffset attribute

◆ SetCenterBackgroundColor()

void SRadialSlider::SetCenterBackgroundColor ( FSlateColor  InCenterHandleColor)

Set the SliderHandleColor attribute

◆ SetCustomDefaultValue()

void SRadialSlider::SetCustomDefaultValue ( const TAttribute< float > &  InValueAttribute)

Set the CustomDefaultValue attribute

◆ SetHandStartEndRatio()

void SRadialSlider::SetHandStartEndRatio ( FVector2D  InHandStartEndRatio)

Set the HandStartEndRatio. Clamped to 0.0 to 1.0, and if the start ratio is more than the end ratio, end ratio will be set to the start ratio.

◆ SetLocked()

void SRadialSlider::SetLocked ( const TAttribute< bool > &  InLocked)

Set the Locked attribute

◆ SetMouseUsesStep()

void SRadialSlider::SetMouseUsesStep ( bool  MouseUsesStep)

Set the MouseUsesStep attribute

◆ SetRequiresControllerLock()

void SRadialSlider::SetRequiresControllerLock ( bool  RequiresControllerLock)

Set the RequiresControllerLock attribute

◆ SetShowSliderHand()

void SRadialSlider::SetShowSliderHand ( bool  ShowSliderHand)

Set the ShowSliderHand attribute

◆ SetShowSliderHandle()

void SRadialSlider::SetShowSliderHandle ( bool  ShowSliderHandle)

Set the ShowSliderHandle attribute

◆ SetSliderBarColor()

void SRadialSlider::SetSliderBarColor ( FSlateColor  InSliderBarColor)

Set the SliderBarColor attribute

◆ SetSliderHandleColor()

void SRadialSlider::SetSliderHandleColor ( FSlateColor  InSliderHandleColor)

Set the SliderHandleColor attribute

◆ SetSliderHandleStartAngleAndSliderHandleEndAngle()

void SRadialSlider::SetSliderHandleStartAngleAndSliderHandleEndAngle ( float  InSliderHandleStartAngle,
float  InSliderHandleEndAngle 
)

Set the SliderHandleStartAngle and SliderHandleEndAngle attributes. If the new SliderHandleStartAngle is more than the new SliderHandleEndAngle, SliderHandleEndAngle will be changed to equal SliderHandleStartAngle.

◆ SetSliderProgressColor()

void SRadialSlider::SetSliderProgressColor ( FSlateColor  InSliderProgressColor)

Set the SliderProgressColor attribute

◆ SetSliderRange()

void SRadialSlider::SetSliderRange ( const FRuntimeFloatCurve InSliderRange)
inline

Set the SliderRange attribute

◆ SetStepSize()

void SRadialSlider::SetStepSize ( const TAttribute< float > &  InStepSize)

Set the StepSize attribute

◆ SetThickness()

void SRadialSlider::SetThickness ( const float  InThickness)

Set the Thickness attribute. For backward compatibility, Thickness will be used for drawing instead of Style->BarThickness only if it has been set with this method,

◆ SetUseCustomDefaultValue()

void SRadialSlider::SetUseCustomDefaultValue ( const TAttribute< bool > &  InValueAttribute)

Set the bUseCustomDefaultValue attribute

◆ SetUseVerticalDrag()

void SRadialSlider::SetUseVerticalDrag ( bool  UseVerticalDrag)

Set the UseVerticalDrag attribute

◆ SetValue()

void SRadialSlider::SetValue ( const TAttribute< float > &  InValueAttribute)

Set the Value attribute

◆ SetValueTags()

void SRadialSlider::SetValueTags ( const TArray< float > &  InValueTags)
inline

Set the ValueTags attribute

◆ SLATE_BEGIN_ARGS()

SRadialSlider::SLATE_BEGIN_ARGS ( SRadialSlider  )
inline

◆ SupportsKeyboardFocus()

bool SRadialSlider::SupportsKeyboardFocus ( ) const
overridevirtual

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Returns
True if this widget can take keyboard focus

Reimplemented from SWidget.

Member Data Documentation

◆ AngularOffset

float SRadialSlider::AngularOffset
protected

The angle at which the radial slider should be offset by

◆ bControllerInputCaptured

bool SRadialSlider::bControllerInputCaptured
protected

◆ bIsFocusable

bool SRadialSlider::bIsFocusable
protected

When true, this slider will be keyboard focusable. Defaults to false.

◆ bMouseUsesStep

bool SRadialSlider::bMouseUsesStep
protected

Sets new value if mouse position is greater/less than half the step size.

◆ bRequiresControllerLock

bool SRadialSlider::bRequiresControllerLock
protected

Sets whether we have to lock input to change the slider value.

◆ bShowSliderHand

bool SRadialSlider::bShowSliderHand
protected

Whether to show the slider hand.

◆ bShowSliderHandle

bool SRadialSlider::bShowSliderHandle
protected

Whether to show the slider handle (thumb).

◆ bUseCustomDefaultValue

TAttribute<bool> SRadialSlider::bUseCustomDefaultValue
protected

◆ bUseVerticalDrag

bool SRadialSlider::bUseVerticalDrag
protected

When true, value is changed when dragging vertically as opposed to along the radial curve.

◆ CachedCursor

EMouseCursor::Type SRadialSlider::CachedCursor
protected

◆ CenterBackgroundBrush

FSlateBrush SRadialSlider::CenterBackgroundBrush
protected

◆ CenterBackgroundColor

TAttribute<FSlateColor> SRadialSlider::CenterBackgroundColor
protected

◆ CustomDefaultValue

TAttribute<float> SRadialSlider::CustomDefaultValue
protected

◆ HandStartEndRatio

FVector2D SRadialSlider::HandStartEndRatio
protected

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).

◆ LockedAttribute

TAttribute<bool> SRadialSlider::LockedAttribute
protected

◆ PressedScreenSpaceTouchDownPosition

FVector2D SRadialSlider::PressedScreenSpaceTouchDownPosition = FVector2D(0, 0)
protected

The location in screenspace the slider was pressed by a touch

◆ SliderBarColor

TAttribute<FSlateColor> SRadialSlider::SliderBarColor
protected

◆ SliderHandleColor

TAttribute<FSlateColor> SRadialSlider::SliderHandleColor
protected

◆ SliderHandleEndAngle

float SRadialSlider::SliderHandleEndAngle
protected

The angle at which the radial slider should end

◆ SliderHandleStartAngle

float SRadialSlider::SliderHandleStartAngle
protected

The angle at which the radial slider should begin

◆ SliderProgressColor

TAttribute<FSlateColor> SRadialSlider::SliderProgressColor
protected

◆ SliderRange

FRuntimeFloatCurve SRadialSlider::SliderRange
protected

A curve that defines how the slider should be sampled. Default is linear.

◆ StepSize

TAttribute<float> SRadialSlider::StepSize
protected

Holds the amount to adjust the value by when using a controller or keyboard

◆ Style

const FSliderStyle* SRadialSlider::Style
protected

◆ Thickness

TAttribute<TOptional<float> > SRadialSlider::Thickness
protected

◆ ValueAttribute

TAttribute<float> SRadialSlider::ValueAttribute
protected

◆ ValueTags

TArray<float> SRadialSlider::ValueTags
protected

The values that should be drawn around the radial slider


The documentation for this class was generated from the following files: