Module |
|
Header |
/Engine/Source/Runtime/SignalProcessing/Public/DSP/VolumeFader.h |
Include |
#include "DSP/VolumeFader.h" |
class FVolumeFader
Control-rate fader for managing volume fades of various standard shapes.
Name | Description | |
---|---|---|
|
FVolumeFader() |
Name | Description | ||
---|---|---|---|
|
Activate() |
Activates the fader if currently deactivated. Sets duration to indefinite (-1.0f) |
|
|
Deactivate() |
Deactivates the fader, causing it to remain at the current value and disregard update. |
|
|
float |
GetActiveDuration() |
Gets time fader is to remain active (-1.0f if always active). |
|
GetCurve() |
Returns the curve type of the fader |
|
|
float |
GetFadeDuration() |
Returns the duration of the fade. |
|
float |
GetTargetVolume() |
Returns the target volume of the fader |
|
float |
GetVolume() |
Returns current volume of fader |
|
float |
GetVolumeAfterTime ( |
Returns the volume given the delta from the current time into the future (Effectively like running to retrieve volume but without actually updating internal state). |
|
IsActive() |
Whether or not the fader is active. |
|
|
IsFading() |
Returns whether or not the fader is currently fading over time. |
|
|
IsFadingIn() |
Returns whether or not the fader is currently fading over time and value is increasing. |
|
|
IsFadingOut() |
Returns whether or not the fader is currently fading over time and value is decreasing. |
|
|
SetActiveDuration ( |
Sets the duration the fader is to be active in the future, after which point the fader is disabled. |
|
|
SetVolume ( |
Sets the volume immediately, interrupting any currently active fade. |
|
|
StartFade ( |
Applies a volume fade over time with the provided parameters. |
|
|
StopFade() |
Stops fade, maintaining the current value as the target. |
|
|
Update ( |
Updates the fader's state with the given delta in time since last update. |