IDaylightControlledLightSystem Class Reference

Search for all occurrences

#include <IDaylightControlledLightSystem.h>

Inheritance diagram for IDaylightControlledLightSystem:

List of all members.

Classes
struct	DaylightSimulationParams
	Set of parameters that may be fed by the daylight system to the controlled light. More...
Public Member Functions
virtual Interface_ID	GetID ()
	struct for passing in relevant values for a daylight
virtual	~IDaylightControlledLightSystem ()
	A virtual destructor for the interface.
virtual void	ControlledByDaylightSystem (IDaylightSystem2 *dls, bool val)=0
	Whether or not it's controlled by the daylight system.
virtual void	SetSimulationParams (IDaylightControlledLightSystem::DaylightSimulationParams &params)=0
	Function to set simulation parameters that may be used by the controlled light.

---

Constructor & Destructor Documentation

virtual ~IDaylightControlledLightSystem

(

)

[inline, virtual]

A virtual destructor for the interface.

{};

---

Member Function Documentation

virtual Interface_ID GetID

(

)

[inline, virtual]

Search for all occurrences

struct for passing in relevant values for a daylight

Returns the Interface ID of this interface

Reimplemented from BaseInterface.

{ return  DAYLIGHT_CONTROLLED_LIGHT_SYSTEM; };

virtual void ControlledByDaylightSystem	(	IDaylightSystem2 *	dls,
		bool	val
	)		[pure virtual]

Search for all occurrences

Whether or not it's controlled by the daylight system.

Parameters:

[in]

val

If true the light object is controlled by the daylight system and and should query the IDaylightSystem2 interface, in order to get any necessary illuminance,irradiance, temperature, etc. values.

See also:

IDaylightSystem2

virtual void SetSimulationParams

(

IDaylightControlledLightSystem::DaylightSimulationParams &

params

)

[pure virtual]

Search for all occurrences

Function to set simulation parameters that may be used by the controlled light.

Parameters:

[in]

params

Set of parameters that may be used by the controlled light to determine how it illuminates. Note that if any of the parameters have a value of IDCLS_ILLEGAL_VALUE then that parameter shouldn't be used in any calculations.