Detailed Description

Access interface for the Mental Ray Physical Sky Environment Map.

This class represents the Mental Ray Physical Sky Environment Map, implemented by 3ds Max. SDK client code can get this interface by querying 3ds Max for the current environment map, then asking that object for this interface:

Texmap* envMap = GetCOREInterface()->GetEnvironmentMap()
BaseInterface* envMapInterface = envMap->GetInterface(IID_MR_PHYSICAL_SKY_ENV_MAP);
IMRPhysicalSkyEnvironmentMap* mrEnvMap = dynamic_cast<IMRPhysicalSkyEnvironmentMap*>(envMapInterface);

#include <imrPhysicalSkyEnvironmentMap.h>

Inheritance diagram for IMRPhysicalSkyEnvironmentMap:

[legend]

List of all members.

Public Member Functions
virtual Interface_ID	GetID ()
	Returns the Interface ID of this interface.
virtual	~IMRPhysicalSkyEnvironmentMap ()
	A virtual destructor for the interface.
Inherit from mrSky
Uses the equivalent settings from the mrSky Parameters rollout for the remaining mr Physical Sky Parameters rollout settings, except for Aerial Perspective. Default=on.
virtual bool	getInheritFromSky (TimeValue &t, Interval &valid) const =0
	Gets whether or not the environment map inherits from mrSky.
virtual bool	setInheritFromSky (TimeValue t, bool inherits)=0
	Sets whether or not the environment map inherits from mrSky.
Background Enabled
When on but no background map is specified, the background of the rendering is transparent black, suitable for external compositing. If you supply a background shader by clicking the button and then specifying a map or shader, the background of the rendering will come from that shader (for example, a texture map that uses a background photograph). In either case the mr Physical Sky will still be visible in reflections and refraction.
virtual bool	getBackgroundEnabled (TimeValue &t, Interval &valid) const =0
	Gets the boolean value of the background being enabled.
virtual bool	setBackgroundEnabled (TimeValue t, bool enableBackground)=0
	Sets the boolean value of the background being enabled.
Sun Disk Intensity
The brightness of the sun.
virtual float	getSunDiskIntensity (TimeValue &t, Interval &valid) const =0
	Gets the intensity of the sun's disk.
virtual bool	setSunDiskIntensity (TimeValue t, float sunDiskIntensity)=0
	Sets the intensity of the sun's disk.
Sun Disk Scale
The size of the sun in the sky.
virtual float	getSunDiskScale (TimeValue &t, Interval &valid) const =0
	Gets the scale of the sun.
virtual bool	setSunDiskScale (TimeValue t, float sunDiskScale)=0
	Sets the scale of the sun.
Sun Glow Intensity
The brightness of the glow surrounding the sun.
virtual float	getSunGlowIntensity (TimeValue &t, Interval &valid) const =0
	Gets the intensity of the sun's glow.
virtual bool	setSunGlowIntensity (TimeValue t, float sunGlowIntensity)=0
	Sets the intensity of the sun's glow.
Background
The custom user specified background to be used as a background map in the scene.
virtual Texmap *	getBackground (TimeValue &t, Interval &valid) const =0
	Gets the current background being used.
virtual bool	setBackground (TimeValue t, Texmap *background)=0
	Sets the background of the scene.

Constructor & Destructor Documentation

virtual ~IMRPhysicalSkyEnvironmentMap ( ) [inline, virtual]

A virtual destructor for the interface.

{};

Member Function Documentation

virtual Interface_ID GetID ( ) [inline, virtual]

Search for all occurrences

Returns the Interface ID of this interface.

Reimplemented from BaseInterface.

{ return IID_MR_PHYSICAL_SKY_ENV_MAP; };

virtual bool getInheritFromSky	(	TimeValue &	t,
		Interval &	valid
	)		const `[pure virtual]`

Search for all occurrences

Gets whether or not the environment map inherits from mrSky.

Parameters:

[in]	t	- The time at which we're getting the value
[in]	valid	- The interval at which we're getting the value

Returns:: A boolean if we're inheriting from mrSky or not

virtual bool setInheritFromSky	(	TimeValue	t,
		bool	inherits
	)		`[pure virtual]`

Search for all occurrences

Sets whether or not the environment map inherits from mrSky.

Parameters:

[in]	t	- The time at which to set the value
[in]	inherits	- A boolean value of what whether or not we're inheriting from mrSky

Returns:: true if the setting was successful

virtual bool getBackgroundEnabled	(	TimeValue &	t,
		Interval &	valid
	)		const `[pure virtual]`

Search for all occurrences

Gets the boolean value of the background being enabled.

Parameters:

[in]	t	- The time at which we're getting the value
[in]	valid	- The interval at which we're getting the value

Returns:: The value of if the background is enabled or not

virtual bool setBackgroundEnabled	(	TimeValue	t,
		bool	enableBackground
	)		`[pure virtual]`

Search for all occurrences

Sets the boolean value of the background being enabled.

Parameters:

[in]	t	- The time at which to set the value
[in]	enableBackground	- The value of what to set the background being enabled to

Returns:: true if the setting was successful

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

Search for all occurrences

Gets the intensity of the sun's disk.

Parameters:

[in]	t	- The time at which we're getting the intensity
[in]	valid	- The interval at which we're getting intensity

Returns:: The value of the intensity

virtual bool setSunDiskIntensity	(	TimeValue	t,
		float	sunDiskIntensity
	)		`[pure virtual]`

Search for all occurrences

Sets the intensity of the sun's disk.

Parameters:

[in]	t	- The time at which to set the intensity
[in]	sunDiskIntensity	- The value of what to set the intensity to

Returns:: true if the setting was successful

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

Search for all occurrences

Gets the scale of the sun.

Parameters:

[in]	t	- The time at which we're getting the scale
[in]	valid	- The interval at which we're getting the scale

Returns:: The value of the scale

virtual bool setSunDiskScale	(	TimeValue	t,
		float	sunDiskScale
	)		`[pure virtual]`

Search for all occurrences

Sets the scale of the sun.

Parameters:

[in]	t	- The time at which to set the scale
[in]	sunDiskScale	- The value of what to set the scale to

Returns:: true if the setting was successful

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

Search for all occurrences

Gets the intensity of the sun's glow.

Parameters:

[in]	t	- The time at which we're getting the intensity
[in]	valid	- The interval at which we're getting the intensity

Returns:: The value of the intensity

virtual bool setSunGlowIntensity	(	TimeValue	t,
		float	sunGlowIntensity
	)		`[pure virtual]`

Search for all occurrences

Sets the intensity of the sun's glow.

Parameters:

[in]	t	- The time at which to set the intensity
[in]	sunGlowIntensity	- The value of what to set the intensity to

Returns:: true if the setting was successful

virtual Texmap* getBackground	(	TimeValue &	t,
		Interval &	valid
	)		const `[pure virtual]`

Search for all occurrences

Gets the current background being used.

Parameters:

[in]	t	- The time at which we're getting background
[in]	valid	- The interval at which we're getting the background

Returns:: A pointer to a texture map of the background

virtual bool setBackground	(	TimeValue	t,
		Texmap *	background
	)		`[pure virtual]`

Search for all occurrences

Sets the background of the scene.

Parameters:

[in]	t	- The time at which to set the background
[in]	background	- A pointer to a texture map of what to set the background to

Returns:: true if the setting was successful

IMRPhysicalSkyEnvironmentMap Class Reference

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation