Detailed Description

Extension to INode for accessing mental ray properties.

This interface class defines a set of methods for accessing mental ray properties on an INode. To get a pointer to this interface from an INode, call:

INodeMentalRayProperties* mr_properties = Get_INodeMentalRayProperties(node);

The properties exposed by this class to the SDK are also exposed to MaxScript through the function publishing system.

#include <INodeMentalRayProperties.h>

Inheritance diagram for INodeMentalRayProperties:

[legend]

List of all members.

Public Types
enum	DisplacementMethod { kDisplacementMethod_Fine = 0, kDisplacementMethod_Fine_NoSmoothing = 1 }
enum	CastModeFG { kCastModeFG_ObjColor = 0, kCastModeFG_Black = 1, kCastModeFG_Invisible = 2 }
enum	PROPERTY_ACCESSOR_ID { GET_DISPLACEMENTUSEGLOBALSETTINGS, SET_DISPLACEMENTUSEGLOBALSETTINGS, GET_DISPLACEMENTMETHOD, SET_DISPLACEMENTMETHOD, GET_VIEWDEPENDENTDISPLACEMENT, SET_VIEWDEPENDENTDISPLACEMENT, GET_DISPLACEMENTEDGELENGTH, SET_DISPLACEMENTEDGELENGTH, GET_MAXDISPLACE, SET_MAXDISPLACE, GET_DISPLACEMENTMAXLEVEL, SET_DISPLACEMENTMAXLEVEL, GET_RECEIVEFGILLUM, SET_RECEIVEFGILLUM, GET_CASTMODEFGILLUM, SET_CASTMODEFGILLUM, GET_EXCLUDEGLOBALILLUM, SET_EXCLUDEGLOBALILLUM, GET_EXCLUDECAUSTICS, SET_EXCLUDECAUSTICS }
Public Member Functions
virtual void	CopyMentalRayPropertiesFrom (const INodeMentalRayProperties &source)=0
	Copy properties from another interface.
virtual bool	MRGetDisplacementUseGlobalSettings () const =0
	Gets the value of the "Use global displacement settings" flag.
virtual void	MRSetDisplacementUseGlobalSettings (bool useGlobal)=0
	Sets the value fo the "Use global displacement settings" flag.
virtual DisplacementMethod	MRGetDisplacementMethod () const =0
	Gets the displacement method to be used.
virtual void	MRSetDisplacementMethod (DisplacementMethod method)=0
	Sets the displacement method to be used.
virtual bool	MRGetIsViewDependentDisplacement () const =0
	Gets the value of the "View-Dependent Displacement" flag.
virtual void	MRSetIsViewDependentDisplacement (bool viewDependent)=0
	Sets the value of the "View-Dependent Displacement" flag.
virtual float	MRGetDisplacementEdgeLength () const =0
	Gets the value of the "Edge Length" property.
virtual void	MRSetDisplacementEdgeLength (float length)=0
	Sets the value of the "Edge Length" property.
virtual float	MRGetMaxDisplace () const =0
	Gets the value of the "Max. Displace" property.
virtual void	MRSetMaxDisplace (float maxDisplace)=0
	Sets the value of the "Max. Displace" property.
virtual unsigned short	MRGetDisplacementMaxLevel () const =0
	Gets the value of the "Displacement Max. Level" property.
virtual void	MRSetDisplacementMaxLevel (unsigned short maxLevel)=0
	Sets the value of the "Displacement Max. Level" property.
virtual bool	MRGetReceiveFGIllum () const =0
	Gets the value of the "Receive Illumination from Final Gather" flag.
virtual void	MRSetReceiveFGIllum (bool onOff)=0
	Sets the value of the "Receive Illumination from Final Gather" flag.
virtual CastModeFG	MRGetCastModeFGIllum () const =0
	Gets the mode for the "Cast Illumination from Final Gather" to be used.
virtual void	MRSetCastModeFGIllum (CastModeFG method)=0
	Sets the mode for the "Cast Illumination from Final Gather" to be used.
virtual bool	MRGetExcludeGlobalIllum () const =0
	Gets the value of the "Exclude from Global Illumination Calculations" flag.
virtual void	MRSetExcludeGlobalIllum (bool onOff)=0
	Sets the value of the "Exclude from Global Illumination Calculations" flag.
virtual bool	MRGetExcludeCaustics () const =0
	Gets the value of the "Exclude from Caustics Calculations" flag.
virtual void	MRSetExcludeCaustics (bool onOff)=0
	Sets the value of the "Exclude from Caustics Calculations" flag.
