Interface: LightingUnits

This core interface provides access to the Lighting Units settings.

Interface: LightingUnits

Methods:

<bool>IsLightingSystemSI()

Returns true if the Lighting Units are set to International (SI) system, false if set to American (AS) sytem.

<bool>IsLightingSystemAS()

Returns true if the Lighting Units are set to American (AS) system, false if set to International (SI) system.

<void>SetLightingSystemToSI()

Sets the Lighting Units to International (SI) system.

<void>SetLightingSystemToAS()

Sets the Lighting Units to American (AS) system.

<string>GetLuminanceUnits()

Returns a string containing the Luminance Units, for example "cd/m^2" for SI and "cd/ft^2" for AS.

<string>GetIlluminanceUnits()

Returns a string containing the Illuminance Units, for example "lx" for SI and "fc" for AS.

<float>ConvertASToSI <float>as_value

Returns the SI value corresponding to the supplied AS value.

<float>ConvertSIToAS <float>si_value

Returns the AS value corresponding to the supplied SI value.

<float>ConvertToCurrentSystem <float>value <bool>is_SI_value

Returns the value in the current system corresponding to the supplied value. When is_SI_value is true, the input value is taken as SI, when false, it is taken as AS value.