iparamm.h File Reference

#include "maxheap.h"
#include <WTypes.h>
#include "maxtypes.h"
#include "coreexp.h"
#include "custcont.h"
#include "paramtype.h"

Classes
class	ParamMapUserDlgProc
class	IParamMap
class	ParamUIDesc

Macros
#define	REDRAW_VIEWS   2
#define	SPIN_AUTOSCALE   -1.0f

Functions
CoreExport BOOL	CreateModalParamMap (ParamUIDesc *desc, int count, IParamArray *pb, TimeValue t, HINSTANCE hInst, const MCHAR *dlgTemplate, HWND hParent, ParamMapUserDlgProc *proc=NULL)
CoreExport IParamMap *	CreateCPParamMap (ParamUIDesc *desc, int count, IParamArray *pb, Interface *ip, HINSTANCE hInst, const MCHAR *dlgTemplate, const MCHAR *title, DWORD flags)
CoreExport IParamMap *	ReplaceCPParamMap (HWND oldhw, ParamUIDesc *desc, int count, IParamArray *pb, Interface *ip, HINSTANCE hInst, const MCHAR *dlgTemplate, const MCHAR *title, DWORD flags)
CoreExport void	DestroyCPParamMap (IParamMap *m)
CoreExport IParamMap *	CreateRParamMap (ParamUIDesc *desc, int count, IParamArray *pb, IRendParams *ip, HINSTANCE hInst, const MCHAR *dlgTemplate, const MCHAR *title, DWORD flags)
CoreExport void	DestroyRParamMap (IParamMap *m)
CoreExport IParamMap *	CreateMParamMap (ParamUIDesc *desc, int count, IParamArray *pb, IMtlParams *ip, HINSTANCE hInst, const MCHAR *dlgTemplate, const MCHAR *title, DWORD flags)
CoreExport void	DestroyMParamMap (IParamMap *m)

Variables
CoreExport ParamDimension *	defaultDim

Macro Definition Documentation

REDRAW_VIEWS

#define REDRAW_VIEWS   2

SPIN_AUTOSCALE

#define SPIN_AUTOSCALE   -1.0f

Function Documentation

CreateModalParamMap()

CoreExport BOOL CreateModalParamMap	(	ParamUIDesc *	desc,
		int	count,
		IParamArray *	pb,
		TimeValue	t,
		HINSTANCE	hInst,
		const MCHAR *	dlgTemplate,
		HWND	hParent,
		ParamMapUserDlgProc *	proc = NULL
	)

Remarks

This function creates a parameter map that will handle a parameter block in a modal dialog where time does not change and the viewport is not redrawn. Note that there is no need to destroy it. It executes the dialog and then destroys itself.

Parameters:

ParamUIDesc *desc

The array of ParamUIDescs, one element for each control to be managed.

int count

The number of items in the array above.

IParamArray *pb

Pointer to an instance of the class IParamArray. This is the pointer to the virtual array of parameters.

TimeValue t

This is just the current time when the user is bringing up the dialog.

HINSTANCE hInst

The DLL instance handle of the plug-in

MCHAR *dlgTemplate

Dialog template for the dialog box.

HWND hParent

The parent window handle.

ParamMapUserDlgProc *proc=NULL

If there is some custom handling required by a particular control, the client can derive a class from ParamMapUserDlgProc and set it as the parameter map's user callback. See Class ParamMapUserDlgProc.

Returns

TRUE if the user selected OK; otherwise FALSE.

CreateCPParamMap()

CoreExport IParamMap* CreateCPParamMap	(	ParamUIDesc *	desc,
		int	count,
		IParamArray *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		const MCHAR *	dlgTemplate,
		const MCHAR *	title,
		DWORD	flags
	)

Remarks

Creates a parameter map to handle the display of parameters in the command panel. This will add the rollup page to the command panel.

Parameters:

ParamUIDesc *desc

The array of ParamUIDescs, one element for each control to be managed.

int count

The number of items in the array above.

IParamArray *pb

Pointer to an instance of the class IParamArray. This is the pointer to the virtual array of parameters.

Interface *ip

The interface pointer passed into the BeginEditParams() method.

HINSTANCE hInst

The DLL instance handle of the plug-in

MCHAR *dlgTemplate

Dialog template for the rollup page (created using the resource editor)

MCHAR *title

The title displayed in the rollup page title bar.

DWORD flags

A set of flags to control settings of the rollup page.

APPENDROLL_CLOSED

Starts the page in the rolled up state.

Returns

