UTFWin::IBiStateEffect class

Base classes

class UTFWinObject

Derived classes

class BiStateEffect

Public static variables

static const uint32_t TYPE

Public functions

auto ToWinProc() -> IWinProc* pure virtual
Get the IWinProc instance that represents this class.
auto GetTime() const -> float pure virtual
Get the duration of the effect.
void SetTime(float value) pure virtual
Set the duration of the effect.
auto GetTriggerType() const -> TriggerType pure virtual
Get the type of event that triggers this effect, in the TriggerType enum.
void SetTriggerType(TriggerType value) pure virtual
Set the type of event that triggers this effect, in the TriggerType enum.
void GetEase(float& easeIn, float& easeOut) const pure virtual
Get ease-in and ease-out time, between 0 and 1.
void SetEase(float easeIn, float easeOut) pure virtual
Set ease-in and ease-out time, between 0 and 1.
auto GetInterpolationType() const -> InterpolationType pure virtual
Get the interpolation type for the effect envelope, in the InterpolationType enum.
void SetInterpolationType(InterpolationType value) pure virtual
Set the interpolation type for the effect envelope, in the InterpolationType enum.
auto GetDamping() const -> float pure virtual
Get spring damping factor (0-1).
void SetDamping(float value) pure virtual
Set spring damping factor (0-1).

Function documentation

void UTFWin::IBiStateEffect::SetTime(float value) pure virtual

Set the duration of the effect.

Parameters
value

void UTFWin::IBiStateEffect::SetTriggerType(TriggerType value) pure virtual

Set the type of event that triggers this effect, in the TriggerType enum.

Parameters
value The new type of event, in the TriggerType value.

void UTFWin::IBiStateEffect::GetEase(float& easeIn, float& easeOut) const pure virtual

Get ease-in and ease-out time, between 0 and 1.

Parameters
easeIn out The destination float where the ease-in time will be put.
easeOut out The destination float where the ease-out time will be put.

void UTFWin::IBiStateEffect::SetEase(float easeIn, float easeOut) pure virtual

Set ease-in and ease-out time, between 0 and 1.

Parameters
easeIn
easeOut

void UTFWin::IBiStateEffect::SetInterpolationType(InterpolationType value) pure virtual

Set the interpolation type for the effect envelope, in the InterpolationType enum.

Parameters
value The new interpolation type, in the InterpolationType enum.

void UTFWin::IBiStateEffect::SetDamping(float value) pure virtual

Set spring damping factor (0-1).

Parameters
value