BEGIN_FUNCTION_MAP	PROP_FNS (GET_DISPLACEMENTUSEGLOBALSETTINGS, MRGetDisplacementUseGlobalSettings, SET_DISPLACEMENTUSEGLOBALSETTINGS, MRSetDisplacementUseGlobalSettings, TYPE_bool)
	PROP_FNS (GET_DISPLACEMENTMETHOD, MRGetDisplacementMethod, SET_DISPLACEMENTMETHOD, MRSetDisplacementMethod, TYPE_ENUM)
	PROP_FNS (GET_VIEWDEPENDENTDISPLACEMENT, MRGetIsViewDependentDisplacement, SET_VIEWDEPENDENTDISPLACEMENT, MRSetIsViewDependentDisplacement, TYPE_bool)
	PROP_FNS (GET_DISPLACEMENTEDGELENGTH, MRGetDisplacementEdgeLength, SET_DISPLACEMENTEDGELENGTH, MRSetDisplacementEdgeLength, TYPE_FLOAT)
	PROP_FNS (GET_MAXDISPLACE, MRGetMaxDisplace, SET_MAXDISPLACE, MRSetMaxDisplace, TYPE_WORLD)
	PROP_FNS (GET_DISPLACEMENTMAXLEVEL, MRGetDisplacementMaxLevel, SET_DISPLACEMENTMAXLEVEL, MRSetDisplacementMaxLevel, TYPE_INT)
	PROP_FNS (GET_RECEIVEFGILLUM, MRGetReceiveFGIllum, SET_RECEIVEFGILLUM, MRSetReceiveFGIllum, TYPE_bool)
	PROP_FNS (GET_CASTMODEFGILLUM, MRGetCastModeFGIllum, SET_CASTMODEFGILLUM, MRSetCastModeFGIllum, TYPE_ENUM)
	PROP_FNS (GET_EXCLUDEGLOBALILLUM, MRGetExcludeGlobalIllum, SET_EXCLUDEGLOBALILLUM, MRSetExcludeGlobalIllum, TYPE_bool)
	PROP_FNS (GET_EXCLUDECAUSTICS, MRGetExcludeCaustics, SET_EXCLUDECAUSTICS, MRSetExcludeCaustics, TYPE_bool)
Static Public Member Functions
static INodeMentalRayProperties *	Get_INodeMentalRayProperties (INode &node)
	Use this function to retrieve a pointer to the INodeMentalRayProperties interface.

Member Enumeration Documentation

enum DisplacementMethod

Search for all occurrences

Enumerator:

kDisplacementMethod_Fine	Search for all occurrences
kDisplacementMethod_Fine_NoSmoothing	Search for all occurrences

                            {
        kDisplacementMethod_Fine = 0,
        kDisplacementMethod_Fine_NoSmoothing = 1
    };

enum CastModeFG

Search for all occurrences

Enumerator:

kCastModeFG_ObjColor	Search for all occurrences
kCastModeFG_Black	Search for all occurrences
kCastModeFG_Invisible	Search for all occurrences

                    {
        kCastModeFG_ObjColor = 0,
        kCastModeFG_Black = 1,
        kCastModeFG_Invisible =2
    };

enum PROPERTY_ACCESSOR_ID

Search for all occurrences

Enumerator:

GET_DISPLACEMENTUSEGLOBALSETTINGS	Search for all occurrences
SET_DISPLACEMENTUSEGLOBALSETTINGS	Search for all occurrences
GET_DISPLACEMENTMETHOD	Search for all occurrences
SET_DISPLACEMENTMETHOD	Search for all occurrences
GET_VIEWDEPENDENTDISPLACEMENT	Search for all occurrences
SET_VIEWDEPENDENTDISPLACEMENT	Search for all occurrences
GET_DISPLACEMENTEDGELENGTH	Search for all occurrences
SET_DISPLACEMENTEDGELENGTH	Search for all occurrences
GET_MAXDISPLACE	Search for all occurrences
SET_MAXDISPLACE	Search for all occurrences
GET_DISPLACEMENTMAXLEVEL	Search for all occurrences
SET_DISPLACEMENTMAXLEVEL	Search for all occurrences
GET_RECEIVEFGILLUM	Search for all occurrences
SET_RECEIVEFGILLUM	Search for all occurrences
GET_CASTMODEFGILLUM	Search for all occurrences
SET_CASTMODEFGILLUM	Search for all occurrences
GET_EXCLUDEGLOBALILLUM	Search for all occurrences
SET_EXCLUDEGLOBALILLUM	Search for all occurrences
GET_EXCLUDECAUSTICS	Search for all occurrences
SET_EXCLUDECAUSTICS	Search for all occurrences

                              {
        GET_DISPLACEMENTUSEGLOBALSETTINGS,
        SET_DISPLACEMENTUSEGLOBALSETTINGS,
        GET_DISPLACEMENTMETHOD,
        SET_DISPLACEMENTMETHOD,
        GET_VIEWDEPENDENTDISPLACEMENT,
        SET_VIEWDEPENDENTDISPLACEMENT,
        GET_DISPLACEMENTEDGELENGTH,
        SET_DISPLACEMENTEDGELENGTH,
        GET_MAXDISPLACE,
        SET_MAXDISPLACE,
        GET_DISPLACEMENTMAXLEVEL,
        SET_DISPLACEMENTMAXLEVEL,
        GET_RECEIVEFGILLUM,
        SET_RECEIVEFGILLUM,
        GET_CASTMODEFGILLUM,
        SET_CASTMODEFGILLUM,
        GET_EXCLUDEGLOBALILLUM,
        SET_EXCLUDEGLOBALILLUM,
        GET_EXCLUDECAUSTICS,
        SET_EXCLUDECAUSTICS
    };

