UTFWin::BiStateEffect class

Base classes

class InteractiveWinProc
class IBiStateEffect

Derived classes

class FadeEffect
class GlideEffect
class InflateEffect
class ModulateEffect
class RotateEffect

Constructors, destructors, conversion operators

BiStateEffect()

Public functions

auto Cast(uint32_t typeID) const -> void* override
void SetSerializer(Serializer& dst) override
auto GetProxyID() const -> uint32_t override
Returns the ID that identifies this type of element in a SPUI file.
auto HandleUIMessage(IWindow* pWindow, const Message& message) -> bool override
Method called every time a message is received on a window that has this IWinProc added.
auto func80h() -> int virtual
void func84h(int arg_0, float arg_4) virtual
void func88h(int arg_0, int arg_4, int arg_C) virtual
auto ToWinProc() -> IWinProc* override
Get the IWinProc instance that represents this class.
auto GetTime() const -> float override
Get the duration of the effect.
void SetTime(float value) override
Set the duration of the effect.
auto GetTriggerType() const -> TriggerType override
Get the type of event that triggers this effect, in the TriggerType enum.
void SetTriggerType(TriggerType value) override
Set the type of event that triggers this effect, in the TriggerType enum.
void GetEase(float& easeIn, float& easeOut) const override
Get ease-in and ease-out time, between 0 and 1.
void SetEase(float easeIn, float easeOut) override
Set ease-in and ease-out time, between 0 and 1.
auto GetInterpolationType() const -> InterpolationType override
Get the interpolation type for the effect envelope, in the InterpolationType enum.
void SetInterpolationType(InterpolationType value) override
Set the interpolation type for the effect envelope, in the InterpolationType enum.
auto GetDamping() const -> float override
Get spring damping factor (0-1).
void SetDamping(float value) override
Set spring damping factor (0-1).

Protected variables

float mfTime
int field_14
Clock mClock
TriggerType mTriggerType
InterpolationType mInterpolationType
float mfEaseIn
float mfEaseOut
float mfDamping
float field_44
float field_48
float field_4C
bool field_50
int field_54
int field_58
int field_5C

Function documentation

bool UTFWin::BiStateEffect::HandleUIMessage(IWindow* pWindow, const Message& message) override

Method called every time a message is received on a window that has this IWinProc added.

Parameters
pWindow The window that received this message.
message The message received.
Returns Whether the message was handled or not.

This method is responsible of handling (or not) the message. This method receives the IWindow that is currently receiving the message; this way, the same IWinProc can be listening for more than one window. This method returns whether the message was handled or not; if it was handled, no other IWinProcs will be called on that window.

void UTFWin::BiStateEffect::SetTime(float value) override

Set the duration of the effect.

Parameters
value

void UTFWin::BiStateEffect::SetTriggerType(TriggerType value) override

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::BiStateEffect::GetEase(float& easeIn, float& easeOut) const override

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::BiStateEffect::SetEase(float easeIn, float easeOut) override

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

Parameters
easeIn
easeOut

void UTFWin::BiStateEffect::SetInterpolationType(InterpolationType value) override

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

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

void UTFWin::BiStateEffect::SetDamping(float value) override

Set spring damping factor (0-1).

Parameters
value