FAtomVolumeFader Class Reference

#include <AtomVolumeFader.h>

Public Member Functions
	FAtomVolumeFader ()
void	Activate ()
void	Deactivate ()
float	GetActiveDuration () const
EAtomFaderCurve	GetCurve () const
float	GetFadeDuration () const
float	GetTargetVolume () const
float	GetVolume () const
float	GetVolumeAfterTime (float InDeltaTime) const
bool	IsActive () const
bool	IsFading () const
bool	IsFadingIn () const
bool	IsFadingOut () const
void	SetActiveDuration (float InDuration)
void	SetVolume (float InVolume)
void	StartFade (float InVolume, float InDuration, EAtomFaderCurve InCurve)
void	StopFade ()
void	Update (float InDeltaTime)

Static Private Member Functions
static float	AlphaToVolume (float InAlpha, EAtomFaderCurve InCurve)

Private Attributes
float	ActiveDuration
float	Alpha
float	Elapsed
EAtomFaderCurve	FadeCurve
float	FadeDuration
float	Target

Detailed Description

Control-rate fader for managing volume fades of various standard shapes.

Constructor & Destructor Documentation

FAtomVolumeFader()

FAtomVolumeFader::FAtomVolumeFader

(

)

Member Function Documentation

Activate()

void FAtomVolumeFader::Activate

(

)

Activates the fader if currently deactivated. Sets duration to indefinite (-1.0f)

AlphaToVolume()

float FAtomVolumeFader::AlphaToVolume ( float InAlpha, EAtomFaderCurve InCurve )

staticprivate

Converts value to final resulting volume

Deactivate()

void FAtomVolumeFader::Deactivate

(

)

Deactivates the fader, causing it to remain at the current value and disregard update.

GetActiveDuration()

float FAtomVolumeFader::GetActiveDuration

(

)

const

Gets time fader is to remain active (-1.0f if always active).

GetCurve()

EAtomFaderCurve FAtomVolumeFader::GetCurve

(

)

const

Returns the curve type of the fader

GetFadeDuration()

float FAtomVolumeFader::GetFadeDuration

(

)

const

Returns the duration of the fade.

GetTargetVolume()

float FAtomVolumeFader::GetTargetVolume

(

)

const

Returns the target volume of the fader

GetVolume()

float FAtomVolumeFader::GetVolume

(

)

const

Returns current volume of fader

GetVolumeAfterTime()

float FAtomVolumeFader::GetVolumeAfterTime

(

float

InDeltaTime

)

const

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()

bool FAtomVolumeFader::IsActive

(

)

const

Whether or not the fader is active.

IsFading()

bool FAtomVolumeFader::IsFading

(

)

const

Returns whether or not the fader is currently fading over time.

IsFadingIn()

bool FAtomVolumeFader::IsFadingIn

(

)

const

Returns whether or not the fader is currently fading over time and value is increasing.

IsFadingOut()

bool FAtomVolumeFader::IsFadingOut

(

)

const

Returns whether or not the fader is currently fading over time and value is decreasing.

SetActiveDuration()

void FAtomVolumeFader::SetActiveDuration

(

float

InDuration

)

Sets the duration the fader is to be active in the future, after which point the fader is disabled. When disabled, fader will hold the current fade state until activated, at which point it will continue applying the fade over the remainder of the fade duration.

SetVolume()

void FAtomVolumeFader::SetVolume

(

float

InVolume

)

Sets the volume immediately, interrupting any currently active fade.

StartFade()

void FAtomVolumeFader::StartFade	(	float	InVolume,
		float	InDuration,
		EAtomFaderCurve	InCurve )

Applies a volume fade over time with the provided parameters.

StopFade()

void FAtomVolumeFader::StopFade

(

)

Stops fade, maintaining the current value as the target.

Update()

void FAtomVolumeFader::Update

(

float

InDeltaTime

)

Updates the fader's state with the given delta in time since last update.

Member Data Documentation

ActiveDuration

float FAtomVolumeFader::ActiveDuration

private

Duration fader is to be active

Alpha

float FAtomVolumeFader::Alpha

private

Current value used to linear interpolate over update delta (Normalized value for non-log, -80dB to 0dB for log)

Elapsed

float FAtomVolumeFader::Elapsed

private

Time elapsed since fade has been initiated

FadeCurve

EAtomFaderCurve FAtomVolumeFader::FadeCurve

private

Audio fader curve to use

FadeDuration

float FAtomVolumeFader::FadeDuration

private

Duration fader is to perform fade

Target

float FAtomVolumeFader::Target

private

Target value used to linear interpolate over update delta (Normalized value for non-log, -80dB to 0dB for log)

---

The documentation for this class was generated from the following files:

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/AtomVolumeFader.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/AtomVolumeFader.cpp