#include <imrPhysicalSkyEnvironmentMap.h>

Class 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);

Inheritance diagram for IMRPhysicalSkyEnvironmentMap:

Public Member Functions
virtual Interface_ID	GetID ()
	Returns the Interface ID of this interface. More...

virtual	~IMRPhysicalSkyEnvironmentMap ()
	A virtual destructor for the interface. More...

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. More...

virtual bool	setInheritFromSky (TimeValue t, bool inherits)=0
	Sets whether or not the environment map inherits from mrSky. More...

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. More...

virtual bool	setBackgroundEnabled (TimeValue t, bool enableBackground)=0
	Sets the boolean value of the background being enabled. More...

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. More...

virtual bool	setSunDiskIntensity (TimeValue t, float sunDiskIntensity)=0
	Sets the intensity of the sun's disk. More...

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. More...

virtual bool	setSunDiskScale (TimeValue t, float sunDiskScale)=0
	Sets the scale of the sun. More...

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. More...

virtual bool	setSunGlowIntensity (TimeValue t, float sunGlowIntensity)=0
	Sets the intensity of the sun's glow. More...

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. More...

virtual bool	setBackground (TimeValue t, Texmap *background)=0
	Sets the background of the scene. More...

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

UtilExport BaseInterface *	GetInterface (Interface_ID id)

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=NULL)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

Constructor & Destructor Documentation

virtual ~IMRPhysicalSkyEnvironmentMap ( )

inlinevirtual

A virtual destructor for the interface.

56 {};

Member Function Documentation

virtual Interface_ID GetID ( )

inlinevirtual

Returns the Interface ID of this interface.

Reimplemented from BaseInterface.

Reimplemented in IMRPhysicalSkyEnvironmentMap2.

53 { return IID_MR_PHYSICAL_SKY_ENV_MAP; };

IID_MR_PHYSICAL_SKY_ENV_MAP

#define IID_MR_PHYSICAL_SKY_ENV_MAP

Interface id for the Mental Ray Physical Sky Environment Map object.

Definition: imrPhysicalSkyEnvironmentMap.h:34

virtual bool getInheritFromSky	(	TimeValue &	t,
		Interval &	valid
	)		const

pure virtual

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

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

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

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

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

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

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

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

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

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

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

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

Class Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation