1. Epic GamesDeveloper
  3. SRadialSlider

SRadialSlider

API > API/Runtime > API/Runtime/AdvancedWidgets > API/Runtime/AdvancedWidgets/Widgets

Inheritance Hierarchy

References

   
Module AdvancedWidgets
Header /Engine/Source/Runtime/AdvancedWidgets/Public/Widgets/SRadialSlider.h
Include #include "Widgets/SRadialSlider.h"

Syntax

class SRadialSlider : public SLeafWidget

Variables

  Type Name Description
Protected variable float AngularOffset The angle at which the radial slider should be offset by
Protected variable bool bControllerInputCaptured Holds a flag indicating whether a controller/keyboard is manipulating the slider's value.
Protected variable bool bIsFocusable When true, this slider will be keyboard focusable. Defaults to false.
Protected variable bool bMouseUsesStep Sets new value if mouse position is greater/less than half the step size.
Protected variable bool bRequiresControllerLock Sets whether we have to lock input to change the slider value.
Protected variable bool bShowSliderHand Whether to show the slider hand.
Protected variable bool bShowSliderHandle Whether to show the slider handle (thumb).
Protected variable TAttribute< bool > bUseCustomDefaultValue Whether the slider should draw it's progress bar from a custom value on the slider.
Protected variable bool bUseVerticalDrag When true, value is changed when dragging vertically as opposed to along the radial curve.
Protected variable EMouseCursor::Type CachedCursor Holds the initial cursor in case a custom cursor has been specified, so we can restore it after dragging the slider.
Protected variable FSlateBrush CenterBackgroundBrush Center background image brush.
Protected variable TAttribute< FSlateColor > CenterBackgroundColor Holds the color of the center background.
Protected variable TAttribute< float > CustomDefaultValue The value where the slider should draw it's progress bar from, independent of direction.
Protected variable 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).
Protected variable TAttribute< bool > LockedAttribute Holds a flag indicating whether the slider is locked.
Protected variable FVector2D PressedScreenSpaceTouchDownPosition The location in screenspace the slider was pressed by a touch
Protected variable TAttribute< FSlateColor > SliderBarColor Holds the color of the slider bar.
Protected variable TAttribute< FSlateColor > SliderHandleColor Holds the color of the slider handle.
Protected variable float SliderHandleEndAngle The angle at which the radial slider should end
Protected variable float SliderHandleStartAngle The angle at which the radial slider should begin
Protected variable TAttribute< FSlateColor > SliderProgressColor Holds the color for the completed progress of the slider bar.
Protected variable FRuntimeFloatCurve SliderRange A curve that defines how the slider should be sampled. Default is linear.
Protected variable TAttribute< float > StepSize Holds the amount to adjust the value by when using a controller or keyboard
Protected variable const FSliderStyle * Style Holds the style passed to the widget upon construction.
Protected variable TAttribute< TOptional< float > > Thickness Thickness used for slider bar instead of Style->BarThickness (see SetThickness)
Protected variable TAttribute< float > ValueAttribute Holds the slider's current value.
Protected variable TArray< float > ValueTags The values that should be drawn around the radial slider

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Virtual void

CommitValue ( float NewValue
)

 Commits the specified slider value.
Public function void

Construct ( const SRadialSlider::FArguments& InDeclaration
)

 Construct the widget.
Public function Const float Get the AngularOffset attribute
Protected function Const const FSlateBrush *  
Public function Const float Get ths CustomDefaultValue attribute
Public function Const float Get the maximum value in Slider Range
Public function Const float Get the minumum value in Slider Range
Public function Const float Get the Slider's Handle position scaled from 0 to 1
Public function Const float

GetNormalizedValue ( float RawValue
)

 Get the Value attribute scaled from 0 to 1
