1. Epic GamesDeveloper
  3. SAudioMaterialKnob

SAudioMaterialKnob

A simple slate that renders a knob in single material and modifies the material on value change.

API > API/Plugins > API/Plugins/AudioWidgets

A simple slate that renders a knob in single material and modifies the material on value change.

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

Syntax

class SAudioMaterialKnob : public SLeafWidget

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/SAudioMaterialKnob.h  
OnMouseCaptureEnd FSimpleDelegate Holds a delegate that is executed when the mouse is let up and a capture ends. AudioMaterialSlate/SAudioMaterialKnob.h  
OnValueChanged FOnFloatValueChanged Holds a delegate that is executed when the knob's value changes. AudioMaterialSlate/SAudioMaterialKnob.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AudioMaterialKnobStyle const FAudioMaterialKnobStyle * Holds the style for the Slate. AudioMaterialSlate/SAudioMaterialKnob.h  
bIsFineTune bool Whether or not we're in fine-tune mode. AudioMaterialSlate/SAudioMaterialKnob.h  
bIsFocusable TAttribute< bool > Holds a flag indicating whether knob will be keyboard focusable. AudioMaterialSlate/SAudioMaterialKnob.h  
bLocked TAttribute< bool > Holds a flag indicating whether the knob is locked. AudioMaterialSlate/SAudioMaterialKnob.h  
bMouseUsesStep TAttribute< bool > Holds a flag indicating whether the knob uses steps when roating on Mouse move. AudioMaterialSlate/SAudioMaterialKnob.h  
CachedCursor EMouseCursor::Type Holds the initial cursor in case a custom cursor has been specified, so we can restore it after dragging the slider. AudioMaterialSlate/SAudioMaterialKnob.h  
DesiredSizeOverride TAttribute< TOptional< FVector2D > > Holds the optional style for the Slate. AudioMaterialSlate/SAudioMaterialKnob.h  
DynamicMaterial TWeakObjectPtr< UMaterialInstanceDynamic > Holds the Modifiable Material that represent the Knob. AudioMaterialSlate/SAudioMaterialKnob.h  
FineTuneSpeed TAttribute< float > Holds the amount to adjust the knob On Mouse move & FineTuning AudioMaterialSlate/SAudioMaterialKnob.h  
MouseDownPosition FVector2D The position of the mouse when it pushed down and started rotating the knob. AudioMaterialSlate/SAudioMaterialKnob.h  
MouseDownValue float The value when the mouse was pushed down AudioMaterialSlate/SAudioMaterialKnob.h  
Owner TWeakObjectPtr< UObject > Holds the owner of the Slate. AudioMaterialSlate/SAudioMaterialKnob.h  
PixelDelta int32 The max pixels to go to min or max value (clamped to 0 or 1) in one drag period AudioMaterialSlate/SAudioMaterialKnob.h  
StepSize TAttribute< float > Holds the amount to adjust the value when steps are used AudioMaterialSlate/SAudioMaterialKnob.h  
TuneSpeed TAttribute< float > Holds the amount to adjust the knob On Mouse move AudioMaterialSlate/SAudioMaterialKnob.h  
ValueAttribute TAttribute< float > Holds the knobs current Value. AudioMaterialSlate/SAudioMaterialKnob.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMaterialInstanceDynamic * ApplyNewMaterial()

 Apply new material to be used to render the Slate. AudioMaterialSlate/SAudioMaterialKnob.h  

void Construct ( const FArguments& InArgs
)

 Constructs this widget with InArgs AudioMaterialSlate/SAudioMaterialKnob.h  

const float GetOutputValue ( const float InSliderValue
)

   AudioMaterialSlate/SAudioMaterialKnob.h  

const float GetSliderValue ( const float OutputValue
)

   AudioMaterialSlate/SAudioMaterialKnob.h  

bool IsLocked()

   AudioMaterialSlate/SAudioMaterialKnob.h  

void SetDesiredSizeOverride ( const FVector2D Size
)

 Set desired size of the Slate AudioMaterialSlate/SAudioMaterialKnob.h  

void SetFineTuneSpeed ( const float InMouseFineTuneSpeed
)

 Set the FineTuneSpeed attribute AudioMaterialSlate/SAudioMaterialKnob.h  

void SetLocked ( const bool InLocked
)

 Set the bLocked attribute AudioMaterialSlate/SAudioMaterialKnob.h  

void SetMouseUsesStep ( const bool InUsesStep
)

 See the bMouseUsesStep attribute AudioMaterialSlate/SAudioMaterialKnob.h  

void SetOutputRange ( const FVector2D Range
)

 Set the output range of the Knob AudioMaterialSlate/SAudioMaterialKnob.h  

void SetStepSize ( const float InStepSize
)

 Set the StepSize attribute AudioMaterialSlate/SAudioMaterialKnob.h  

void SetTuneSpeed ( const float InMouseSpeed
)

 Set the TuneSpeed attribute AudioMaterialSlate/SAudioMaterialKnob.h  

void SetValue ( const TAttribute< float >& InValueAttribute
)

 Set the Value attribute AudioMaterialSlate/SAudioMaterialKnob.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

 SWidget. AudioMaterialSlate/SAudioMaterialKnob.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FVector2D ComputeDesiredSize ( float
) const

   AudioMaterialSlate/SAudioMaterialKnob.h  

virtual bool IsInteractable()

   AudioMaterialSlate/SAudioMaterialKnob.h  

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

   AudioMaterialSlate/SAudioMaterialKnob.h  

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

   AudioMaterialSlate/SAudioMaterialKnob.h  

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

   AudioMaterialSlate/SAudioMaterialKnob.h  

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

   AudioMaterialSlate/SAudioMaterialKnob.h  

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

   AudioMaterialSlate/SAudioMaterialKnob.h  

virtual bool SupportsKeyboardFocus()

   AudioMaterialSlate/SAudioMaterialKnob.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page