UTFWin::GlideEffect class
#include <Spore ModAPI/Spore/UTFWin/GlideEffect.h>

Base classes

class BiStateEffect
class IGlideEffect

Constructors, destructors, conversion operators

GlideEffect()
~GlideEffect() virtual

Public functions

auto AddRef() -> int override
auto Release() -> int override
auto Cast(uint32_t typeID) const -> void* override
auto GetEventFlags() const -> int override: Gets the flags that represent which type of messages this IWinProc can handle.
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 SetSerializer(Serializer& dst) -> void override
auto GetProxyID() const -> uint32_t override: Returns the ID that identifies this type of element in a SPUI file.
auto ToWinProc() -> IWinProc* override: Get the IWinProc instance that represents this class.
auto GetOffset() const -> const Math::Point& override: Get the direction and distance to displace the window when hidden.
auto SetOffset(const Math::Point& offset) -> void override: Set the direction and distance to displace the window when hidden.
auto func80h() -> int override
auto func88h(int, int, int) -> void override

Function documentation

int UTFWin::GlideEffect::GetEventFlags() const override

Gets the flags that represent which type of messages this IWinProc can handle.

This allows for better performance, since generally a procedure only needs to listen specific events. The flags are in the kEventFlag... values.

bool UTFWin::GlideEffect::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::GlideEffect::SetOffset(const Math::Point& offset) override

Set the direction and distance to displace the window when hidden.

Parameters
offset

UTFWin::GlideEffect class #include <Spore ModAPI/Spore/UTFWin/GlideEffect.h>