Navigation
API > API/Plugins > API/Plugins/HarmonixDsp
A struct that contains data about a modulator target. including its name, range of modulation, etc.
| Name | FModulatorTarget |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixDsp/Public/HarmonixDsp/Modulators/ModulatorTarget.h |
| Include Path | #include "HarmonixDsp/Modulators/ModulatorTarget.h" |
Syntax
struct FModulatorTarget
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| HarmonixDsp/Modulators/ModulatorTarget.h | |||
FModulatorTarget
(
FName InName, |
HarmonixDsp/Modulators/ModulatorTarget.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| kDummyTarget | FModulatorTarget | HarmonixDsp/Modulators/ModulatorTarget.h | |
| kPitchName | const FName | HarmonixDsp/Modulators/ModulatorTarget.h | |
| kStartPointName | const FName | HarmonixDsp/Modulators/ModulatorTarget.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DefaultRangeMag | float | Hint for reasonable range | HarmonixDsp/Modulators/ModulatorTarget.h | |
| DepthMode | EDepthMode | How to apply a depth of less than 100% | HarmonixDsp/Modulators/ModulatorTarget.h | |
| Name | FName | Name of the modulator target. | HarmonixDsp/Modulators/ModulatorTarget.h | |
| TargetFloat | float * | Reference to the value to modulate | HarmonixDsp/Modulators/ModulatorTarget.h | |
| Units | FString | Units the range is expressed in | HarmonixDsp/Modulators/ModulatorTarget.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float ApplyDepthToNormalizedValue
(
float x, |
Take a number on [0,1] and transform it based on a depth | HarmonixDsp/Modulators/ModulatorTarget.h | |
float GetDefaultRangeMagnitude() |
HarmonixDsp/Modulators/ModulatorTarget.h | ||
FName GetName() |
HarmonixDsp/Modulators/ModulatorTarget.h | ||
TInterval< float > GetRangeWithMagnitude
(
float InMagnitude |
HarmonixDsp/Modulators/ModulatorTarget.h | ||
float * GetTargetFloat() |
HarmonixDsp/Modulators/ModulatorTarget.h | ||
const FString & GetUnits() |
HarmonixDsp/Modulators/ModulatorTarget.h |