Swarm::IEffectMap class

Effect maps are one of the way effects can react to environment information from the game.

Effect maps are used to retrieve color, height, normal, or velocity information that changes on each point in space. More information: https://github.com/emd4600/SporeModder-FX/wiki/Effect-Maps

Derived classes

class cEffectMapBase

Public functions

auto AddRef() -> int pure virtual
auto Release() -> int pure virtual
auto Start() -> void pure virtual
auto Finish() -> void pure virtual
auto ModificationCount() -> int pure virtual
auto GetBounds() -> Math::BoundingBox pure virtual
Returns the bounding box that contains the whole map.
auto PointInMap(const Math::Vector3& position) -> bool pure virtual
Returns whether the given point is considered to be inside of the map.
auto InWorldSpace() -> bool pure virtual
Returns whether this map is in world space or not.
auto Height(const Math::Vector3& position) -> float pure virtual
Returns the height of the map at the given position.
auto Normal(const Math::Vector3& position) -> Math::Vector3 pure virtual
Returns the normal direction of the map at the given position.
auto Velocity(const Math::Vector3& position) -> Math::Vector3 pure virtual
Returns the velocity (i.e., speed with direction) of the map at the given position.
auto ColorAlpha(void* unk) -> Math::ColorRGBA pure virtual
Returns the RGBA color of the map at the given position.

Function documentation

bool Swarm::IEffectMap::PointInMap(const Math::Vector3& position) pure virtual

Returns whether the given point is considered to be inside of the map.

Parameters
position

float Swarm::IEffectMap::Height(const Math::Vector3& position) pure virtual

Returns the height of the map at the given position.

Parameters
position

Math::Vector3 Swarm::IEffectMap::Normal(const Math::Vector3& position) pure virtual

Returns the normal direction of the map at the given position.

Parameters
position

Math::Vector3 Swarm::IEffectMap::Velocity(const Math::Vector3& position) pure virtual

Returns the velocity (i.e., speed with direction) of the map at the given position.

Parameters
position

Math::ColorRGBA Swarm::IEffectMap::ColorAlpha(void* unk) pure virtual

Returns the RGBA color of the map at the given position.

Parameters
unk