1. Epic GamesDeveloper
  3. USynth2DSlider

USynth2DSlider

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

API > API/Plugins > API/Plugins/Synthesis

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

  • No Children
   
Name USynth2DSlider
Type class
Header File /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Public/UI/Synth2DSlider.h
Include Path #include "UI/Synth2DSlider.h"

Syntax

UCLASS (MinimalAPI)  
class USynth2DSlider : public UWidget

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

USynth2DSlider ( const FObjectInitializer& ObjectInitializer
)

   UI/Synth2DSlider.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
IndentHandle bool Whether the slidable area should be indented to fit the handle. UI/Synth2DSlider.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Appearance
  • AdvancedDisplay
IsFocusable bool Should the slider be focusable? UI/Synth2DSlider.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Interaction"
Locked bool Whether the handle is interactive or fixed. UI/Synth2DSlider.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Appearance
  • AdvancedDisplay
OnControllerCaptureBegin FOnControllerCaptureBeginEventSynth2D Invoked when the controller capture begins. UI/Synth2DSlider.h
  • BlueprintAssignable
  • Category="Widget Event"
OnControllerCaptureEnd FOnControllerCaptureEndEventSynth2D Invoked when the controller capture ends. UI/Synth2DSlider.h
  • BlueprintAssignable
  • Category="Widget Event"
OnMouseCaptureBegin FOnMouseCaptureBeginEventSynth2D Invoked when the mouse is pressed and a capture begins. UI/Synth2DSlider.h
  • BlueprintAssignable
  • Category="Widget Event"
OnMouseCaptureEnd FOnMouseCaptureEndEventSynth2D Invoked when the mouse is released and a capture ends. UI/Synth2DSlider.h
  • BlueprintAssignable
  • Category="Widget Event"
OnValueChangedX FOnFloatValueChangedEventSynth2D Called when the value is changed by slider or typing. UI/Synth2DSlider.h
  • BlueprintAssignable
  • Category="Widget Event"
OnValueChangedY FOnFloatValueChangedEventSynth2D Called when the value is changed by slider or typing. UI/Synth2DSlider.h
  • BlueprintAssignable
  • Category="Widget Event"
SliderHandleColor FLinearColor The color to draw the slider handle in. UI/Synth2DSlider.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Appearance
StepSize float The amount to adjust the value by, when using a controller or keyboard UI/Synth2DSlider.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Appearance
  • Meta=(ClampMin="0", ClampMax="1", UIMin="0", UIMax="1")
ValueX float   UI/Synth2DSlider.h
  • EditAnywhere
  • Category=Appearance
  • Meta=(ClampMin="0", ClampMax="1", UIMin="0", UIMax="1")
ValueXDelegate FGetFloat A bindable delegate to allow logic to drive the value of the widget UI/Synth2DSlider.h  
ValueY float   UI/Synth2DSlider.h
  • EditAnywhere
  • Category=Appearance
  • Meta=(ClampMin="0", ClampMax="1", UIMin="0", UIMax="1")
ValueYDelegate FGetFloat A bindable delegate to allow logic to drive the value of the widget UI/Synth2DSlider.h  
WidgetStyle FSynth2DSliderStyle The progress bar style UI/Synth2DSlider.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Style"
  • Meta=(DisplayName="Style")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

   UI/Synth2DSlider.h  

FVector2D GetValue()

 Gets the current value of the slider. UI/Synth2DSlider.h
  • BlueprintCallable
  • Category="Behavior"

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   UI/Synth2DSlider.h  

void SetIndentHandle ( bool InValue
)

 Sets if the slidable area should be indented to fit the handle UI/Synth2DSlider.h
  • BlueprintCallable
  • Category="Behavior"

void SetLocked ( bool InValue
)

 Sets the handle to be interactive or fixed UI/Synth2DSlider.h
  • BlueprintCallable
  • Category="Behavior"

void SetSliderHandleColor ( FLinearColor InValue
)

 Sets the color of the handle bar UI/Synth2DSlider.h
  • BlueprintCallable
  • Category="Appearance"

void SetStepSize ( float InValue
)

 Sets the amount to adjust the value by, when using a controller or keyboard UI/Synth2DSlider.h
  • BlueprintCallable
  • Category="Behavior"

void SetValue ( FVector2D InValue
)

 Sets the current value of the slider. UI/Synth2DSlider.h
  • BlueprintCallable
  • Category="Behavior"

virtual void SynchronizeProperties()

   UI/Synth2DSlider.h  

Protected

Name Remarks Include Path Unreal Specifiers

void HandleOnControllerCaptureBegin()

   UI/Synth2DSlider.h  

void HandleOnControllerCaptureEnd()

   UI/Synth2DSlider.h  

void HandleOnMouseCaptureBegin()

   UI/Synth2DSlider.h  

void HandleOnMouseCaptureEnd()

   UI/Synth2DSlider.h  

void HandleOnValueChangedX ( float InValue
)

   UI/Synth2DSlider.h  

void HandleOnValueChangedY ( float InValue
)

   UI/Synth2DSlider.h  
  UI/Synth2DSlider.h  
  UI/Synth2DSlider.h  

virtual TSharedRef< SWidget > RebuildWidget()

   UI/Synth2DSlider.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page