3ds Max C++ API Reference
Loading...
Searching...
No Matches
INodeMentalRayProperties Class Referenceabstract

Extension to INode for accessing mental ray properties. More...

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/INodeMentalRayProperties.h>

Inheritance diagram for INodeMentalRayProperties:

Public Types

enum  DisplacementMethod { kDisplacementMethod_Fine = 0 , kDisplacementMethod_Fine_NoSmoothing = 1 , kDisplacementMethod_Parametric = 2 }
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 Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

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.
 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)
Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
virtual LifetimeType LifetimeControl ()
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport ~FPMixinInterface ()
virtual BaseInterface * GetInterface (Interface_ID id)
virtual FPInterfaceDesc * GetDescByID (Interface_ID id)
virtual Interface_ID GetID ()
Public Member Functions inherited from FPInterface
virtual FPInterfaceDesc * GetDesc ()=0
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)
virtual ActionTable * GetActionTable ()
virtual void EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor.
virtual BaseInterface * AcquireInterface ()
virtual void ReleaseInterface ()
virtual void DeleteInterface ()
virtual BaseInterface * CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
template<class InterfaceType>
InterfaceType * GetTypedInterface ()

Static Public Member Functions

static INodeMentalRayProperties * Get_INodeMentalRayProperties (INode &node)
 Use this function to retrieve a pointer to the INodeMentalRayProperties interface.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void * operator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void * operator new (size_t size, void *placement_ptr)
 Placement new operator.
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator.
static UtilExport void * aligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
static UtilExport void * aligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary.
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Additional Inherited Members

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterface & operator= (const FPMixinInterface &rhs)
Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs

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.

Member Enumeration Documentation

◆ DisplacementMethod

enum DisplacementMethod
Enumerator
kDisplacementMethod_Fine 
kDisplacementMethod_Fine_NoSmoothing 
kDisplacementMethod_Parametric 
42 {
43 kDisplacementMethod_Fine = 0,
44 kDisplacementMethod_Fine_NoSmoothing = 1,
45 kDisplacementMethod_Parametric = 2,
46 };
INodeMentalRayProperties::kDisplacementMethod_Parametric
@ kDisplacementMethod_Parametric
Definition INodeMentalRayProperties.h:45
INodeMentalRayProperties::kDisplacementMethod_Fine
@ kDisplacementMethod_Fine
Definition INodeMentalRayProperties.h:43
INodeMentalRayProperties::kDisplacementMethod_Fine_NoSmoothing
@ kDisplacementMethod_Fine_NoSmoothing
Definition INodeMentalRayProperties.h:44

◆ CastModeFG

enum CastModeFG
Enumerator
kCastModeFG_ObjColor 
kCastModeFG_Black 
kCastModeFG_Invisible 
48 {
49 kCastModeFG_ObjColor = 0,
50 kCastModeFG_Black = 1,
51 kCastModeFG_Invisible =2
52 };
INodeMentalRayProperties::kCastModeFG_Black
@ kCastModeFG_Black
Definition INodeMentalRayProperties.h:50
INodeMentalRayProperties::kCastModeFG_ObjColor
@ kCastModeFG_ObjColor
Definition INodeMentalRayProperties.h:49
INodeMentalRayProperties::kCastModeFG_Invisible
@ kCastModeFG_Invisible
Definition INodeMentalRayProperties.h:51

◆ PROPERTY_ACCESSOR_ID

