This reference page is linked to from the following overview topics: Lesson 6: Parameter Blocks, Major New Features, Incremental Improvements, Overview: Parameter Blocks, Parameter Blocks, Parameter Block Flags, Parameter Types, Getting and Setting Parameter Block Values, Parameter Block 1, Custom Attributes, Strong References, Translation of Texture Map and Materials, Controllers and Parameter Blocks, Animation Track Locking, IIKChainControl, Creating Parameter Blocks, Getting and Setting Parameter Block Version, Supporting Save to Previous.

Detailed Description

See also:: Class ReferenceTarget, Class ParamBlockDesc2, List of ParamType2 Choices, Structure ParamDef, Class PBValidator, Class PBAccessor, Class PBBitmap, Class ParamBlock2PLCB, Class ClassDesc2, Class Animatable, Structure ParamAlias.

Description:: This class provides an interface for working with parameter block2s. There are methods for getting and setting parameters, descriptor access, parameter map access, etc.

Method Groups:: See Method Groups for Class IParamBlock2.

#include <iparamb2.h>

Inheritance diagram for IParamBlock2:

[legend]

List of all members.

Public Member Functions
virtual DWORD	GetVersion ()=0
virtual int	NumParams ()=0
virtual MCHAR *	GetLocalName ()=0
virtual ParamBlockDesc2 *	GetDesc ()=0
virtual void	ReleaseDesc ()=0
virtual void	SetDesc (ParamBlockDesc2 *desc)=0
virtual ParamDef &	GetParamDef (ParamID id)=0
virtual BlockID	ID ()=0
virtual int	IDtoIndex (ParamID id)=0
virtual ParamID	IndextoID (int i)=0
virtual ReferenceMaker *	GetOwner ()=0
virtual SClass_ID	GetAnimParamControlType (int anim)=0
virtual SClass_ID	GetParamControlType (ParamID id)=0
virtual ParamType2	GetParameterType (ParamID id)=0
virtual MSTR	GetLocalName (ParamID id, int tabIndex=-1)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, float v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, int v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, Point3 &v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, Point4 &v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, Color &v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, AColor &v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, const MCHAR *v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, Mtl *v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, Texmap *v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, PBBitmap *v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, INode *v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, ReferenceTarget *v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, IParamBlock2 *v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, Matrix3 &v, int tabIndex=0)=0
virtual BOOL	SetValue (ParamID id, TimeValue t, const MaxSDK::AssetManagement::AssetUser &v, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, float &v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, int &v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, Point3 &v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, Point4 &v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, Color &v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, AColor &v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, const MCHAR *&v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, Mtl *&v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, Texmap *&v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, PBBitmap *&v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, INode *&v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, ReferenceTarget *&v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, IParamBlock2 *&v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, Matrix3 &v, Interval &ivalid, int tabIndex=0)=0
virtual BOOL	GetValue (ParamID id, TimeValue t, MaxSDK::AssetManagement::AssetUser &v, Interval &ivalid, int tabIndex=0)=0
virtual Color	GetColor (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual AColor	GetAColor (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual Point3	GetPoint3 (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual Point4	GetPoint4 (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual int	GetInt (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual float	GetFloat (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual TimeValue	GetTimeValue (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual const MCHAR *	GetStr (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual Mtl *	GetMtl (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual Texmap *	GetTexmap (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual PBBitmap *	GetBitmap (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual INode *	GetINode (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual ReferenceTarget *	GetReferenceTarget (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual IParamBlock2 *	GetParamBlock2 (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual Matrix3	GetMatrix3 (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual MaxSDK::AssetManagement::AssetUser	GetAssetUser (ParamID id, TimeValue t=0, int tabIndex=0)=0
virtual PB2Value &	GetPB2Value (ParamID id, int tabIndex=0)=0
virtual int	Count (ParamID id)=0
virtual void	ZeroCount (ParamID id)=0
virtual void	SetCount (ParamID id, int n)=0
virtual int	Delete (ParamID id, int start, int num)=0
virtual int	Resize (ParamID id, int num)=0
virtual void	Shrink (ParamID id)=0
virtual void	Sort (ParamID id, CompareFnc cmp)=0
virtual int	Insert (ParamID id, int at, int num, float *el)=0
virtual int	Insert (ParamID id, int at, int num, Point3 **el)=0
virtual int	Insert (ParamID id, int at, int num, Point4 **el)=0
virtual int	Insert (ParamID id, int at, int num, Color **el)=0
virtual int	Insert (ParamID id, int at, int num, AColor **el)=0
virtual int	Insert (ParamID id, int at, int num, TimeValue *el)=0
virtual int	Insert (ParamID id, int at, int num, MCHAR **vel)=0
virtual int	Insert (ParamID id, int at, int num, const MCHAR **vel)=0
virtual int	Insert (ParamID id, int at, int num, Mtl **el)=0
virtual int	Insert (ParamID id, int at, int num, Texmap **el)=0
virtual int	Insert (ParamID id, int at, int num, PBBitmap **el)=0
virtual int	Insert (ParamID id, int at, int num, INode **v)=0
virtual int	Insert (ParamID id, int at, int num, ReferenceTarget **el)=0
virtual int	Insert (ParamID id, int at, int num, IParamBlock2 **el)=0
virtual int	Insert (ParamID id, int at, int num, Matrix3 **el)=0
virtual int	Append (ParamID id, int num, float *el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, Point3 **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, Point4 **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, Color **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, AColor **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, TimeValue *el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, MCHAR **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, const MCHAR **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, Mtl **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, Texmap **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, PBBitmap **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, INode **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, ReferenceTarget **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, IParamBlock2 **el, int allocExtra=0)=0
virtual int	Append (ParamID id, int num, Matrix3 **el, int allocExtra=0)=0
virtual BOOL	KeyFrameAtTimeByIndex (int i, TimeValue t, int tabIndex=0)
	Checks to see if a keyframe exists for the given parameter at the given time.
MAX_DEPRECATED BOOL	KeyFrameAtTime (int i, TimeValue t, int tabIndex=0)
virtual BOOL	KeyFrameAtTimeByID (ParamID id, TimeValue t, int tabIndex=0)
	Checks to see if a keyframe exists for the given parameter at the given time.
MAX_DEPRECATED BOOL	KeyFrameAtTime (ParamID id, TimeValue t, int tabIndex=0)
virtual void	RemoveControllerByIndex (int i, int tabIndex)=0
	Removes the 'i-th' controller.
MAX_DEPRECATED void	RemoveController (int i, int tabIndex)
virtual Control *	GetControllerByID (ParamID id, int tabIndex=0)=0
	Gets a pointer to the controller of the specified parameter.
MAX_DEPRECATED Control *	GetController (ParamID id, int tabIndex=0)
virtual Control *	GetControllerByIndex (int i, int tabIndex=0)=0
	Gets a pointer to the controller of the specified parameter.
MAX_DEPRECATED Control *	GetController (int i, int tabIndex=0)
virtual void	SetControllerByIndex (int i, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE)=0
	Sets the indexed parameter controller to the one specified.
virtual void	SetControllerByID (ParamID id, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE)
	Sets the parameter with the given id to the specified controller.
MAX_DEPRECATED void	SetController (int i, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE)
MAX_DEPRECATED void	SetController (ParamID id, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE)
virtual void	SwapControllers (int i1, int tabIndex1, int i2, int tabIndex2)=0
	Swaps the two controllers of the parameters whose indices are passed.
virtual int	GetRefNum (int i, int tabIndex=0)=0
virtual int	GetControllerRefNum (int i, int tabIndex=0)=0
virtual int	GetAnimNum (ParamID id, int tabIndex=0)=0
virtual int	AnimNumToParamNum (int animNum, int &tabIndex)=0
virtual ParamDimension *	GetParamDimension (int subAnim)=0
virtual void	RescaleParam (int paramNum, int tabIndex, float f)=0
virtual ParamID	LastNotifyParamID ()=0
virtual ParamID	LastNotifyParamID (int &tabIndex)=0
virtual void	EnableNotifications (BOOL onOff)=0
virtual BOOL	IsNotificationEnabled ()=0
	This method returns a BOOL value to indicate whether the notifications are globally enabled.
virtual void	RefDeleted (ParamID id, int tabIndex=0)=0
virtual void	SetMap (IParamMap2 *m, MapID map_id=0)=0
virtual IParamMap2 *	GetMap (MapID map_id=0)=0
virtual void	SetRolloutOpen (BOOL open, MapID map_id=0)=0
virtual BOOL	GetRolloutOpen (MapID map_id=0)=0
virtual void	SetRolloutScrollPos (int pos, MapID map_id=0)=0
virtual int	GetRolloutScrollPos (MapID map_id=0)=0
virtual IAutoMParamDlg *	GetMParamDlg ()=0
virtual IAutoEParamDlg *	GetEParamDlg ()=0
virtual void	InitMSParameters ()=0
virtual void	DefineParamAlias (MCHAR *alias_name, ParamID id, int tabIndex=-1)=0
virtual ParamAlias *	FindParamAlias (MCHAR *alias_name)=0
virtual MCHAR *	FindParamAlias (ParamID id, int tabIndex=-1)=0
virtual void	ClearParamAliases ()=0
virtual int	ParamAliasCount ()=0
virtual ParamAlias *	GetParamAlias (int i)=0
virtual void	SetSubAnimNum (ParamID id, int subAnimNum, int tabIndex=0)=0
virtual void	ClearSubAnimMap ()=0
virtual void	Assign (ParamID id, IParamBlock2 *src, ParamID src_id)=0
virtual ParamID	FindRefParam (ReferenceTarget *ref, int &tabIndex)=0
virtual void	ResetAll (BOOL updateUI=TRUE, BOOL callSetHandlers=TRUE)=0
virtual void	Reset (ParamID id, int tabIndex=-1, BOOL updateUI=TRUE, BOOL callSetHandlers=TRUE)=0
virtual void	CallSet (ParamID id, int tabIndex=-1)=0
virtual void	CallGet (ParamID id, int tabIndex=-1)=0
virtual void	CallSets ()=0
virtual void	CallGets ()=0
virtual void	GetValidity (TimeValue t, Interval &valid)=0

Member Function Documentation

virtual DWORD GetVersion ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the version of this parameter block.

virtual int NumParams ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the number of parameters in this parameter block.

virtual MCHAR* GetLocalName ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the localized name for the parameter block.

virtual ParamBlockDesc2* GetDesc ( ) [pure virtual]

Search for all occurrences

Remarks:: Aquires the descriptor for this parameter block. Call ReleaseDesc() when done.

virtual void ReleaseDesc ( ) [pure virtual]

Search for all occurrences

Remarks:: Releases the descriptor for this parameter block. See GetDesc() above.

virtual void SetDesc ( ParamBlockDesc2 * desc ) [pure virtual]

Search for all occurrences

Remarks:: Sets the descriptor associated with the parameter block.

Parameters:

desc	Points to the descriptor to set.

virtual ParamDef& GetParamDef ( ParamID id ) [pure virtual]

Search for all occurrences

Remarks:: Returns a reference to the ParamDef structure for this parameter block.

Parameters:

id	The parameter ID.

virtual BlockID ID ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the BlockID of the parameter block. Note: typedef short BlockID;

virtual int IDtoIndex ( ParamID id ) [pure virtual]

Search for all occurrences

Remarks:: Returns the zero based index of the parameter into the parameter definitions array of the given parameter ID or -1 if not found.

Parameters:

id	The parameter ID whose index to return.

virtual ParamID IndextoID ( int i ) [pure virtual]

Search for all occurrences

Remarks:: Returns the parameter ID of the parameter given its index into the parameter definitions array.

Parameters:

i	The index of the parameter whose ID is to be returned.

virtual ReferenceMaker* GetOwner ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to the owner of this parameter block.

virtual SClass_ID GetAnimParamControlType ( int anim ) [pure virtual]

Search for all occurrences

Remarks:: Returns the Super Class ID of the parameter's controller (specified by sub-anim number).

Parameters:

anim	The sub-anim index of the parameter.

virtual SClass_ID GetParamControlType ( ParamID id ) [pure virtual]

Search for all occurrences

Remarks:: Returns the Super Class ID of the parameter's controller (specified by paramter ID).

Parameters:

id	The ID of the parameter.

virtual ParamType2 GetParameterType ( ParamID id ) [pure virtual]

Search for all occurrences

Remarks:: Returns the type of the specified parameter.

Parameters:

id	The ID of the parameter.

virtual MSTR GetLocalName	(	ParamID	id,
		int	tabIndex = `-1`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the local name for the specified parameter or Tab<> parameter entry.

Parameters:

id	The permanent ID of the parameter.
tabIndex	If the parameter is a table this is the zero based index into the table of the parameter.

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		float	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the floating point value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_FLOAT, TYPE_ANGLE, TYPE_PCNT_FRAC, TYPE_WORLD, TYPE_COLOR_CHANNEL

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		int	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the integer value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_INT, TYPE_BOOL, TYPE_TIMEVALUE, TYPE_RADIOBTN_INDEX, TYPE_INDEX

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		Point3 &	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the Point3 value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_POINT3, TYPE_RGBA, TYPE_HSV

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		Point4 &	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the Point4 value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_POINT4, TYPE_FRGBA

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		Color &	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the Color value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_POINT3, TYPE_RGBA, TYPE_HSV

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		AColor &	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the AColor value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_POINT4, TYPE_FRGBA

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		const MCHAR *	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the string value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_FILENAME or TYPE_STRING

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		Mtl *	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the Mtl* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_MTL

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		Texmap *	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the Texmap* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_TEXMAP

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		PBBitmap *	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the PBBitmap* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_BITMAP

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		INode *	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the INode* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_INODE

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		ReferenceTarget *	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the ReferenceTarget* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_MTL, TYPE_TEXMAP, TYPE_INODE, TYPE_REFTARG, TYPE_PBLOCK2, TYPE_OBJECT, TYPE_CONTROL

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		IParamBlock2 *	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the IParamBlock2* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_PBLOCK2

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		Matrix3 &	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the Matrix3 value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_MATRIX3; TYPE_MATRIX3 items cannot be animated.

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		const MaxSDK::AssetManagement::AssetUser &	v,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the AssetId value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to set the value.
v	The value to set.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to set.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no set occurs: TYPE_FILENAME

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		float &	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the floating point value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain 0.0f: TYPE_FLOAT, TYPE_ANGLE, TYPE_PCNT_FRAC, TYPE_WORLD, TYPE_COLOR_CHANNEL

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		int &	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the integer value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain 0: TYPE_INT, TYPE_BOOL, TYPE_TIMEVALUE, TYPE_RADIOBTN_INDEX, TYPE_INDEX

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		Point3 &	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the Point3 value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain Point3::Origin: TYPE_POINT3, TYPE_RGBA, TYPE_HSV

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		Point4 &	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the Point4 value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain Point4::Origin: TYPE_POINT4, TYPE_FRGBA

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		Color &	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the Color value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain black: TYPE_POINT3, TYPE_RGBA, TYPE_HSV

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		AColor &	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the AColor value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain black: TYPE_POINT4, TYPE_FRGBA

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		const MCHAR *&	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the string value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will not be modified: TYPE_FILENAME or TYPE_STRING

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		Mtl *&	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the Mtl* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain NULL: TYPE_MTL

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		Texmap *&	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the Texmap* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain NULL: TYPE_TEXMAP

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		PBBitmap *&	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the PBBitmap* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain NULL: TYPE_BITMAP

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		INode *&	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the INode* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain NULL: TYPE_INODE

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		ReferenceTarget *&	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the ReferenceTarget* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain NULL: TYPE_MTL, TYPE_TEXMAP, TYPE_INODE, TYPE_REFTARG, TYPE_PBLOCK2, TYPE_OBJECT, TYPE_CONTROL

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		IParamBlock2 *&	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the IParamBlock2* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain NULL: TYPE_PBLOCK2

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		Matrix3 &	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the Matrix3 value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain IdentityMatrix: TYPE_MATRIX3; TYPE_MATRIX3 items cannot be animated.

virtual BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		MaxSDK::AssetManagement::AssetUser &	v,
		Interval &	ivalid,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the AssetUser value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
v	The value to retrieve is returned here.
ivalid	This is the validity interval which is updated by the validity of the retrieved parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: TRUE on success; otherwise FALSE.

Note:: The ParamType must be one of the following, otherwise no get occurs and v will contain IdentityMatrix: TYPE_FILENAME

virtual Color GetColor	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the Color value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The Color value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of black returned: TYPE_POINT3, TYPE_RGBA, TYPE_HSV

virtual AColor GetAColor	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the AColor value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The AColor value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of black returned: TYPE_POINT4, TYPE_FRGBA

virtual Point3 GetPoint3	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the Point3 value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The Point3 value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of Point3::Origin returned: TYPE_POINT3, TYPE_RGBA, TYPE_HSV

virtual Point4 GetPoint4	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the Point4 value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The Point4 value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of Point4::Origin returned: TYPE_POINT4, TYPE_FRGBA

virtual int GetInt	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the integer value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The integer value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of 0 will be returned: TYPE_INT, TYPE_BOOL, TYPE_TIMEVALUE, TYPE_RADIOBTN_INDEX, TYPE_INDEX

virtual float GetFloat	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the floating point value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The floating point value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of 0.0f will be returned: TYPE_FLOAT, TYPE_ANGLE, TYPE_PCNT_FRAC, TYPE_WORLD, TYPE_COLOR_CHANNEL

virtual TimeValue GetTimeValue	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the TimeValue value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The TimeValue value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of 0 will be returned: TYPE_INT, TYPE_BOOL, TYPE_TIMEVALUE, TYPE_RADIOBTN_INDEX, TYPE_INDEX

virtual const MCHAR* GetStr	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the string pointer value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The string pointer value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of NULL will be returned: TYPE_FILENAME or TYPE_STRING

virtual Mtl* GetMtl	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the Mtl* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The Mtl* value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of NULL will be returned: TYPE_MTL

virtual Texmap* GetTexmap	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the Texmap* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The Texmap* value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of NULL will be returned: TYPE_TEXMAP

virtual PBBitmap* GetBitmap	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the PBBitmap* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The PBBitmap* value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of NULL will be returned: TYPE_BITMAP

virtual INode* GetINode	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the INode* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The INode* value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of NULL will be returned: TYPE_INODE

virtual ReferenceTarget* GetReferenceTarget	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the ReferenceTarget* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The ReferenceTarget* value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of NULL will be returned: TYPE_MTL, TYPE_TEXMAP, TYPE_INODE, TYPE_REFTARG, TYPE_PBLOCK2, TYPE_OBJECT, TYPE_CONTROL

virtual IParamBlock2* GetParamBlock2	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the IParamBlock2* value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The IParamBlock2* value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of NULL will be returned: TYPE_PBLOCK2

virtual Matrix3 GetMatrix3	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Retrieves the Matrix3 value of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The Matrix3 value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of IdentityMatrix will be returned: TYPE_MATRIX3; TYPE_MATRIX3 items cannot be animated.

virtual MaxSDK::AssetManagement::AssetUser GetAssetUser	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the assetuser of the specified parameter at the specified time.

Parameters:

id	The permanent ID of the parameter.
t	The time at which to get the value.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The AssetUser value retrieved.

Note:: The ParamType must be one of the following, otherwise no get occurs and a value of kInvalid will be returned: TYPE_FILENAME

virtual PB2Value& GetPB2Value	(	ParamID	id,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This methods is used for getting a parameter value as a PB2Value reference.

Parameters:

id	The permanent ID of the parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns:: The PB2Value value retrieved.

virtual int Count ( ParamID id ) [pure virtual]

Search for all occurrences

Remarks:: Returns the number of entries being used in the table.

Parameters:

id	The permanent ID of the parameter.

virtual void ZeroCount ( ParamID id ) [pure virtual]

Search for all occurrences

Remarks:: Set the number of elements in the table that are actually used to zero.

Parameters:

id	The permanent ID of the parameter.

virtual void SetCount	(	ParamID	id,
		int	n
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Set the number of elements in the table that are actually used to n.

Parameters:

id	The permanent ID of the parameter.
n	The number of elements to set.

virtual int Delete	(	ParamID	id,
		int	start,
		int	num
	)		`[pure virtual]`

Search for all occurrences

Remarks:: List-type delete of num elements starting with start

Parameters:

id	The permanent ID of the parameter.
start	The start position for element deletion.
num	The number of elements to delete.

Returns:: Returns the number of items left in the table.

virtual int Resize	(	ParamID	id,
		int	num
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Changes the number of allocated items to num.

Parameters:

id	The permanent ID of the parameter.
num	The new size of the table.

Returns:: Nonzero if the array was resized; otherwise 0.

virtual void Shrink ( ParamID id ) [pure virtual]

Search for all occurrences

Remarks:: Reallocate so there is no wasted space.

Parameters:

id	The permanent ID of the parameter.

virtual void Sort	(	ParamID	id,
		CompareFnc	cmp
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sorts the array using the compare function.

Parameters:

id The permanent ID of the parameter.

cmp Type of function to pass to Sort(). Note: Sort() just uses the C library qsort function. The developer must implement the CompareFnc function.

typedef int( __cdecl *CompareFnc) (const void *elem1, const void elem2);

The return value of CompareFnc is show below in the relationship of elem1 to elem2:

< 0

if elem1 less than elem2

0

if elem1 identical to elem2

> 0

if elem1 greater than elem2

Sample Code:

        static int CompTable( const void *elem1, const void *elem2 )
        {
            MCHAR *a = (MCHAR *)elem1;
            MCHAR *b = (MCHAR *)elem2;
            return(_tcscmp(a,b));
        }

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		float *	el
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num float elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
el	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Point3 **	el
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num Point3* elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
el	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Point4 **	el
	)		`[pure virtual]`

Search for all occurrences

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Color **	el
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num Color* elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
el	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		AColor **	el
	)		`[pure virtual]`

Search for all occurrences

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		TimeValue *	el
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num TimeValue elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
el	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		MCHAR **	vel
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num string (MCHAR*) elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
vel	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		const MCHAR **	vel
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num string (const MCHAR*) elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
vel	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Mtl **	el
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num Mtl* elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
el	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Texmap **	el
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num Texmap* elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num
el	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		PBBitmap **	el
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num PBBitmap* elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
el	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		INode **	v
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num INode* elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
v	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		ReferenceTarget **	el
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num ReferenceTarget* elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
el	Array of elements to insert.

Returns:: Returns at.

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		IParamBlock2 **	el
	)		`[pure virtual]`

Search for all occurrences

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Matrix3 **	el
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Insert num Matrix3* elements at position at.

Parameters:

id	The permanent ID of the parameter.
at	Zero based array index where to insert the elements.
num	Number of elements to insert.
el	Array of elements to insert.

Returns:: Returns at.

virtual int Append	(	ParamID	id,
		int	num,
		float *	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num float elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		Point3 **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num Point3* elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		Point4 **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

virtual int Append	(	ParamID	id,
		int	num,
		Color **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num Color* elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		AColor **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

virtual int Append	(	ParamID	id,
		int	num,
		TimeValue *	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num TimeValue elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		MCHAR **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num string (MCHAR*) elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		const MCHAR **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num string (const MCHAR*) elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		Mtl **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num Mtl* elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		Texmap **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num Texmap* elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		PBBitmap **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num PBBitmap* elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: The number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		INode **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num INode* elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		ReferenceTarget **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num ReferenceTarget* elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual int Append	(	ParamID	id,
		int	num,
		IParamBlock2 **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

virtual int Append	(	ParamID	id,
		int	num,
		Matrix3 **	el,
		int	allocExtra = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Append num Matrix3* elements at the end of the array.

Parameters:

id	The permanent ID of the parameter.
num	The number of elements to append to the end of the array.
el	The elements to append.
allocExtra	If you need to enlarge the array specify an non-zero value and this many extra slots will be allocated.

Returns:: Returns the number of elements in use prior to appending.

virtual BOOL KeyFrameAtTimeByIndex	(	int	i,
		TimeValue	t,
		int	tabIndex = `0`
	)		`[inline, virtual]`

Search for all occurrences

Checks to see if a keyframe exists for the given parameter at the given time.

Parameters:

i	Zero based index of the parameter to check.
t	The time to check.
tabIndex	If the parameter is a table this is the zero based index of the element in the table to check.

Returns:: TRUE if a keyframe exists at the specified time; otherwise FALSE.

{ return FALSE; }

MAX_DEPRECATED BOOL KeyFrameAtTime	(	int	i,
		TimeValue	t,
		int	tabIndex = `0`
	)

Search for all occurrences

Deprecated:: Deprecated in 3ds Max 2012. Use KeyFrameAtTimeByIndex or instead.

virtual BOOL KeyFrameAtTimeByID	(	ParamID	id,
		TimeValue	t,
		int	tabIndex = `0`
	)		`[inline, virtual]`

Search for all occurrences

Checks to see if a keyframe exists for the given parameter at the given time.

Note this method is slower than KeyFrameAtTimeByIndex.

Parameters:

id	The permanent ID of the parameter.
t	The time to check.
tabIndex	If the parameter is a table this is the zero based index of the element in the table to check.

Returns:: TRUE if a keyframe exists at the specified time; otherwise FALSE.

{ return KeyFrameAtTimeByIndex(IDtoIndex(id), t, tabIndex); }

MAX_DEPRECATED BOOL KeyFrameAtTime	(	ParamID	id,
		TimeValue	t,
		int	tabIndex = `0`
	)

Search for all occurrences

Deprecated:: Deprecated in 3ds Max 2012. Use KeyFrameAtTimeByID instead.

virtual void RemoveControllerByIndex	(	int	i,
		int	tabIndex
	)		`[pure virtual]`

Search for all occurrences

Removes the 'i-th' controller.

Parameters:

i	Specifies which controller using the zero based index of the parameter in the block.
tabIndex	If the parameter is a table this is the zero based index of the element in the table whose controller is removed.

MAX_DEPRECATED void RemoveController	(	int	i,
		int	tabIndex
	)

Search for all occurrences

Deprecated:: Deprecated in 3ds Max 2012. Use RemoveControllerByIndex instead.

virtual Control* GetControllerByID	(	ParamID	id,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Gets a pointer to the controller of the specified parameter.

Note this method is slower than GetControllerByIndex.

Parameters:

id	The permanent ID of the parameter.
tabIndex	If the parameter is a table this is the zero based index of the element in the table whose controller is returned.

MAX_DEPRECATED Control* GetController	(	ParamID	id,
		int	tabIndex = `0`
	)

Search for all occurrences

Deprecated:: Deprecated in 3ds Max 2012. Use GetControllerByID instead.

virtual Control* GetControllerByIndex	(	int	i,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Gets a pointer to the controller of the specified parameter.

Parameters:

i	Specifies which controller using the zero based index of the parameter in the block.
tabIndex	If the parameter is a table this is the zero based index of the element in the table whose controller is returned.

MAX_DEPRECATED Control* GetController	(	int	i,
		int	tabIndex = `0`
	)

Search for all occurrences

Deprecated:: Deprecated in 3ds Max 2012. Use GetControllerByIndex instead.

virtual void SetControllerByIndex	(	int	i,
		int	tabIndex,
		Control *	c,
		BOOL	preserveFrame0Value = `TRUE`
	)		`[pure virtual]`

Search for all occurrences

Sets the indexed parameter controller to the one specified.

Parameters:

i	Specifies which controller using the zero based index of the parameter in the block.
tabIndex	If the parameter is a table this is the zero based index of the element in the table.
c	The controller to set.
preserveFrame0Value	If TRUE the controllers value at frame 0 is preserved.

virtual void SetControllerByID	(	ParamID	id,
		int	tabIndex,
		Control *	c,
		BOOL	preserveFrame0Value = `TRUE`
	)		`[inline, virtual]`

Search for all occurrences

Sets the parameter with the given id to the specified controller.

Note that this is slower than calling SetControllerByIndex.

Parameters:

id	The parameter id of the controller to be set.
tabIndex	If the parameter is a table this is the zero based index of the element in the table.
c	The controller to set.
preserveFrame0Value	If TRUE the controllers value at frame 0 is preserved.

{ SetControllerByIndex(IDtoIndex(id), tabIndex, c, preserveFrame0Value); }

MAX_DEPRECATED void SetController	(	int	i,
		int	tabIndex,
		Control *	c,
		BOOL	preserveFrame0Value = `TRUE`
	)

Search for all occurrences

Deprecated:: Deprecated in 3ds Max 2012. Use SetControllerByIndex instead.

MAX_DEPRECATED void SetController	(	ParamID	id,
		int	tabIndex,
		Control *	c,
		BOOL	preserveFrame0Value = `TRUE`
	)

Search for all occurrences

Deprecated:: Deprecated in 3ds Max 2012. Use SetControllerByID instead.

virtual void SwapControllers	(	int	i1,
		int	tabIndex1,
		int	i2,
		int	tabIndex2
	)		`[pure virtual]`

Search for all occurrences

Swaps the two controllers of the parameters whose indices are passed.

Parameters:

i1	The zero based index of one of the parameters in the parameter block.
tabIndex1	If the parameter is a table this is the zero based index of the element in the table.
i2	The zero based index of one of the other parameters in the parameter block.
tabIndex2	If the parameter is a table this is the zero based index of the element in the table.

virtual int GetRefNum	(	int	i,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Given a parameter index this method will return the reference number of that parameter.

Parameters:

i	The zero based index of the parameter in the parameter block.
tabIndex	If the parameter is a table this is the zero based index of the element in the table.

virtual int GetControllerRefNum	(	int	i,
		int	tabIndex = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the reference number of the specified parameter's controller or -1 if not found.

Parameters:

i	The zero based index into the parameter definitions array of the parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index in the table of the parameter.

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

Search for all occurrences

Remarks:: Returns the sub-anim number of the parameter whose ID is passed or -1 if not found.

Parameters:

id	The parameter ID of the parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index in the table of the parameter.

virtual int AnimNumToParamNum	(	int	animNum,
		int &	tabIndex
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Returns the index into the parameter definitions array of the parameter whose sub-anim index is specified or -1 if not found.

Parameters:

animNum	The zero based sub-anim index of the parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the parameter.

virtual ParamDimension* GetParamDimension ( int subAnim ) [pure virtual]

Search for all occurrences

Remarks:: Returns the dimension of the parameter whose sub-anim index is passed or defaultDim if not found.

Parameters:

subAnim The zero based sub-anim index of the parameter.

Reimplemented from Animatable.

virtual void RescaleParam	(	int	paramNum,
		int	tabIndex,
		float	f
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This is only for use in a RescaleWorldUnits() implementation: The parameter block implementation of RescaleWorldUnits scales only tracks that have dimension type = stdWorldDim. If letting the parameter block handle the rescaling is not sufficient, call this on just the parameters you need to rescale.

Parameters:

paramNum	The index into the parmeter block of the parameter to rescale.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the parameter.
f	The value to scale by.

virtual ParamID LastNotifyParamID ( ) [pure virtual]

Search for all occurrences

virtual ParamID LastNotifyParamID ( int & tabIndex ) [pure virtual]

Search for all occurrences

Remarks:: Like LastNotifyParamID(), but takes an int& tabIndex argument so that it can return both the ID of the changing parameter (as the result) and the changing element index for Tab<> parameters.

If the ParamID returns -1 because no parameter is currently changing, tabIndex is not updated. If the change to a Tab<> parameter is not to a single element (such as a sort), the tabIndex is set to -1. For multiple inserts, appends, deletes, the tabIndex returned is the index of the first element inserted, appended, deleted.

Parameters:

tabIndex The index of the changing element for Tab<> parameters is returned here.

virtual void EnableNotifications ( BOOL onOff ) [pure virtual]

Search for all occurrences

Remarks:

Controls whether NotifyDependents() messages are sent when a parameter is changed, such as through

a SetValue() call. For example:

        pblock->EnableNotifications(FALSE);
        ... param change code ...
        pblock->EnableNotifications(TRUE);

Notifications are enabled by default. Note that this is a GLOBAL enable/disable, ALL paramblocks will be prevented from sending notifications while EnableNotifications(FALSE) is in effect.

Parameters:

onOff TRUE to enable notifications, FALSE to disable them.

virtual BOOL IsNotificationEnabled ( ) [pure virtual]

Search for all occurrences

This method returns a BOOL value to indicate whether the notifications are globally enabled.

Returns:: TRUE if the notifications are enabled, FALSE otherwise.

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

Search for all occurrences

Remarks:: This method should be called when the parameter block owner has deleted the reference to a reference target parameter. This sets the value to NULL and invalidates the UI associated with the pblock. Note that this must only be called on P_OWNERS_REF parameters.

Parameters:

id	The ID of the reference target parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the parameter.

virtual void SetMap	(	IParamMap2 *	m,
		MapID	map_id = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method sets the parameter map2 associated with this parameter block2.

Parameters:

m	Points to the parameter map.
map_id	Specifies the ID of the map to set.

virtual IParamMap2* GetMap ( MapID map_id = 0 ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to the parameter map2 associated with this parameter block.

Parameters:

map_id Specifies the ID of the map to get.

virtual void SetRolloutOpen	(	BOOL	open,
		MapID	map_id = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the rollout state to open or closed.

Note: Normally, developers don't need to call this method (or the related ones below) explicitly; they are used internally to keep track of rollouts states. Instead, use the ClassDesc2 method RestoreRolloutState() at the end of a BeginEditParams() or CreateParamDlg() to reset the rollouts to the state last used for the current object.

Parameters:

open	TRUE for open; FALSE for closed.
map_id	Specifies the ID of the map/rollout to set open/closed state for.

virtual BOOL GetRolloutOpen ( MapID map_id = 0 ) [pure virtual]

Search for all occurrences

Remarks:: Returns TRUE if the rollout is open; FALSE if closed. This is normally used internally -- see the note above in SetRolloutOpen().

Parameters:

map_id Specifies the ID of the map/rollout to get open/closed state for.

virtual void SetRolloutScrollPos	(	int	pos,
		MapID	map_id = `0`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Sets the rollout scroll position. This is normally used internally -- see the note above in SetRolloutOpen().

Parameters:

pos	The position to set.
map_id	Specifies the ID of the map/rollout to set scroll position for.

virtual int GetRolloutScrollPos ( MapID map_id = 0 ) [pure virtual]

Search for all occurrences

Remarks:: Returns the rollout scroll position. This is normally used internally -- see the note above in SetRolloutOpen().

Parameters:

map_id Specifies the ID of the map/rollout to get scroll position for.

virtual IAutoMParamDlg* GetMParamDlg ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to the automatic parameter dialog object for a plug-in material or texmap (which has its interface in the materias editor). See Class IAutoMParamDlg.

virtual IAutoEParamDlg* GetEParamDlg ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to the automatic parameter dialog object for the rendering effects plug-in. See Class IAutoEParamDlg.

virtual void InitMSParameters ( ) [pure virtual]

Search for all occurrences

Remarks:: This method initializes the parameters with MAXScript defaults.

The ParamBlockDesc2 descriptor lets you specify default values for parameters (using the tag p_default), and these get installed when you first create an object and its paramblocks. Sometimes, the default value needed for interactive creation is not the one you want when creating an object via the scripter. For example, a sphere should start out with radius 0 when you create it interactively, but you want a non-zero default if you create it in the scripter, say with sphere(), otherwise it would be invisible. There is another tag, p_ms_default, that lets you set a separate default for scripter-based creation (the p_ms_default for sphere radius is 25). This method is used internally by the scripter to set the p_ms_default values in after a script-based creation. It is not normally used by plug-in developers.

virtual void DefineParamAlias	(	MCHAR *	alias_name,
		ParamID	id,
		int	tabIndex = `-1`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This is used to allow parameter 'aliases' to be set up for MAXScript use. Individual Tab<> parameter elements can have aliases. This is used to set up dynamically-varying parameters, such as the texture maps in the new Standard material, which sets up aliases for elements in the texture map arrays.

Parameters:

alias_name	The name of the alias.
id	The permanent ID of the parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index of the parameter in the table.

virtual ParamAlias* FindParamAlias ( MCHAR * alias_name ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to a Structure ParamAlias object which describes the paramater alias whose name is passed. This includes the name, ParamID and Tab<> index.

Parameters:

alias_name The name of the alias to find.

virtual MCHAR* FindParamAlias	(	ParamID	id,
		int	tabIndex = `-1`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: Finds the name of a parmameter alias using the ID and Tab<> index passed.

Parameters:

id	The permanent ID of the parameter.
tabIndex	If the parameter is a Tab<> this is the zero based index into the table. If not a Tab<> use the default of -1.

Returns:: The name of the alias or NULL if not found.

virtual void ClearParamAliases ( ) [pure virtual]

Search for all occurrences

Remarks:: Breaks the association between the aliases and their parameters in this block. The method ParamAliasCount() below will return 0 following this call.

virtual int ParamAliasCount ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the number of aliases currently defined.

virtual ParamAlias* GetParamAlias ( int i ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to the 'i-th' alias. See Structure ParamAlias.

Parameters:

i	The zero based index of the alias to return.

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

Search for all occurrences

Remarks:: This method allows for the arbitrary ordering of sub-anim numbers for parameters and Tab<> parameter elements. It sets the sub-anim number for the specified parameter.

This call lets you set arbitrary sub-anim number ordering for the subAnim parameters and Tab<> parameter elements in the block. You must set numbers for ALL subAnims and take care that all numbers are used. Note that in the case of the various ReferenceTarget* parameter types, NULL values for any parameter or Tab<> elements are not included the subAnim count, so if such a parameter is made non-NULL (or vice-versa), you need to reassign the subanim numbers to take that change into account.

Parameters:

id	The permanent parameter ID
subAnimNum	The zero based sub-anim number.
tabIndex	The zero based index into the table of the parameter.

virtual void ClearSubAnimMap ( ) [pure virtual]

Search for all occurrences

Remarks:: This method clears any sub-anim map used to allow arbitrary ordering of sub-anim numbers for parameters.

virtual void Assign	(	ParamID	id,
		IParamBlock2 *	src,
		ParamID	src_id
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method is used for copying parameter values between parameter blocks (which is useful during old-version updating). This method copies from the 'src' block 'src_id' parameter into this parameter block's 'id' parameter. Developers are responsible for making sure the types are the same, otherwise an assert() may occur.

Parameters:

id	This ID specifies the destination parameter.
src	Points to the source parameter block 2.
src_id	The source parameter ID.

virtual ParamID FindRefParam	(	ReferenceTarget *	ref,
		int &	tabIndex
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method that takes a reference target object ref stored somewhere in this parameter block and returns the ParamID and tabIndex of the containing parameter, or -1 if not found in the parameter block.

Parameters:

ref	The reference target to find.
tabIndex	The table index if the parameter is a Tab<>.

virtual void ResetAll	(	BOOL	updateUI = `TRUE`,
		BOOL	callSetHandlers = `TRUE`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method resets all the parameters in the block to their default values and optionally updates any associated ParamMap2 UI that is currently displaying the contents of the block. It also optionally causing all the PBAccessor Set() methods to be called after the reset.

Parameters:

updateUI	TRUE to update the user inteface; FALSE to not update.
callSetHandlers	TRUE to call PBAccessor::Set() for all the parameters; otherwise FALSE.

virtual void Reset	(	ParamID	id,
		int	tabIndex = `-1`,
		BOOL	updateUI = `TRUE`,
		BOOL	callSetHandlers = `TRUE`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method resets the single parameter specified to its default value. If the parameter is a Tab<> and the tabIndex is -1, all the elements in the table are reset.

Parameters:

id	The ID of the parameter to reset.
tabIndex	If the parameter is a Tab<> this is the index into the table of the parameter to reset. A value of -1 causes all the elements in the table to be reset.
updateUI	Determines if the user inteface is updated for the parameter. TRUE to update; FALSE to not update.
callSetHandlers	Determines if the method PBAccessor::Set() should be called on the parameter. TRUE to call it; FALSE to not call it.

virtual void CallSet	(	ParamID	id,
		int	tabIndex = `-1`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method forces a call to the PBAccessor::Set() method for the specified parameter. If the parameter is a Tab<> parameter and the tabIndex is -1, all the elements have the appropriate functions called.

Parameters:

id	The ID of the parameter.
tabIndex	If the parameter is a Tab<> parameter this is the zero based index into the table of the element. A value of -1 causes all the appropriate Set() methods to be called.

virtual void CallGet	(	ParamID	id,
		int	tabIndex = `-1`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method forces a call to the PBAccessor::Get() method for the specified parameter. If the parameter is a Tab<> parameter and the tabIndex is -1, all the elements have the appropriate functions called.

Parameters:

id	The ID of the parameter.
tabIndex	If the parameter is a Tab<> parameter this is the zero based index into the table of the element. A value of -1 causes all the appropriate Get() methods to be called.

virtual void CallSets ( ) [pure virtual]

Search for all occurrences

Remarks:: This method forces a call to the PBAccessor::Set() method for every parameter in the block. Any parameters which are Tab<> parameters will have Set() call for every appropriate element.

virtual void CallGets ( ) [pure virtual]

Search for all occurrences

Remarks:: This method forces a call to the PBAccessor::Get() method for every parameter in the block. Any parameters which are Tab<> parameters will have Get() call for every appropriate element.

virtual void GetValidity	(	TimeValue	t,
		Interval &	valid
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method updates the validity interval passed with the cumulative interval for every parameter in the parameter block.

Parameters:

t	The time about which the interval is computed.
valid	The interval to update.

IParamBlock2 Class Reference

Detailed Description

Public Member Functions

Member Function Documentation