Audio::FEnvelope Class Reference

#include <Envelope.h>

Classes
struct	FEnvData

Public Types
enum class	EEnvelopeState {   Off , Attack , Decay , Sustain ,   Release , Shutdown }

Public Member Functions
SIGNALPROCESSING_API	FEnvelope ()
virtual SIGNALPROCESSING_API	~FEnvelope ()
SIGNALPROCESSING_API void	Init (const float InSampleRate, const int32 InVoiceId=0, FModulationMatrix *InModMatrix=nullptr, const bool bInSimulateAnalog=true)
SIGNALPROCESSING_API void	SetSimulateAnalog (const bool bInSimulatingAnalog)
void	SetLegato (const bool bInLegatoMode)
void	SetRetrigger (const bool bInRetrigger)
bool	IsRetrigger () const
virtual SIGNALPROCESSING_API void	Start ()
virtual SIGNALPROCESSING_API void	StartLegato (const float InNewDepth)
virtual void	StartLegato ()
virtual SIGNALPROCESSING_API void	Stop ()
virtual SIGNALPROCESSING_API void	Shutdown ()
virtual SIGNALPROCESSING_API void	Kill ()
virtual SIGNALPROCESSING_API bool	IsDone () const
virtual SIGNALPROCESSING_API void	Reset ()
virtual SIGNALPROCESSING_API void	Update ()
virtual SIGNALPROCESSING_API float	Generate (float *BiasedOutput=nullptr)
virtual SIGNALPROCESSING_API EEnvelopeState	GetState () const
virtual SIGNALPROCESSING_API void	SetAttackTime (const float InAttackTimeMsec)
virtual SIGNALPROCESSING_API void	SetDecayTime (const float InDecayTimeMsec)
virtual SIGNALPROCESSING_API void	SetSustainGain (const float InSustainGain)
virtual SIGNALPROCESSING_API void	SetReleaseTime (const float InReleaseTimeMsec)
virtual SIGNALPROCESSING_API void	SetInvert (const bool bInInvert)
virtual SIGNALPROCESSING_API void	SetBiasInvert (const bool bInBiasInvert)
virtual SIGNALPROCESSING_API void	SetDepth (const float InDepth)
virtual SIGNALPROCESSING_API void	SetBiasDepth (const float InDepth)
const FPatchSource	GetModSourceEnv () const
const FPatchSource	GetModSourceBiasEnv () const

Protected Attributes
int32	VoiceId
float	CurrentEnvelopeValue
float	CurrentEnvelopeBiasValue
float	SampleRate
float	AttackTimeMSec
float	DecayTimeMsec
float	SustainGain
float	ReleaseTimeMsec
float	ShutdownTimeMsec
float	ShutdownDelta
float	Depth
float	BiasDepth
float	OutputGain
FEnvData	AttackData
FEnvData	DecayData
FEnvData	ReleaseData
EEnvelopeState	CurrentState
FModulationMatrix *	ModMatrix
FPatchSource	EnvSource
FPatchSource	BiasedEnvSource
uint8	bIsSimulatingAnalog:1
uint8	bIsLegatoMode:1
uint8	bIsRetriggerMode:1
uint8	bChanged:1
uint8	bInvert:1
uint8	bBiasInvert:1
uint8	bCurrentCycleIsADOnly:1

Member Enumeration Documentation

EEnvelopeState

enum class Audio::FEnvelope::EEnvelopeState

strong

Enumerator
Off
Attack
Decay
Sustain
Release
Shutdown

Constructor & Destructor Documentation

FEnvelope()

Audio::FEnvelope::FEnvelope

(

)

~FEnvelope()

Audio::FEnvelope::~FEnvelope ( )

virtual

Member Function Documentation

Generate()

float Audio::FEnvelope::Generate ( float *  BiasedOutput = nullptr )

virtual

GetModSourceBiasEnv()

const FPatchSource Audio::FEnvelope::GetModSourceBiasEnv ( ) const

inline

GetModSourceEnv()

const FPatchSource Audio::FEnvelope::GetModSourceEnv ( ) const

inline

GetState()

FEnvelope::EEnvelopeState Audio::FEnvelope::GetState ( ) const

virtual

Init()

void Audio::FEnvelope::Init	(	const float	InSampleRate,
		const int32	InVoiceId = 0,
		FModulationMatrix *	InModMatrix = nullptr,
		const bool	bInSimulateAnalog = true
	)

IsDone()

bool Audio::FEnvelope::IsDone ( ) const

virtual

IsRetrigger()