enum PROPERTY_ACCESSOR_ID
Enumerator
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 
156 {
157 GET_DISPLACEMENTUSEGLOBALSETTINGS,
158 SET_DISPLACEMENTUSEGLOBALSETTINGS,
159 GET_DISPLACEMENTMETHOD,
160 SET_DISPLACEMENTMETHOD,
161 GET_VIEWDEPENDENTDISPLACEMENT,
162 SET_VIEWDEPENDENTDISPLACEMENT,
163 GET_DISPLACEMENTEDGELENGTH,
164 SET_DISPLACEMENTEDGELENGTH,
165 GET_MAXDISPLACE,
166 SET_MAXDISPLACE,
167 GET_DISPLACEMENTMAXLEVEL,
168 SET_DISPLACEMENTMAXLEVEL,
169 GET_RECEIVEFGILLUM,
170 SET_RECEIVEFGILLUM,
171 GET_CASTMODEFGILLUM,
172 SET_CASTMODEFGILLUM,
173 GET_EXCLUDEGLOBALILLUM,
174 SET_EXCLUDEGLOBALILLUM,
175 GET_EXCLUDECAUSTICS,
176 SET_EXCLUDECAUSTICS
177 };
INodeMentalRayProperties::GET_DISPLACEMENTUSEGLOBALSETTINGS
@ GET_DISPLACEMENTUSEGLOBALSETTINGS
Definition INodeMentalRayProperties.h:157
INodeMentalRayProperties::SET_EXCLUDECAUSTICS
@ SET_EXCLUDECAUSTICS
Definition INodeMentalRayProperties.h:176
INodeMentalRayProperties::GET_DISPLACEMENTEDGELENGTH
@ GET_DISPLACEMENTEDGELENGTH
Definition INodeMentalRayProperties.h:163
INodeMentalRayProperties::SET_DISPLACEMENTMAXLEVEL
@ SET_DISPLACEMENTMAXLEVEL
Definition INodeMentalRayProperties.h:168
INodeMentalRayProperties::GET_VIEWDEPENDENTDISPLACEMENT
@ GET_VIEWDEPENDENTDISPLACEMENT
Definition INodeMentalRayProperties.h:161
INodeMentalRayProperties::GET_MAXDISPLACE
@ GET_MAXDISPLACE
Definition INodeMentalRayProperties.h:165
INodeMentalRayProperties::SET_EXCLUDEGLOBALILLUM
@ SET_EXCLUDEGLOBALILLUM
Definition INodeMentalRayProperties.h:174
INodeMentalRayProperties::SET_DISPLACEMENTMETHOD
@ SET_DISPLACEMENTMETHOD
Definition INodeMentalRayProperties.h:160
INodeMentalRayProperties::SET_MAXDISPLACE
@ SET_MAXDISPLACE
Definition INodeMentalRayProperties.h:166
INodeMentalRayProperties::SET_DISPLACEMENTUSEGLOBALSETTINGS
@ SET_DISPLACEMENTUSEGLOBALSETTINGS
Definition INodeMentalRayProperties.h:158
INodeMentalRayProperties::GET_DISPLACEMENTMETHOD
@ GET_DISPLACEMENTMETHOD
Definition INodeMentalRayProperties.h:159
INodeMentalRayProperties::SET_CASTMODEFGILLUM
@ SET_CASTMODEFGILLUM
Definition INodeMentalRayProperties.h:172
INodeMentalRayProperties::SET_DISPLACEMENTEDGELENGTH
@ SET_DISPLACEMENTEDGELENGTH
Definition INodeMentalRayProperties.h:164
INodeMentalRayProperties::GET_DISPLACEMENTMAXLEVEL
@ GET_DISPLACEMENTMAXLEVEL
Definition INodeMentalRayProperties.h:167
INodeMentalRayProperties::GET_CASTMODEFGILLUM
@ GET_CASTMODEFGILLUM
Definition INodeMentalRayProperties.h:171
INodeMentalRayProperties::SET_VIEWDEPENDENTDISPLACEMENT
@ SET_VIEWDEPENDENTDISPLACEMENT
Definition INodeMentalRayProperties.h:162
INodeMentalRayProperties::GET_RECEIVEFGILLUM
@ GET_RECEIVEFGILLUM
Definition INodeMentalRayProperties.h:169
INodeMentalRayProperties::SET_RECEIVEFGILLUM
@ SET_RECEIVEFGILLUM
Definition INodeMentalRayProperties.h:170
INodeMentalRayProperties::GET_EXCLUDEGLOBALILLUM
@ GET_EXCLUDEGLOBALILLUM
Definition INodeMentalRayProperties.h:173
INodeMentalRayProperties::GET_EXCLUDECAUSTICS
@ GET_EXCLUDECAUSTICS
Definition INodeMentalRayProperties.h:175

Member Function Documentation

◆ Get_INodeMentalRayProperties()

INodeMentalRayProperties * Get_INodeMentalRayProperties ( INode & node)
inlinestatic

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.
207 {
208
209 return static_cast<INodeMentalRayProperties*>(node.GetInterface(NODEMENTALRAYPROPERTIES_INTERFACE));
210}
NODEMENTALRAYPROPERTIES_INTERFACE
#define NODEMENTALRAYPROPERTIES_INTERFACE
The interface ID for class INodeMentalRayProperties.
Definition INodeMentalRayProperties.h:23
INode::GetInterface
BaseInterface * GetInterface(Interface_ID id)
Definition inode.h:1736

