1. Epic GamesDeveloper
  3. SAudioMaterialLabeledKnob

SAudioMaterialLabeledKnob

Wraps [SAudioMaterialKnob](API\Plugins\AudioWidgets\SAudioMaterialKnob) and adds Label text that will show a value text.

API > API/Plugins > API/Plugins/AudioWidgets

Wraps SAudioMaterialKnob and adds Label text that will show a value text.

   
Name SAudioMaterialLabeledKnob
Type class
Header File /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioMaterialSlate/SAudioMaterialLabeledKnob.h
Include Path #include "AudioMaterialSlate/SAudioMaterialLabeledKnob.h"

Syntax

class SAudioMaterialLabeledKnob : public SAudioInputWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnMouseCaptureBegin FSimpleDelegate Holds a delegate that is executed when the mouse is pressed and a capture begins. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
OnMouseCaptureEnd FSimpleDelegate Holds a delegate that is executed when the mouse is let up and a capture ends. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
OnValueChanged FOnFloatValueChanged Holds a delegate that is executed when the knob's value changes. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
OnValueTextCommitted FOnFloatValueChanged Holds a delegate that is executed when the value is committed from label's text field. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AudioUnitProcessor TSharedPtr< FAudioUnitProcessor > Hold the ref to the current Unit processor AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
AudioUnitsValueType TAttribute< EAudioUnitsValueType > Holds the knob's unit value type. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
DesiredSizeOverride TAttribute< TOptional< FVector2D > >   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
Knob TSharedPtr< SAudioMaterialKnob > Widget components. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
Label TSharedPtr< SAudioTextBox >   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
NormalizedLinearSliderRange const FVector2D   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
OutputRange FVector2D Range for output. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
Owner TWeakObjectPtr< UObject > Holds the owner of the Slate. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
Style const FAudioMaterialKnobStyle * Holds the style for the Slate. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
ValueAttribute TAttribute< float > Holds the knobs current Value. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  
VerticalLayotWidget TSharedPtr< SVerticalBox > VerticalBox that holds the widgets AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs
)

 Constructs this widget with InArgs AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual const float GetOutputValueForText ( const float InSliderValue
)

   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual const float GetSliderValueForText ( const float OutputValue
)

   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

void SetValue ( float InValueAttribute
)

 Set the Value attribute AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

Overridden from SAudioInputWidget

Name Remarks Include Path Unreal Specifiers

virtual const float GetOutputValue ( const float InSliderValue
)

 SAudioInputWidget. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual const float GetSliderValue ( const float OutputValue
)

   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual void SetDesiredSizeOverride ( const FVector2D Size
)

   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual void SetLabelBackgroundColor ( FSlateColor InColor
)

   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual void SetOutputRange ( const FVector2D InRange
)

   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual void SetShowUnitsText ( const bool bShowUnitsText
)

   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual void SetSliderValue ( float InSliderValue
)

 Set the knob's linear (0-1 normalized) value. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual void SetUnitsText ( const FText Units
)

   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

virtual void SetUnitsTextReadOnly ( const bool bIsReadOnly
)

   AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

Protected

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FVector2D ComputeDesiredSize ( float
) const

 SWidget. AudioMaterialSlate/SAudioMaterialLabeledKnob.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page