ILightingUnits Class Reference

ILightingUnits Class Referenceabstract

#include <ILightingUnits.h>

Class Description

Provides access to the lighting unit system for converting and displaying luminance and illuminance values.

+ Inheritance diagram for ILightingUnits:

Classes

struct  LightDispInfo
 Encapsulates the information related to a unit system. More...
 

Public Types

enum  LightingSystems { DISPLAY_INTERNATIONAL, DISPLAY_AMERICAN, DISPLAY_TYPE_COUNT }
 Enumerates the available unit system for displaying lighting quantities. More...
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
 

Public Member Functions

virtual const MCHARGetFirstLightingSystemName () const =0
 For internal use. More...
 
virtual const MCHARGetNextLightingSystemName () const =0
 For internal use. More...
 
virtual LightingSystems GetLightingSystem () const =0
 Returns the unit system currently being used for display. More...
 
virtual void SetLightingSystem (LightingSystems system)=0
 Sets the unit system to be used for display. More...
 
virtual const MCHARGetLuminanceUnits () const =0
 Returns the unit suffix as a text string, to be used for displaying luminance values. More...
 
virtual const MCHARGetIlluminanceUnits () const =0
 Returns the unit suffix as a text string, to be used for displaying illuminance values. More...
 
virtual double ConvertValue (const double value, const LightingSystems from_system, const LightingSystems to_system) const =0
 Converts a luminance or illuminance unit, from one system to the other. More...
 
virtual double ConvertToDisplay (const double value, const LightingSystems from_system) const =0
 Converts a luminance or illuminance unit, from the given system to the one used for display. More...
 
virtual double ConvertFromDisplay (const double value, const LightingSystems to_system) const =0
 Converts a luminance or illuminance unit, from the display system to the given one. More...
 
virtual double ConvertLuminanceToCurrSystem (double luminanceValue) const =0
 
virtual double ConvertLuminanceToCurrSystem (double luminanceValue, int inputType) const =0
 
virtual double ConvertLuminanceToSI (double AS_LuminanceValue) const =0
 
virtual double ConvertLuminanceToAS (double SI_LuminanceValue) const =0
 
virtual double ConvertIlluminanceToCurrSystem (double illuminanceValue) const =0
 
virtual double ConvertIlluminanceToCurrSystem (double illuminanceValue, int inputType) const =0
 
virtual double ConvertIlluminanceToSI (double AS_IlluminanceValue) const =0
 
virtual double ConvertIlluminanceToAS (double SI_IlluminanceValue) const =0
 
virtual LightDispInfo GetLightingUnitDisplayInfo () const =0
 Retrieves the display unit currently in use for lighting quantities. More...
 
- Public Member Functions inherited from FPInterfaceDesc
CoreExport FPInterfaceDesc ()
 
CoreExport FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...)
 
CoreExport ~FPInterfaceDesc ()
 
virtual void Init ()
 
LifetimeType LifetimeControl ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
CoreExport void LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...)
 
CoreExport void AppendFunction (int id,...)
 Add a new function to this interface descriptor. More...
 
CoreExport void AppendProperty (int id,...)
 Add a new property to this interface descriptor. More...
 
CoreExport void AppendEnum (int id,...)
 Add a new enum to this interface descriptor. More...
 
CoreExport void SetClassDesc (ClassDesc *i_cd)
 
CoreExport va_list check_fn (va_list ap, int id)
 
CoreExport va_list scan_fn (va_list ap, int id, int index)
 
CoreExport va_list check_prop (va_list ap, int id)
 
CoreExport va_list scan_prop (va_list ap, int id, int index)
 
CoreExport va_list check_enum (va_list ap, EnumID id)
 
CoreExport va_list scan_enum (va_list ap, EnumID id, int index)
 
FPInterfaceDescGetDesc ()
 
Interface_ID GetID ()
 
CoreExport FPFunctionDefGetFnDef (FunctionID fid)
 