bool Audio::FEnvelope::IsRetrigger ( ) const

inline

Kill()

void Audio::FEnvelope::Kill ( )

virtual

Reset()

void Audio::FEnvelope::Reset ( )

virtual

SetAttackTime()

void Audio::FEnvelope::SetAttackTime ( const float  InAttackTimeMsec )

virtual

SetBiasDepth()

void Audio::FEnvelope::SetBiasDepth ( const float  InDepth )

virtual

SetBiasInvert()

void Audio::FEnvelope::SetBiasInvert ( const bool  bInBiasInvert )

virtual

SetDecayTime()

void Audio::FEnvelope::SetDecayTime ( const float  InDecayTimeMsec )

virtual

SetDepth()

void Audio::FEnvelope::SetDepth ( const float  InDepth )

virtual

SetInvert()

void Audio::FEnvelope::SetInvert ( const bool  bInInvert )

virtual

SetLegato()

void Audio::FEnvelope::SetLegato ( const bool  bInLegatoMode )

inline

SetReleaseTime()

void Audio::FEnvelope::SetReleaseTime ( const float  InReleaseTimeMsec )

virtual

SetRetrigger()

void Audio::FEnvelope::SetRetrigger ( const bool  bInRetrigger )

inline

SetSimulateAnalog()

void Audio::FEnvelope::SetSimulateAnalog

(

const bool

bInSimulatingAnalog

)

SetSustainGain()

void Audio::FEnvelope::SetSustainGain ( const float  InSustainGain )

virtual

Shutdown()

void Audio::FEnvelope::Shutdown ( )

virtual

Start()

void Audio::FEnvelope::Start ( )

virtual

StartLegato() [1/2]

virtual void Audio::FEnvelope::StartLegato ( )

inlinevirtual

StartLegato() [2/2]

void Audio::FEnvelope::StartLegato ( const float  InNewDepth )

virtual

Stop()

void Audio::FEnvelope::Stop ( )

virtual

Update()

void Audio::FEnvelope::Update ( )

virtual

Member Data Documentation

AttackData

FEnvData Audio::FEnvelope::AttackData

protected

AttackTimeMSec

float Audio::FEnvelope::AttackTimeMSec

protected

bBiasInvert

uint8 Audio::FEnvelope::bBiasInvert

protected

bChanged

uint8 Audio::FEnvelope::bChanged

protected

bCurrentCycleIsADOnly

uint8 Audio::FEnvelope::bCurrentCycleIsADOnly

protected

BiasDepth

float Audio::FEnvelope::BiasDepth

protected

BiasedEnvSource

FPatchSource Audio::FEnvelope::BiasedEnvSource

protected

bInvert

uint8 Audio::FEnvelope::bInvert

protected

bIsLegatoMode

uint8 Audio::FEnvelope::bIsLegatoMode

protected

bIsRetriggerMode

uint8 Audio::FEnvelope::bIsRetriggerMode

protected

bIsSimulatingAnalog

uint8 Audio::FEnvelope::bIsSimulatingAnalog

protected

CurrentEnvelopeBiasValue

float Audio::FEnvelope::CurrentEnvelopeBiasValue

protected

CurrentEnvelopeValue

float Audio::FEnvelope::CurrentEnvelopeValue

protected

CurrentState

EEnvelopeState Audio::FEnvelope::CurrentState

protected

DecayData

FEnvData Audio::FEnvelope::DecayData

protected

DecayTimeMsec

float Audio::FEnvelope::DecayTimeMsec

protected

Depth

float Audio::FEnvelope::Depth

protected

EnvSource

FPatchSource Audio::FEnvelope::EnvSource

protected

ModMatrix

FModulationMatrix* Audio::FEnvelope::ModMatrix

protected

OutputGain

float Audio::FEnvelope::OutputGain

protected

ReleaseData

FEnvData Audio::FEnvelope::ReleaseData

protected

ReleaseTimeMsec

float Audio::FEnvelope::ReleaseTimeMsec

protected

SampleRate

float Audio::FEnvelope::SampleRate

protected

ShutdownDelta

float Audio::FEnvelope::ShutdownDelta

protected

ShutdownTimeMsec

float Audio::FEnvelope::ShutdownTimeMsec

protected

SustainGain

float Audio::FEnvelope::SustainGain

protected

VoiceId

int32 Audio::FEnvelope::VoiceId

protected

---

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

• Engine/Source/Runtime/SignalProcessing/Public/DSP/Envelope.h
• Engine/Source/Runtime/SignalProcessing/Private/Envelope.cpp