IMRPhysicalSkyInterface2 Class Reference

Search for all occurrences

---

Detailed Description

Access to additional fucntionality for the Mental Ray Physical Sky object.

This class represents additional functionality to the Mental Ray Physical Sky object. Given a pointer to a skylight object, one can get this interfaces as follows:

Object* skylight = // obtain a pointer to an object
BaseInterface* skyInteface = skylight->GetInterface(MRPHYSSKY_LIGHT_INTERFACECLASS2_ID);
IMRPhysicalSkyInterface2* physSkyInterface = dynamic_cast<IMRPhysicalSkyInterface2*>(skyInterface);

#include <imrPhysicalSkyLight.h>

Inheritance diagram for IMRPhysicalSkyInterface2:

List of all members.

Public Member Functions
virtual Interface_ID	GetID ()
	Returns the Interface ID of this interface.
CIE Direct Normal Illuminance
The direct normal illuminance value used by the CIE Sky Model. This value will drive a MR Sun object if one exists in the same daylight system as the sky object
virtual float	getCIEDirectNormalIlluminance (TimeValue &t, Interval &valid) const =0
	Gets the CIE direct normal illuminance value.
virtual bool	setCIEDirectNormalIlluminance (TimeValue t, float CIEDirectNormalIlluminance)=0
	Sets the CIE direct normal illuminance value.

---

Member Function Documentation

virtual Interface_ID GetID

(

)

[inline, virtual]

Search for all occurrences

Returns the Interface ID of this interface.

Reimplemented from IMRPhysicalSkyInterface.

{ return MRPHYSSKY_LIGHT_INTERFACECLASS2_ID; }

virtual float getCIEDirectNormalIlluminance	(	TimeValue &	t,
		Interval &	valid
	)		const [pure virtual]

Search for all occurrences

Gets the CIE direct normal illuminance value.

Parameters:

[in]	t	- The time at which we're getting the direct normal illuminance for the CIE model
[in]	valid	- The interval at which we're getting the direct normal illuminance for the CIE model

Returns:

The direct normal illuminance value used by the CIE model

virtual bool setCIEDirectNormalIlluminance	(	TimeValue	t,
		float	CIEDirectNormalIlluminance
	)		[pure virtual]

Search for all occurrences

Sets the CIE direct normal illuminance value.

Parameters:

[in]	t	- The time at which we are setting the CIE direct normal illuminance
[in]	CIEDirectNormalIlluminance	- The value that the CIE direct normal illuminance will be set to

Returns:

true if the setting was successful, false otherwise