3ds Max C++ API Reference
IRadiosityPreferences Class Referenceabstract

#include <IRadiosityPreferences.h>

+ Inheritance diagram for IRadiosityPreferences:

Public Member Functions

virtual BOOL GetAutoProcessObjectRefine () const =0
 
virtual void SetAutoProcessObjectRefine (BOOL val)=0
 
virtual BOOL GetDisplayReflectanceInMEditor () const =0
 
virtual void SetDisplayReflectanceInMEditor (BOOL val)=0
 
virtual BOOL GetDisplayInViewport () const =0
 
virtual void SetDisplayInViewport (BOOL val)=0
 
virtual BOOL GetDisplayResetWarning () const =0
 
virtual void SetDisplayResetWarning (BOOL val)=0
 
virtual BOOL GetUpdateDataWhenRequiredOnStart () const =0
 
virtual void SetUpdateDataWhenRequiredOnStart (BOOL val)=0
 
virtual BOOL GetSaveScene () const =0
 
virtual void SetSaveScene (BOOL val)=0
 
virtual BOOL GetUseRadiosity () const =0
 The functions below provide access to current radiosity settings. More...
 
virtual void SetUseRadiosity (BOOL val)=0
 
virtual BOOL GetComputeRadiosity () const =0
 
virtual void SetComputeRadiosity (BOOL val)=0
 
- Public Member Functions inherited from FPInterfaceDesc
CoreExport FPInterfaceDesc ()
 
CoreExport FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...)
 
CoreExport ~FPInterfaceDesc ()
 
virtual void Init ()
 
LifetimeType LifetimeControl ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
CoreExport void LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...)
 
CoreExport void AppendFunction (int id,...)
 Add a new function to this interface descriptor. More...
 
CoreExport void AppendProperty (int id,...)
 Add a new property to this interface descriptor. More...
 
CoreExport void AppendEnum (int id,...)
 Add a new enum to this interface descriptor. More...
 
CoreExport void SetClassDesc (ClassDesc *i_cd)
 
CoreExport va_list check_fn (va_list ap, int id)
 
CoreExport va_list scan_fn (va_list ap, int id, int index)
 
CoreExport va_list check_prop (va_list ap, int id)
 
CoreExport va_list scan_prop (va_list ap, int id, int index)
 
CoreExport va_list check_enum (va_list ap, EnumID id)
 
CoreExport va_list scan_enum (va_list ap, EnumID id, int index)
 
FPInterfaceDescGetDesc ()
 
Interface_ID GetID ()
 
CoreExport FPFunctionDefGetFnDef (FunctionID fid)
 
ActionTableGetActionTable ()
 
CoreExport void EnableActions (BOOL onOff)
 
virtual CoreExport HINSTANCE HInstance ()
 
virtual CoreExport const MCHARGetRsrcString (StringResID id)
 
- Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPParams *params)
 
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
 
virtual CoreExport FunctionID FindFn (const MCHAR *name)
 
virtual CoreExport BOOL IsEnabled (FunctionID actionID)
 
virtual CoreExport BOOL IsChecked (FunctionID actionID)
 
