IRadiosityPreferences Class Reference

Search for all occurrences

---

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.

#include <IRadiosityPreferences.h>

Inheritance diagram for IRadiosityPreferences:

List of all members.

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.
virtual void	SetUseRadiosity (BOOL val)=0
virtual BOOL	GetComputeRadiosity () const =0
virtual void	SetComputeRadiosity (BOOL val)=0

---

Member Function Documentation

virtual BOOL GetAutoProcessObjectRefine

(

)

const [pure virtual]

Search for all occurrences

Remarks:

Returns the state of the checkbox "Automatically Process Refine Iterations Stored in Geometric Objects", in the preferences dialog Advanced Lighting tab

virtual void SetAutoProcessObjectRefine

(

BOOL

val

)

[pure virtual]

Search for all occurrences

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.

virtual BOOL GetDisplayReflectanceInMEditor

(

)

const [pure virtual]

Search for all occurrences

Remarks:

Returns the state of the checkbox "Display Reflectance \& Transmittance Information", in the preferences dialog Advanced Lighting tab

virtual void SetDisplayReflectanceInMEditor

(

BOOL

val

)

[pure virtual]

Search for all occurrences

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.

virtual BOOL GetDisplayInViewport

(

)

const [pure virtual]

Search for all occurrences

Remarks:

Returns the state of the checkbox "Display Radiosity in Viewports", in the preferences dialog Advanced Lighting tab

virtual void SetDisplayInViewport

(

BOOL

val

)

[pure virtual]

Search for all occurrences

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.

virtual BOOL GetDisplayResetWarning

(

)

const [pure virtual]

Search for all occurrences

Remarks:

Returns the state of the checkbox "Display Reset Warning", in the preferences dialog Advanced Lighting tab

virtual void SetDisplayResetWarning

(

BOOL

val

)

[pure virtual]

Search for all occurrences

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.

virtual BOOL GetUpdateDataWhenRequiredOnStart

(

)

const [pure virtual]

Search for all occurrences

virtual void SetUpdateDataWhenRequiredOnStart

(

BOOL

val

)

[pure virtual]

Search for all occurrences

virtual BOOL GetSaveScene

(

)

const [pure virtual]

Search for all occurrences

Remarks:

Returns the state of the checkbox "Save Scene Information in MAX File", in the preferences dialog Advanced Lighting tab

virtual void SetSaveScene

(

BOOL

val

)

[pure virtual]

Search for all occurrences

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.

virtual BOOL GetUseRadiosity

(

)

const [pure virtual]

Search for all occurrences

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

virtual void SetUseRadiosity

(

BOOL

val

)

[pure virtual]

Search for all occurrences

Remarks:

Sets the state of the "Use Advanced Lighting" checkbox in the render dialog

Parameters:

BOOL val

TRUE for on; FALSE for off.

virtual BOOL GetComputeRadiosity

(

)

const [pure virtual]

Search for all occurrences

Remarks:

Returns the state of the "Compute Advanced Lighting when Required" checkbox in the render dialog

virtual void SetComputeRadiosity

(

BOOL

val

)

[pure virtual]

Search for all occurrences

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.