Detailed Description

See also:: , Parameter Maps, Class ParamMapUserDlgProc, Class ParamUIDesc, Parameter Blocks, Class IParamArray

Description:: This class provides methods to work with parameter maps. These are things like invalidating the parameter map so it gets redrawn, working with the parameter blocks associated with the parameter map, and establishing an optional dialog proc to handle controls not directly handled by the pmap. This section also documents several functions that are available for creating and destroying parameter maps but are not part of this class.

Note: The use of this class requires the explicit inclusion the IPARAMM.H header file.

#include <iparamm.h>

Inheritance diagram for IParamMap:

Public Member Functions
virtual	~IParamMap ()
virtual void	Invalidate ()=0
virtual void	SetParamBlock (IParamArray *pb)=0
virtual void	SetUserDlgProc (ParamMapUserDlgProc *proc=NULL)=0
virtual ParamMapUserDlgProc *	GetUserDlgProc ()=0
virtual void	SetPBlockIndex (int mapIndex, int blockIndex)=0
virtual HWND	GetHWnd ()=0
virtual IParamArray *	GetParamBlock ()=0
virtual BOOL	DlgActive ()=0

Constructor & Destructor Documentation

virtual ~IParamMap ( ) [inline, virtual]

{}

virtual void Invalidate ( ) [pure virtual]

Remarks:: Implemented by the System.

Call this method to update (redraw) the user interface controls. This marks the UI controls as needing to be updated and the parameter map will take care of it.

virtual void SetParamBlock ( IParamArray * pb ) [pure virtual]

Remarks:: Implemented by the System.

This method swaps the existing parameter block with a new one and updates the user interface. Consider the following example to understand how this is used: If a user is in create mode, and has created a sphere object, and then goes to create another sphere, the user interface stays up. The parameter map that manages the UI is not deleted. When the user creates the second sphere, the parameter map needs to refer to the new sphere's parameter block (not the previous one any longer). This method is used to set the parameter map to point to the new parameter block.

virtual void SetUserDlgProc ( ParamMapUserDlgProc * proc = NULL ) [pure virtual]

Remarks:: Implemented by the System.

This method allows the developer to provide special handling for a control. The developer provides a dialog proc to process the message from the control. This method is used to tell the parameter map that the developer defined method should be called. The given proc will be called after default processing is done. Note that if the proc is non-NULL when the ParamMap is deleted its DeleteThis() method will be called.

Parameters:: ParamMapUserDlgProc *proc=NULL

A pointer to the user dialog proc class to process the control.

virtual ParamMapUserDlgProc* GetUserDlgProc ( ) [pure virtual]

virtual void SetPBlockIndex	(	int	mapIndex,
		int	blockIndex
	)		`[pure virtual]`

Remarks:: Implemented by the System.

This method changes a parameter map entry to refer to a different item in the parameter block. This is used for example by the Optimize modifier. This modifier has two sets of parameters that may be adjusted (L1 and L2). Optimize only maintains a single parameter block however. This pblock contains both sets of parameters. When the user switches between these two sets, this method is called to point the UI controls at different indices in the parameter block.

Parameters:: int mapIndex

The map entry to change.

int blockIndex

The new parameter block index.

virtual HWND GetHWnd ( ) [pure virtual]

Remarks:: Implemented by the System.

Returns the window handle of the rollup page (or dialog).

virtual IParamArray* GetParamBlock ( ) [pure virtual]

Remarks:: Implemented by the System.

Returns a pointer to the parameter block managed by the parameter map.

virtual BOOL DlgActive ( ) [pure virtual]