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

Base classes

class BiStateEffect
class IModulateEffect

Constructors, destructors, conversion operators

ModulateEffect()
~ModulateEffect() 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 GetColors(Math::Color& color1, Math::Color& color2) const -> void override
Get first and second modulation color.
auto SetColors(Math::Color color1, Math::Color color2) -> void override
Set first and second modulation color.
auto func84h(int, float) -> void override

Protected variables

Math::Color mColor1
Math::Color mColor2
int field_6C

Function documentation

int UTFWin::ModulateEffect::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::ModulateEffect::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::ModulateEffect::GetColors(Math::Color& color1, Math::Color& color2) const override

Get first and second modulation color.

Parameters
color1 out
color2 out

void UTFWin::ModulateEffect::SetColors(Math::Color color1, Math::Color color2) override

Set first and second modulation color.

Parameters
color1
color2