Member Function Documentation

INodeMentalRayProperties * Get_INodeMentalRayProperties ( INode & node ) [inline, static]

Search for all occurrences

Use this function to retrieve a pointer to the INodeMentalRayProperties interface.

Parameters:

[in] node - The node on which you want to query the interface.

Returns:: A pointer to the interface. May be NULL if the interface is not supported by this release.

                                                                                                   {

    return static_cast<INodeMentalRayProperties*>(node.GetInterface(NODEMENTALRAYPROPERTIES_INTERFACE));
}

virtual void CopyMentalRayPropertiesFrom ( const INodeMentalRayProperties & source ) [pure virtual]

Search for all occurrences

Copy properties from another interface.

Parameters:

[in] source - The properties to be copied.

virtual bool MRGetDisplacementUseGlobalSettings ( ) const [pure virtual]

Search for all occurrences

Gets the value of the "Use global displacement settings" flag.

Returns:: The value of the flag.

virtual void MRSetDisplacementUseGlobalSettings ( bool useGlobal ) [pure virtual]

Search for all occurrences

Sets the value fo the "Use global displacement settings" flag.

Parameters:

[in] useGlobal - The value to be set.

virtual DisplacementMethod MRGetDisplacementMethod ( ) const [pure virtual]

Search for all occurrences

Gets the displacement method to be used.

Returns:: The displacement method to be used.

virtual void MRSetDisplacementMethod ( DisplacementMethod method ) [pure virtual]

Search for all occurrences

Sets the displacement method to be used.

Parameters:

[in] method - The displacement method.

virtual bool MRGetIsViewDependentDisplacement ( ) const [pure virtual]

Search for all occurrences

Gets the value of the "View-Dependent Displacement" flag.

Returns:: The value of the flag.

virtual void MRSetIsViewDependentDisplacement ( bool viewDependent ) [pure virtual]

Search for all occurrences

Sets the value of the "View-Dependent Displacement" flag.

Parameters:

[in] viewDependent - The value to be set.

virtual float MRGetDisplacementEdgeLength ( ) const [pure virtual]

Search for all occurrences

Gets the value of the "Edge Length" property.

Note: this value should be interpreted as pixels if the "view-dependent" flag is ON, and as object-space units if the "view-dependent" flag is OFF.

Returns:: The value of the "Edge Length" parameter.

virtual void MRSetDisplacementEdgeLength ( float length ) [pure virtual]

Search for all occurrences

Sets the value of the "Edge Length" property.

Note: this value should be interpreted as pixels if the "view-dependent" flag is ON, and as object-space units if the "view-dependent" flag is OFF.

Parameters:

[in] length - The value to be set.

virtual float MRGetMaxDisplace ( ) const [pure virtual]

Search for all occurrences

Gets the value of the "Max. Displace" property.

Returns:: The value of the "Max. Displace" property.

virtual void MRSetMaxDisplace ( float maxDisplace ) [pure virtual]

Search for all occurrences

Sets the value of the "Max. Displace" property.

Parameters:

[in] maxDisplace - The value to be set.

virtual unsigned short MRGetDisplacementMaxLevel ( ) const [pure virtual]

Search for all occurrences

Gets the value of the "Displacement Max. Level" property.

Returns:: The value of the "Displacement Max. Level" property.

virtual void MRSetDisplacementMaxLevel ( unsigned short maxLevel ) [pure virtual]

