1. Epic GamesDeveloper
  3. FModulationMatrix

FModulationMatrix

API > API/Runtime > API/Runtime/SignalProcessing

   
Name FModulationMatrix
Type class
Header File /Engine/Source/Runtime/SignalProcessing/Public/DSP/ModulationMatrix.h
Include Path #include "DSP/ModulationMatrix.h"

Syntax

class FModulationMatrix

Constructors

Name Remarks Include Path Unreal Specifiers

FModulationMatrix()

   DSP/ModulationMatrix.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FModulationMatrix()

   DSP/ModulationMatrix.h  

Structs

Name Remarks
FDestData  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddPatch ( const int32 VoiceId,
FPatch* Patch
)

 Adds a new patch connection between one source and one or more destinations. DSP/ModulationMatrix.h  

void ClearPatches ( const int32 VoiceId
)

 Clear all patch connections. DSP/ModulationMatrix.h  

FPatchDestination CreatePatchDestination ( const int32 VoiceId,
const int32 Stage,
const float DefaultDepth
)

 Crates a new patch destination object and returns the patch destination id. DSP/ModulationMatrix.h  

FPatchSource CreatePatchSource ( const int32 VoiceId
)

 Creates a new patch source object and returns the patch source id. DSP/ModulationMatrix.h  

bool GetDestinationValue ( const int32 VoiceId,
const FPatchDestination& Destination,
float& OutValue
) const

 Get the modulation destination value of the given destination id. DSP/ModulationMatrix.h  

int32 GetNumPatches ( const int32 VoiceId
) const

 Returns the number of patch connections. DSP/ModulationMatrix.h  

void Init ( const int32 NumVoices
)

 Initialize the modulation matrix with the desired number of voices. DSP/ModulationMatrix.h  

bool RemovePatch ( const int32 VoiceId,
FPatch* Patch
)

 Removes the given patch connection between a source and one or more destinations. DSP/ModulationMatrix.h  

void ResetPatchSourceState()

 Reset all patch state. DSP/ModulationMatrix.h  

bool SetSourceValue ( const int32 VoiceId,
const FPatchSource& Source,
const float Value
)

 Set the modulation source value of the given id. DSP/ModulationMatrix.h  

void Update ( const int32 VoiceId,
const int32 Stage
)

 Perform the matrix update. Optionally do only a given stage. DSP/ModulationMatrix.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ResetDestinations ( const int32 VoiceId
)

   DSP/ModulationMatrix.h  

bool ValidatePatch ( const int32 VoiceId,
FPatch* Patch
)

   DSP/ModulationMatrix.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page