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

Base classes

class Effect
class IPerspectiveEffect

Constructors, destructors, conversion operators

PerspectiveEffect()
~PerspectiveEffect() 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 GetNearPlane() const -> float override: Get near plane z-position (strength of perspective effect).
auto SetNearPlane(float nearPlane) -> void override: Set near plane z-position (strength of perspective effect).
auto func80h(int) -> void virtual

Function documentation

int UTFWin::PerspectiveEffect::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::PerspectiveEffect::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::PerspectiveEffect::SetNearPlane(float nearPlane) override

Set near plane z-position (strength of perspective effect).

Parameters
nearPlane

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