Graphics::ILightingWorld class

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, float) -> int pure virtual
void UpdateLightPosition(int index, const Vector3&) pure virtual
void RemoveLight(int index) pure virtual
auto CreateLightingInfo(float boundingRadius, const Vector3& position) -> void* pure virtual
void UpdateLightingInfo(float, const Vector3&, void* pLightingInfo) pure virtual
void DestroyLightingInfo(void* pLightingInfo) pure virtual
void ApplyGlobalState(App::cViewer* viewer) pure virtual
void SetTransform(const Transform& transform) pure virtual
Sets the transform for this lighting world.
auto GetTransform() -> Transform pure virtual
void SetLightingState(uint32_t configID) 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.
void SetLightDecalManager(Object*) pure virtual
void SetWorldType(int worldType, const BoundingBox& bbox) 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.

The ID is the instance ID of a .prop lighting configuration file located in the 0x40200100 (lighting_properties~) folder.