virtual CoreExport BOOL IsVisible (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsEnabled (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsChecked (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsVisible (FunctionID actionID)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 

Additional Inherited Members

- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
 
- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 
- Public Attributes inherited from FPInterfaceDesc
Interface_ID ID
 
MSTR internal_name
 
StringResID description
 
ClassDesccd
 
USHORT flags
 
Tab< FPFunctionDef * > functions
 
Tab< FPPropDef * > props
 
Tab< FPEnum * > enumerations
 
MSPluginClasspc
 
Rolloutrollout
 
ActionTableaction_table
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Member Functions inherited from FPInterfaceDesc
CoreExport void load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 

Detailed Description

See also
: Class RadiosityEffect

Description:
This class is only available in release 5 or later.

This class defines the interface for accessing the Advanced Lighting Preferences from the 'Advanced Lighting' tab in the preferences dialog. It also provides access to the use/compute advanced lighting controls found in the Rendering dialog. This is a function-published static interface; you can use GetCOREInterface() to obtain an instance of the class, as follows:

IRadiosityPreferences* r = static_cast<IRadiosityPreferences*>(GetCOREInterface(IRADIOSITYPREFERENCES_INTERFACE));

This interface is also accessible via MAXScript as "<b>RadiosityPreferences</b>".

All methods of this class are implemented by the system.

Member Function Documentation

◆ GetAutoProcessObjectRefine()

virtual BOOL GetAutoProcessObjectRefine ( ) const
pure virtual
Remarks
Returns the state of the checkbox "Automatically Process Refine Iterations Stored in Geometric Objects", in the preferences dialog Advanced Lighting tab

◆ SetAutoProcessObjectRefine()

virtual void SetAutoProcessObjectRefine ( BOOL  val)
pure virtual
Remarks
Sets the state of the checkbox "Automatically Process Refine Iterations Stored in Geometric Objects", in the preferences dialog Advanced Lighting tab

Parameters:
BOOL val

TRUE for on; FALSE for off.

◆ GetDisplayReflectanceInMEditor()

virtual BOOL GetDisplayReflectanceInMEditor ( ) const
pure virtual
Remarks
Returns the state of the checkbox "Display Reflectance \& Transmittance Information", in the preferences dialog Advanced Lighting tab

◆ SetDisplayReflectanceInMEditor()

virtual void SetDisplayReflectanceInMEditor ( BOOL  val)
pure virtual
Remarks
Sets the state of the checkbox "Display Reflectance \& Transmittance Information", in the preferences dialog Advanced Lighting tab

Parameters:
BOOL val

TRUE for on; FALSE for off.

◆ GetDisplayInViewport()

virtual BOOL GetDisplayInViewport ( ) const
pure virtual
Remarks
Returns the state of the checkbox "Display Radiosity in Viewports", in the preferences dialog Advanced Lighting tab

◆ SetDisplayInViewport()

virtual void SetDisplayInViewport ( BOOL  val)
pure virtual
Remarks
Sets the state of the checkbox "Display Radiosity in Viewports", in the preferences dialog Advanced Lighting tab

Parameters:
BOOL val

TRUE for on; FALSE for off.

◆ GetDisplayResetWarning()

virtual BOOL GetDisplayResetWarning ( ) const
pure virtual
Remarks
Returns the state of the checkbox "Display Reset Warning", in the preferences dialog Advanced Lighting tab

◆ SetDisplayResetWarning()

virtual void SetDisplayResetWarning ( BOOL  val)
pure virtual
Remarks
Sets the state of the checkbox "Display Reset Warning", in the preferences dialog Advanced Lighting tab

Parameters:
BOOL val

TRUE for on; FALSE for off.

◆ GetUpdateDataWhenRequiredOnStart()

virtual BOOL GetUpdateDataWhenRequiredOnStart ( ) const
pure virtual

◆ SetUpdateDataWhenRequiredOnStart()

virtual void SetUpdateDataWhenRequiredOnStart ( BOOL  val)
pure virtual

◆ GetSaveScene()

virtual BOOL GetSaveScene ( ) const
pure virtual
Remarks
Returns the state of the checkbox "Save Scene Information in MAX File", in the preferences dialog Advanced Lighting tab

◆ SetSaveScene()

virtual void SetSaveScene ( BOOL  val)
pure virtual
Remarks
Sets the state of the checkbox "Save Scene Information in MAX File", in the preferences dialog Advanced Lighting tab

Parameters:
BOOL val

TRUE for on; FALSE for off.

◆ GetUseRadiosity()

virtual BOOL GetUseRadiosity ( ) const
pure virtual

The functions below provide access to current radiosity settings.

These properties are saved on a per file basis, so they are not written into the .ini file.

Remarks
Returns the state of the "Use Advanced Lighting" checkbox in the render dialog

◆ SetUseRadiosity()

virtual void SetUseRadiosity ( BOOL  val)
pure virtual
Remarks
Sets the state of the "Use Advanced Lighting" checkbox in the render dialog

Parameters:
BOOL val

TRUE for on; FALSE for off.

◆ GetComputeRadiosity()

virtual BOOL GetComputeRadiosity ( ) const
pure virtual
Remarks
Returns the state of the "Compute Advanced Lighting when Required" checkbox in the render dialog

◆ SetComputeRadiosity()

virtual void SetComputeRadiosity ( BOOL  val)
pure virtual
Remarks
Sets the state of the "Compute Advanced Lighting when Required" checkbox in the render dialog

Parameters:
BOOL val

TRUE for on; FALSE for off.