#include <customgui_soundeffector.h>
Represents a probe in a SoundData.
Calculation Values | |
Bool | _clamp |
Int32 | _colorMode |
Int32 | _samplingMode |
Float | _strength |
Vector | _color |
GeData | _gradient |
Float | _fadePercentage |
Bool | _freeze |
maxon::BaseArray< Float > | _freezeArray |
Constructor/Destructor | |
Probe ()=default | |
virtual | ~Probe () |
Right/left Bottom/Top Values | |
Float | GetRight () const |
Float | GetLeft () const |
Float | GetBottom () const |
Float | GetTop () const |
Bool | SetRight (Float right) |
Bool | SetLeft (Float left) |
Bool | SetTop (Float top) |
Bool | SetBottom (Float bottom) |
Validate | |
void | ValidateDimensions () |
|
default |
Default constructor.
|
virtual |
Destructor.
Float GetRight | ( | ) | const |
Retrieves the right value of probe in Hertz.
Float GetLeft | ( | ) | const |
Retrieves the left value of probe in Hertz.
Float GetBottom | ( | ) | const |
Retrieves the bottom value of probe as normalized ratio.
Float GetTop | ( | ) | const |
Retrieves the top value of probe in normalized ratio.
Sets the right value of probe in Hertz [1...22050].
[in] | right | The right value to set. |
Sets the left value of probe in Hertz [1...22050].
[in] | left | The left value to set. |
Sets top value of probe as normalized ratio [0...1].
[in] | top | The top value to set. |
Sets bottom value of probe as normalized ratio [0...1].
[in] | bottom | The bottom value to set. |
void ValidateDimensions | ( | ) |
Validates probe dimensions. Swaps Left/Right - Top/Bottom if values are inverted.
Bool _clamp |
Set to true (default) to limit the output of the probe from 0.0 to 1.0 and ignore values outside of the range.
Int32 _colorMode |
The color mode.
Int32 _samplingMode |
The probe mode.
Float _strength |
Overall strength multiplier for the probe.
Vector _color |
Color of the probe used when the probe's color mode is Custom Color.
Float _fadePercentage |
Fade percentage for decay.
Bool _freeze |
Freeze state of the output.
maxon::BaseArray<Float> _freezeArray |
Freeze values of the output.