This reference page is linked to from the following overview topics: Parameter Block UI Specification Arguments, Parameter Flags.

Detailed Description

See also:: Class IParamBlock2, Class ParamBlockDesc2, Class ParamMap2UserDlgProc.

Description:: This class provides methods to work with parameter map2s. Methods are provided for 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 parameter map. 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 IPARAMM2.H header file.

#include <iparamm2.h>

Inheritance diagram for IParamMap2:

[legend]

List of all members.

Public Member Functions
virtual void	Invalidate ()=0
virtual void	Validate ()=0
virtual void	Invalidate (ParamID id, int tabIndex=0)=0
virtual void	UpdateUI (TimeValue t)=0
virtual void	RedrawViews (TimeValue t, DWORD flag=REDRAW_NORMAL)=0
virtual Interval &	Validity ()=0
virtual void	SetParamBlock (IParamBlock2 *pb)=0
virtual MapID	GetMapID ()=0
virtual void	SetUserDlgProc (ParamMap2UserDlgProc *proc=NULL)=0
virtual ParamMap2UserDlgProc *	GetUserDlgProc ()=0
virtual void	ReplaceParam (ParamID curParam, ParamID newParam)
virtual HWND	GetHWnd ()=0
virtual IRollupWindow *	GetIRollup ()
virtual IParamBlock2 *	GetParamBlock ()=0
virtual BOOL	DlgActive ()=0
virtual ParamBlockDesc2 *	GetDesc ()=0
virtual void	ActivateDlg (BOOL onOff)=0
virtual int	FindSubTexFromHWND (HWND hw)=0
virtual int	FindSubMtlFromHWND (HWND hw)=0
virtual void	Enable (ParamID id, BOOL onOff, int tabIndex=0)=0
virtual void	SetText (ParamID id, MCHAR *txt, int tabIndex=0)=0
virtual void	SetTooltip (ParamID id, bool bEnable, const MCHAR *txt, int tabIndex=0)=0
	Set tooltip of param UI control.
virtual void	SetRange (ParamID id, float low, float high, int tabIndex=0)=0
virtual void	Show (ParamID id, BOOL showHide, int tabIndex=0)=0
virtual void	SetThing (ReferenceTarget *m)=0

Member Function Documentation

virtual void Invalidate ( ) [pure virtual]

Search for all occurrences

Remarks:: This method marks the user interface as needing to be updated. This affects the entire UI for the parameter map.

virtual void Validate ( ) [pure virtual]

Search for all occurrences

Remarks:: This methods un-invalidates the entire user interface.

