#include "maxheap.h"
#include "iparamb2.h"
#include "render.h"
#include "pbbitmap.h"

Classes
class	ParamMap2UserDlgProc
class	IParamMap2
class	IAutoMParamDlg
class	IAutoEParamDlg
Functions
PB2Export BOOL	CreateModalParamMap2 (MapID map_id, IParamBlock2 pb, TimeValue t, HINSTANCE hInst, MCHAR dlgTemplate, HWND hParent, ParamMap2UserDlgProc *proc=NULL)
BOOL	CreateModalParamMap2 (IParamBlock2 pb, TimeValue t, HINSTANCE hInst, MCHAR dlgTemplate, HWND hParent, ParamMap2UserDlgProc *proc=NULL)
PB2Export BOOL	CreateModalParamMap2 (MapID map_id, IParamBlock2 pb, TimeValue t, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, HWND hParent, ParamMap2UserDlgProc *proc=NULL)
BOOL	CreateModalParamMap2 (IParamBlock2 pb, TimeValue t, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, HWND hParent, ParamMap2UserDlgProc *proc=NULL)
PB2Export IParamMap2 *	CreateChildModalParamMap2 (MapID map_id, IParamBlock2 pb, HINSTANCE hInst, IParamMap2 parent, MCHAR dlgTemplate, MCHAR title, ParamMap2UserDlgProc *proc=NULL)
IParamMap2 *	CreateChildModalParamMap2 (IParamBlock2 pb, HINSTANCE hInst, IParamMap2 parent, MCHAR dlgTemplate, MCHAR title, ParamMap2UserDlgProc *proc=NULL)
PB2Export IParamMap2 *	CreateModelessParamMap2 (MapID map_id, IParamBlock2 pb, TimeValue t, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, HWND hParent, ParamMap2UserDlgProc *proc=NULL)
IParamMap2 *	CreateModelessParamMap2 (IParamBlock2 pb, TimeValue t, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, HWND hParent, ParamMap2UserDlgProc *proc=NULL)
PB2Export IParamMap2 *	CreateModelessParamMap2 (MapID map_id, IParamBlock2 pb, TimeValue t, HINSTANCE hInst, MCHAR dlgTemplate, HWND hParent, ParamMap2UserDlgProc *proc=NULL)
IParamMap2 *	CreateModelessParamMap2 (IParamBlock2 pb, TimeValue t, HINSTANCE hInst, MCHAR dlgTemplate, HWND hParent, ParamMap2UserDlgProc *proc=NULL)
PB2Export void	DestroyModelessParamMap2 (IParamMap2 *m)
PB2Export IParamMap2 *	CreateChildModalParamMap2 (MapID map_id, IParamBlock2 pb, HINSTANCE hInst, IParamMap2 parent, DLGTEMPLATE dlgTemplate, MCHAR title, ParamMap2UserDlgProc *proc=NULL)
IParamMap2 *	CreateChildModalParamMap2 (IParamBlock2 pb, HINSTANCE hInst, IParamMap2 parent, DLGTEMPLATE dlgTemplate, MCHAR title, ParamMap2UserDlgProc *proc=NULL)
PB2Export void	DestroyChildModalParamMap2 (IParamMap2 *m)
PB2Export IParamMap2 *	CreateCPParamMap2 (MapID map_id, IParamBlock2 pb, Interface ip, HINSTANCE hInst, MCHAR dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
IParamMap2 *	CreateCPParamMap2 (IParamBlock2 pb, Interface ip, HINSTANCE hInst, MCHAR dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
PB2Export IParamMap2 *	CreateCPParamMap2 (MapID map_id, IParamBlock2 pb, Interface ip, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
IParamMap2 *	CreateCPParamMap2 (IParamBlock2 pb, Interface ip, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
PB2Export void	DestroyCPParamMap2 (IParamMap2 *m)
PB2Export IParamMap2 *	CreateChildCPParamMap2 (MapID map_id, IParamBlock2 pb, Interface ip, HINSTANCE hInst, IParamMap2 parent, MCHAR dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
IParamMap2 *	CreateChildCPParamMap2 (IParamBlock2 pb, Interface ip, HINSTANCE hInst, IParamMap2 parent, MCHAR dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
PB2Export IParamMap2 *	CreateChildCPParamMap2 (MapID map_id, IParamBlock2 pb, Interface ip, HINSTANCE hInst, IParamMap2 parent, DLGTEMPLATE dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
IParamMap2 *	CreateChildCPParamMap2 (IParamBlock2 pb, Interface ip, HINSTANCE hInst, IParamMap2 parent, DLGTEMPLATE dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
PB2Export void	DestroyChildCPParamMap2 (IParamMap2 *m)
PB2Export IParamMap2 *	CreateRParamMap2 (MapID map_id, IParamBlock2 pb, IRendParams ip, HINSTANCE hInst, MCHAR dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, int category=ROLLUP_CAT_STANDARD)
IParamMap2 *	CreateRParamMap2 (IParamBlock2 pb, IRendParams ip, HINSTANCE hInst, MCHAR dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, int category=ROLLUP_CAT_STANDARD)
PB2Export IParamMap2 *	CreateRParamMap2 (MapID map_id, IParamBlock2 pb, IRendParams ip, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, int category=ROLLUP_CAT_STANDARD)
IParamMap2 *	CreateRParamMap2 (IParamBlock2 pb, IRendParams ip, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, int category=ROLLUP_CAT_STANDARD)
PB2Export void	DestroyRParamMap2 (IParamMap2 *m)
PB2Export IParamMap2 *	CreateChildRParamMap2 (MapID map_id, IParamBlock2 pb, IRendParams ip, HINSTANCE hInst, IParamMap2 parent, MCHAR dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
IParamMap2 *	CreateChildRParamMap2 (IParamBlock2 pb, IRendParams ip, HINSTANCE hInst, IParamMap2 parent, MCHAR dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
PB2Export IParamMap2 *	CreateChildRParamMap2 (MapID map_id, IParamBlock2 pb, IRendParams ip, HINSTANCE hInst, IParamMap2 parent, DLGTEMPLATE dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
IParamMap2 *	CreateChildRParamMap2 (IParamBlock2 pb, IRendParams ip, HINSTANCE hInst, IParamMap2 parent, DLGTEMPLATE dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
PB2Export void	DestroyChildRParamMap2 (IParamMap2 *m)
PB2Export IParamMap2 *	CreateMParamMap2 (MapID map_id, IParamBlock2 pb, IMtlParams ip, HINSTANCE hInst, HWND hmedit, TexDADMgr tdad, MtlDADMgr mdad, MCHAR dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
IParamMap2 *	CreateMParamMap2 (IParamBlock2 pb, IMtlParams ip, HINSTANCE hInst, HWND hmedit, TexDADMgr tdad, MtlDADMgr mdad, MCHAR dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
PB2Export IParamMap2 *	CreateMParamMap2 (MapID map_id, IParamBlock2 pb, IMtlParams ip, HINSTANCE hInst, HWND hmedit, TexDADMgr tdad, MtlDADMgr mdad, DLGTEMPLATE dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
IParamMap2 *	CreateMParamMap2 (IParamBlock2 pb, IMtlParams ip, HINSTANCE hInst, HWND hmedit, TexDADMgr tdad, MtlDADMgr mdad, DLGTEMPLATE dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
PB2Export void	DestroyMParamMap2 (IParamMap2 *m)
PB2Export IParamMap2 *	CreateChildMParamMap2 (MapID map_id, IParamBlock2 pb, IMtlParams ip, HINSTANCE hInst, IParamMap2 parent, HWND hmedit, TexDADMgr tdad, MtlDADMgr mdad, MCHAR dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
IParamMap2 *	CreateChildMParamMap2 (IParamBlock2 pb, IMtlParams ip, HINSTANCE hInst, IParamMap2 parent, HWND hmedit, TexDADMgr tdad, MtlDADMgr mdad, MCHAR dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
PB2Export IParamMap2 *	CreateChildMParamMap2 (MapID map_id, IParamBlock2 pb, IMtlParams ip, HINSTANCE hInst, IParamMap2 parent, HWND hmedit, TexDADMgr tdad, MtlDADMgr mdad, DLGTEMPLATE dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
IParamMap2 *	CreateChildMParamMap2 (IParamBlock2 pb, IMtlParams ip, HINSTANCE hInst, IParamMap2 parent, HWND hmedit, TexDADMgr tdad, MtlDADMgr mdad, DLGTEMPLATE dlgTemplate, MCHAR title, ParamMap2UserDlgProc dlgProc=NULL)
PB2Export void	DestroyChildMParamMap2 (IParamMap2 *m)
PB2Export IParamMap2 *	CreateRWParamMap2 (MapID map_id, IParamBlock2 pb, IRollupWindow rw, HINSTANCE hInst, MCHAR dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, BOOL bindPBlockToMap=TRUE)
IParamMap2 *	CreateRWParamMap2 (IParamBlock2 pb, IRollupWindow rw, HINSTANCE hInst, MCHAR dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, BOOL bindPBlockToMap=TRUE)
PB2Export IParamMap2 *	CreateRWParamMap2 (MapID map_id, IParamBlock2 pb, IRollupWindow rw, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, BOOL bindPBlockToMap=TRUE)
IParamMap2 *	CreateRWParamMap2 (IParamBlock2 pb, IRollupWindow rw, HINSTANCE hInst, DLGTEMPLATE dlgTemplate, MCHAR title, DWORD flags, ParamMap2UserDlgProc *dlgProc=NULL, BOOL bindPBlockToMap=TRUE)
PB2Export void	DestroyRWParamMap2 (IParamMap2 *m)
PB2Export IAutoMParamDlg *	CreateAutoMParamDlg (MapID map_id, HWND hMedit, IMtlParams i, ReferenceTarget obj, IParamBlock2 pb, ClassDesc2 cd, HINSTANCE inst, MCHAR dlgTemplate, MCHAR title, int rollFlags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
IAutoMParamDlg *	CreateAutoMParamDlg (HWND hMedit, IMtlParams i, ReferenceTarget obj, IParamBlock2 pb, ClassDesc2 cd, HINSTANCE inst, MCHAR dlgTemplate, MCHAR title, int rollFlags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
PB2Export IAutoMParamDlg *	CreateAutoMParamDlg (MapID map_id, HWND hMedit, IMtlParams i, ReferenceTarget obj, IParamBlock2 pb, ClassDesc2 cd, HINSTANCE inst, DLGTEMPLATE dlgTemplate, MCHAR title, int rollFlags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
IAutoMParamDlg *	CreateAutoMParamDlg (HWND hMedit, IMtlParams i, ReferenceTarget obj, IParamBlock2 pb, ClassDesc2 cd, HINSTANCE inst, DLGTEMPLATE dlgTemplate, MCHAR title, int rollFlags, ParamMap2UserDlgProc *dlgProc=NULL, HWND hOldRollup=NULL, int category=ROLLUP_CAT_STANDARD)
PB2Export IAutoEParamDlg *	CreateAutoEParamDlg (MapID map_id, IRendParams i, SpecialFX e, IParamBlock2 pb, ClassDesc2 cd, HINSTANCE inst, MCHAR dlgTemplate, MCHAR title, int rollFlags, ParamMap2UserDlgProc *dlgProc=NULL, int category=ROLLUP_CAT_STANDARD)
IAutoEParamDlg *	CreateAutoEParamDlg (IRendParams i, SpecialFX e, IParamBlock2 pb, ClassDesc2 cd, HINSTANCE inst, MCHAR dlgTemplate, MCHAR title, int rollFlags, ParamMap2UserDlgProc *dlgProc=NULL, int category=ROLLUP_CAT_STANDARD)
PB2Export IAutoEParamDlg *	CreateAutoEParamDlg (MapID map_id, IRendParams i, SpecialFX e, IParamBlock2 pb, ClassDesc2 cd, HINSTANCE inst, DLGTEMPLATE dlgTemplate, MCHAR title, int rollFlags, ParamMap2UserDlgProc *dlgProc=NULL, int category=ROLLUP_CAT_STANDARD)
IAutoEParamDlg *	CreateAutoEParamDlg (IRendParams i, SpecialFX e, IParamBlock2 pb, ClassDesc2 cd, HINSTANCE inst, DLGTEMPLATE dlgTemplate, MCHAR title, int rollFlags, ParamMap2UserDlgProc *dlgProc=NULL, int category=ROLLUP_CAT_STANDARD)

Function Documentation

PB2Export BOOL CreateModalParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		TimeValue	t,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		HWND	hParent,
		ParamMap2UserDlgProc *	proc = `NULL`
	)

Search for all occurrences

Remarks:: Creates a parameter map that will handle a parameter block in a modeless dialog where time does not change and the viewports are not redrawn. This overload of CreateModalParamMap2() has a new parameter, map_id, that specifies the ID of the parameter map/rollup to be created for this particular parameter block. See original function for the rest of the description.

BOOL CreateModalParamMap2	(	IParamBlock2 *	pb,
		TimeValue	t,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		HWND	hParent,
		ParamMap2UserDlgProc *	proc = `NULL`
	)		`[inline]`

Search for all occurrences

Remarks:: This function creates a parameter map that will handle a parameter block in a modeless dialog where time does not change and the viewports are not redrawn. Note that there is no need to destroy it. It executes the dialog and then destorys itself.

Note, in version 4.0 and later, this actually maps to a call on the explicit map ID overload of CreateModalParamMap2() with default map ID of 0.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

TimeValue t

The time at which the dialog is launched.

HINSTANCE hInst

The plug-ins instance handle.

MCHAR *dlgTemplate

The dialog template.

HWND hParent

The parent window.

ParamMap2UserDlgProc *proc=NULL

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

Returns:: Returns TRUE if the user selected OK, FALSE otherwise.

Definition at line 305 of file iparamm2.h.

                                         { return CreateModalParamMap2(0, pb, t, hInst, dlgTemplate, hParent, proc); }

PB2Export BOOL CreateModalParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		TimeValue	t,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		HWND	hParent,
		ParamMap2UserDlgProc *	proc = `NULL`
	)

Search for all occurrences

BOOL CreateModalParamMap2	(	IParamBlock2 *	pb,
		TimeValue	t,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		HWND	hParent,
		ParamMap2UserDlgProc *	proc = `NULL`
	)		`[inline]`

Search for all occurrences

Remarks:: This function creates a parameter map that will handle a parameter block in a modeless dialog where time does not change and the viewports are not redrawn. Note that there is no need to destroy it. It executes the dialog and then destorys itself. This function is currently not in use.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

TimeValue t

The time at which the dialog is launched.

HINSTANCE hInst

The plug-ins instance handle.

DLGTEMPLATE *dlgTemplate

The dialog template.

HWND hParent

The parent window.

ParamMap2UserDlgProc *proc=NULL

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

Returns:: Returns TRUE if the user selected OK, FALSE otherwise.

Definition at line 341 of file iparamm2.h.

                                         { return CreateModalParamMap2(0, pb, t, hInst, dlgTemplate, hParent, proc); }

PB2Export IParamMap2* CreateChildModalParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	proc = `NULL`
	)

Search for all occurrences

IParamMap2* CreateChildModalParamMap2	(	IParamBlock2 *	pb,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	proc = `NULL`
	)		`[inline]`

Search for all occurrences

Definition at line 358 of file iparamm2.h.

                                         { return CreateChildModalParamMap2(0, pb, hInst, parent, dlgTemplate, title, proc); }

PB2Export IParamMap2* CreateModelessParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		TimeValue	t,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		HWND	hParent,
		ParamMap2UserDlgProc *	proc = `NULL`
	)

Search for all occurrences

IParamMap2* CreateModelessParamMap2	(	IParamBlock2 *	pb,
		TimeValue	t,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		HWND	hParent,
		ParamMap2UserDlgProc *	proc = `NULL`
	)		`[inline]`

Search for all occurrences

Definition at line 375 of file iparamm2.h.

                                         { return CreateModelessParamMap2(0, pb, t, hInst, dlgTemplate, hParent, proc); }

PB2Export IParamMap2* CreateModelessParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		TimeValue	t,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		HWND	hParent,
		ParamMap2UserDlgProc *	proc = `NULL`
	)

Search for all occurrences

IParamMap2* CreateModelessParamMap2	(	IParamBlock2 *	pb,
		TimeValue	t,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		HWND	hParent,
		ParamMap2UserDlgProc *	proc = `NULL`
	)		`[inline]`

Search for all occurrences

Definition at line 391 of file iparamm2.h.

                                         { return CreateModelessParamMap2(0, pb, t, hInst, dlgTemplate, hParent, proc); }

PB2Export void DestroyModelessParamMap2 ( IParamMap2 * m )

Search for all occurrences

PB2Export IParamMap2* CreateChildModalParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	proc = `NULL`
	)

Search for all occurrences

IParamMap2* CreateChildModalParamMap2	(	IParamBlock2 *	pb,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	proc = `NULL`
	)		`[inline]`

Search for all occurrences

Definition at line 410 of file iparamm2.h.

                                         { return CreateChildModalParamMap2(0, pb, hInst, parent, dlgTemplate, title, proc); }

PB2Export void DestroyChildModalParamMap2 ( IParamMap2 * m )

Search for all occurrences

Remarks:: This function destroys a parameter map created by CreateChildModalParamMap2().

Parameters:: IParamMap2 *m

Points to the parameter map2 to destroy.

PB2Export IParamMap2* CreateCPParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

Remarks:: Creates a parameter map to handle the display of parameters in the command panel. This overload of CreateCPParamMap2() has a new parameter, map_id, that specifies the ID of the parameter map/rollup to be created for this particular parameter block. See original function for the rest of the description.

IParamMap2* CreateCPParamMap2	(	IParamBlock2 *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Remarks:: This function creates a parameter map to handle the display of parameters in the command panel. This will add a rollup page to the command panel (or optionally replace an existing one).

Note, in version 4.0 and later, this actually maps to a call on the explicit map ID overload of CreateCPParamMap2() with default map ID of 0.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

Interface *ip

Pass in the plug-ins interface pointer.

HINSTANCE hInst

The plug-ins instance handle.

MCHAR *dlgTemplate

The dialog template.

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.

ParamMap2UserDlgProc* dlgProc=NULL,

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

HWND hOldRollup=NULL

If non-NULL specifies an existing rollup window in the current UI context that should be replaced with the newly created rollup for this map.

int category = ROLLUP_CAT_STANDARD

The category parameter provides flexibility with regard to where a particular rollup should be displayed in the UI. RollupPanels with lower category fields will be displayed before RollupPanels with higher category fields. For RollupPanels with equal category value the one that was added first will be displayed first. Allthough it is possible to pass any int value as category there exist currently 5 different category defines: ROLLUP_CAT_SYSTEM, ROLLUP_CAT_STANDARD, and ROLLUP_CAT_CUSTATTRIB.

When using ROLLUP_SAVECAT, the rollup page will make the provided category sticky, meaning it will not read the category from the RollupOrder.cfg file, but rather save the category field that was passed as argument in the CatRegistry and in the RollupOrder.cfg file.

The method will take the category of the replaced rollup in case the flags argument contains ROLLUP_USEREPLACEDCAT. This is mainly done, so that this system works with param maps as well.

Returns:: Returns a pointer to the parameter map2.

Definition at line 488 of file iparamm2.h.

                                             { return CreateCPParamMap2(0, pb, ip, hInst, dlgTemplate, title, flags, dlgProc, hOldRollup, category); }

PB2Export IParamMap2* CreateCPParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

IParamMap2* CreateCPParamMap2	(	IParamBlock2 *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Remarks:: This function creates a parameter map to handle the display of parameters in the command panel. This will add a rollup page to the command panel (or optionally replace an existing one). This function is currently not used.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

Interface *ip

Pass in the plug-ins interface pointer.

HINSTANCE hInst

The plug-ins instance handle.

MCHAR *dlgTemplate

The dialog template.

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.

ParamMap2UserDlgProc* dlgProc=NULL,

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

HWND hOldRollup=NULL

If non-NULL specifies an existing rollup window in the current UI context that should be replaced with the newly created rollup for this map.

int category = ROLLUP_CAT_STANDARD

The category parameter provides flexibility with regard to where a particular rollup should be displayed in the UI. RollupPanels with lower category fields will be displayed before RollupPanels with higher category fields. For RollupPanels with equal category value the one that was added first will be displayed first. Allthough it is possible to pass any int value as category there exist currently 5 different category defines: ROLLUP_CAT_SYSTEM, ROLLUP_CAT_STANDARD, and ROLLUP_CAT_CUSTATTRIB.

When using ROLLUP_SAVECAT, the rollup page will make the provided category sticky, meaning it will not read the category from the RollupOrder.cfg file, but rather save the category field that was passed as argument in the CatRegistry and in the RollupOrder.cfg file.

The method will take the category of the replaced rollup in case the flags argument contains ROLLUP_USEREPLACEDCAT. This is mainly done, so that this system works with param maps as well.

Returns:: Returns a pointer to the parameter map2.

Definition at line 552 of file iparamm2.h.

                                             { return CreateCPParamMap2(0, pb, ip, hInst, dlgTemplate, title, flags, dlgProc, hOldRollup, category); }

PB2Export void DestroyCPParamMap2 ( IParamMap2 * m )

Search for all occurrences

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

Parameters:: IParamMap2 *m

A pointer to the parameter map2 to delete.

PB2Export IParamMap2* CreateChildCPParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)

Search for all occurrences

Remarks:: Create a child dialog of the given parent command panel parammap (for tabbed dialogs, etc.) This overload of CreateChildCPParamMap2() has a new parameter, map_id, that specifies the ID of the parameter map/rollup to be created for this particular parameter block. See original function for the rest of the description.

IParamMap2* CreateChildCPParamMap2	(	IParamBlock2 *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)		`[inline]`

Search for all occurrences

Remarks:: This function creates a child dialog of the given parent parammap (for tabbed dialogs, etc.). This version takes an extra parent IParamMap2* and creates a child dialog window in the parent parammap's window (rather than a new rollup) that is mapped by the new parammap. Developers need to call this explicitly once the parent parammap has been created as child parammaps are not created automatically by the P_AUTO_UI mechanisms.

Note, in version 4.0 and later, this actually maps to a call on the explicit map ID overload of CreateChildCPParamMap2() with default map ID of 0.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

Interface *ip

Pass in the plug-ins rendering parameters interface pointer.

HINSTANCE hInst

The plug-ins instance handle.

IParamMap2* parent

The parent parameter map.

MCHAR *dlgTemplate

The dialog template.

MCHAR *title

The title displayed.

ParamMap2UserDlgProc* dlgProc=NULL

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

Returns:: Returns a pointer to the parameter map2.

Definition at line 612 of file iparamm2.h.

                                            { return CreateChildCPParamMap2(0, pb, ip, hInst, parent, dlgTemplate, title, dlgProc); }

PB2Export IParamMap2* CreateChildCPParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)

Search for all occurrences

IParamMap2* CreateChildCPParamMap2	(	IParamBlock2 *	pb,
		Interface *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)		`[inline]`

Search for all occurrences

Remarks:: This function creates a child dialog of the given parent parammap (for tabbed dialogs, etc.). This version takes an extra parent IParamMap2* and creates a child dialog window in the parent parammap's window (rather than a new rollup) that is mapped by the new parammap. Developers need to call this explicitly once the parent parammap has been created as child parammaps are not created automatically by the P_AUTO_UI mechanisms. This function is currently not used.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

Interface *ip

Pass in the plug-ins rendering parameters interface pointer.

HINSTANCE hInst

The plug-ins instance handle.

IParamMap2* parent

The parent parameter map.

MCHAR *dlgTemplate

The dialog template.

MCHAR *title

The title displayed.

ParamMap2UserDlgProc* dlgProc=NULL

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

Returns:: Returns a pointer to the parameter map2.

Definition at line 655 of file iparamm2.h.

                                            { return CreateChildCPParamMap2(0, pb, ip, hInst, parent, dlgTemplate, title, dlgProc); }

PB2Export void DestroyChildCPParamMap2 ( IParamMap2 * m )

Search for all occurrences

Remarks:: This function destroys a parameter map created by CreateChildCPParamMap2().

Parameters:: IParamMap2 *m

Points to the parameter map2 to destroy.

PB2Export IParamMap2* CreateRParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IRendParams *	ip,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

Remarks:: Creates a parameter map to handle the display of render parameters or atmospheric plug-in parameters. This overload of CreateRParamMap2() has a new parameter, map_id, that specifies the ID of the parameter map/rollup to be created for this particular parameter block. See original function for the rest of the description.

IParamMap2* CreateRParamMap2	(	IParamBlock2 *	pb,
		IRendParams *	ip,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Remarks:: Creates a parameter map to handle the display of render parameters or atmospheric plug-in parameters.

Note, in version 4.0 and later, this actually maps to a call on the explicit map ID overload of CreateRParamMap2() with default map ID of 0.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

IRendParams *ip

Pass in the plug-ins rendering parameters interface pointer. See Class IRendParams.

HINSTANCE hInst

The plug-ins instance handle.

MCHAR *dlgTemplate

The dialog template.

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.

ParamMap2UserDlgProc* dlgProc=NULL

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

int category = ROLLUP_CAT_STANDARD

The category parameter provides flexibility with regard to where a particular rollup should be displayed in the UI. RollupPanels with lower category fields will be displayed before RollupPanels with higher category fields. For RollupPanels with equal category value the one that was added first will be displayed first. Allthough it is possible to pass any int value as category there exist currently 5 different category defines: ROLLUP_CAT_SYSTEM, ROLLUP_CAT_STANDARD, and ROLLUP_CAT_CUSTATTRIB.

When using ROLLUP_SAVECAT, the rollup page will make the provided category sticky, meaning it will not read the category from the RollupOrder.cfg file, but rather save the category field that was passed as argument in the CatRegistry and in the RollupOrder.cfg file.

The method will take the category of the replaced rollup in case the flags argument contains ROLLUP_USEREPLACEDCAT. This is mainly done, so that this system works with param maps as well.

Returns:: Returns a pointer to the parameter map2.

Definition at line 729 of file iparamm2.h.

                                            { return CreateRParamMap2(0, pb, ip, hInst, dlgTemplate, title, flags, dlgProc, category); }

PB2Export IParamMap2* CreateRParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IRendParams *	ip,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

IParamMap2* CreateRParamMap2	(	IParamBlock2 *	pb,
		IRendParams *	ip,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Remarks:: Creates a parameter map to handle the display of render parameters or atmospheric plug-in parameters.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

IRendParams *ip

Pass in the plug-ins rendering parameters interface pointer. See Class IRendParams.

HINSTANCE hInst

The plug-ins instance handle.

DLGTEMPLATE *dlgTemplate

The dialog template.

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.

ParamMap2UserDlgProc* dlgProc=NULL

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

int category = ROLLUP_CAT_STANDARD

The category parameter provides flexibility with regard to where a particular rollup should be displayed in the UI. RollupPanels with lower category fields will be displayed before RollupPanels with higher category fields. For RollupPanels with equal category value the one that was added first will be displayed first. Allthough it is possible to pass any int value as category there exist currently 5 different category defines: ROLLUP_CAT_SYSTEM, ROLLUP_CAT_STANDARD, and ROLLUP_CAT_CUSTATTRIB.

When using ROLLUP_SAVECAT, the rollup page will make the provided category sticky, meaning it will not read the category from the RollupOrder.cfg file, but rather save the category field that was passed as argument in the CatRegistry and in the RollupOrder.cfg file.

The method will take the category of the replaced rollup in case the flags argument contains ROLLUP_USEREPLACEDCAT. This is mainly done, so that this system works with param maps as well.

Returns:: Returns a pointer to the parameter map2.

Definition at line 788 of file iparamm2.h.

                                            { return CreateRParamMap2(0, pb, ip, hInst, dlgTemplate, title, flags, dlgProc, category); }

PB2Export void DestroyRParamMap2 ( IParamMap2 * m )

Search for all occurrences

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

Parameters:: IParamMap2 *m

Points to the parameter map2 to destroy.

PB2Export IParamMap2* CreateChildRParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IRendParams *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)

Search for all occurrences

Remarks:: Creates a parameter map for render or atmospheric parameters in a child dialog window of the given parent parammap. This overload of CreateChildRParamMap2() has a new parameter, map_id, that specifies the ID of the parameter map/rollup to be created for this particular parameter block. See original function for the rest of the description.

IParamMap2* CreateChildRParamMap2	(	IParamBlock2 *	pb,
		IRendParams *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)		`[inline]`

Search for all occurrences

Remarks:: This function create a parameter map for render or atmospheric parameters in a child dialog window of the given parent parammap, used typically to create tab child windows in a tabbed rollout. This version takes an extra parent IParamMap2* and creates a child dialog window in the parent parammap's window (rather than a new rollup) that is mapped by the new parammap. Developers need to call this explicitly once the parent parammap has been created as child parammaps are not created automatically by the P_AUTO_UI mechanisms.

Note, in version 4.0 and later, this actually maps to a call on the explicit map ID overload of CreateChildRParamMap2() with default map ID of 0.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

IRendParams *ip

Pass in the plug-ins material parameters interface pointer. See Class IRendParams.

HINSTANCE hInst

The plug-ins instance handle.

IParamMap2* parent

The parent parameter map.

MCHAR *dlgTemplate

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

MCHAR *title

The title displayed in the dialog.

ParamMap2UserDlgProc* dlgProc=NULL

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

Returns:: Returns a pointer to the parameter map2 created.

Definition at line 851 of file iparamm2.h.

                                            { return CreateChildRParamMap2(0, pb, ip, hInst, parent, dlgTemplate, title, dlgProc); }

PB2Export IParamMap2* CreateChildRParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IRendParams *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)

Search for all occurrences

IParamMap2* CreateChildRParamMap2	(	IParamBlock2 *	pb,
		IRendParams *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)		`[inline]`

Search for all occurrences

Remarks:: This function create a parameter map for render or atmospheric parameters in a child dialog window of the given parent parammap, used typically to create tab child windows in a tabbed rollout. This version takes an extra parent IParamMap2* and creates a child dialog window in the parent parammap's window (rather than a new rollup) that is mapped by the new parammap. Developers need to call this explicitly once the parent parammap has been created as child parammaps are not created automatically by the P_AUTO_UI mechanisms. This function is currently not being used.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

IRendParams *ip

Pass in the plug-ins material parameters interface pointer. See Class IRendParams.

HINSTANCE hInst

The plug-ins instance handle.

IParamMap2* parent

The parent parameter map.

DLGTEMPLATE *dlgTemplate

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

MCHAR *title

The title displayed in the dialog.

ParamMap2UserDlgProc* dlgProc=NULL

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

Returns:: Returns a pointer to the parameter map2 created.

Definition at line 896 of file iparamm2.h.

                                            { return CreateChildRParamMap2(0, pb, ip, hInst, parent, dlgTemplate, title, dlgProc); }

PB2Export void DestroyChildRParamMap2 ( IParamMap2 * m )

Search for all occurrences

Remarks:: This function destroys a parameter map created by CreateChildRParamMap2().

Parameters:: IParamMap2 *m

Points to the parameter map2 to destroy.

PB2Export IParamMap2* CreateMParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IMtlParams *	ip,
		HINSTANCE	hInst,
		HWND	hmedit,
		TexDADMgr *	tdad,
		MtlDADMgr *	mdad,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

Remarks:: Creates a parameter map to handle the display of texture map or material parameters in the material editor. This overload of CreateMParamMap2() has a new parameter, map_id, that specifies the ID of the parameter map/rollup to be created for this particular parameter block. See original function for the rest of the description.

IParamMap2* CreateMParamMap2	(	IParamBlock2 *	pb,
		IMtlParams *	ip,
		HINSTANCE	hInst,
		HWND	hmedit,
		TexDADMgr *	tdad,
		MtlDADMgr *	mdad,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Remarks:: Creates a parameter map to handle the display of texture map or material parameters in the material editor.

Note, in version 4.0 and later, this actually maps to a call on the explicit map ID overload of CreateMParamMap2() with default map ID of 0.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

IMtlParams *ip

Pass in the plug-ins material parameters interface pointer. See Class IMtlParams.

HINSTANCE hInst

The plug-ins instance handle.

HWND hmedit

The window handle to the materials editor.

TexDADMgr* dad

Points to the manager used to handle drag and drop of textures. See Class TexDADMgr.

MtlDADMgr* mdad

Points to the manager used to handle drag and drop of materials. See Class MtlDADMgr.

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.

ParamMap2UserDlgProc* dlgProc=NULL

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

HWND hOldRollup=NULL

If non-NULL specifies an existing rollup window in the current UI context that should be replaced with the newly created rollup for this map.

int category = ROLLUP_CAT_STANDARD

The category parameter provides flexibility with regard to where a particular rollup should be displayed in the UI. RollupPanels with lower category fields will be displayed before RollupPanels with higher category fields. For RollupPanels with equal category value the one that was added first will be displayed first. Allthough it is possible to pass any int value as category there exist currently 5 different category defines: ROLLUP_CAT_SYSTEM, ROLLUP_CAT_STANDARD, and ROLLUP_CAT_CUSTATTRIB.

When using ROLLUP_SAVECAT, the rollup page will make the provided category sticky, meaning it will not read the category from the RollupOrder.cfg file, but rather save the category field that was passed as argument in the CatRegistry and in the RollupOrder.cfg file.

The method will take the category of the replaced rollup in case the flags argument contains ROLLUP_USEREPLACEDCAT. This is mainly done, so that this system works with param maps as well.

Returns:: Returns a pointer to the parameter map2 created.

Definition at line 985 of file iparamm2.h.

                                            { return CreateMParamMap2(0, pb, ip, hInst, hmedit, tdad, mdad, dlgTemplate, title, flags, dlgProc, hOldRollup, category); }

PB2Export IParamMap2* CreateMParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IMtlParams *	ip,
		HINSTANCE	hInst,
		HWND	hmedit,
		TexDADMgr *	tdad,
		MtlDADMgr *	mdad,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

IParamMap2* CreateMParamMap2	(	IParamBlock2 *	pb,
		IMtlParams *	ip,
		HINSTANCE	hInst,
		HWND	hmedit,
		TexDADMgr *	tdad,
		MtlDADMgr *	mdad,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Remarks:: Creates a parameter map to handle the display of texture map or material parameters in the material editor. This function is currently not in use.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

IMtlParams *ip

Pass in the plug-ins material parameters interface pointer. See Class IMtlParams.

HINSTANCE hInst

The plug-ins instance handle.

HWND hmedit

The window handle to the materials editor.

TexDADMgr* dad

Points to the manager used to handle drag and drop of textures. See Class TexDADMgr.

MtlDADMgr* mdad

Points to the manager used to handle drag and drop of materials. See Class MtlDADMgr.

DLGTEMPLATE *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.

ParamMap2UserDlgProc* dlgProc=NULL

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

HWND hOldRollup=NULL

If non-NULL specifies an existing rollup window in the current UI context that should be replaced with the newly created rollup for this map.

int category = ROLLUP_CAT_STANDARD

The category parameter provides flexibility with regard to where a particular rollup should be displayed in the UI. RollupPanels with lower category fields will be displayed before RollupPanels with higher category fields. For RollupPanels with equal category value the one that was added first will be displayed first. Allthough it is possible to pass any int value as category there exist currently 5 different category defines: ROLLUP_CAT_SYSTEM, ROLLUP_CAT_STANDARD, and ROLLUP_CAT_CUSTATTRIB.

When using ROLLUP_SAVECAT, the rollup page will make the provided category sticky, meaning it will not read the category from the RollupOrder.cfg file, but rather save the category field that was passed as argument in the CatRegistry and in the RollupOrder.cfg file.

The method will take the category of the replaced rollup in case the flags argument contains ROLLUP_USEREPLACEDCAT. This is mainly done, so that this system works with param maps as well.

Returns:: Returns a pointer to the parameter map2 created.

Definition at line 1063 of file iparamm2.h.

                                            { return CreateMParamMap2(0, pb, ip, hInst, hmedit, tdad, mdad, dlgTemplate, title, flags, dlgProc, hOldRollup, category); }

PB2Export void DestroyMParamMap2 ( IParamMap2 * m )

Search for all occurrences

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

Parameters:: IParamMap2 *m

Points to the parameter map2 to destroy.

PB2Export IParamMap2* CreateChildMParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IMtlParams *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		HWND	hmedit,
		TexDADMgr *	tdad,
		MtlDADMgr *	mdad,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)

Search for all occurrences

Remarks:: This function creates a child dialog of the given modal parent parammap (for tabbed dialogs, etc.). Unlike modal parent parammap, you do need to destroy it. This version takes an extra parent IParamMap2* and creates a child dialog window in the parent parammap's window (rather than a new rollup) that is mapped by the new parammap. Developers need to call this explicitly once the parent parammap has been created as child parammaps are not created automatically by the P_AUTO_UI mechanisms.

Parameters:: MapID map_id

Specifies the ID of the parameter map/rollup to be created for this particular parameter block.

IParamBlock2 *pb

Points to the parameter block2.

HINSTANCE hInst

The plug-ins instance handle.

IParamMap2* parent

The parent parameter map.

MCHAR *dlgTemplate

The dialog template.

MCHAR *title

The title displayed in the dialog.

ParamMap2UserDlgProc *proc=NULL

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

Returns:: Returns TRUE if the user selected OK, FALSE otherwise.

IParamMap2* CreateChildMParamMap2	(	IParamBlock2 *	pb,
		IMtlParams *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		HWND	hmedit,
		TexDADMgr *	tdad,
		MtlDADMgr *	mdad,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)		`[inline]`

Search for all occurrences

Remarks:: This function creates and returns a child dialog of the given parent parammap (for tabbed dialogs, etc.). This version takes an extra parent IParamMap2* and create a child dialog window in the parent parammap's window (rather than a new rollup) that is mapped by the new parammap. Developers need to call this explicitly once the parent parammap has been created as child parammaps are not created automatically by the P_AUTO_UI mechanisms.

Note, in version 4.0 and later, this actually maps to a call on the explicit map ID overload of CreateChildMParamMap2() with default map ID of 0.

Parameters:: IParamBlock2 *pb

Points to the parameter block2.

IMtlParams *ip

Pass in the plug-ins material parameters interface pointer. See Class IMtlParams.

HINSTANCE hInst

The plug-ins instance handle.

IParamMap2* parent

The parent parameter map.

TexDADMgr* tdad

Points to the manager used to handle drag and drop of textures. See Class TexDADMgr.

MtlDADMgr* mdad

Points to the manager used to handle drag and drop of materials. See Class MtlDADMgr_.

MCHAR *dlgTemplate

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

MCHAR *title

The title displayed in the dialog.

ParamMap2UserDlgProc* dlgProc=NULL

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

Returns:: Returns a pointer to the parameter map2 created.

Definition at line 1157 of file iparamm2.h.

                                            { return CreateChildMParamMap2(0, pb, ip, hInst, parent, hmedit, tdad, mdad, dlgTemplate, title, dlgProc); }

PB2Export IParamMap2* CreateChildMParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IMtlParams *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		HWND	hmedit,
		TexDADMgr *	tdad,
		MtlDADMgr *	mdad,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)

Search for all occurrences

IParamMap2* CreateChildMParamMap2	(	IParamBlock2 *	pb,
		IMtlParams *	ip,
		HINSTANCE	hInst,
		IParamMap2 *	parent,
		HWND	hmedit,
		TexDADMgr *	tdad,
		MtlDADMgr *	mdad,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		ParamMap2UserDlgProc *	dlgProc = `NULL`
	)		`[inline]`

Search for all occurrences

Definition at line 1181 of file iparamm2.h.

                                            { return CreateChildMParamMap2(0, pb, ip, hInst, parent, hmedit, tdad, mdad, dlgTemplate, title, dlgProc); }

PB2Export void DestroyChildMParamMap2 ( IParamMap2 * m )

Search for all occurrences

Remarks:: This function destroys a parameter map created by CreateChildMParamMap2().

Parameters:: IParamMap2 *m

Points to the parameter map2 to destroy.

PB2Export IParamMap2* CreateRWParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IRollupWindow *	rw,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		BOOL	bindPBlockToMap = `TRUE`
	)

Search for all occurrences

IParamMap2* CreateRWParamMap2	(	IParamBlock2 *	pb,
		IRollupWindow *	rw,
		HINSTANCE	hInst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		BOOL	bindPBlockToMap = `TRUE`
	)		`[inline]`

Search for all occurrences

Definition at line 1214 of file iparamm2.h.

                                   { return CreateRWParamMap2(0, pb, rw, hInst, dlgTemplate, title, flags, dlgProc, bindPBlockToMap); }

PB2Export IParamMap2* CreateRWParamMap2	(	MapID	map_id,
		IParamBlock2 *	pb,
		IRollupWindow *	rw,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		BOOL	bindPBlockToMap = `TRUE`
	)

Search for all occurrences

IParamMap2* CreateRWParamMap2	(	IParamBlock2 *	pb,
		IRollupWindow *	rw,
		HINSTANCE	hInst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		DWORD	flags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		BOOL	bindPBlockToMap = `TRUE`
	)		`[inline]`

Search for all occurrences

Definition at line 1234 of file iparamm2.h.

                                   { return CreateRWParamMap2(0, pb, rw, hInst, dlgTemplate, title, flags, dlgProc, bindPBlockToMap); }

PB2Export void DestroyRWParamMap2 ( IParamMap2 * m )

Search for all occurrences

PB2Export IAutoMParamDlg* CreateAutoMParamDlg	(	MapID	map_id,
		HWND	hMedit,
		IMtlParams *	i,
		ReferenceTarget *	obj,
		IParamBlock2 *	pb,
		ClassDesc2 *	cd,
		HINSTANCE	inst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		int	rollFlags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

Remarks:: This function may be called to create a parameter map2 for use in the material editor dialog. This overload of CreateAutoMParamDlg() has a new parameter, map_id, that specifies the ID of the parameter map/rollup to be created for this particular parameter block. See original function for the rest of the description.

IAutoMParamDlg* CreateAutoMParamDlg	(	HWND	hMedit,
		IMtlParams *	i,
		ReferenceTarget *	obj,
		IParamBlock2 *	pb,
		ClassDesc2 *	cd,
		HINSTANCE	inst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		int	rollFlags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Remarks:: This function may be called to create a parameter map2 for use in the material editor dialog.

Note, in version 4.0 and later, this actually maps to a call on the explicit map ID overload of CreateAutoMParamDlg() with default map ID of 0.

Parameters:: HWND hMedit

The window handle of the materials editor.

IMtlParams *i

The interface pointer for materials. See Class IMtlParams.

MtlBase* mtl

Points to the material calling this function.

IParamBlock2* pb

Points to the parameter block instance associated with the parameter map.

ClassDesc2* cd

The class descriptor2 for the plug-in creating the parameter map.

HINSTANCE inst

The plug-ins DLL instance handle.

MCHAR* dlgTemplate

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

MCHAR* title

The title displayed in the rollup page title bar.

int rollFlags

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

APPENDROLL_CLOSED

Starts the page in the rolled up state.

ParamMap2UserDlgProc* dlgProc=NULL

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

HWND hOldRollup=NULL

An optional window handle to allow supplying an existing rollup that will be replaced by the newly cerated one.

Returns:: A pointer to an interface for managing the parameter map2.

Definition at line 1351 of file iparamm2.h.

                                            {
                                                return CreateAutoMParamDlg(0, hMedit, i, obj, pb, cd, inst, dlgTemplate, 
                                                                           title, rollFlags, dlgProc, hOldRollup, category); 
                                            }

PB2Export IAutoMParamDlg* CreateAutoMParamDlg	(	MapID	map_id,
		HWND	hMedit,
		IMtlParams *	i,
		ReferenceTarget *	obj,
		IParamBlock2 *	pb,
		ClassDesc2 *	cd,
		HINSTANCE	inst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		int	rollFlags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

IAutoMParamDlg* CreateAutoMParamDlg	(	HWND	hMedit,
		IMtlParams *	i,
		ReferenceTarget *	obj,
		IParamBlock2 *	pb,
		ClassDesc2 *	cd,
		HINSTANCE	inst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		int	rollFlags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		HWND	hOldRollup = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Definition at line 1368 of file iparamm2.h.

                                            {
                                                return CreateAutoMParamDlg(0, hMedit, i, obj, pb, cd, inst, dlgTemplate, 
                                                                           title, rollFlags, dlgProc, hOldRollup, category); 
                                            }

PB2Export IAutoEParamDlg* CreateAutoEParamDlg	(	MapID	map_id,
		IRendParams *	i,
		SpecialFX *	e,
		IParamBlock2 *	pb,
		ClassDesc2 *	cd,
		HINSTANCE	inst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		int	rollFlags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

Remarks:: This function creates an AutoEParamDlg for render effects. This overload of CreateAutoEParamDlg() has a new parameter, map_id, that specifies the ID of the parameter map/rollup to be created for this particular parameter block. See original function for the rest of the description.

IAutoEParamDlg* CreateAutoEParamDlg	(	IRendParams *	i,
		SpecialFX *	e,
		IParamBlock2 *	pb,
		ClassDesc2 *	cd,
		HINSTANCE	inst,
		MCHAR *	dlgTemplate,
		MCHAR *	title,
		int	rollFlags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Remarks:: This function creates an AutoEParamDlg for render effects.

Note, in version 4.0 and later, this actually maps to a call on the explicit map ID overload of CreateAutoEParamDlg() with default map ID of 0.

Parameters:: IRendParams *i

An interface pointer for rendering effects.

SpecialFX* e

Points to the rendering effect calling this function.

IParamBlock2* pb

Points to the parameter block instance associated with the parameter map.

ClassDesc2* cd

The class descriptor2 for the plug-in creating the parameter map.

HINSTANCE inst

The plug-ins DLL instance handle.

MCHAR* dlgTemplate

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

MCHAR* title

The title displayed in the rollup page title bar.

int rollFlags

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

APPENDROLL_CLOSED

Starts the page in the rolled up state.

ParamMap2UserDlgProc* dlgProc=NULL

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

Returns:: A pointer to an interface for managing the parameter map2.

Definition at line 1468 of file iparamm2.h.

                                            { 
                                                return CreateAutoEParamDlg(0, i, e, pb, cd, inst, dlgTemplate, title, rollFlags, dlgProc, category);
                                            }

PB2Export IAutoEParamDlg* CreateAutoEParamDlg	(	MapID	map_id,
		IRendParams *	i,
		SpecialFX *	e,
		IParamBlock2 *	pb,
		ClassDesc2 *	cd,
		HINSTANCE	inst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		int	rollFlags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

Search for all occurrences

IAutoEParamDlg* CreateAutoEParamDlg	(	IRendParams *	i,
		SpecialFX *	e,
		IParamBlock2 *	pb,
		ClassDesc2 *	cd,
		HINSTANCE	inst,
		DLGTEMPLATE *	dlgTemplate,
		MCHAR *	title,
		int	rollFlags,
		ParamMap2UserDlgProc *	dlgProc = `NULL`,
		int	category = `ROLLUP_CAT_STANDARD`
	)		`[inline]`

Search for all occurrences

Definition at line 1483 of file iparamm2.h.

                                            { 
                                                return CreateAutoEParamDlg(0, i, e, pb, cd, inst, dlgTemplate, title, rollFlags, dlgProc, category);
                                            }

iparamm2.h File Reference

Classes

Functions

Function Documentation