SRadialSlider

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AdvancedWidgets

Header

/Engine/Source/Runtime/AdvancedWidgets/Public/Slate/SRadialSlider.h

Include

#include "Slate/SRadialSlider.h"

Syntax

class SRadialSlider : public SLeafWidget

Variables

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

 

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::T...

 

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

 

CenterBackgroundColor

Holds the color of the center background.

Protected variable

TAttribute< flo...

 

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

 

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

 

SliderBarColor

Holds the color of the slider bar.

Protected variable

TAttribute< FSl...

 

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

 

SliderProgressColor

Holds the color for the completed progress of the slider bar.

Protected variable

FRuntimeFloatCu...

 

SliderRange

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

Protected variable

TAttribute< flo...

 

StepSize

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

Protected variable

const FSliderSt...

 

Style

Holds the style passed to the widget upon construction.

Protected variable

TAttribute< TOp...

 

Thickness

Thickness used for slider bar instead of Style->BarThickness (see SetThickness)

Protected variable

TAttribute< flo...

 

ValueAttribute

Holds the slider's current value.

Protected variable

TArray< float >

 

ValueTags

The values that should be drawn around the radial slider

Constructors

Name Description

Public function

SRadialSlider()

Functions

Name Description

Protected function Virtual

void

 

CommitValue

(
    float NewValue
)

Commits the specified slider value.

Public function

void

 

Construct

(
    const SRadialSlider::FArguments& I...
)

Construct the widget.

Public function Const

float

 

GetAngularOffset()

Get the AngularOffset attribute

Protected function Const

const FSlate...

 

GetBarImage()

Public function Const

float

 

GetCustomDefaultValue()

Get ths CustomDefaultValue attribute

Public function Const

float

 

GetMaxValue()

Get the maximum value in Slider Range

Public function Const

float

 

GetMinValue()

Get the minumum value in Slider Range

Public function Const

float

 

GetNormalizedSliderHandlePosition()

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

 

GetSliderHandleEndAngle()

Get the MaxSliderHandleAngle attribute

Public function Const

float

 

GetSliderHandleStartAngle()

Get the MinSliderHandleAngle attribute

Public function Const

FRuntimeFloa...

 

GetSliderRange()

Get the SliderRange attribute

Public function Const

float

 

GetStepSize()

Get the StepSize attribute

Protected function Const

const FSlate...

 

GetThumbImage()

Public function Const

bool

 

GetUseCustomDefaultValue()

Get the bUseCustomDefaultValue attribute

Public function Const

float

 

GetValue()

Get the Value attribute

Public function Const

TArray< floa...

 

GetValueTags()

Get the ValueTags attribute

Public function Const

bool

 

IsLocked()

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

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

Set the SliderRange attribute

Public function

void

 

SetStepSize

(
    const TAttribute< float >& InStepS...
)

Set the StepSize attribute

Public function

void

 

SetThickness

(
    const float InThickness
)

Set the Thickness attribute.

Public function

void

 

SetUseCustomDefaultValue

(
    const TAttribute< bool >& InValueA...
)

Set the bUseCustomDefaultValue attribute

Public function

void

 

SetUseVerticalDrag

(
    bool UseVerticalDrag
)

Set the UseVerticalDrag attribute

Public function

void

 

SetValue

(
    const TAttribute< float >& InValue...
)

Set the Value attribute

Public function

void

 

SetValueTags

(
    const TArray< float >& InValueTags
)

Set the ValueTags attribute

Overridden from SWidget

Name Description

Public function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float
)

Overwritten from SWidget.

Public function Virtual

TSharedRef< ...

 

CreateAccessibleWidget()

Public function Virtual Const

bool

 

IsInteractable()

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

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.

Public function Virtual Const

int32

 

OnPaint

(
    const FPaintArgs& Args,
    const FGeometry& AllottedGeometry,
    const FSlateRect& MyCullingRect,
    FSlateWindowElementList& OutDrawEl...,
    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

 

SupportsKeyboardFocus()

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

Classes

Name

Description

Public struct

FArguments