URadialSlider

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

VirtualCamera

Header

/Engine/Plugins/Experimental/VirtualCamera/Source/VirtualCamera/Public/Components/RadialSlider.h

Include

#include "Components/RadialSlider.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
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

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

AngularOffset

Rotates radial slider by arbitrary offset to support full gamut of configurations.

Public variable UProperty Category, EditAnywhere

bool

 

bUseCustomDefaultValue

Whether the slider should draw it's progress bar from a custom value on the slider

Public variable UProperty Category, EditAnywhere, Meta

float

 

CustomDefaultValue

The value where the slider should draw it's progress bar from, independent of direction

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

IsFocusable

Should the slider be focusable?

Protected variable

float

 

K2_Cache_Value

Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly

bool

 

Locked

Whether the handle is interactive or fixed.

Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly

bool

 

MouseUsesStep

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

Protected variable

TSharedPtr< SRa...

 

MyRadialSlider

Native Slate Widget

Public variable UProperty Category BlueprintAssignable

FOnControllerCa...

 

OnControllerCaptureBegin

Invoked when the controller capture begins.

Public variable UProperty Category BlueprintAssignable

FOnControllerCa...

 

OnControllerCaptureEnd

Invoked when the controller capture ends.

Public variable UProperty Category BlueprintAssignable

FOnMouseCapture...

 

OnMouseCaptureBegin

Invoked when the mouse is pressed and a capture begins.

Public variable UProperty Category BlueprintAssignable

FOnMouseCapture...

 

OnMouseCaptureEnd

Invoked when the mouse is released and a capture ends.

Public variable UProperty Category BlueprintAssignable

FOnFloatValueCh...

 

OnValueChanged

Called when the value is changed by slider or typing.

Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly

bool

 

RequiresControllerLock

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

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

SliderBarColor

The color to draw the slider bar in.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

SliderHandleColor

The color to draw the slider handle in.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

SliderHandleEndAngle

The angle at which the Slider Handle will end.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

SliderHandleStartAngle

The angle at which the Slider Handle will start.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

SliderProgressColor

The color to draw the completed progress of the slider bar in.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FRuntimeFloatCu...

 

SliderRange

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

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

StepSize

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

Public variable UProperty Category, EditAnywhere, Meta

float

 

Value

The slider value to display.

Public variable UProperty

FGetFloat

 

ValueDelegate

A bindable delegate to allow logic to drive the value of the widget

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

TArray< float >

 

ValueTags

Adds text tags to the radial slider at the value's position.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FSliderStyle

 

WidgetStyle

The progress bar style

Constructors

Name Description

Public function

URadialSlider

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const UFunction BlueprintCallable, Category

float

 

GetCustomDefaultValue()

Gets the current custom default value of the slider.

Public function Const UFunction BlueprintCallable, Category

float

 

GetNormalizedSliderHandlePosition()

Get the current raw slider alpha from 0 to 1

Public function Const UFunction BlueprintCallable, Category

float

 

GetValue()

Gets the current value of the slider.

Protected function

void

 

HandleOnControllerCaptureBegin()

Protected function

void

 

HandleOnControllerCaptureEnd()

Protected function

void

 

HandleOnMouseCaptureBegin()

Protected function

void

 

HandleOnMouseCaptureEnd()

Protected function

void

 

HandleOnValueChanged

(
    float InValue
)

Protected function

float

 

K2_Gate_Value()

Public function UFunction BlueprintCallable, Category

void

 

SetAngularOffset

(
    float InValue
)

Sets the Angular Offset for the slider.

Public function UFunction BlueprintCallable, Category

void

 

SetCustomDefaultValue

(
    float InValue
)

Sets the current custom default value of the slider.

Public function UFunction BlueprintCallable, Category

void

 

SetLocked

(
    bool InValue
)

Sets the handle to be interactive or fixed

Public function UFunction BlueprintCallable, Category

void

 

SetSliderBarColor

(
    FLinearColor InValue
)

Sets the color of the slider bar

Public function UFunction BlueprintCallable, Category

void

 

SetSliderHandleColor

(
    FLinearColor InValue
)

Sets the color of the handle bar

Public function UFunction BlueprintCallable, Category

void

 

SetSliderHandleEndAngle

(
    float InValue
)

Sets the maximum angle of the slider.

Public function UFunction BlueprintCallable, Category

void

 

SetSliderHandleStartAngle

(
    float InValue
)

Sets the minimum angle of the slider.

Public function UFunction BlueprintCallable, Category

void

 

SetSliderProgressColor

(
    FLinearColor InValue
)

Sets the progress color of the slider bar

Public function UFunction BlueprintCallable, Category

void

 

SetSliderRange

(
    const FRuntimeFloatCurve& InSlider...
)

Sets the curve for the slider range

Public function UFunction BlueprintCallable, Category

void

 

SetStepSize

(
    float InValue
)

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

Public function UFunction BlueprintCallable, Category

void

 

SetValue

(
    float InValue
)

Sets the current value of the slider.

Public function UFunction BlueprintCallable, Category

void

 

SetValueTags

(
    const TArray< float >& InValueTags
)

Adds value tags to the slider.

Overridden from UWidget

Name Description

Protected function Virtual Const

TSharedPtr< ...

 

GetAccessibleWidget()

Gets the widget that accessibility properties should synchronize to.

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss