FModulationMatrix

Windows
MacOS
Linux

References

Module

SignalProcessing

Header

/Engine/Source/Runtime/SignalProcessing/Public/DSP/ModulationMatrix.h

Include

#include "DSP/ModulationMatrix.h"

Syntax

class FModulationMatrix

Variables

Name Description

Protected variable

TArray< TArray<...

 

Destinations

Protected variable

int32

 

NumVoices

Protected variable

TArray< TArray<...

 

Patches

Protected variable

TArray< TArray<...

 

Sources

Constructors

Name Description

Public function

FModulationMatrix()

Destructors

Name Description

Public function Virtual

~FModulationMatrix()

Functions

Name Description

Public function

bool

 

AddPatch

(
    const int32 VoiceId,
    FPatch* Patch
)

Adds a new patch connection between one source and one or more destinations.

Public function

void

 

ClearPatches

(
    const int32 VoiceId
)

Clear all patch connections.

Public function

FPatchDestin...

 

CreatePatchDestination

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

Crates a new patch destination object and returns the patch destination id.

Public function

FPatchSource

 

CreatePatchSource

(
    const int32 VoiceId
)

Creates a new patch source object and returns the patch source id.

Public function Const

bool

 

GetDestinationValue

(
    const int32 VoiceId,
    const FPatchDestination& Destinati...,
    float& OutValue
)

Get the modulation destination value of the given destination id.

Public function Const

int32

 

GetNumPatches

(
    const int32 VoiceId
)

Returns the number of patch connections.

Public function

void

 

Init

(
    const int32 NumVoices
)

Initialize the modulation matrix with the desired number of voices.

Public function

bool

 

RemovePatch

(
    const int32 VoiceId,
    FPatch* Patch
)

Removes the given patch connection between a source and one or more destinations.

Protected function

void

 

ResetDestinations

(
    const int32 VoiceId
)

Public function

void

 

ResetPatchSourceState()

Reset all patch state.

Public function

bool

 

SetSourceValue

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

Set the modulation source value of the given id.

Public function

void

 

Update

(
    const int32 VoiceId,
    const int32 Stage
)

Perform the matrix update. Optionally do only a given stage.

Protected function

bool

 

ValidatePatch

(
    const int32 VoiceId,
    FPatch* Patch
)

Classes

Name

Description

Protected struct

FDestData
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss