This is the documentation for Enlighten.

class Enlighten SpotlightMeta

class Enlighten::SpotlightMeta

    └>Enlighten::BaseLightMeta

Public interface for querying common metadata of a single spotlight.

Functions

Name Description
BaseLightMeta(const MetaBlock::BaseLightData *)

Constructs a BaseLightMeta from the given internal data.

GetCastsShadows()

Checks if this light casts shadows.

GetCutoffRadius()

Gets the cutoff radius of this spot light.

GetDirection()

Gets the direction of this spot light.

GetEnabled()

Checks if this light is enabled.

GetGuid()

Gets the GUID of this light.

GetInnerConeAngle()

Gets the inner cone angle of this spot light.

GetIntensity()

Gets the intensity of this light.

GetIntensityRadius()

Gets the intensity radius of this spot light.

GetNormalisedColour()

Gets the normalised colour of this light.

GetOuterConeAngle()

Gets the outer cone angle of this spot light.

GetPosition()

Gets the position of this spot 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.


float Enlighten::SpotlightMeta::GetCutoffRadius


public: float GetCutoffRadius() const


Gets the cutoff radius of this spot light.


const Geo::v128& Enlighten::SpotlightMeta::GetDirection


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


Gets the direction of this spot 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::SpotlightMeta::GetInnerConeAngle


public: float GetInnerConeAngle() const


Gets the inner cone angle of this spot light.


float Enlighten::BaseLightMeta::GetIntensity


public: float GetIntensity() const


Gets the intensity of this light.


float Enlighten::SpotlightMeta::GetIntensityRadius


public: float GetIntensityRadius() const


Gets the intensity radius of this spot light.


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


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


Gets the normalised colour of this light.


float Enlighten::SpotlightMeta::GetOuterConeAngle


public: float GetOuterConeAngle() const


Gets the outer cone angle of this spot light.


const Geo::v128& Enlighten::SpotlightMeta::GetPosition


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


Gets the position of this spot 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.