ActionTableGetActionTable ()
 
CoreExport void EnableActions (BOOL onOff)
 
virtual CoreExport HINSTANCE HInstance ()
 
virtual CoreExport const MCHARGetRsrcString (StringResID id)
 
- Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPParams *params)
 
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
 
virtual CoreExport FunctionID FindFn (const MCHAR *name)
 
virtual CoreExport BOOL IsEnabled (FunctionID actionID)
 
virtual CoreExport BOOL IsChecked (FunctionID actionID)
 
virtual CoreExport BOOL IsVisible (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsEnabled (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsChecked (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsVisible (FunctionID actionID)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=NULL)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 
- Public Attributes inherited from FPInterfaceDesc
Interface_ID ID
 
MSTR internal_name
 
StringResID description
 
ClassDesccd
 
USHORT flags
 
Tab< FPFunctionDef * > functions
 
Tab< FPPropDef * > props
 
Tab< FPEnum * > enumerations
 
MSPluginClass * pc
 
Rolloutrollout
 
ActionTableaction_table
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Member Functions inherited from FPInterfaceDesc
CoreExport void load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 

Member Enumeration Documentation

Enumerates the available unit system for displaying lighting quantities.

Enumerator
DISPLAY_INTERNATIONAL 

The SI system used cd?m² and lux.

DISPLAY_AMERICAN 

The AS system uses cd?f² and footcandles.

DISPLAY_TYPE_COUNT 
30  {
36  };
Definition: ILightingUnits.h:35
The SI system used cd?m² and lux.
Definition: ILightingUnits.h:32
The AS system uses cd?f² and footcandles.
Definition: ILightingUnits.h:34

Member Function Documentation

virtual const MCHAR* GetFirstLightingSystemName ( ) const
pure virtual

For internal use.

virtual const MCHAR* GetNextLightingSystemName ( ) const
pure virtual

For internal use.

virtual LightingSystems GetLightingSystem ( ) const
pure virtual

Returns the unit system currently being used for display.

virtual void SetLightingSystem ( LightingSystems  system)
pure virtual

Sets the unit system to be used for display.

virtual const MCHAR* GetLuminanceUnits ( ) const
pure virtual

Returns the unit suffix as a text string, to be used for displaying luminance values.

virtual const MCHAR* GetIlluminanceUnits ( ) const
pure virtual

Returns the unit suffix as a text string, to be used for displaying illuminance values.

virtual double ConvertValue ( const double  value,
const LightingSystems  from_system,
const LightingSystems  to_system 
) const
pure virtual

Converts a luminance or illuminance unit, from one system to the other.

virtual double ConvertToDisplay ( const double  value,
const LightingSystems  from_system 
) const
pure virtual

Converts a luminance or illuminance unit, from the given system to the one used for display.

virtual double ConvertFromDisplay ( const double  value,
const LightingSystems  to_system 
) const
pure virtual

Converts a luminance or illuminance unit, from the display system to the given one.

virtual double ConvertLuminanceToCurrSystem ( double  luminanceValue) const
pure virtual
virtual double ConvertLuminanceToCurrSystem ( double  luminanceValue,
int  inputType 
) const
pure virtual
virtual double ConvertLuminanceToSI ( double  AS_LuminanceValue) const
pure virtual
virtual double ConvertLuminanceToAS ( double  SI_LuminanceValue) const
pure virtual
virtual double ConvertIlluminanceToCurrSystem ( double  illuminanceValue) const
pure virtual
virtual double ConvertIlluminanceToCurrSystem ( double  illuminanceValue,
int  inputType 
) const
pure virtual
virtual double ConvertIlluminanceToSI ( double  AS_IlluminanceValue) const
pure virtual
virtual double ConvertIlluminanceToAS ( double  SI_IlluminanceValue) const
pure virtual
virtual LightDispInfo GetLightingUnitDisplayInfo ( ) const
pure virtual

Retrieves the display unit currently in use for lighting quantities.