UAtomBusEffectPreset Class Reference

#include <AtomBusEffectPreset.h>

Inheritance diagram for UAtomBusEffectPreset:

Public Member Functions
	UAtomBusEffectPreset (const FObjectInitializer &ObjectInitializer)
virtual void	ApplyToDefautlsSettings ()
UAtomBus *	GetBus () const
virtual float	GetParameterValue (int ParameterIndex) const
virtual FColor	GetPresetColor () const override
virtual bool	IsBypassed () const
virtual void	PostInitProperties () override
virtual void	PostLoad () override
virtual void	SetBypass (bool bBypass)
virtual void	SetParameterValue (int ParameterIndex, float Value)
Public Member Functions inherited from UAtomEffectPreset
	UAtomEffectPreset (const FObjectInitializer &ObjectInitializer)
virtual	~UAtomEffectPreset ()=default
virtual bool	CanFilter () const
virtual UAtomEffectPreset *	CreateNewPreset (UObject *InParent, FName Name, EObjectFlags Flags) const
virtual FText	GetAssetActionName () const
FORCEINLINE FName	GetEffectName () const
FORCEINLINE int32	GetNumParameters () const
FORCEINLINE FName	GetPluginName () const
virtual UClass *	GetSupportedClass () const
virtual bool	HasAssetActions () const
virtual void	Init ()

Static Public Member Functions
static UAtomBusEffectPreset *	CreateBusEffectPreset (UObject *InOuter, const FName &InBusEffectName)
static UAtomBusEffectPreset *	CreateBusEffectPreset (UObject *InOuter, const UClass *InPresetClass, const FName &InName=NAME_None)
static const UClass *	GetBusEffectPresetClassFromName (const FName &InBusEffectName)
static const FName	GetBusEffectPresetNameFromClass (const UClass *InBusEffectClass)
static int32	GetBusEffectPresetNumParameters (const FName &InBusEffectName)

Protected Member Functions
void	Update () const
void	UpdateBypass () const
void	UpdateParameter (int ParamIndex) const

Static Protected Member Functions
static void	RegisterBusEffectClass (FName BusEffectName, UClass *BusEffectClass, int32 BusEffectNumParameters)

Protected Attributes
bool	bInitialized = false
Protected Attributes inherited from UAtomEffectPreset
FName	EffectName
int32	NumParameters
FName	PluginName

Static Protected Attributes
static TMap< FName, TPair< const UClass *, int > >	BusEffects

Private Member Functions
void	AddTargetBus (const UAtomBus *InBus)
void	RemoveTargetBus (const UAtomBus *InBus)

Private Attributes
TSet< TObjectPtr< const UAtomBus > >	TargetBuses

Friends
class	FAtomRuntime
class	UAtomBus

Detailed Description

Preset of a bus effect that can be shared between sounds.

Constructor & Destructor Documentation

UAtomBusEffectPreset()

UAtomBusEffectPreset::UAtomBusEffectPreset

(

const FObjectInitializer &

ObjectInitializer

)

Member Function Documentation

AddTargetBus()

void UAtomBusEffectPreset::AddTargetBus ( const UAtomBus * InBus )

private

Links with a bus to apply this preset.

ApplyToDefautlsSettings()

virtual void UAtomBusEffectPreset::ApplyToDefautlsSettings ( )

inlinevirtual

CreateBusEffectPreset() [1/2]

UAtomBusEffectPreset * UAtomBusEffectPreset::CreateBusEffectPreset ( UObject * InOuter, const FName & InBusEffectName )

static

Convinient function to create effect preset object from ADX bus effect name.

CreateBusEffectPreset() [2/2]

UAtomBusEffectPreset * UAtomBusEffectPreset::CreateBusEffectPreset ( UObject * InOuter, const UClass * InPresetClass, const FName & InName = NAME_None )

static

Convinient function to create effect preset object from a UAtomBusEffectPreset sub-class.

GetBus()

UAtomBus * UAtomBusEffectPreset::GetBus

(

)

const

Gets the owner AtomBus. It can be nullptr if preset is not bus default preset. (Not present in same package than rack/bus.)

GetBusEffectPresetClassFromName()

const UClass * UAtomBusEffectPreset::GetBusEffectPresetClassFromName ( const FName & InBusEffectName )

static

Gets the preset class from ADX bus effect name.

GetBusEffectPresetNameFromClass()

const FName UAtomBusEffectPreset::GetBusEffectPresetNameFromClass ( const UClass * InBusEffectClass )