◆ CopyMentalRayPropertiesFrom()

virtual void CopyMentalRayPropertiesFrom ( const INodeMentalRayProperties & source)
pure virtual

Copy properties from another interface.

Parameters
[in]source- The properties to be copied.

◆ MRGetDisplacementUseGlobalSettings()

virtual bool MRGetDisplacementUseGlobalSettings ( ) const
pure virtual

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

Returns
The value of the flag.

◆ MRSetDisplacementUseGlobalSettings()

virtual void MRSetDisplacementUseGlobalSettings ( bool useGlobal)
pure virtual

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

Parameters
[in]useGlobal- The value to be set.

◆ MRGetDisplacementMethod()

virtual DisplacementMethod MRGetDisplacementMethod ( ) const
pure virtual

Gets the displacement method to be used.

Returns
The displacement method to be used.

◆ MRSetDisplacementMethod()

virtual void MRSetDisplacementMethod ( DisplacementMethod method)
pure virtual

Sets the displacement method to be used.

Parameters
[in]method- The displacement method.

◆ MRGetIsViewDependentDisplacement()

virtual bool MRGetIsViewDependentDisplacement ( ) const
pure virtual

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

Returns
The value of the flag.

◆ MRSetIsViewDependentDisplacement()

virtual void MRSetIsViewDependentDisplacement ( bool viewDependent)
pure virtual

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

Parameters
[in]viewDependent- The value to be set.

◆ MRGetDisplacementEdgeLength()

virtual float MRGetDisplacementEdgeLength ( ) const
pure virtual

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.

◆ MRSetDisplacementEdgeLength()

virtual void MRSetDisplacementEdgeLength ( float length)
pure virtual

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.

◆ MRGetMaxDisplace()

virtual float MRGetMaxDisplace ( ) const
pure virtual

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

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

◆ MRSetMaxDisplace()

virtual void MRSetMaxDisplace ( float maxDisplace)
pure virtual

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

Parameters
[in]maxDisplace- The value to be set.

◆ MRGetDisplacementMaxLevel()

virtual unsigned short MRGetDisplacementMaxLevel ( ) const
pure virtual

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

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

◆ MRSetDisplacementMaxLevel()

virtual void MRSetDisplacementMaxLevel ( unsigned short maxLevel)
pure virtual

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

Parameters
[in]maxLevel- The value to bet set.

◆ MRGetReceiveFGIllum()

virtual bool MRGetReceiveFGIllum ( ) const
pure virtual

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

Returns
The value of the flag.

◆ MRSetReceiveFGIllum()

virtual void MRSetReceiveFGIllum ( bool onOff)
pure virtual

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

Parameters
[in]onOff- The value to be set.

◆ MRGetCastModeFGIllum()

virtual CastModeFG MRGetCastModeFGIllum ( ) const
pure virtual

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.

◆ MRSetCastModeFGIllum()

virtual void MRSetCastModeFGIllum ( CastModeFG method)
pure virtual

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.

◆ MRGetExcludeGlobalIllum()

virtual bool MRGetExcludeGlobalIllum ( ) const
pure virtual

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

Returns
The value of the flag.

◆ MRSetExcludeGlobalIllum()

virtual void MRSetExcludeGlobalIllum ( bool onOff)
pure virtual

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

Parameters
[in]onOff- The value to be set.

◆ MRGetExcludeCaustics()

virtual bool MRGetExcludeCaustics ( ) const
pure virtual

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

Returns
The value of the flag.

◆ MRSetExcludeCaustics()

virtual void MRSetExcludeCaustics ( bool onOff)
pure virtual

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

Parameters
[in]onOff- The value to be set.

◆ PROP_FNS() [1/10]

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

◆ PROP_FNS() [2/10]

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

◆ PROP_FNS() [3/10]

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

◆ PROP_FNS() [4/10]

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

◆ PROP_FNS() [5/10]

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

◆ PROP_FNS() [6/10]

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

◆ PROP_FNS() [7/10]

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

◆ PROP_FNS() [8/10]

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

◆ PROP_FNS() [9/10]

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

◆ PROP_FNS() [10/10]

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