Navigation
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 | USynthKnob |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Public/UI/SynthKnob.h |
| Include Path | #include "UI/SynthKnob.h" |
Syntax
UCLASS (MinimalAPI)
class USynthKnob : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → USynthKnob
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
USynthKnob
(
const FObjectInitializer& ObjectInitializer |
UI/SynthKnob.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| IsFocusable | bool | Should the slider be focusable? | UI/SynthKnob.h |
|
| Locked | bool | Whether the handle is interactive or fixed. | UI/SynthKnob.h |
|
| MouseFineTuneSpeed | float | The speed of the mouse knob control when fine-tuning the knob | UI/SynthKnob.h |
|
| MouseSpeed | float | The speed of the mouse knob control | UI/SynthKnob.h |
|
| OnControllerCaptureBegin | FOnControllerCaptureBeginEvent | Invoked when the controller capture begins. | UI/SynthKnob.h |
|
| OnControllerCaptureEnd | FOnControllerCaptureEndEvent | Invoked when the controller capture ends. | UI/SynthKnob.h |
|
| OnMouseCaptureBegin | FOnMouseCaptureBeginEvent | Invoked when the mouse is pressed and a capture begins. | UI/SynthKnob.h |
|
| OnMouseCaptureEnd | FOnMouseCaptureEndEvent | Invoked when the mouse is released and a capture ends. | UI/SynthKnob.h |
|
| OnValueChanged | FOnFloatValueChangedEvent | Called when the value is changed by slider or typing. | UI/SynthKnob.h |
|
| ParameterName | FText | The name of the pararameter. Will show when knob turns. | UI/SynthKnob.h |
|
| ParameterUnits | FText | The parameter units (e.g. hz). Will append to synth tooltip info. | UI/SynthKnob.h |
|
| ShowTooltipInfo | uint32 | Enable tool tip window to show parameter information while knob turns | UI/SynthKnob.h |
|
| StepSize | float | The amount to adjust the value by, when using a controller or keyboard | UI/SynthKnob.h |
|
| Value | float | The volume value to display. | UI/SynthKnob.h |
|
| ValueDelegate | FGetFloat | A bindable delegate to allow logic to drive the value of the widget | UI/SynthKnob.h | |
| WidgetStyle | FSynthKnobStyle | The synth knob style | UI/SynthKnob.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
UI/SynthKnob.h | ||
float GetValue() |
Gets the current value of the slider. | UI/SynthKnob.h |
|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
UI/SynthKnob.h | ||
void SetLocked
(
bool InValue |
Sets the handle to be interactive or fixed | UI/SynthKnob.h |
|
void SetStepSize
(
float InValue |
Sets the amount to adjust the value by, when using a controller or keyboard | UI/SynthKnob.h |
|
void SetValue
(
float InValue |
Sets the current value of the slider. | UI/SynthKnob.h |
|
virtual void SynchronizeProperties() |
UI/SynthKnob.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void HandleOnControllerCaptureBegin() |
UI/SynthKnob.h | ||
void HandleOnControllerCaptureEnd() |
UI/SynthKnob.h | ||
void HandleOnMouseCaptureBegin() |
UI/SynthKnob.h | ||
void HandleOnMouseCaptureEnd() |
UI/SynthKnob.h | ||
void HandleOnValueChanged
(
float InValue |
UI/SynthKnob.h | ||
PROPERTY_BINDING_IMPLEMENTATION
(
float, |
UI/SynthKnob.h | ||
virtual TSharedRef< SWidget > RebuildWidget() |
UI/SynthKnob.h |