1. Epic GamesDeveloper
  3. URadialSlider

URadialSlider

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

API > API/Runtime > API/Runtime/AdvancedWidgets > API/Runtime/AdvancedWidgets/Components

Inheritance Hierarchy

References

   
Module AdvancedWidgets
Header /Engine/Source/Runtime/AdvancedWidgets/Public/Components/RadialSlider.h
Include #include "Components/RadialSlider.h"

Syntax

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

  Type Name Description
Public variable float AngularOffset Rotates radial slider by arbitrary offset to support full gamut of configurations.
Public variable bool bUseCustomDefaultValue Whether the slider should draw it's progress bar from a custom value on the slider
Public variable FLinearColor CenterBackgroundColor The color to draw the center background in.
Public variable float CustomDefaultValue The value where the slider should draw it's progress bar from, independent of direction
Public 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).
Public variable bool IsFocusable Should the slider be focusable?
Protected variable float K2_Cache_Value  
Public variable bool Locked Whether the handle is interactive or fixed.
Public variable bool MouseUsesStep Sets new value if mouse position is greater/less than half the step size.
Protected variable TSharedPtr< SRadialSlider > MyRadialSlider Native Slate Widget
Public variable FOnControllerCaptureBeginEvent OnControllerCaptureBegin Invoked when the controller capture begins.
Public variable FOnControllerCaptureEndEvent OnControllerCaptureEnd Invoked when the controller capture ends.
Public variable FOnMouseCaptureBeginEvent OnMouseCaptureBegin Invoked when the mouse is pressed and a capture begins.
Public variable FOnMouseCaptureEndEvent OnMouseCaptureEnd Invoked when the mouse is released and a capture ends.
Public variable FOnFloatValueChangedEvent OnValueChanged Called when the value is changed by slider or typing.
Public variable bool RequiresControllerLock Sets whether we have to lock input to change the slider value.
Public variable bool ShowSliderHand Whether to show the slider hand.
Public variable bool ShowSliderHandle Whether to show the slider handle (thumb).
Public variable FLinearColor SliderBarColor The color to draw the slider bar in.
Public variable FLinearColor SliderHandleColor The color to draw the slider handle in.
Public variable float SliderHandleEndAngle The angle at which the Slider Handle will end.
Public variable float SliderHandleStartAngle The angle at which the Slider Handle will start.
Public variable FLinearColor SliderProgressColor The color to draw the completed progress of the slider bar in.
Public variable FRuntimeFloatCurve SliderRange A curve that defines how the slider should be sampled. Default is linear.
Public variable float StepSize The amount to adjust the value by, when using a controller or keyboard
Public variable bool UseVerticalDrag Whether the value is changed when dragging vertically as opposed to along the radial curve.
Public variable float Value The slider value to display.
Public variable FGetFloat ValueDelegate A bindable delegate to allow logic to drive the value of the widget
Public variable TArray< float > ValueTags Adds text tags to the radial slider at the value's position.
Public variable FSliderStyle WidgetStyle The progress bar style

Constructors

  Type Name Description
Public function  

URadialSlider ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const float Gets the current custom default value of the slider.
Public function Const float Get the current raw slider alpha from 0 to 1
Public function Const float Gets the current value of the slider.
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void

HandleOnValueChanged ( float InValue
)

  
Protected function float  
Public function void

SetAngularOffset ( float InValue
)

 Sets the Angular Offset for the slider.
Public function void Sets the color of the slider bar
Public function void

SetCustomDefaultValue ( float InValue
)

 Sets the current custom default value of the slider.
Public function 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).
Public function void

SetLocked ( bool InValue
)

 Sets the handle to be interactive or fixed
Public function void

SetShowSliderHand ( bool InShowSliderHand
)

 Whether to show the slider hand.
Public function void

SetShowSliderHandle ( bool InShowSliderHandle
)

 Whether to show the slider handle (thumb).
Public function void Sets the color of the slider bar
Public function void Sets the color of the handle bar
Public function void

SetSliderHandleEndAngle ( float InValue
)

 Sets the maximum angle of the slider.
Public function void

SetSliderHandleStartAngle ( float InValue
)

 Sets the minimum angle of the slider.
Public function void Sets the progress color of the slider bar
Public function void

SetSliderRange ( const FRuntimeFloatCurve& InSliderRange
)

 Sets the curve for the slider range
Public function void

SetStepSize ( float InValue
)

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

SetUseVerticalDrag ( bool InUseVerticalDrag
)

 Set whether the value is changed when dragging vertically as opposed to along the radial curve.
Public function void

SetValue ( float InValue
)

 Sets the current value of the slider.
Public function void

SetValueTags ( const TArray< float >& InValueTags
)

 Adds value tags to the slider.

Overridden from UWidget

  Type Name Description
Protected function Virtual Const TSharedPtr< SWidget > Gets the widget that accessibility properties should synchronize to.
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page