1. Epic GamesDeveloper
  3. USynthKnob

USynthKnob

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

Unreal Engine C++ API Reference > Plugins > Synthesis > UI

Inheritance Hierarchy

References

   
Module Synthesis
Header /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Public/UI/SynthKnob.h
Include #include "UI/SynthKnob.h"

Syntax

UCLASS&40;&41;  
class USynthKnob : 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

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool IsFocusable Should the slider be focusable?
Protected variable float K2_Cache_Value  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly bool Locked Whether the handle is interactive or fixed.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float MouseFineTuneSpeed The speed of the mouse knob control when fine-tuning the knob
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float MouseSpeed The speed of the mouse knob control
Protected variable TSharedPtr< SSynthKnob > MySynthKnob Native Slate Widget
Public variable UProperty Category BlueprintAssignable FOnControllerCaptureBeginEvent OnControllerCaptureBegin Invoked when the controller capture begins.
Public variable UProperty Category BlueprintAssignable FOnControllerCaptureEndEvent OnControllerCaptureEnd Invoked when the controller capture ends.
Public variable UProperty Category BlueprintAssignable FOnMouseCaptureBeginEvent OnMouseCaptureBegin Invoked when the mouse is pressed and a capture begins.
Public variable UProperty Category BlueprintAssignable FOnMouseCaptureEndEvent OnMouseCaptureEnd Invoked when the mouse is released and a capture ends.
Public variable UProperty Category BlueprintAssignable FOnFloatValueChangedEvent OnValueChanged Called when the value is changed by slider or typing.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FText ParameterName The name of the pararameter. Will show when knob turns.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FText ParameterUnits The parameter units (e.g. hz). Will append to synth tooltip info.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly uint32: 1 ShowTooltipInfo Enable tool tip window to show parameter information while knob turns
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 Value The volume value to display.
Public variable UProperty FGetFloat ValueDelegate A bindable delegate to allow logic to drive the value of the widget
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FSynthKnobStyle WidgetStyle The synth knob style

Constructors

  Type Name Description
Public function  

USynthKnob ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category float Gets the current value of the slider.
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void

HandleOnValueChanged ( float InValue
)

  
Protected function float  
Public function UFunction BlueprintCallable, Category void

SetLocked ( bool InValue
)

 Sets the handle to be interactive or fixed
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 ( float InValue
)

 Sets the current value of the slider.

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page