Graphics::ILightingWorld class
#include <Spore ModAPI/Spore/Graphics/ILightingWorld.h>

A lighting world is a space with a specific lighting configuration.

Lighting worlds use configuration files stored in the lighting_properties~ folder, which specify information about the different lights and shadows, ambient lighting, etc.

The lighting in a world is not affected by and does not interact with other lighting worlds. For that reason, lighting worlds are usually paired with IModelWorld instances.

Constructors, destructors, conversion operators

~ILightingWorld() virtual

Public functions

auto AddRef() -> int pure virtual
auto Release() -> int pure virtual
auto AddLight(const Vector3& position, const ColorRGB& color, float strength, float size) -> int pure virtual
auto UpdateLightPosition(int index, const Vector3&) -> void pure virtual
auto RemoveLight(int index) -> void pure virtual
auto CreateLightingInfo(float boundingRadius, const Vector3& position) -> void* pure virtual
auto UpdateLightingInfo(float, const Vector3&, void* pLightingInfo) -> void pure virtual
auto DestroyLightingInfo(void* pLightingInfo) -> void pure virtual
auto ApplyGlobalState(App::cViewer* viewer) -> void pure virtual
auto SetTransform(const Transform& transform) -> void pure virtual: Sets the transform for this lighting world.
auto GetTransform() -> Transform pure virtual
auto SetLightingState(uint32_t configID) -> void pure virtual: Sets this lighting world to use the given configuration.
auto GetLightingState() -> uint32_t pure virtual: Returns the instance ID of the configuration file used to define this lighting world.
auto GetLightingStateConfig() -> App::PropertyList* pure virtual: Returns the configuration file (as a App::PropertyList) used to define this lighting world.
auto SetLightDecalManager(Object*) -> void pure virtual
auto SetWorldType(int worldType, const BoundingBox& bbox) -> void pure virtual

Function documentation

void Graphics::ILightingWorld::SetTransform(const Transform& transform) pure virtual

Sets the transform for this lighting world.

Parameters
transform

void Graphics::ILightingWorld::SetLightingState(uint32_t configID) pure virtual

Sets this lighting world to use the given configuration.

Parameters
configID	The instance ID of the configuration file.