IEffectManager Class Reference

The Effect Manager is responsible for displaying effect parameters. In 3ds Max this is implemented by the DirectX 9 Material. More...

#include <RTMax.h>

Inheritance diagram for IEffectManager:

Public Types
enum	{ kDirectX9 , kDirectX10 }

Public Member Functions
virtual	~IEffectManager ()
	Destructor.
virtual void	SetFloatParam (D3DXHANDLE handle, const MCHAR *paramName, const MCHAR *uiName, float val, float min, float max, float step, MaxSemantics semantic)=0
	Display a floating point value in the Dialog box.
virtual void	SetIntParam (D3DXHANDLE handle, const MCHAR *paramName, const MCHAR *uiName, int val, int min, int max, int step, MaxSemantics semantic)=0
	Display an integer value in the Dialog box.
virtual void	SetColorParam (D3DXHANDLE handle, const MCHAR *paramName, const MCHAR *uiName, D3DXVECTOR4 color, MaxSemantics semantic)=0
	Display a color value in the Dialog box.
virtual void	SetPoint4Param (D3DXHANDLE handle, const MCHAR *paramName, const MCHAR *uiName, D3DXVECTOR4 val, float min, float max, float step, MaxSemantics semantic)=0
	Display a D3DVECTOR4 value in the Dialog box.
virtual void	SetBooleanParam (D3DXHANDLE handle, const MCHAR *paramName, const MCHAR *uiName, BOOL val, MaxSemantics semantic)=0
	Display a boolean value in the Dialog box.
virtual void	SetTextureParam (D3DXHANDLE handle, const MCHAR *paramName, const MCHAR *uiName, const MCHAR *filename, MaxSemantics semantic, bool mappingEnabled=false, int mappingChannel=1)=0
	Display a bitmap selection button.
virtual void	SetLightParam (D3DXHANDLE handle, const MCHAR *paramName, const MCHAR *uiName, bool target, MaxSemantics semantic)=0
	Display a Light selection box, or provide access to lights based on the parameter.
virtual void	SetTransformParam (D3DXHANDLE handle, MaxSemantics semantic)=0
	Non UI Element used to set various transforms defined in the effect file.
virtual void	SetGeometryParam (D3DXHANDLE handle, MaxSemantics semantic)=0
	Non UI Element used to set various geometry based data defined in the effect file.
virtual void	SetEnvironmentParam (D3DXHANDLE handle, MaxSemantics semantic)=0
	Non UI Element used to set various environmental based data defined in the effect file.
virtual void	SetTechnique (D3DXHANDLE handle, const MCHAR *techniqueName, bool bDefault)=0
	Set the techniques used in the effect file.
virtual UINT	GetDirectXVersion ()=0
	Get the current DirectX version.

Additional Inherited Members
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.

Detailed Description

The Effect Manager is responsible for displaying effect parameters. In 3ds Max this is implemented by the DirectX 9 Material.

All parameters except textures are handled by the Effect Manager. This includes setting the data on the render pass. Textures are controlled by the Effect Parser, as the the parser understands the usage, the manager simply provided the resource name from the UI It is the managers responsibility to make sure the data is set for each pass. This may or may not mean providing a UI, but the methods provide enough hints to be able to implement this.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kDirectX9
kDirectX10

        {
        kDirectX9,
        kDirectX10,
    };

Constructor & Destructor Documentation

~IEffectManager()

virtual ~IEffectManager ( )

inlinevirtual

Destructor.

{;}

Member Function Documentation

SetFloatParam()

virtual void SetFloatParam ( D3DXHANDLE  handle, const MCHAR *  paramName, const MCHAR *  uiName, float  val, float  min, float  max, float  step, MaxSemantics  semantic  )

pure virtual

Display a floating point value in the Dialog box.

Parameters

handle	The handle to the parameter in the effect file
paramName	The name of the actual parameter. This will be used in the paramblock
uiName	The name to be displayed in the Dialog box
val	The default value
min	The minimum value for the UI control
max	The maximum value for the UI control
step	The increment value for the UI control
semantic	The semantic of the parameter.

SetIntParam()

virtual void SetIntParam ( D3DXHANDLE  handle, const MCHAR *  paramName, const MCHAR *  uiName, int  val, int  min, int  max, int  step, MaxSemantics  semantic  )

pure virtual

Display an integer value in the Dialog box.

Parameters

handle	The handle to the parameter in the effect file
paramName	The name of the actual parameter. This will be used in the paramblock
uiName	The name to be displayed in the Dialog box
val	The default value
min	The minimum value for the UI control
max	The maximum value for the UI control
step	The increment value for the UI control
semantic	The semantic of the parameter.

SetColorParam()

virtual void SetColorParam ( D3DXHANDLE  handle, const MCHAR *  paramName, const MCHAR *  uiName, D3DXVECTOR4  color, MaxSemantics  semantic  )

pure virtual

Display a color value in the Dialog box.

This will be a standard 3ds Max color swatch

Parameters

handle	The handle to the parameter in the effect file
paramName	The name of the actual parameter. This will be used in the paramblock
uiName	The name to be displayed in the Dialog box
color	The default color to display
semantic	The semantic of the parameter.

SetPoint4Param()

virtual void SetPoint4Param ( D3DXHANDLE  handle, const MCHAR *  paramName, const MCHAR *  uiName, D3DXVECTOR4  val, float  min, float  max, float  step, MaxSemantics  semantic  )

pure virtual

Display a D3DVECTOR4 value in the Dialog box.

This will be 4 3ds Max spinner UI elements

Parameters

handle	The handle to the parameter in the effect file
paramName	The name of the actual parameter. This will be used in the paramblock
uiName	The name to be displayed in the Dialog box
val	The default value
min	The minimum value for the UI control
max	The maximum value for the UI control
step	The increment value for the UI control
semantic	The semantic of the parameter.

SetBooleanParam()

virtual void SetBooleanParam ( D3DXHANDLE  handle, const MCHAR *  paramName, const MCHAR *  uiName, BOOL  val, MaxSemantics  semantic  )

pure virtual

Display a boolean value in the Dialog box.

This will be a standard 3ds Max check box

Parameters

handle	The handle to the parameter in the effect file
paramName	The name of the actual parameter. This will be used in the paramblock
uiName	The name to be displayed in the Dialog box
val	The default color to display
semantic	The semantic of the parameter.

SetTextureParam()

virtual void SetTextureParam ( D3DXHANDLE  handle, const MCHAR *  paramName, const MCHAR *  uiName, const MCHAR *  filename, MaxSemantics  semantic, bool  mappingEnabled = false, int  mappingChannel = 1  )

pure virtual

Display a bitmap selection button.

Parameters

handle	The handle to the parameter in the effect file
paramName	The name of the actual parameter. This will be used in the paramblock
uiName	The name to be displayed in the Dialog box
filename	The default filename to display
semantic	The semantic of the parameter. This is defined in the effect file and is used for render to texture.
mappingEnabled	Specifies whether the mapping channel UI should be shown for the texture
mappingChannel	This provides the default mapping channel to use.

SetLightParam()

virtual void SetLightParam ( D3DXHANDLE  handle, const MCHAR *  paramName, const MCHAR *  uiName, bool  target, MaxSemantics  semantic  )

pure virtual

Display a Light selection box, or provide access to lights based on the parameter.

Parameters

handle	The handle to the parameter in the effect file
paramName	The name of the actual parameter. This will be used in the paramblock
uiName	The name to be displayed in the Dialog box
target	Specifies if the light is a directional light. This is used to filter the UI light list.
semantic	The semantic of the parameter.

SetTransformParam()

virtual void SetTransformParam ( D3DXHANDLE  handle, MaxSemantics  semantic  )

pure virtual

Non UI Element used to set various transforms defined in the effect file.

Parameters

handle	The handle to the parameter in the effect file
semantic	The semantic of the transform to set.

SetGeometryParam()

virtual void SetGeometryParam ( D3DXHANDLE  handle, MaxSemantics  semantic  )

pure virtual

Non UI Element used to set various geometry based data defined in the effect file.

Parameters

handle	The handle to the parameter in the effect file
semantic	The semantic of the transform to set.

SetEnvironmentParam()

virtual void SetEnvironmentParam ( D3DXHANDLE  handle, MaxSemantics  semantic  )

pure virtual

Non UI Element used to set various environmental based data defined in the effect file.

Parameters

handle	The handle to the parameter in the effect file
semantic	The semantic of the transform to set.

SetTechnique()

virtual void SetTechnique ( D3DXHANDLE  handle, const MCHAR *  techniqueName, bool  bDefault  )

pure virtual

Set the techniques used in the effect file.

The default is used as the primary technique especially for multi pass effects

Parameters

handle	The handle to the technique
techniqueName	The name to display in the UI
bDefault	The default technique to used

GetDirectXVersion()

virtual UINT GetDirectXVersion ( )

pure virtual

Get the current DirectX version.

Currently this will ONLY return kDirectX9

Returns

This will return kDirectX9. In the future this could also be kDirectX10