Public function Const float Get the MaxSliderHandleAngle attribute
Public function Const float Get the MinSliderHandleAngle attribute
Public function Const FRuntimeFloatCurve Get the SliderRange attribute
Public function Const float Get the StepSize attribute
Protected function Const const FSlateBrush *  
Public function Const bool Get the bUseCustomDefaultValue attribute
Public function Const float Get the Value attribute
Public function Const TArray< float > Get the ValueTags attribute
Public function Const bool  
Protected function float

PositionToValue ( const FGeometry& MyGeometry,
const FVector2D& AbsolutePosition
)

 Calculates the new value based on the given absolute coordinates.
Public function void

SetAngularOffset ( float InAngularOffset
)

 Set the AngularOffset attribute
Public function void

SetCenterBackgroundColor ( FSlateColor InCenterHandleColor
)

 Set the SliderHandleColor attribute
Public function void

SetCustomDefaultValue ( const TAttribute< float >& InValueAttribute
)

 Set the CustomDefaultValue attribute
Public function void

SetHandStartEndRatio ( FVector2D InHandStartEndRatio
)

 Set the HandStartEndRatio.
Public function void

SetLocked ( const TAttribute< bool >& InLocked
)

 Set the Locked attribute
Public function void

SetMouseUsesStep ( bool MouseUsesStep
)

 Set the MouseUsesStep attribute
Public function void

SetRequiresControllerLock ( bool RequiresControllerLock
)

 Set the RequiresControllerLock attribute
Public function void

SetShowSliderHand ( bool ShowSliderHand
)

 Set the ShowSliderHand attribute
Public function void

SetShowSliderHandle ( bool ShowSliderHandle
)

 Set the ShowSliderHandle attribute
Public function void

SetSliderBarColor ( FSlateColor InSliderBarColor
)

 Set the SliderBarColor attribute
Public function void

SetSliderHandleColor ( FSlateColor InSliderHandleColor
)

 Set the SliderHandleColor attribute
Public function void

SetSliderHandleStartAngleAndSliderHandleEndAngle ( float InSliderHandleStartAngle,
float InSliderHandleEndAngle
)

 Set the SliderHandleStartAngle and SliderHandleEndAngle attributes.
Public function void

SetSliderProgressColor ( FSlateColor InSliderProgressColor
)

 Set the SliderProgressColor attribute
Public function void

SetSliderRange ( const FRuntimeFloatCurve& InSliderRange
)

 Set the SliderRange attribute
Public function void

SetStepSize ( const TAttribute< float >& InStepSize
)

 Set the StepSize attribute
Public function void

SetThickness ( const float InThickness
)

 Set the Thickness attribute.
Public function void

SetUseCustomDefaultValue ( const TAttribute< bool >& InValueAttribute
)

 Set the bUseCustomDefaultValue attribute
Public function void

SetUseVerticalDrag ( bool UseVerticalDrag
)

 Set the UseVerticalDrag attribute
Public function void

SetValue ( const TAttribute< float >& InValueAttribute
)

 Set the Value attribute
Public function void

SetValueTags ( const TArray< float >& InValueTags
)

 Set the ValueTags attribute

Overridden from SWidget

  Type Name Description
Public function Virtual Const FVector2D

ComputeDesiredSize ( float
)

 Overwritten from SWidget.
Public function Virtual TSharedRef< FSlateAccessibleWidget >  
Public function Virtual Const bool  
Public function Virtual void

OnFocusLost ( const FFocusEvent& InFocusEvent
)

 Called when this widget loses focus. This event does not bubble.
Public function Virtual 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)
Public function Virtual FReply

OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is released when this widget has focus
Public function Virtual 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.
Public function Virtual 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.
Public function Virtual FReply

OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse moved within it.
Public function Virtual FNavigationReply

OnNavigation ( const FGeometry& MyGeometry,
const FNavigationEvent& InNavigationEvent
)

 Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.
Public function Virtual Const int32

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

 Overwritten from SWidget.
Public function Virtual FReply

OnTouchEnded ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is ended (finger lifted)
Public function Virtual FReply

OnTouchMoved ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is moved (finger moved)
Public function Virtual FReply

OnTouchStarted ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is started (finger down)
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page