1. Epic GamesDeveloper
  3. UAudioMaterialKnob

UAudioMaterialKnob

A simple widget that shows a turning Knob that allows you to control the value between 0..1.

API > API/Plugins > API/Plugins/AudioWidgets

A simple widget that shows a turning Knob that allows you to control the value between 0..1. Knob is rendered by using material instead of texture.

  • No Children
   
Name UAudioMaterialKnob
Type class
Header File /Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Public/AudioMaterialSlate/AudioMaterialKnob.h
Include Path #include "AudioMaterialSlate/AudioMaterialKnob.h"

Syntax

UCLASS (MinimalAPI)  
class UAudioMaterialKnob : public UWidget

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UAudioMaterialKnob ( const FObjectInitializer& ObjectInitializer
)

   AudioMaterialSlate/AudioMaterialKnob.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnKnobValueChanged FOnKnobValueChangedEvent Called when the value is changed by knob. AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintAssignable
  • Category="Widget Event"
WidgetStyle FAudioMaterialKnobStyle The button's style AudioMaterialSlate/AudioMaterialKnob.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Style"
  • Meta=(DisplayName="Style", ShowOnlyInnerProperties)

Protected

Name Type Remarks Include Path Unreal Specifiers
bLocked bool Whether the knob is interactive or fixed. AudioMaterialSlate/AudioMaterialKnob.h
  • EditAnywhere
  • BlueprintSetter=SetLocked
  • BlueprintGetter=GetIsLocked
  • Category=Appearance
  • AdvancedDisplay
bMouseUsesStep bool Sets new value if mouse position is greater/less than half the step size. AudioMaterialSlate/AudioMaterialKnob.h
  • EditAnywhere
  • BlueprintSetter=SetMouseUsesStep
  • BlueprintGetter=GetMouseUsesStep
  • Category=Appearance
  • AdvancedDisplay
FineTuneSpeed float The tune speed when fine-tuning the knob AudioMaterialSlate/AudioMaterialKnob.h
  • EditAnywhere
  • BlueprintSetter=SetFineTuneSpeed
  • BlueprintGetter=GetFineTuneSpeed
  • Category=Appearance
  • AdvancedDisplay
  • Meta=(ClampMin="0", ClampMax="1", UIMin="0", UIMax="1")
Knob TSharedPtr< SAudioMaterialKnob > Native Slate Widget AudioMaterialSlate/AudioMaterialKnob.h  
StepSize float The amount to adjust the value by, when using steps AudioMaterialSlate/AudioMaterialKnob.h
  • EditAnywhere
  • BlueprintSetter=SetStepSize
  • BlueprintGetter=GetStepSize
  • Category=Appearance
  • AdvancedDisplay
  • Meta=(UIMin="0", UIMax="1")
TuneSpeed float The tune speed of the knob AudioMaterialSlate/AudioMaterialKnob.h
  • EditAnywhere
  • BlueprintSetter=SetTuneSpeed
  • BlueprintGetter=GetTuneSpeed
  • Category=Appearance
  • Meta=(ClampMin="0", ClampMax="1", UIMin="0", UIMax="1")
Value float Default Value of the Knob AudioMaterialSlate/AudioMaterialKnob.h
  • EditAnywhere
  • BlueprintSetter=SetValue
  • BlueprintGetter=GetValue
  • Category="Appearance"
  • Meta=(UIMin="0", UIMax="1")

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetFineTuneSpeed()

 Get the Knobs fine-tune speed AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintPure
  • Category="Audio Widgets| Audio Material Knob"

bool GetIsLocked()

 Get whether the knob is interactive or fixed. AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintPure
  • Category="Audio Widgets| Audio Material Knob"

bool GetMouseUsesStep()

 Get whether the knob uses steps when tuning On Mouse move AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintPure
  • Category="Audio Widgets| Audio Material Knob"

float GetStepSize()

 Get Step Size AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintPure
  • Category="Audio Widgets| Audio Material Knob"

float GetTuneSpeed()

 Get the Knobs tune speed AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintPure
  • Category="Audio Widgets| Audio Material Knob"

float GetValue()

 Get the current value of the knob. AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintPure
  • Category="Audio Widgets| Audio Material Knob"

void SetFineTuneSpeed ( float InValue
)

 Set the knobs fine-tune speed. InValue is Clamped between 0.f - 1.f AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintCallable
  • Category="Audio Widgets| Audio Material Knob"

void SetLocked ( bool InLocked
)

 Set the knob to be interactive or fixed AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintCallable
  • Category="Audio Widgets| Audio Material Knob"

void SetMouseUsesStep ( bool InUsesStep
)

 Set the knob to use steps when turning On Mouse move AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintCallable
  • Category="Audio Widgets| Audio Material Knob"

void SetStepSize ( float InValue
)

 Set the amount to adjust the value when using steps AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintCallable
  • Category="Audio Widgets| Audio Material Knob"

void SetTuneSpeed ( float InValue
)

 Set the knobs tune speed. InValue is Clamped between 0.f - 1.f AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintCallable
  • Category="Audio Widgets| Audio Material Knob"

void SetValue ( float InValue
)

 Set the current value of the knob. InValue is Clamped between 0.f - 1.f AudioMaterialSlate/AudioMaterialKnob.h
  • BlueprintCallable
  • Category="Audio Widgets| Audio Material Knob"

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

   AudioMaterialSlate/AudioMaterialKnob.h  

virtual void SynchronizeProperties()

 UWidget. AudioMaterialSlate/AudioMaterialKnob.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

 UVisual. AudioMaterialSlate/AudioMaterialKnob.h  

Protected

Name Remarks Include Path Unreal Specifiers

void HandleOnKnobValueChanged ( float InValue
)

   AudioMaterialSlate/AudioMaterialKnob.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

 UWidget. AudioMaterialSlate/AudioMaterialKnob.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page