virtual void Invalidate	(	ParamID	id,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This methods marks a specific control in the UI as requiring an update.

Parameters:

id	The permanent ID of the control requiring an update.
tabIndex	If the control is a Tab<> then this is the zero based index into the table of the value to be invalidated.

virtual void UpdateUI ( TimeValue t ) [pure virtual]

Search for all occurrences

Remarks:: This method will update the user interface if the current settings are not valid at the given time (i.e., if anything is animated at that time).

Parameters:

t	The time to check for the update.

virtual void RedrawViews	(	TimeValue	t,
		DWORD	flag = `REDRAW_NORMAL`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method may be called to cause the viewports to be redrawn.

Parameters:

t	The time at which to redraw the viewports.
flag	You may specify one of the following: REDRAW_BEGIN Call this before you redraw. REDRAW_INTERACTIVE This allows the view quality to degrade to maintain interactively. REDRAW_END If during interactive redraw the state degraded, this will redraw the views in the undegraded state. REDRAW_NORMAL This redraws the views in the undegraded state.

virtual Interval& Validity ( ) [pure virtual]

Search for all occurrences

Remarks:: Provides access to pmap's validity interval. Returns a refernce to the actual interval so it can be modified if desired.

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

Search for all occurrences

Remarks:: This method swaps the existing parameter block with a new one and updates user interface.

Parameters:

pb	Points to the new parameter block2 to use.

virtual MapID GetMapID ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the parameter map's ID.

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

Search for all occurrences

Remarks:: This method allows a developer to provide special handling for one or more controls. 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 ParamMap2 is deleted its DeleteThis() method will be called.

Parameters:

proc	Points to the user dialog proc object to process the controls.

virtual ParamMap2UserDlgProc* GetUserDlgProc ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to the user dialog proc for the parameter map (or NULL if none is defined). See SetUserDlgProc() above.

virtual void ReplaceParam	(	ParamID	curParam,
		ParamID	newParam
	)		`[inline, virtual]`

Search for all occurrences

Remarks:: This method changes a parameter map entry to refer to a different item in the parameter block.

Parameters:

curParam	The parameter ID of the item to change.
newParam	The new parameter ID.

{ UNUSED_PARAM(curParam); UNUSED_PARAM(newParam); }

virtual HWND GetHWnd ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the dialog window handle of the parameter map.

virtual IRollupWindow* GetIRollup ( ) [inline, virtual]

Search for all occurrences

{ return NULL; }

virtual IParamBlock2* GetParamBlock ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to the parameter block2 used by this parameter map.

virtual BOOL DlgActive ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns TRUE if the parameter map dialog proc is active; otherwise FALSE.

virtual ParamBlockDesc2* GetDesc ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to the ParamBlockDesc2 instance for this parameter map.

virtual void ActivateDlg ( BOOL onOff ) [pure virtual]

Search for all occurrences

Remarks:: This method is called to indicate the dialog is going inactive or is becoming active.

Parameters:

onOff TRUE if becoming active; FALSE for inactive.

virtual int FindSubTexFromHWND ( HWND hw ) [pure virtual]

Search for all occurrences

Remarks:: This method is sent to a Material Editor map to find the SubTex index corresponding to the control handle. It should return the index of the sub-texmap corresponding to the window whose handle is passed. If the handle is not valid return -1.

Parameters:

hw	The window handle of the control.

virtual int FindSubMtlFromHWND ( HWND hw ) [pure virtual]

Search for all occurrences

virtual void Enable	(	ParamID	id,
		BOOL	onOff,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method is used to enable of disable an individual user interface control.

Parameters:

id	The parameter ID of the control to enable/disable.
onOff	TRUE to enable; FALSE to disable.
tabIndex	If the control is a Tab<> then this is the zero based index in the table of the item to enable/disable.

virtual void SetText	(	ParamID	id,
		MCHAR *	txt,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method sets the text of a parameter user interface control.

Parameters:

id	The ID of the parameter whose user interface text to change.
txt	The new string to display.
tabIndex	If the parmeter is a Tab<> this is the zero based index of the parameter in the table.

virtual void SetTooltip	(	ParamID	id,
		bool	bEnable,
		const MCHAR *	txt,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Set tooltip of param UI control.

This method allows for turning on or off the tooltip for a parameter user interface control.

Parameters:

id	- The ID of the parameter whose user interface tooltip to set.
bEnable	- if true, the tooltip is enabled, otherwise disabled. When disabled, the tooltip won't be displayed when the the mouse hovers on top of the control. Enabling the tooltip repeatedly will have the same effect as enabling it once.
text	- pointer to a string representing the text to be displayed in the tooltip window. This parameter is ignored when the tooltip is being disabled.
tabIndex	If the parameter is a Tab<> this is the zero based index of the parameter in the table.

virtual void SetRange	(	ParamID	id,
		float	low,
		float	high,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method sets the range of parameter for a spinner or slider control.

Parameters:

id	The ID of the parameter.
low	The low range for the spinner / slider.
high	The high range for the spinner / slider.
tabIndex	If the parmeter is a Tab<> this is the zero based index of the parameter in the table.

virtual void Show	(	ParamID	id,
		BOOL	showHide,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method will show or hide the specified control.

Parameters:

id	The ID of the parameter.
showHide	TRUE to show; FALSE to hide.
tabIndex	If the parmeter is a Tab<> this is the zero based index of the parameter in the table.

virtual void SetThing ( ReferenceTarget * m ) [pure virtual]

Search for all occurrences

Remarks:: This method is called by any IAutoXXParamDlg when it receives a SetThing().

Parameters:

m	The item which was set.

IParamMap2 Class Reference

Detailed Description

Public Member Functions

Member Function Documentation