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

Base classes

class BiStateEffect
class IRotateEffect

Constructors, destructors, conversion operators

RotateEffect()
~RotateEffect() 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 GetRotationAxis() const -> const Math::Vector3& override
Get rotation axis (need not be normalized).
auto SetRotationAxis(const Math::Vector3& axis) -> void override
Set rotation axis (need not be normalized).
auto GetRotationAngle() const -> float override
Get angle to rotate by clockwise (in degrees).
auto SetRotationAngle(float angle) -> void override
Set angle to rotate by clockwise (in degrees).
auto func80h() -> int override
auto func88h(int, int, int) -> void override

Protected variables

Math::Vector3 mRotAxis
float mfRotAngle
float field_74

Function documentation

int UTFWin::RotateEffect::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::RotateEffect::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::RotateEffect::SetRotationAxis(const Math::Vector3& axis) override

Set rotation axis (need not be normalized).

Parameters
axis

void UTFWin::RotateEffect::SetRotationAngle(float angle) override

Set angle to rotate by clockwise (in degrees).

Parameters
angle