AtomModulation::IGenerator类 参考

#include <AtomModulationGenerator.h>

类 AtomModulation::IGenerator 继承关系图:

Public 成员函数
virtual	~IGenerator ()=default
virtual FGeneratorPtr	Clone () const =0
virtual void	GetDebugCategories (TArray< FString > &OutDebugCategories) const =0
virtual const FString &	GetDebugName () const =0
virtual void	GetDebugValues (TArray< FString > &OutDebugValues) const =0
virtual float	GetValue () const =0
virtual void	Init (FAtomRuntimeId InRuntimeID)
virtual bool	IsBypassed () const =0
void	PumpCommands ()
virtual void	Update (double InElapsed)=0
virtual void	UpdateGenerator (FGeneratorPtr &&InGenerator)=0
Public 成员函数 继承自 AtomModulation::IGeneratorFixLayout
virtual	~IGeneratorFixLayout ()=default

Protected 成员函数
CRI_API void	AtomThreadCommand (TUniqueFunction< void()> &&InCommand)

Protected 属性
FAtomRuntimeId	AtomRuntimeID = INDEX_NONE

Private 属性
TQueue< TUniqueFunction< void()> >	CommandQueue

构造及析构函数说明

~IGenerator()

virtual AtomModulation::IGenerator::~IGenerator ( )

virtualdefault

成员函数说明

AtomThreadCommand()

void AtomModulation::IGenerator::AtomThreadCommand ( TUniqueFunction< void()> && InCommand )

protected

Clone()

virtual FGeneratorPtr AtomModulation::IGenerator::Clone ( ) const

pure virtual

在 AtomModulation::FADEnvelopeGenerator, AtomModulation::FEnvelopeFollowerGenerator , 以及 AtomModulation::FLFOGenerator 内被实现.

GetDebugCategories()

virtual void AtomModulation::IGenerator::GetDebugCategories ( TArray< FString > & OutDebugCategories ) const

pure virtual

在 AtomModulation::FADEnvelopeGenerator, AtomModulation::FEnvelopeFollowerGenerator , 以及 AtomModulation::FLFOGenerator 内被实现.

GetDebugName()

virtual const FString & AtomModulation::IGenerator::GetDebugName ( ) const

pure virtual

在 AtomModulation::FADEnvelopeGenerator, AtomModulation::FEnvelopeFollowerGenerator , 以及 AtomModulation::FLFOGenerator 内被实现.

GetDebugValues()

virtual void AtomModulation::IGenerator::GetDebugValues ( TArray< FString > & OutDebugValues ) const

pure virtual

在 AtomModulation::FADEnvelopeGenerator, AtomModulation::FEnvelopeFollowerGenerator , 以及 AtomModulation::FLFOGenerator 内被实现.

GetValue()

virtual float AtomModulation::IGenerator::GetValue ( ) const

pure virtual

Returns current value of the generator.

在 AtomModulation::FADEnvelopeGenerator, AtomModulation::FEnvelopeFollowerGenerator , 以及 AtomModulation::FLFOGenerator 内被实现.

Init()

virtual void AtomModulation::IGenerator::Init ( FAtomRuntimeId InRuntimeID )

inlinevirtual

(Optional) Initializer step where the generator is provided the associated parent Atom runtime's Id.

被 AtomModulation::FEnvelopeFollowerGenerator 重载.

IsBypassed()

virtual bool AtomModulation::IGenerator::IsBypassed ( ) const

pure virtual

Returns whether or not the generator is bypassed.

在 AtomModulation::FADEnvelopeGenerator, AtomModulation::FEnvelopeFollowerGenerator , 以及 AtomModulation::FLFOGenerator 内被实现.

PumpCommands()

void AtomModulation::IGenerator::PumpCommands

(

)

Pumps commands from Audio Thread to the generator's modulation processing thread.

Update()

virtual void AtomModulation::IGenerator::Update ( double InElapsed )

pure virtual

Updates the generators value at the audio block rate on the modulation processing thread.

在 AtomModulation::FADEnvelopeGenerator, AtomModulation::FEnvelopeFollowerGenerator , 以及 AtomModulation::FLFOGenerator 内被实现.

UpdateGenerator()

virtual void AtomModulation::IGenerator::UpdateGenerator ( FGeneratorPtr && InGenerator )

pure virtual

Allows child generator class to override default copy/update behavior when receiving an updated generator call from the Atom thread. Useful for ignoring updates while a generator is running or deferring the transition to the new generator state to the modulation processing thread. This enables interpolating between existing and new generator state, properties, avoiding discontinuities, etc.

参数

InGenerator

- The constructed version of the generator being sent from the Atom Thread

在 AtomModulation::FADEnvelopeGenerator, AtomModulation::FEnvelopeFollowerGenerator , 以及 AtomModulation::FLFOGenerator 内被实现.

类成员变量说明

AtomRuntimeID

FAtomRuntimeId AtomModulation::IGenerator::AtomRuntimeID = INDEX_NONE

protected

CommandQueue

TQueue<TUniqueFunction<void()> > AtomModulation::IGenerator::CommandQueue

private

---

该类的文档由以下文件生成:

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