1. Epic GamesDeveloper
  3. SSynthKnob

SSynthKnob

API > API/Plugins > API/Plugins/Synthesis

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

Syntax

class SSynthKnob : 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/SSynthKnob.h  
bIsFineTune bool Whether or not we're in fine-tune mode. UI/SSynthKnob.h  
bIsFocusable bool When true, this slider will be keyboard focusable. Defaults to false. UI/SSynthKnob.h  
bIsMouseDown bool Whether or not the mouse is down. UI/SSynthKnob.h  
FineTuneKey FKey The key to use when fine tuning. UI/SSynthKnob.h  
KnobImages TArray< FSlateBrush * >   UI/SSynthKnob.h  
LockedAttribute TAttribute< bool > Holds a flag indicating whether the slider is locked. UI/SSynthKnob.h  
MouseDownPosition FVector2D The position of the mouse when it pushed down and started rotating the knob. UI/SSynthKnob.h  
MouseDownValue float The value when the mouse was pushed down UI/SSynthKnob.h  
MouseFineTuneSpeed TAttribute< float > Holds the amount to adjust the value by when using a controller or keyboard UI/SSynthKnob.h  
MouseSpeed TAttribute< float > Holds the amount to adjust the value by when using a controller or keyboard UI/SSynthKnob.h  
OnControllerCaptureBegin FSimpleDelegate Holds a delegate that is executed when capture begins for controller or keyboard. UI/SSynthKnob.h  
OnControllerCaptureEnd FSimpleDelegate Holds a delegate that is executed when capture ends for controller or keyboard. UI/SSynthKnob.h  
OnMouseCaptureBegin FSimpleDelegate Holds a delegate that is executed when the mouse is pressed and a capture begins. UI/SSynthKnob.h  
OnMouseCaptureEnd FSimpleDelegate Holds a delegate that is executed when the mouse is let up and a capture ends. UI/SSynthKnob.h  
OnValueChanged FOnFloatValueChanged Holds a delegate that is executed when the slider's value changed. UI/SSynthKnob.h  
Orientation EOrientation Holds the slider's orientation. UI/SSynthKnob.h  
ParameterName TAttribute< FText >   UI/SSynthKnob.h  
ParameterRange TAttribute< FVector2D >   UI/SSynthKnob.h  
ParameterUnits TAttribute< FText >   UI/SSynthKnob.h  
PixelDelta int32 The max pixels to go to min or max value (clamped to 0 or 1) in one drag period UI/SSynthKnob.h  
ShowTooltip TAttribute< bool >   UI/SSynthKnob.h  
StepSize TAttribute< float > Holds the amount to adjust the value by when using a controller or keyboard UI/SSynthKnob.h  
Style const FSynthKnobStyle * Holds the style passed to the widget upon construction. UI/SSynthKnob.h  
ValueAttribute TAttribute< float > Holds the slider's current value. UI/SSynthKnob.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CommitValue ( float NewValue
)

 Commits the specified slider value. UI/SSynthKnob.h  

void Construct ( const SSynthKnob::FArguments& InDeclaration
)

 Construct the widget. UI/SSynthKnob.h  

FVector2D GetMouseDownPosition()

 Return the last mouse down position. UI/SSynthKnob.h  

float GetValue()

 See the Value attribute UI/SSynthKnob.h  

bool IsLocked()

   UI/SSynthKnob.h  

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

   UI/SSynthKnob.h  

void SetLocked ( const TAttribute< bool >& InLocked
)

 See the Locked attribute UI/SSynthKnob.h  

void SetMouseFineTuneSpeed ( const float InMouseFineTuneSpeed
)

 See the MousePeed attribute UI/SSynthKnob.h  

void SetMouseSpeed ( const float InMouseSpeed
)

 See the MousePeed attribute UI/SSynthKnob.h  

void SetStepSize ( const float InStepSize
)

 See the StepSize attribute UI/SSynthKnob.h  

void SetValue ( const TAttribute< float >& InValueAttribute
)

 See the Value attribute UI/SSynthKnob.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier
) const

   UI/SSynthKnob.h  

virtual bool IsInteractable()

   UI/SSynthKnob.h  

virtual void OnFocusLost ( const FFocusEvent& InFocusEvent
)

   UI/SSynthKnob.h  

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

   UI/SSynthKnob.h  

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

   UI/SSynthKnob.h  

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

   UI/SSynthKnob.h  

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

   UI/SSynthKnob.h  

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

   UI/SSynthKnob.h  

virtual bool SupportsKeyboardFocus()

   UI/SSynthKnob.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page