1. Epic GamesDeveloper
  3. SSynth2DSlider

SSynth2DSlider

A Slate slider control is a linear scale and draggable handle.

API > API/Plugins > API/Plugins/Synthesis

A Slate slider control is a linear scale and draggable handle.

   
Name SSynth2DSlider
Type class
Header File /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Public/UI/SSynth2DSlider.h
Include Path #include "UI/SSynth2DSlider.h"

Syntax

class SSynth2DSlider : public SLeafWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bControllerInputCaptured bool Holds a flag indicating whether a controller/keyboard is manipulating the slider's value. UI/SSynth2DSlider.h  
bIsFocusable bool When true, this slider will be keyboard focusable. Defaults to false. UI/SSynth2DSlider.h  
IndentHandle TAttribute< bool > Holds a flag indicating whether the slideable area should be indented to fit the handle. UI/SSynth2DSlider.h  
LockedAttribute TAttribute< bool > Holds a flag indicating whether the slider is locked. UI/SSynth2DSlider.h  
OnControllerCaptureBegin FSimpleDelegate Holds a delegate that is executed when capture begins for controller or keyboard. UI/SSynth2DSlider.h  
OnControllerCaptureEnd FSimpleDelegate Holds a delegate that is executed when capture ends for controller or keyboard. UI/SSynth2DSlider.h  
OnMouseCaptureBegin FSimpleDelegate Holds a delegate that is executed when the mouse is pressed and a capture begins. UI/SSynth2DSlider.h  
OnMouseCaptureEnd FSimpleDelegate Holds a delegate that is executed when the mouse is let up and a capture ends. UI/SSynth2DSlider.h  
OnValueChangedX FOnFloatValueChanged Holds a delegate that is executed when the slider's value changed. UI/SSynth2DSlider.h  
OnValueChangedY FOnFloatValueChanged   UI/SSynth2DSlider.h  
Orientation EOrientation Holds the slider's orientation. UI/SSynth2DSlider.h  
SliderBarColor TAttribute< FSlateColor > Holds the color of the slider bar. UI/SSynth2DSlider.h  
SliderHandleColor TAttribute< FSlateColor > Holds the color of the slider handle. UI/SSynth2DSlider.h  
StepSize TAttribute< float > Holds the amount to adjust the value by when using a controller or keyboard UI/SSynth2DSlider.h  
Style const FSynth2DSliderStyle * Holds the style passed to the widget upon construction. UI/SSynth2DSlider.h  
ValueAttributeX TAttribute< float >   UI/SSynth2DSlider.h  
ValueAttributeY TAttribute< float >   UI/SSynth2DSlider.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const SSynth2DSlider::FArguments& InDeclaration
)

 Construct the widget. UI/SSynth2DSlider.h  

float GetValueX()

 See the Value attribute UI/SSynth2DSlider.h  

float GetValueY()

   UI/SSynth2DSlider.h  

bool IsLocked()

   UI/SSynth2DSlider.h  

virtual int32 OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
) const

   UI/SSynth2DSlider.h  

void SetIndentHandle ( const TAttribute< bool >& InIndentHandle
)

 See the IndentHandle attribute UI/SSynth2DSlider.h  

void SetLocked ( const TAttribute< bool >& InLocked
)

 See the Locked attribute UI/SSynth2DSlider.h  

void SetOrientation ( EOrientation InOrientation
)

 See the Orientation attribute UI/SSynth2DSlider.h  

void SetSliderBarColor ( FSlateColor InSliderBarColor
)

 See the SliderBarColor attribute UI/SSynth2DSlider.h  

void SetSliderHandleColor ( FSlateColor InSliderHandleColor
)

 See the SliderHandleColor attribute UI/SSynth2DSlider.h  

void SetStepSize ( const TAttribute< float >& InStepSize
)

 See the StepSize attribute UI/SSynth2DSlider.h  

void SetValueX ( const TAttribute< float >& InValueAttribute
)

 See the Value attribute UI/SSynth2DSlider.h  

void SetValueY ( const TAttribute< float >& InValueAttribute
)

   UI/SSynth2DSlider.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FVector2D ComputeDesiredSize ( float
) const

   UI/SSynth2DSlider.h  

virtual bool IsInteractable()

   UI/SSynth2DSlider.h  

virtual void OnFocusLost ( const FFocusEvent& InFocusEvent
)

   UI/SSynth2DSlider.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   UI/SSynth2DSlider.h  

virtual FReply OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   UI/SSynth2DSlider.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   UI/SSynth2DSlider.h  

virtual FReply OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   UI/SSynth2DSlider.h  

virtual FReply OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   UI/SSynth2DSlider.h  

virtual bool SupportsKeyboardFocus()

   UI/SSynth2DSlider.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CommitValue ( float NewValueX,
float NewValueY
)

 Commits the specified slider value. UI/SSynth2DSlider.h  

FVector2D PositionToValue ( const FGeometry& MyGeometry,
const FVector2D& AbsolutePosition
)

 Calculates the new value based on the given absolute coordinates. UI/SSynth2DSlider.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page