USynth2DSlider

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

Syntax

UCLASS()
class USynth2DSlider : 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, AdvancedDisplay BlueprintReadOnly

bool

 

IndentHandle

Whether the slidable area should be indented to fit the handle.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

IsFocusable

Should the slider be focusable?

Protected variable

float

 

K2_Cache_ValueX

Protected variable

float

 

K2_Cache_ValueY

Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly

bool

 

Locked

Whether the handle is interactive or fixed.

Protected variable

TSharedPtr< SSy...

 

MySlider

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

 

OnValueChangedX

Called when the value is changed by slider or typing.

Public variable UProperty Category BlueprintAssignable

FOnFloatValueCh...

 

OnValueChangedY

Called when the value is changed by slider or typing.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

FLinearColor

 

SliderHandleColor

The color to draw the slider handle in.

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

 

ValueX

Public variable UProperty

FGetFloat

 

ValueXDelegate

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

Public variable UProperty Category, EditAnywhere, Meta

float

 

ValueY

Public variable UProperty

FGetFloat

 

ValueYDelegate

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

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FSynth2DSliderS...

 

WidgetStyle

The progress bar style

Constructors

Name Description

Public function

USynth2DSlider

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const UFunction BlueprintCallable, Category

FVector2D

 

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

 

HandleOnValueChangedX

(
    float InValue
)

Protected function

void

 

HandleOnValueChangedY

(
    float InValue
)

Protected function

float

 

K2_Gate_ValueX()

Protected function

float

 

K2_Gate_ValueY()

Public function UFunction BlueprintCallable, Category

void

 

SetIndentHandle

(
    bool InValue
)

Sets if the slidable area should be indented to fit the handle

Public function UFunction BlueprintCallable, Category

void

 

SetLocked

(
    bool InValue
)

Sets the handle to be interactive or fixed

Public function UFunction BlueprintCallable, Category

void

 

SetSliderHandleColor

(
    FLinearColor InValue
)

Sets the color of the handle bar

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

(
    FVector2D InValue
)

Sets the current value of the slider.

Overridden from UWidget

Name Description

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
)

References

Module

Synthesis

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback