Navigation
API > API/Runtime > API/Runtime/AdvancedWidgets
A simple widget that shows a sliding bar with a handle that allows you to control the value between 0..1.
- No Children
| Name | URadialSlider |
| Type | class |
| Header File | /Engine/Source/Runtime/AdvancedWidgets/Public/Components/RadialSlider.h |
| Include Path | #include "Components/RadialSlider.h" |
Syntax
UCLASS (MinimalAPI)
class URadialSlider : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → URadialSlider
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URadialSlider
(
const FObjectInitializer& ObjectInitializer |
Components/RadialSlider.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AngularOffset | float | Rotates radial slider by arbitrary offset to support full gamut of configurations. | Components/RadialSlider.h |
|
| bUseCustomDefaultValue | bool | Whether the slider should draw it's progress bar from a custom value on the slider | Components/RadialSlider.h |
|
| CenterBackgroundColor | FLinearColor | The color to draw the center background in. | Components/RadialSlider.h |
|
| CustomDefaultValue | float | The value where the slider should draw it's progress bar from, independent of direction | Components/RadialSlider.h |
|
| HandStartEndRatio | FVector2D | 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). | Components/RadialSlider.h |
|
| IsFocusable | bool | Should the slider be focusable? | Components/RadialSlider.h |
|
| Locked | bool | Whether the handle is interactive or fixed. | Components/RadialSlider.h |
|
| MouseUsesStep | bool | Sets new value if mouse position is greater/less than half the step size. | Components/RadialSlider.h |
|
| OnControllerCaptureBegin | FOnControllerCaptureBeginEvent | Invoked when the controller capture begins. | Components/RadialSlider.h |
|
| OnControllerCaptureEnd | FOnControllerCaptureEndEvent | Invoked when the controller capture ends. | Components/RadialSlider.h |
|
| OnMouseCaptureBegin | FOnMouseCaptureBeginEvent | Invoked when the mouse is pressed and a capture begins. | Components/RadialSlider.h |
|
| OnMouseCaptureEnd | FOnMouseCaptureEndEvent | Invoked when the mouse is released and a capture ends. | Components/RadialSlider.h |
|
| OnValueChanged | FOnFloatValueChangedEvent | Called when the value is changed by slider or typing. | Components/RadialSlider.h |
|
| RequiresControllerLock | bool | Sets whether we have to lock input to change the slider value. | Components/RadialSlider.h |
|
| ShowSliderHand | bool | Whether to show the slider hand. | Components/RadialSlider.h |
|
| ShowSliderHandle | bool | Whether to show the slider handle (thumb). | Components/RadialSlider.h |
|
| SliderBarColor | FLinearColor | The color to draw the slider bar in. | Components/RadialSlider.h |
|
| SliderHandleColor | FLinearColor | The color to draw the slider handle in. | Components/RadialSlider.h |
|
| SliderHandleEndAngle | float | The angle at which the Slider Handle will end. | Components/RadialSlider.h |
|
| SliderHandleStartAngle | float | The angle at which the Slider Handle will start. | Components/RadialSlider.h |
|
| SliderProgressColor | FLinearColor | The color to draw the completed progress of the slider bar in. | Components/RadialSlider.h |
|
| SliderRange | FRuntimeFloatCurve | A curve that defines how the slider should be sampled. Default is linear. | Components/RadialSlider.h |
|
| StepSize | float | The amount to adjust the value by, when using a controller or keyboard | Components/RadialSlider.h |
|
| UseVerticalDrag | bool | Whether the value is changed when dragging vertically as opposed to along the radial curve. | Components/RadialSlider.h |
|
| Value | float | The slider value to display. | Components/RadialSlider.h |
|
| ValueDelegate | FGetFloat | A bindable delegate to allow logic to drive the value of the widget | Components/RadialSlider.h | |
| ValueTags | TArray< float > | Adds text tags to the radial slider at the value's position. | Components/RadialSlider.h |
|
| WidgetStyle | FSliderStyle | The progress bar style | Components/RadialSlider.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetCustomDefaultValue() |
Gets the current custom default value of the slider. | Components/RadialSlider.h |
|
float GetNormalizedSliderHandlePosition() |
Get the current raw slider alpha from 0 to 1 | Components/RadialSlider.h |
|
float GetValue() |
Gets the current value of the slider. | Components/RadialSlider.h |
|
void SetAngularOffset
(
float InValue |
Sets the Angular Offset for the slider. | Components/RadialSlider.h |
|
void SetCenterBackgroundColor
(
FLinearColor InValue |
Sets the color of the slider bar | Components/RadialSlider.h |
|
void SetCustomDefaultValue
(
float InValue |
Sets the current custom default value of the slider. | Components/RadialSlider.h |
|
void SetHandStartEndRatio
(
FVector2D InValue |
Sets the 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). | Components/RadialSlider.h |
|
void SetLocked
(
bool InValue |
Sets the handle to be interactive or fixed | Components/RadialSlider.h |
|
void SetShowSliderHand
(
bool InShowSliderHand |
Whether to show the slider hand. | Components/RadialSlider.h |
|
void SetShowSliderHandle
(
bool InShowSliderHandle |
Whether to show the slider handle (thumb). | Components/RadialSlider.h |
|
void SetSliderBarColor
(
FLinearColor InValue |
Sets the color of the slider bar | Components/RadialSlider.h |
|
void SetSliderHandleColor
(
FLinearColor InValue |
Sets the color of the handle bar | Components/RadialSlider.h |
|
void SetSliderHandleEndAngle
(
float InValue |
Sets the maximum angle of the slider. | Components/RadialSlider.h |
|
void SetSliderHandleStartAngle
(
float InValue |
Sets the minimum angle of the slider. | Components/RadialSlider.h |
|
void SetSliderProgressColor
(
FLinearColor InValue |
Sets the progress color of the slider bar | Components/RadialSlider.h |
|
void SetSliderRange
(
const FRuntimeFloatCurve& InSliderRange |
Sets the curve for the slider range | Components/RadialSlider.h |
|
void SetStepSize
(
float InValue |
Sets the amount to adjust the value by, when using a controller or keyboard | Components/RadialSlider.h |
|
void SetUseVerticalDrag
(
bool InUseVerticalDrag |
Set whether the value is changed when dragging vertically as opposed to along the radial curve. | Components/RadialSlider.h |
|
void SetValue
(
float InValue |
Sets the current value of the slider. | Components/RadialSlider.h |
|
void SetValueTags
(
const TArray< float >& InValueTags |
Adds value tags to the slider. | Components/RadialSlider.h |
|
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
Components/RadialSlider.h | ||
virtual void SynchronizeProperties() |
Components/RadialSlider.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
Components/RadialSlider.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void HandleOnControllerCaptureBegin() |
Components/RadialSlider.h | ||
void HandleOnControllerCaptureEnd() |
Components/RadialSlider.h | ||
void HandleOnMouseCaptureBegin() |
Components/RadialSlider.h | ||
void HandleOnMouseCaptureEnd() |
Components/RadialSlider.h | ||
void HandleOnValueChanged
(
float InValue |
Components/RadialSlider.h | ||
float K2_Gate_Value() |
Components/RadialSlider.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< SWidget > GetAccessibleWidget() |
Components/RadialSlider.h | ||
virtual TSharedRef< SWidget > RebuildWidget() |
Components/RadialSlider.h |