This is the documentation for Enlighten.

class Enlighten DirectionalLightMeta

class Enlighten::DirectionalLightMeta

    └>Enlighten::BaseLightMeta

Public interface for querying common metadata of a single directional light.

Functions

Name Description
BaseLightMeta(const MetaBlock::BaseLightData *)

Constructs a BaseLightMeta from the given internal data.

GetCastsShadows()

Checks if this light casts shadows.

GetDirection()

Gets the direction of this directional light.

GetEnabled()

Checks if this light is enabled.

GetGuid()

Gets the GUID of this light.

GetIntensity()

Gets the intensity of this light.

GetNormalisedColour()

Gets the normalised colour of this light.

GetRadiosityMultiplier()

Gets the radiosity multiplier of this light.

IsValid()

Some accessors return an 'invalid' object to represent nothing or not-found.

Variables

Name Description
const MetaBlock::BaseLightData * m_Data

The internal data (inside MetaBlock).


Enlighten::BaseLightMeta::BaseLightMeta


protected: BaseLightMeta
(
    const MetaBlock::BaseLightData * data
)


Constructs a BaseLightMeta from the given internal data.


bool Enlighten::BaseLightMeta::GetCastsShadows


public: bool GetCastsShadows() const


Checks if this light casts shadows.


const Geo::v128& Enlighten::DirectionalLightMeta::GetDirection


public: const Geo::v128 & GetDirection() const


Gets the direction of this directional light.


bool Enlighten::BaseLightMeta::GetEnabled


public: bool GetEnabled() const


Checks if this light is enabled.


const Geo::GeoGuid& Enlighten::BaseLightMeta::GetGuid


public: const Geo::GeoGuid & GetGuid() const


Gets the GUID of this light.


float Enlighten::BaseLightMeta::GetIntensity


public: float GetIntensity() const


Gets the intensity of this light.


const Geo::v128& Enlighten::BaseLightMeta::GetNormalisedColour


public: const Geo::v128 & GetNormalisedColour() const


Gets the normalised colour of this light.


float Enlighten::BaseLightMeta::GetRadiosityMultiplier


public: float GetRadiosityMultiplier() const


Gets the radiosity multiplier of this light.


bool Enlighten::BaseLightMeta::IsValid


public: bool IsValid() const


Some accessors return an 'invalid' object to represent nothing or not-found.