ILightingUnits Class Reference

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

#include <ILightingUnits.h>

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 MCHAR *	GetFirstLightingSystemName () const =0
	For internal use.
virtual const MCHAR *	GetNextLightingSystemName () const =0
	For internal use.
virtual LightingSystems	GetLightingSystem () const =0
	Returns the unit system currently being used for display.
virtual void	SetLightingSystem (LightingSystems system)=0
	Sets the unit system to be used for display.
virtual const MCHAR *	GetLuminanceUnits () const =0
	Returns the unit suffix as a text string, to be used for displaying luminance values.
virtual const MCHAR *	GetIlluminanceUnits () const =0
	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 =0
	Converts a luminance or illuminance unit, from one system to the other.
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.
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.
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.
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 BaseInterface *	GetInterface (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.
CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor.
CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor.
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)
FPInterfaceDesc *	GetDesc ()
Interface_ID	GetID ()
CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)
ActionTable *	GetActionTable ()
CoreExport void	EnableActions (BOOL onOff)
virtual CoreExport HINSTANCE	HInstance ()
virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)
Public Member Functions inherited from FPInterface
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDesc ()=0
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)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
static UtilExport void *	operator 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID
MSTR	internal_name
StringResID	description
ClassDesc *	cd
USHORT	flags
Tab< FPFunctionDef * >	functions
Tab< FPPropDef * >	props
Tab< FPEnum * >	enumerations
MSPluginClass *	pc
Rollout *	rollout
ActionTable *	action_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)

Detailed Description

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

Member Enumeration Documentation

LightingSystems

enum LightingSystems

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

                         {
        DISPLAY_INTERNATIONAL,
        DISPLAY_AMERICAN,
        DISPLAY_TYPE_COUNT
    };

Member Function Documentation

GetFirstLightingSystemName()

virtual const MCHAR * GetFirstLightingSystemName ( ) const

pure virtual

For internal use.

GetNextLightingSystemName()

virtual const MCHAR * GetNextLightingSystemName ( ) const

pure virtual

For internal use.

GetLightingSystem()

virtual LightingSystems GetLightingSystem ( ) const

pure virtual

Returns the unit system currently being used for display.

SetLightingSystem()

virtual void SetLightingSystem ( LightingSystems  system )

pure virtual

Sets the unit system to be used for display.

GetLuminanceUnits()

virtual const MCHAR * GetLuminanceUnits ( ) const

pure virtual

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

GetIlluminanceUnits()

virtual const MCHAR * GetIlluminanceUnits ( ) const

pure virtual

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

ConvertValue()

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.

ConvertToDisplay()

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.

ConvertFromDisplay()

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.

ConvertLuminanceToCurrSystem() [1/2]

virtual double ConvertLuminanceToCurrSystem ( double  luminanceValue ) const

pure virtual

Deprecated:

Use ConvertToDisplay().

ConvertLuminanceToCurrSystem() [2/2]

virtual double ConvertLuminanceToCurrSystem ( double  luminanceValue, int  inputType  ) const

pure virtual

Deprecated:

Use ConvertToDisplay().

ConvertLuminanceToSI()

virtual double ConvertLuminanceToSI ( double  AS_LuminanceValue ) const

pure virtual

Deprecated:

Use ConvertValue().

ConvertLuminanceToAS()

virtual double ConvertLuminanceToAS ( double  SI_LuminanceValue ) const

pure virtual

Deprecated:

Use ConvertValue().

ConvertIlluminanceToCurrSystem() [1/2]

virtual double ConvertIlluminanceToCurrSystem ( double  illuminanceValue ) const

pure virtual

Deprecated:

Use ConvertToDisplay().

ConvertIlluminanceToCurrSystem() [2/2]

virtual double ConvertIlluminanceToCurrSystem ( double  illuminanceValue, int  inputType  ) const

pure virtual

Deprecated:

Use ConvertToDisplay().

ConvertIlluminanceToSI()

virtual double ConvertIlluminanceToSI ( double  AS_IlluminanceValue ) const

pure virtual

Deprecated:

Use ConvertValue().

ConvertIlluminanceToAS()

virtual double ConvertIlluminanceToAS ( double  SI_IlluminanceValue ) const

pure virtual

Deprecated:

Use ConvertValue().

GetLightingUnitDisplayInfo()

virtual LightDispInfo GetLightingUnitDisplayInfo ( ) const

pure virtual

Retrieves the display unit currently in use for lighting quantities.