Search for all occurrences

Sets the value of the "Displacement Max. Level" property.

Parameters:

[in] maxLevel - The value to bet set.

virtual bool MRGetReceiveFGIllum ( ) const [pure virtual]

Search for all occurrences

Gets the value of the "Receive Illumination from Final Gather" flag.

Returns:: The value of the flag.

virtual void MRSetReceiveFGIllum ( bool onOff ) [pure virtual]

Search for all occurrences

Sets the value of the "Receive Illumination from Final Gather" flag.

Parameters:

[in] onOff - The value to be set.

virtual CastModeFG MRGetCastModeFGIllum ( ) const [pure virtual]

Search for all occurrences

Gets the mode for the "Cast Illumination from Final Gather" to be used.

Returns:: The mode to be used for FG Rays that hit the object.

virtual void MRSetCastModeFGIllum ( CastModeFG method ) [pure virtual]

Search for all occurrences

Sets the mode for the "Cast Illumination from Final Gather" to be used.

Parameters:

[in] method - The mode to be used for FG Rays that hit the object.

virtual bool MRGetExcludeGlobalIllum ( ) const [pure virtual]

Search for all occurrences

Gets the value of the "Exclude from Global Illumination Calculations" flag.

Returns:: The value of the flag.

virtual void MRSetExcludeGlobalIllum ( bool onOff ) [pure virtual]

Search for all occurrences

Sets the value of the "Exclude from Global Illumination Calculations" flag.

Parameters:

[in] onOff - The value to be set.

virtual bool MRGetExcludeCaustics ( ) const [pure virtual]

Search for all occurrences

Gets the value of the "Exclude from Caustics Calculations" flag.

Returns:: The value of the flag.

virtual void MRSetExcludeCaustics ( bool onOff ) [pure virtual]

Search for all occurrences

Sets the value of the "Exclude from Caustics Calculations" flag.

Parameters:

[in] onOff - The value to be set.

BEGIN_FUNCTION_MAP PROP_FNS	(	GET_DISPLACEMENTUSEGLOBALSETTINGS	,
		MRGetDisplacementUseGlobalSettings	,
		SET_DISPLACEMENTUSEGLOBALSETTINGS	,
		MRSetDisplacementUseGlobalSettings	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	GET_DISPLACEMENTMETHOD	,
		MRGetDisplacementMethod	,
		SET_DISPLACEMENTMETHOD	,
		MRSetDisplacementMethod	,
		TYPE_ENUM
	)

Search for all occurrences

PROP_FNS	(	GET_VIEWDEPENDENTDISPLACEMENT	,
		MRGetIsViewDependentDisplacement	,
		SET_VIEWDEPENDENTDISPLACEMENT	,
		MRSetIsViewDependentDisplacement	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	GET_DISPLACEMENTEDGELENGTH	,
		MRGetDisplacementEdgeLength	,
		SET_DISPLACEMENTEDGELENGTH	,
		MRSetDisplacementEdgeLength	,
		TYPE_FLOAT
	)

Search for all occurrences

PROP_FNS	(	GET_MAXDISPLACE	,
		MRGetMaxDisplace	,
		SET_MAXDISPLACE	,
		MRSetMaxDisplace	,
		TYPE_WORLD
	)

Search for all occurrences

PROP_FNS	(	GET_DISPLACEMENTMAXLEVEL	,
		MRGetDisplacementMaxLevel	,
		SET_DISPLACEMENTMAXLEVEL	,
		MRSetDisplacementMaxLevel	,
		TYPE_INT
	)

Search for all occurrences

PROP_FNS	(	GET_RECEIVEFGILLUM	,
		MRGetReceiveFGIllum	,
		SET_RECEIVEFGILLUM	,
		MRSetReceiveFGIllum	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	GET_CASTMODEFGILLUM	,
		MRGetCastModeFGIllum	,
		SET_CASTMODEFGILLUM	,
		MRSetCastModeFGIllum	,
		TYPE_ENUM
	)

Search for all occurrences

PROP_FNS	(	GET_EXCLUDEGLOBALILLUM	,
		MRGetExcludeGlobalIllum	,
		SET_EXCLUDEGLOBALILLUM	,
		MRSetExcludeGlobalIllum	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	GET_EXCLUDECAUSTICS	,
		MRGetExcludeCaustics	,
		SET_EXCLUDECAUSTICS	,
		MRSetExcludeCaustics	,
		TYPE_bool
	)

Search for all occurrences

INodeMentalRayProperties Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Member Enumeration Documentation

Member Function Documentation