INaturalLightClass Class Reference
 
 
 
INaturalLightClass Class Reference

#include <naturalLight.h>

Inheritance diagram for INaturalLightClass:
FPStaticInterface FPInterfaceDesc FPInterface BaseInterface InterfaceServer MaxHeapOperators NaturalLightClassBaseImp

Class Description



class INaturalLightClass: public BaseInterface

Description:
This class is only available in release 5 or later.

INaturalLightClass is a static interface that is attached to the class descriptors for light classes that wish to advertise that they represent either skylight or sunlight on the surface of the earth.

It is used by the Daylight System, to populate it's UI with the classes that describe themselves as naturalLight. This is an example of the way it is used.

void addClassToCombo(ClassDesc* pCd, HWND sunCombo, HWND skyCombo)

{

INaturalLightClass* pNC;

pNC = GetNaturalLightClassInterface(pCd);

if (pNC != NULL) {

if (pNC->IsSun()) {

addLightToCombo(sunCombo, pCd->ClassName(), pCd);

}

if (pNC->IsSky()) {

addLightToCombo(skyCombo, pCd->ClassName(), pCd);

}

}

}

Public Types

enum   { natLightIsSun = 0, natLightIsSky = 1 }

Public Member Functions

BEGIN_FUNCTION_MAP virtual
END_FUNCTION_MAP BOOL 
IsSun () const =0
virtual BOOL  IsSky () const =0

Member Enumeration Documentation

anonymous enum

Member Function Documentation

BEGIN_FUNCTION_MAP virtual END_FUNCTION_MAP BOOL IsSun ( ) const [pure virtual]
Remarks:
Returns whether the light is a "Sun" light.

virtual BOOL IsSky ( ) const [pure virtual]
Remarks:
Returns whether the light is a "Sky" light