IParameterManager Class Reference

A data management class for accessing data required for displaying real time effects. More...

#include <RTMax.h>

Inheritance diagram for IParameterManager:

Public Types
enum	{   kPType_Unknown , kPType_Float , kPType_Int , kPType_Bool ,   kPType_Point4 , kPType_Matrix , kPType_Color , kPType_Struct ,   kPType_Texture , kPType_Point3 }

Public Member Functions
virtual	~IParameterManager ()
	Destructor.
virtual int	GetNumberOfParams ()=0
	The total number of parameters maintained by the manager.
virtual MaxSemantics	GetParamSemantics (int index)=0
	The semantic for the parameter.
virtual const MCHAR *	GetParamName (int index)=0
	Retireve the name of the parameter.
virtual bool	GetParamData (LPVOID data, int index)=0
	Access to the actual data stored by the manager.
virtual bool	GetParamData (LPVOID data, const MCHAR *paramName)=0
	Access to the actual data stored by the manager.
virtual int	GetParamType (int index)=0
	Access the data type of the parameter.
virtual int	GetParamType (const MCHAR *parmName)=0
	Access the data type of the parameter.
virtual int	GetParamSize (int index)=0
	Access the data size of the parameter (mainly designed for kPType_Struct type)

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

A data management class for accessing data required for displaying real time effects.

An instance of this class is maintained by the DirectX 9 Shader material and is passed into the IEffectParser::PreRender() method. This allows the Effect Parsers to format the data accordingly based on the runtime active for the shader

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kPType_Unknown
kPType_Float
kPType_Int
kPType_Bool
kPType_Point4
kPType_Matrix
kPType_Color
kPType_Struct
kPType_Texture
kPType_Point3

        {
        kPType_Unknown,
        kPType_Float,
        kPType_Int,
        kPType_Bool,
        kPType_Point4,
        kPType_Matrix,
        kPType_Color,
        kPType_Struct,
        kPType_Texture,
        kPType_Point3,
    };

Constructor & Destructor Documentation

~IParameterManager()

virtual ~IParameterManager ( )

inlinevirtual

Destructor.

{;}

Member Function Documentation

GetNumberOfParams()

virtual int GetNumberOfParams ( )

pure virtual

The total number of parameters maintained by the manager.

Returns

The number of parameters

GetParamSemantics()

virtual MaxSemantics GetParamSemantics ( int  index )

pure virtual

The semantic for the parameter.

This will be the semantic usage found in the shader file when it is parsed by the system

Parameters

index

The index of the parameter to query

Returns

An item from MaxSemantics representing the semantic found in the file

GetParamName()

virtual const MCHAR * GetParamName ( int  index )

pure virtual

Retireve the name of the parameter.

This will be the name of the parameter found in the shader file

Parameters

index

The index of the parameter to query

Returns

A string containing the name

GetParamData() [1/2]

virtual bool GetParamData ( LPVOID  data, int  index  )

pure virtual

Access to the actual data stored by the manager.

This is the main access point for data retrieval. It is the calling code's responsibility to make sure there is enough space allocated to receive the data. This can be determined by calling GetParamType, which will return the data type. If it is a kPtype_Matrix, then internally this is stored as an 4x4 float array

Parameters

data	A pointer to a buffer to receive the data
index	THe index of the parameter to query

Returns

True/False depending if the parameter was found, and the data copied correctly

GetParamData() [2/2]

virtual bool GetParamData ( LPVOID  data, const MCHAR *  paramName  )

pure virtual

Access to the actual data stored by the manager.

This is an access point for data retrieval. It is the calling code's responsibility to make sure there is enough space allocated to receive the data. This can be determined by calling GetParamType, which will return the data type. If it is a kPtype_Matrix, then internally this is stored as an 4x4 float array

Parameters

data	A pointer to a buffer to receive the data
paramName	The name of the parameter to query

Returns

True/False depending if the parameter was found, and the data copied correctly

GetParamType() [1/2]

virtual int GetParamType ( int  index )

pure virtual

Access the data type of the parameter.

This method returns the type of parameter. This will be one of the enumerated types define in IParameterManager, kPType_Matrix etc..

Parameters

index

The index of the parameter to query

Returns

The parameter type

GetParamType() [2/2]

virtual int GetParamType ( const MCHAR *  parmName )

pure virtual

Access the data type of the parameter.

This method returns the type of parameter. This will be one of the enumerated types define in IParameterManager, kPType_Matrix etc..

Parameters

parmName

The name of the parameter to query

Returns

The parameter type

GetParamSize()

virtual int GetParamSize ( int  index )

pure virtual

Access the data size of the parameter (mainly designed for kPType_Struct type)

This method returns the size of the parameter, in D3DXVECTOR4 (upper rounded to), or number of textures.

Parameters

index

The index of the parameter to query

Returns

The parameter size