static

Gets the ADX bus effect name from preset class.

GetBusEffectPresetNumParameters()

int32 UAtomBusEffectPreset::GetBusEffectPresetNumParameters ( const FName & InBusEffectName )

static

Gets the number of parameters used by a bus effect.

GetParameterValue()

virtual float UAtomBusEffectPreset::GetParameterValue ( int ParameterIndex ) const

inlinevirtual

Reimplemented in UAtomBusEffectBandpassFilterPreset, UAtomBusEffectBinauralPreset, UAtomBusEffectBiquadFilterPreset, UAtomBusEffectBitCrusherPreset, UAtomBusEffectChorusPreset, UAtomBusEffectCompressorPreset, UAtomBusEffectDelayPreset, UAtomBusEffectDistortionPreset, UAtomBusEffectEchoPreset, UAtomBusEffectFlangerPreset, UAtomBusEffectI3DL2ReverbPreset, UAtomBusEffectIRReverbPreset, UAtomBusEffectLimiterPreset, UAtomBusEffectMultiBandEQPreset, UAtomBusEffectMultiTapDelayPreset, UAtomBusEffectPhaserPreset, UAtomBusEffectPitchShifterPreset, UAtomBusEffectReverbPreset, and UAtomBusEffectSurrounderWithEQPreset.

GetPresetColor()

virtual FColor UAtomBusEffectPreset::GetPresetColor ( ) const

inlineoverridevirtual

Reimplemented from UAtomEffectPreset.

IsBypassed()

virtual bool UAtomBusEffectPreset::IsBypassed ( ) const

inlinevirtual

PostInitProperties()

void UAtomBusEffectPreset::PostInitProperties ( )

overridevirtual

Reimplemented in UAtomBusEffectMultiBandEQPreset.

PostLoad()

void UAtomBusEffectPreset::PostLoad ( )

overridevirtual

RegisterBusEffectClass()

void UAtomBusEffectPreset::RegisterBusEffectClass ( FName BusEffectName, UClass * BusEffectClass, int32 BusEffectNumParameters )

inlinestaticprotected

RemoveTargetBus()

void UAtomBusEffectPreset::RemoveTargetBus ( const UAtomBus * InBus )

private

Removes link this preset to a bus.

SetBypass()

virtual void UAtomBusEffectPreset::SetBypass ( bool bBypass )

inlinevirtual

SetParameterValue()

virtual void UAtomBusEffectPreset::SetParameterValue ( int ParameterIndex, float Value )

inlinevirtual

Reimplemented in UAtomBusEffectBandpassFilterPreset, UAtomBusEffectBinauralPreset, UAtomBusEffectBiquadFilterPreset, UAtomBusEffectBitCrusherPreset, UAtomBusEffectChorusPreset, UAtomBusEffectCompressorPreset, UAtomBusEffectDelayPreset, UAtomBusEffectDistortionPreset, UAtomBusEffectEchoPreset, UAtomBusEffectFlangerPreset, UAtomBusEffectI3DL2ReverbPreset, UAtomBusEffectIRReverbPreset, UAtomBusEffectLimiterPreset, UAtomBusEffectMultiBandEQPreset, UAtomBusEffectMultiTapDelayPreset, UAtomBusEffectPhaserPreset, UAtomBusEffectPitchShifterPreset, UAtomBusEffectReverbPreset, and UAtomBusEffectSurrounderWithEQPreset.

Update()

void UAtomBusEffectPreset::Update ( ) const

protected

UpdateBypass()

void UAtomBusEffectPreset::UpdateBypass ( ) const

protected

UpdateParameter()

void UAtomBusEffectPreset::UpdateParameter ( int ParamIndex ) const

protected

Friends And Related Symbol Documentation

FAtomRuntime

friend class FAtomRuntime

friend

UAtomBus

friend class UAtomBus

friend

Member Data Documentation

bInitialized

bool UAtomBusEffectPreset::bInitialized = false

protected

BusEffects

TMap< FName, TPair< const UClass *, int32 > > UAtomBusEffectPreset::BusEffects

staticprotected

The global Atom bus effect dictionary

TargetBuses

TSet<TObjectPtr<const UAtomBus> > UAtomBusEffectPreset::TargetBuses

private

Keeps the buses using this preset to apply effect settings to Atom runtime.

---

The documentation for this class was generated from the following files:

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/AtomBusEffectPreset.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/AtomBusEffectPreset.cpp