A pointer to the parameter map that is created.

ReplaceCPParamMap()

CoreExport IParamMap* ReplaceCPParamMap	(	HWND	oldhw,
		ParamUIDesc *	desc,
		int	count,
		IParamArray *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		const MCHAR *	dlgTemplate,
		const MCHAR *	title,
		DWORD	flags
	)

Remarks

This method allows one to switch rollups in the command panel. It creates the new parameter map and calls Interface:: ReplaceRollupPage().

Parameters:

HWND oldhw

The window handle of the old rollup.

ParamUIDesc *desc

The array of ParamUIDescs, one element for each control to be managed.

int count

The number of items in the array above.

IParamArray *pb

Pointer to an instance of the class IParamArray. This is the pointer to the virtual array of parameters.

Interface *ip

The interface pointer passed into the BeginEditParams() method.

HINSTANCE hInst

The DLL instance handle of the plug-in

MCHAR *dlgTemplate

Dialog template for the rollup page (created using the resource editor)

MCHAR *title

The title displayed in the rollup page title bar.

DWORD flags

A set of flags to control settings of the rollup page.

APPENDROLL_CLOSED

Starts the page in the rolled up state.

Returns

A pointer to the parameter map that is created.

DestroyCPParamMap()

CoreExport void DestroyCPParamMap

(

IParamMap *

m

)

Remarks

This function destroys a command panel parameter map. The rollup page from the command panel is removed and the parameter map is deleted.

Parameters:

IParamMap *m

A pointer to the parameter map to destroy.

CreateRParamMap()

CoreExport IParamMap* CreateRParamMap	(	ParamUIDesc *	desc,
		int	count,
		IParamArray *	pb,
		IRendParams *	ip,
		HINSTANCE	hInst,
		const MCHAR *	dlgTemplate,
		const MCHAR *	title,
		DWORD	flags
	)

Remarks

This function creates a parameter map to handle the display of render parameters or atmospheric plug-in parameters.

Parameters:

ParamUIDesc *desc

The array of ParamUIDescs, one element for each control to be managed.

int count

The number of items in the array above.

IParamArray *pb

Pointer to an instance of the class IParamArray. This is the pointer to the array of parameters.

IRendParams *ip

The interface pointer passed into CreateParamDlg().

HINSTANCE hInst

The DLL instance handle of the plug-in

MCHAR *dlgTemplate

Dialog template for the rollup page (created using the resource editor)

MCHAR *title

The title displayed in the rollup page title bar.

DWORD flags

A flag to control the settings of the rollup page:

APPENDROLL_CLOSED

Starts the page in the rolled up state.

Returns

A pointer to the parameter map that is created.

DestroyRParamMap()

CoreExport void DestroyRParamMap

(

IParamMap *

m

)

Remarks

This function destroys a parameter map created by CreateRParamMap(). The rollup page is removed and the parameter map is deleted.

Parameters:

IParamMap *m

A pointer to the parameter map to destroy.

CreateMParamMap()

CoreExport IParamMap* CreateMParamMap	(	ParamUIDesc *	desc,
		int	count,
		IParamArray *	pb,
		IMtlParams *	ip,
		HINSTANCE	hInst,
		const MCHAR *	dlgTemplate,
		const MCHAR *	title,
		DWORD	flags
	)

Remarks

This function is available in release 2.0 and later only.

This function creates a parameter map to handle the display of texture map or material parameters in the material editor.

Parameters:

ParamUIDesc *desc

The array of ParamUIDescs, one element for each control to be managed.

int count

The number of items in the array above.

IParamArray *pb

Pointer to an instance of the class IParamArray. This is the pointer to the array of parameters.

IMtlParams *ip

The interface pointer. See Class IMtlParams.

HINSTANCE hInst

The DLL instance handle of the plug-in

MCHAR *dlgTemplate

Dialog template for the rollup page (created using the resource editor)

MCHAR *title

The title displayed in the rollup page title bar.

DWORD flags

A flag to control the settings of the rollup page:

APPENDROLL_CLOSED

Starts the page in the rolled up state.

Returns

A pointer to the parameter map that is created.

DestroyMParamMap()

CoreExport void DestroyMParamMap

(

IParamMap *

m

)

Remarks

This function is available in release 2.0 and later only.

This function destroys a parameter map created by CreateMParamMap(). The rollup page is removed and the parameter map is deleted.

Parameters:

IParamMap *m

A pointer to the parameter map to destroy.

Variable Documentation

defaultDim

CoreExport ParamDimension* defaultDim

extern