IMRPhysicalSkyEnvironmentMap2 Class Reference

#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:

IMRPhysicalSkyEnvironmentMap* mrEnvMap = IMRPhysicalSkyEnvironmentMap2::GetThisInterface(GetCOREInterface()->GetEnvironmentMap());

Inheritance diagram for IMRPhysicalSkyEnvironmentMap2:

Classes
struct	ShadingParameters

Public Member Functions
virtual Interface_ID	GetID ()
	Returns the Interface ID of this interface. More...
virtual ShadingParameters	GetShadingParameters (const TimeValue t, Interval &valid)=0
	Fetches the various shading parameters of the sky environment. More...
Public Member Functions inherited from IMRPhysicalSkyEnvironmentMap
virtual	~IMRPhysicalSkyEnvironmentMap ()
	A virtual destructor for the interface. More...
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...
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...
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...
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...
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...
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...

Static Public Member Functions
static IMRPhysicalSkyEnvironmentMap2 *	GetThisInterface (InterfaceServer *server)
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...

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

Member Function Documentation

virtual Interface_ID GetID ( )

inlinevirtual

Returns the Interface ID of this interface.

Reimplemented from IMRPhysicalSkyEnvironmentMap.

{ return IID_MR_PHYSICAL_SKY_ENV_MAP2; }

static IMRPhysicalSkyEnvironmentMap2* GetThisInterface ( InterfaceServer *  server )

inlinestatic

    {
        return 
            (server != nullptr) 
            ? dynamic_cast<IMRPhysicalSkyEnvironmentMap2*>(server->GetInterface(IID_MR_PHYSICAL_SKY_ENV_MAP2)) 
            : nullptr;
    }

virtual ShadingParameters GetShadingParameters ( const TimeValue  t, Interval &  valid  )

pure virtual

Fetches the various shading parameters of the sky environment.

This method is used to fetch all the relevant shading parameters exposed by the sky environment map. It implements full support for the "inherit from scene Sun & Sky" parameter: if the inherit flag is set, this method will search the scene for Sun & Sky objects, will read its properties, and will return them instead of the sky environment's.

Parameters

[in]	t	- The time at which to evaluate the properties.
[in,out]	valid	- The validity interval, its input value being intersected with that of all fetched properties.

Returns

The structure containing all fetched parameter values.