#include <iparamb2.h>

Inheritance diagram for IParamBlock2:

Classes
class	ParameterIterator
	Provides standard C++ iteration functionality for the parameters stored by an IParamBlock2. More...

Public Member Functions
virtual void	RefDeleted (ParamID id, int tabIndex=0)=0

template<typename T >
bool	SetValueByName (const MCHAR *const paramName, const T &value, const TimeValue t, const int tabIndex=0)
	Set a parameter value using the parameter name. More...

template<typename T >
bool	GetValueByName (const MCHAR *const paramName, const TimeValue t, T &value, Interval &validity, const int tabIndex=0)
	Get a parameter value using the parameter name. More...

Version/Parameter Number/Local Name/ParamDef/BlockID/Owner Access

virtual DWORD	GetVersion ()=0

virtual int	NumParams ()=0

virtual const MCHAR *	GetLocalName ()=0

virtual ParamDef &	GetParamDef (ParamID id)=0

virtual BlockID	ID ()=0

virtual ReferenceMaker *	GetOwner ()=0

const ParamDef *	GetParamDefByIndex (const unsigned int parameterIndex) const
	Returns the parameter definition for the parameter with the given index. More...

Descriptor Access
virtual ParamBlockDesc2 *	GetDesc ()=0

virtual void	ReleaseDesc ()=0

virtual void	SetDesc (ParamBlockDesc2 *desc)=0

Index-to/from-ID Methods
virtual int	IDtoIndex (ParamID id)=0

virtual ParamID	IndextoID (int i)=0

Super Class ID Access
virtual SClass_ID	GetAnimParamControlType (int anim)=0

virtual SClass_ID	GetParamControlType (ParamID id)=0

Parameter Type and Local Name
virtual ParamType2	GetParameterType (ParamID id)=0

virtual MSTR	GetLocalName (ParamID id, int tabIndex=-1, bool localized=true)=0

SetValue() Parameter Accessors

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, const Point2 &v, int tabIndex=0)=0

virtual BOOL	SetValue (ParamID id, TimeValue t, const Point3 &v, int tabIndex=0)=0

virtual BOOL	SetValue (ParamID id, TimeValue t, const Point4 &v, int tabIndex=0)=0

virtual BOOL	SetValue (ParamID id, TimeValue t, const Color &v, int tabIndex=0)=0

virtual BOOL	SetValue (ParamID id, TimeValue t, const 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, const Matrix3 &v, int tabIndex=0)=0

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

GetValue() Parameter Accessors

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, Point2 &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

template<typename ValueType >
BOOL	GetValue (ParamID id, TimeValue t, ValueType &v, int tabIndex=0)

Shortcut Get Methods
virtual Color	GetColor (ParamID id, TimeValue t=0, int tabIndex=0)=0

Color	GetColor (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual AColor	GetAColor (ParamID id, TimeValue t=0, int tabIndex=0)=0

AColor	GetAColor (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual Point2	GetPoint2 (ParamID id, TimeValue t=0, int tabIndex=0)=0

Point2	GetPoint2 (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual Point3	GetPoint3 (ParamID id, TimeValue t=0, int tabIndex=0)=0

Point3	GetPoint3 (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual Point4	GetPoint4 (ParamID id, TimeValue t=0, int tabIndex=0)=0

Point4	GetPoint4 (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual int	GetInt (ParamID id, TimeValue t=0, int tabIndex=0)=0

int	GetInt (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual float	GetFloat (ParamID id, TimeValue t=0, int tabIndex=0)=0

float	GetFloat (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual TimeValue	GetTimeValue (ParamID id, TimeValue t=0, int tabIndex=0)=0

TimeValue	GetTimeValue (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

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

const MCHAR *	GetStr (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual Mtl *	GetMtl (ParamID id, TimeValue t=0, int tabIndex=0)=0

Mtl *	GetMtl (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual Texmap *	GetTexmap (ParamID id, TimeValue t=0, int tabIndex=0)=0

Texmap *	GetTexmap (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual PBBitmap *	GetBitmap (ParamID id, TimeValue t=0, int tabIndex=0)=0

PBBitmap *	GetBitmap (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual INode *	GetINode (ParamID id, TimeValue t=0, int tabIndex=0)=0

INode *	GetINode (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual ReferenceTarget *	GetReferenceTarget (ParamID id, TimeValue t=0, int tabIndex=0)=0

ReferenceTarget *	GetReferenceTarget (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual IParamBlock2 *	GetParamBlock2 (ParamID id, TimeValue t=0, int tabIndex=0)=0

IParamBlock2 *	GetParamBlock2 (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual Matrix3	GetMatrix3 (ParamID id, TimeValue t=0, int tabIndex=0)=0

Matrix3	GetMatrix3 (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

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

MaxSDK::AssetManagement::AssetUser	GetAssetUser (const ParamID id, const TimeValue t, Interval &validity, const int tabIndex=0)

virtual PB2Value &	GetPB2Value (ParamID id, int tabIndex=0)=0

Table (Tab<>) Management

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

Table (Tab<>) Insert Methods

virtual int	Insert (ParamID id, int at, int num, float *el)=0

virtual int	Insert (ParamID id, int at, int num, Point2 **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

Table (Tab<>) Append Methods
virtual int	Append (ParamID id, int num, float *el, int allocExtra=0)=0

virtual int	Append (ParamID id, int num, Point2 **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

Keyframe Checking

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. More...

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. More...

Controller Access
virtual void	RemoveControllerByIndex (int i, int tabIndex)=0
	Removes the 'i-th' controller. More...

virtual Control *	GetControllerByID (ParamID id, int tabIndex=0)=0
	Gets a pointer to the controller of the specified parameter. More...

virtual Control *	GetControllerByIndex (int i, int tabIndex=0)=0
	Gets a pointer to the controller of the specified parameter. More...

virtual void	SetControllerByIndex (int i, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE)=0
	Sets the indexed parameter controller to the one specified. More...

virtual void	SetControllerByID (ParamID id, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE)
	Sets the parameter with the given id to the specified controller. More...

virtual void	SwapControllers (int i1, int tabIndex1, int i2, int tabIndex2)=0
	Swaps the two controllers of the parameters whose indices are passed. More...

Reference Related Methods
virtual int	GetRefNum (int i, int tabIndex=0)=0

virtual int	GetControllerRefNum (int i, int tabIndex=0)=0

Anim Num/Param ID Conversion

virtual int	GetAnimNum (ParamID id, int tabIndex=0)=0

virtual int	AnimNumToParamNum (int animNum, int &tabIndex)=0

Parameter Dimension Related Methods

virtual ParamDimension *	GetParamDimension (int subAnim)=0

virtual void	RescaleParam (int paramNum, int tabIndex, float f)=0

Parameter Change Notification Methods

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. More...

Parameter Map Access

virtual void	SetMap (IParamMap2 *m, MapID map_id=0)=0

virtual IParamMap2 *	GetMap (MapID map_id=0)=0

Rollout Access
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

ParamDlg Access
virtual IAutoMParamDlg *	GetMParamDlg ()=0

virtual IAutoEParamDlg *	GetEParamDlg ()=0

MAXScript Default Parameter Initialization

virtual void	InitMSParameters ()=0

Alias Maintenance

virtual void	DefineParamAlias (const MCHAR *alias_name, ParamID id, int tabIndex=-1)=0

virtual ParamAlias *	FindParamAlias (const MCHAR *alias_name)=0

virtual const MCHAR *	FindParamAlias (ParamID id, int tabIndex=-1)=0

virtual void	ClearParamAliases ()=0

virtual int	ParamAliasCount ()=0

virtual ParamAlias *	GetParamAlias (int i)=0

SubAnim Numbering Related Methods

virtual void	SetSubAnimNum (ParamID id, int subAnimNum, int tabIndex=0)=0

virtual void	ClearSubAnimMap ()=0

Copying Parameter Values Between Blocks

virtual void	Assign (ParamID id, IParamBlock2 *src, ParamID src_id)=0

Finding Parameter IDs

virtual ParamID	FindRefParam (ReferenceTarget *ref, int &tabIndex)=0

Reset To Default Values
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

PBAccessor Get/Set Methods

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

Validity of Parameter Block

virtual void	GetValidity (TimeValue t, Interval &valid)=0

Parameter Iteration
Standard, STL-like iteration on the parameters stored in this block.
ParameterIterator	begin ()
	Returns an iterator to the first parameter in the block. More...

ParameterIterator	end ()
	Returns an iterator that is one past the last valid parameter. More...

Public Member Functions inherited from ReferenceTarget
virtual CoreExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class. More...

virtual CoreExport SClass_ID	SuperClassID ()
	Retrieves a constant representing the type of the plugin. More...

virtual BOOL	IsRefTarget ()
	Checks if this is a ReferenceTarget. More...

CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference. More...

CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references. More...

CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents. More...

void	BeginDependencyTest ()
	Starts Dependency Test. More...

BOOL	EndDependencyTest ()
	Ends Dependency Test. More...

virtual void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target. More...

virtual void	RefAddedUndoRedo (RefMakerHandle rm)
	Called after a reference is made to a target because of undo or redo. More...

virtual void	RefDeleted ()
	Called after a references to this is deleted. More...

virtual void	RefDeletedUndoRedo ()
	Called after a references to this is deleted because of undo or redo. More...

CoreExport RefResult	DeleteAllRefsToMe ()
	Deletes all references to this ReferenceTarget. More...

CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this. More...

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...

virtual CoreExport RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object. More...

virtual CoreExport void	BaseClone (ReferenceTarget from, ReferenceTarget to, RemapDir &remap)
	This method copies base class data from an object to its clone. More...

virtual CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=NULL, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS)
	Notify all dependent RefMakers concerned with the message. More...

void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline. More...

virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG. More...

virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets. More...

virtual CoreExport void *	GetInterface (ULONG id)
	Inherited from Animatable. More...

virtual CoreExport BaseInterface *	GetInterface (Interface_ID id)
	Inherited from Animatable. More...

CoreExport	ReferenceTarget ()
	Constructor. More...

virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents. More...

CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents. More...

Public Member Functions inherited from ReferenceMaker
CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers. More...

CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker. More...

CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item. More...

CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference. More...

virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered. More...

CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker. More...

virtual CoreExport IOResult	Save (ISave *isave)
	Called for saving data. More...

virtual CoreExport IOResult	Load (ILoad *iload)
	Called for loading data. More...

virtual int	RemapRefOnLoad (int iref)
	Used to load old files with references. More...

virtual CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in reference hierarchy. More...

virtual CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags)
	Enumerate auxiliary files (e.g. bitmaps) More...

virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration. More...

virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
	Used to specify reference slot remapping during scene file save. More...

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...

CoreExport bool	EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
	This method provides a general purpose reference enumerator. More...

CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget. More...

virtual BOOL	IsRefMaker ()
	Tells whether it is a ReferenceMaker. More...

virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not. More...

virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save. More...

CoreExport	ReferenceMaker ()
	Constructor. More...

CoreExport void	DeleteMe ()
	Deletes an instance of this class. More...

virtual CoreExport int	NumRefs ()
	Returns the total number of references this ReferenceMaker can hold. More...

virtual CoreExport RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference. More...

Public Member Functions inherited from Animatable
virtual void	FreeCaches ()

virtual int	NumChildren ()

virtual Animatable *	ChildAnim (int i)

virtual CoreExport MSTR	NodeName ()

virtual void	EditTrack ()

virtual CoreExport BOOL	SubAnimSetKeyBufferPresent (int subNum)
	returns true if the sub-anim has a "Set Key" buffer present More...

virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present More...

virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim. More...

virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers. More...

virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim. More...

virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers. More...

virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete. More...

virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used. More...

virtual bool	GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
	This method is called to access the object specified name to use for the Maxscript macrorecorder. More...

CoreExport	Animatable ()
	Constructor. More...

virtual CoreExport void	DeleteThis ()
	Deletes an instance of this class. More...

virtual void	GetClassName (MSTR &s) MAX_SEALED

MSTR	ClassName (bool localized=true) const
	Returns the name of the plugin class. More...

virtual CoreExport Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class. More...

virtual void	BeginEditParams (IObjParam ip, ULONG flags, Animatable prev=NULL)

virtual void	EndEditParams (IObjParam ip, ULONG flags, Animatable next=NULL)

virtual CoreExport void	ReleaseInterface (ULONG id, void *i)

virtual CoreExport int	SetProperty (ULONG id, void *data)

virtual CoreExport void *	GetProperty (ULONG id)

CoreExport void	AppendProperty (AnimProperty *prop)
	A function to directly add arbitrary properties to this object developers should ensure that the properties ID does not conflict with any Max-specific IDs. More...

CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property. More...

CoreExport void	AddAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid, DWORD len, void *data)
	Adds application/plugin specific (custom) data to an Animatable. More...

CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable. More...

CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable. More...

CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable. More...

virtual int	NumSubs ()

virtual Animatable *	SubAnim (int i)

virtual MSTR	SubAnimName (int i) MAX_SEALED

virtual CoreExport MSTR	SubAnimName (int i, bool localized)

virtual BOOL	CanDeleteSubAnim (int i)

virtual void	DeleteSubAnim (int i)

virtual DWORD	GetSubAnimCurveColor (int subNum)

virtual int	SubNumToRefNum (int subNum)

virtual BOOL	CanCopyAnim ()

CoreExport int	HasSubElements (int type=0)

virtual int	GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	The values max and min should be initialized before calling this function. More...

virtual BOOL	SelectSubAnim (int subNum)

virtual BOOL	BypassTreeView ()

virtual BOOL	BypassTrackBar ()

virtual BOOL	BypassPropertyLevel ()

virtual BOOL	InvisibleProperty ()

virtual int	NumKeys ()

virtual TimeValue	GetKeyTime (int index)

virtual int	GetKeyIndex (TimeValue t)

virtual BOOL	GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)

virtual void	CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)

virtual void	DeleteKeyAtTime (TimeValue t)

virtual BOOL	IsKeyAtTime (TimeValue t, DWORD flags)

virtual int	GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)

virtual int	GetKeySelState (BitArray &sel, Interval range, DWORD flags)

CoreExport void	OpenTreeEntry (int type, DWORD tv)

CoreExport void	CloseTreeEntry (int type, DWORD tv)

CoreExport int	IsTreeEntryOpen (int type, DWORD tv)

CoreExport BOOL	GetSelInTrackView (DWORD tv)

CoreExport void	SetSelInTrackView (DWORD tv, BOOL sel)

CoreExport BOOL	InTrackViewSelSet (int which)

CoreExport void	SetTrackViewSelSet (int which, BOOL inOut)

virtual BOOL	AssignController (Animatable *control, int subAnim)

virtual BOOL	CanAssignController (int subAnim)
	Return true if we can reassign the subanim specified. More...

virtual BOOL	CanMakeUnique ()

CoreExport int	EnumAnimTree (AnimEnum animEnum, Animatable client, int subNum)

virtual int	RenderBegin (TimeValue t, ULONG flags=0)

virtual int	RenderEnd (TimeValue t)

virtual CoreExport Interval	GetTimeRange (DWORD flags)

virtual void	EditTimeRange (Interval range, DWORD flags)

virtual void	DeleteTime (Interval iv, DWORD flags)

virtual void	ReverseTime (Interval iv, DWORD flags)

virtual void	ScaleTime (Interval iv, float s)

virtual void	InsertTime (TimeValue ins, TimeValue amount)

virtual BOOL	SupportTimeOperations ()

virtual CoreExport void	MapKeys (TimeMap *map, DWORD flags)

virtual void	DeleteKeys (DWORD flags)

virtual void	DeleteKeyByIndex (int index)

virtual void	SelectKeys (TrackHitTab &sel, DWORD flags)

virtual void	SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)

virtual void	SelectSubCurve (int subNum, BOOL sel)

virtual void	SelectKeyByIndex (int i, BOOL sel)

virtual BOOL	IsKeySelected (int i)

virtual void	FlagKey (TrackHitRecord hit)

virtual int	GetFlagKeyIndex ()

virtual int	NumSelKeys ()

virtual void	CloneSelectedKeys (BOOL offset=FALSE)

virtual void	AddNewKey (TimeValue t, DWORD flags)

virtual void	MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)

virtual void	ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)

virtual void	SelectCurve (BOOL sel)

virtual BOOL	IsCurveSelected ()
	Returns TRUE if the function curve is selected; otherwise returns FALSE. More...

virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed. More...

virtual int	GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)

virtual void	SetSelKeyCoords (TimeValue t, float val, DWORD flags)

virtual int	SetSelKeyCoordsExpr (ParamDimension dim, const MCHAR timeExpr, const MCHAR *valExpr, DWORD flags)

virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)

virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)

virtual CoreExport BOOL	IsAnimated ()

virtual BOOL	CanCopyTrack (Interval iv, DWORD flags)

virtual BOOL	CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)

virtual TrackClipObject *	CopyTrack (Interval iv, DWORD flags)

virtual void	PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)

virtual BOOL	CanCopySubTrack (int subNum, Interval iv, DWORD flags)

virtual BOOL	CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)

virtual TrackClipObject *	CopySubTrack (int subNum, Interval iv, DWORD flags)

virtual void	PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)

virtual int	GetTrackVSpace (int lineHeight)

virtual int	HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)

virtual int	PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)

virtual int	PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)

virtual int	PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)

virtual int	HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)

virtual int	PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)

virtual int	HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)

virtual void	EditTrackParams (TimeValue t, ParamDimensionBase dim, const MCHAR pname, HWND hParent, IObjParam *ip, DWORD flags)

virtual int	TrackParamsType ()

virtual int	GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	This method is called to calculate the largest and smallest values of the anim. More...

CoreExport void	AddNoteTrack (NoteTrack *note)

CoreExport void	DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)

CoreExport BOOL	HasNoteTracks ()

CoreExport int	NumNoteTracks ()

CoreExport NoteTrack *	GetNoteTrack (int i)

virtual void	FreeAllBitmaps ()

virtual void	GetSystemNodes (INodeTab &nodes, SysNodeContext Context)

virtual BOOL	IsSubClassOf (Class_ID classID)
	returns true if the animatable has sub-classed off the given class More...

virtual CoreExport void	MouseCycleCompleted (TimeValue t)

virtual CoreExport void	MouseCycleStarted (TimeValue t)

virtual int	NumParamBlocks ()

virtual IParamBlock2 *	GetParamBlock (int i)

virtual IParamBlock2 *	GetParamBlockByID (short id)

CoreExport bool	SvSaveData (ISave *isave, USHORT id)

CoreExport bool	SvLoadData (ILoad *iLoad)

CoreExport DWORD	SvGetRefIndex ()

CoreExport void	SvSetRefIndex (DWORD i)

CoreExport bool	SvDeleteRefIndex ()

virtual CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager gom, Animatable owner, int id, DWORD flags)

CoreExport SvGraphNodeReference	SvStdTraverseAnimGraph (IGraphObjectManager gom, Animatable owner, int id, DWORD flags)

virtual CoreExport bool	SvCanInitiateLink (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvCanConcludeLink (IGraphObjectManager gom, IGraphNode gNode, IGraphNode *gNodeChild)

virtual CoreExport MSTR	SvGetName (IGraphObjectManager gom, IGraphNode gNode, bool isBeingEdited)

virtual CoreExport bool	SvCanSetName (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvSetName (IGraphObjectManager gom, IGraphNode gNode, const MSTR &name)

virtual CoreExport bool	SvCanRemoveThis (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvRemoveThis (IGraphObjectManager gom, IGraphNode gNode)
	Called when the user deletes this object in the schematic view... More...

virtual CoreExport bool	SvIsSelected (IGraphObjectManager gom, IGraphNode gNode)
	Returns true if the object is selected in its schematic view. More...

virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport COLORREF	SvHighlightColor (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport COLORREF	SvGetSwatchColor (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvIsInactive (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvLinkChild (IGraphObjectManager gom, IGraphNode gNodeThis, IGraphNode *gNodeChild)

virtual CoreExport bool	SvHandleDoubleClick (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvCanSelect (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvEditProperties (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MSTR	SvGetTip (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MSTR	SvGetRefTip (IGraphObjectManager gom, IGraphNode gNode, IGraphNode *gNodeMaker)

virtual CoreExport bool	SvCanDetach (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvDetach (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MSTR	SvGetRelTip (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"... More...

virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method... More...

virtual CoreExport bool	SvDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship. More...

virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view... More...

CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class. More...

CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container. More...

CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container. More...

void	SetAFlag (DWORD mask)

void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags. More...

bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags. More...

void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags. More...

void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags. More...

bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags. More...

CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit. More...

CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit. More...

CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit. More...

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Static Public Member Functions inherited from Animatable
static CoreExport BOOL	IsDeleted (Animatable *anim)
	Debug method to determine whether an object has been deleted. More...

static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object. More...

static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle. More...

static CoreExport AnimHandle	GetNextHandle ()
	Get the unique handle for the next Animatable object to be created. More...

static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables. More...

static CoreExport bool	RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport bool	UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index. More...

static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index. More...

static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables. More...

Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void ptr, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void ptr, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0

Protected Member Functions inherited from ReferenceTarget
virtual CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep)
	Method to perform an enumeration on a ReferenceTarget. More...

virtual CoreExport	~ReferenceTarget ()=0
	Destructor. More...

Protected Member Functions inherited from ReferenceMaker
virtual RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)=0
	Receives and responds to messages. More...

virtual CoreExport	~ReferenceMaker ()=0
	Destructor. More...

virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`. More...

void	BlockEval ()
	Validates a given reference link between this reference maker and its reference target. More...

void	UnblockEval ()
	Validates a given reference link between this reference maker and its reference target. More...

int	Evaluating ()
	Validates a given reference link between this reference maker and its reference target. More...

CoreExport RefResult	StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
	Validates a given reference link between this reference maker and its reference target. More...

Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor. More...

Protected Member Functions inherited from Noncopyable
	Noncopyable ()

	~Noncopyable ()

Protected Attributes inherited from Animatable
DWORD	aflag

AnimPropertyList	aprops

Detailed Description

See also: Class ReferenceTarget, Class ParamBlockDesc2, ParamType, ParamType2, 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.

Member Function Documentation

◆ GetVersion()

virtual DWORD GetVersion ( )

pure virtual

Remarks: Returns the version of this parameter block.

◆ NumParams()

virtual int NumParams ( )

pure virtual

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

◆ GetLocalName() [1/2]

virtual const MCHAR* GetLocalName ( )

pure virtual

Remarks: Returns the localized name for the parameter block.

◆ GetParamDef()

virtual ParamDef& GetParamDef ( ParamID id )

pure virtual

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

Parameters

id	The parameter ID.

◆ ID()

virtual BlockID ID ( )

pure virtual

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

◆ GetOwner()

virtual ReferenceMaker* GetOwner ( )

pure virtual

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

◆ GetParamDefByIndex()

const ParamDef * GetParamDefByIndex ( const unsigned int parameterIndex ) const

inline

Returns the parameter definition for the parameter with the given index.

Parameters

parameterIndex Index of the parameter to be fetched.

Returns: A pointer to the parameter definition for the given index, or null if the index is invalid.

 {
     ParamBlockDesc2* const pbdesc = const_cast<IParamBlock2*>(this)->GetDesc();
     if(DbgVerify(pbdesc != nullptr))
     {
         return pbdesc->GetParamDefByIndex(parameterIndex);
     }
     else
     {
         return nullptr;
     }
 }

◆ GetDesc()

virtual ParamBlockDesc2* GetDesc ( )

pure virtual

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

◆ ReleaseDesc()

virtual void ReleaseDesc ( )

pure virtual

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

◆ SetDesc()

virtual void SetDesc ( ParamBlockDesc2 * desc )

pure virtual

Remarks: Sets the descriptor associated with the parameter block.

Parameters

desc	Points to the descriptor to set.

◆ IDtoIndex()

virtual int IDtoIndex ( ParamID id )

pure virtual

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.

◆ IndextoID()

virtual ParamID IndextoID ( int i )

pure virtual

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.

◆ GetAnimParamControlType()

virtual SClass_ID GetAnimParamControlType ( int anim )

pure virtual

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.

◆ GetParamControlType()

virtual SClass_ID GetParamControlType ( ParamID id )

pure virtual

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

Parameters

id	The ID of the parameter.

◆ GetParameterType()

virtual ParamType2 GetParameterType ( ParamID id )

pure virtual

Remarks: Returns the type of the specified parameter.

Parameters

id	The ID of the parameter.

◆ GetLocalName() [2/2]

virtual MSTR GetLocalName	(	ParamID	id,
		int	tabIndex = `-1`,
		bool	localized = `true`
	)

pure virtual

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.
localized	If true, then the name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the name in English.

◆ SetValue() [1/16]

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

pure virtual

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

◆ SetValue() [2/16]

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

pure virtual

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

◆ SetValue() [3/16]

virtual BOOL SetValue	(	ParamID	id,
		TimeValue	t,
		const Point2 &	v,
		int	tabIndex = `0`
	)

pure virtual

Remarks: Sets the Point2 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_POINT2, TYPE_INT2, TYPE_BOOL2

◆ SetValue() [4/16]

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

pure virtual

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

◆ SetValue() [5/16]

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

pure virtual

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

◆ SetValue() [6/16]

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

pure virtual

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

◆ SetValue() [7/16]

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

pure virtual

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

◆ SetValue() [8/16]

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

pure virtual

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

◆ SetValue() [9/16]

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

pure virtual

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

◆ SetValue() [10/16]

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

pure virtual

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

◆ SetValue() [11/16]

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

pure virtual

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

◆ SetValue() [12/16]

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

pure virtual

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

◆ SetValue() [13/16]

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

pure virtual

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

◆ SetValue() [14/16]

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

pure virtual

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

◆ SetValue() [15/16]

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

pure virtual

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.

◆ SetValue() [16/16]

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

pure virtual

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

◆ GetValue() [1/17]

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

pure virtual

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

◆ GetValue() [2/17]

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

pure virtual

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

◆ GetValue() [3/17]

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

pure virtual

Remarks: Retrieves the Point2 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 Point2::Origin: TYPE_POINT2, TYPE_INT2, TYPE_BOOL2

◆ GetValue() [4/17]

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

pure virtual

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

◆ GetValue() [5/17]

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

pure virtual

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

◆ GetValue() [6/17]

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

pure virtual

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

◆ GetValue() [7/17]

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

pure virtual

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

◆ GetValue() [8/17]

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

pure virtual

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

◆ GetValue() [9/17]

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

pure virtual

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

◆ GetValue() [10/17]

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

pure virtual

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

◆ GetValue() [11/17]

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

pure virtual

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

◆ GetValue() [12/17]

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

pure virtual

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.
[out]	ivalid	Validity interval of the node parameter. It's updated (intersected) by the validity of certain aspects of the node, such as geometry and transform, as specified in the parameter descriptor. See P_USE_NODE_OS_VALIDITY and P_USE_NODE_TM_VALIDITY for more details. This validity interval does not pertain to the validity of the node pointer.
	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

◆ GetValue() [13/17]

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

pure virtual

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

◆ GetValue() [14/17]

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

pure virtual

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

◆ GetValue() [15/17]

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

pure virtual

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.

◆ GetValue() [16/17]

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

pure virtual

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

◆ GetValue() [17/17]

BOOL GetValue	(	ParamID	id,
		TimeValue	t,
		ValueType &	v,
		int	tabIndex = `0`
	)

inline

Remarks: Retrieves the 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.
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: Use this overload when validity interval is irrelevant

 {
     Interval valid = FOREVER;
     return GetValue(id, t, v, valid, tabIndex);
 }

◆ GetColor() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetColor(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetColor() [2/2]

Color GetColor	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     Color val(0.0f, 0.0f, 0.0f);
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetAColor() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetAColor(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetAColor() [2/2]

AColor GetAColor	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     AColor val(0.0f, 0.0f, 0.0f, 0.0f);
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetPoint2() [1/2]

virtual Point2 GetPoint2	(	ParamID	id,
		TimeValue	t = `0`,
		int	tabIndex = `0`
	)

pure virtual

Remarks: Returns the Point2 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 Point2 value retrieved.

Note: The ParamType must be one of the following, otherwise no get occurs and a value of Point2::Origin returned: TYPE_POINT2, TYPE_INT2, TYPE_BOOL2; Please use IParamBlock2::GetPoint2(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetPoint2() [2/2]

Point2 GetPoint2	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

Remarks: Retrieves the Point2 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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	tabIndex	If the parameter is a Tab<> this is the zero based index into the table of the value to get.

Returns: The Point2 value retrieved.

Note: The ParamType must be one of the following, otherwise no get occurs and a value of Point3::Origin returned: TYPE_POINT2, TYPE_INT2, TYPE_BOOL2

 {
     Point2 val(0.0f, 0.0f);
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetPoint3() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetPoint3(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetPoint3() [2/2]

Point3 GetPoint3	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     Point3 val(0.0f, 0.0f, 0.0f);
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetPoint4() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetPoint4(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetPoint4() [2/2]

Point4 GetPoint4	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     Point4 val(0.0f, 0.0f, 0.0f, 0.0f);
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetInt() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetInt(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetInt() [2/2]

int GetInt	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     int val = 0;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetFloat() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetFloat(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetFloat() [2/2]

float GetFloat	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     float val = 0.0f;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
  
 }

◆ GetTimeValue() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetTimeValue(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetTimeValue() [2/2]

TimeValue GetTimeValue	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     TimeValue val = 0;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetStr() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetStr(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetStr() [2/2]

const MCHAR * GetStr	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     const MCHAR* val = nullptr;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetMtl() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetMtl(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetMtl() [2/2]

Mtl * GetMtl	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     Mtl* val = nullptr;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetTexmap() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetTexmap(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetTexmap() [2/2]

Texmap * GetTexmap	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     Texmap* val = nullptr;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetBitmap() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetBitmap(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetBitmap() [2/2]

PBBitmap * GetBitmap	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     PBBitmap* val = nullptr;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetINode() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetINode(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetINode() [2/2]

INode * GetINode	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     INode* val = nullptr;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetReferenceTarget() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetReferenceTarget(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetReferenceTarget() [2/2]

ReferenceTarget * GetReferenceTarget	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     ReferenceTarget* val = nullptr;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetParamBlock2() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetParamBlock2(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetParamBlock2() [2/2]

IParamBlock2 * GetParamBlock2	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     IParamBlock2* val = nullptr;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetMatrix3() [1/2]

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

pure virtual

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.; Starting in 3ds Max 2016, please use IParamBlock2::GetMatrix3(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetMatrix3() [2/2]

Matrix3 GetMatrix3	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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.

 {
     Matrix3 val;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetAssetUser() [1/2]

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

pure virtual

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; Starting in 3ds Max 2016, please use IParamBlock2::GetAssetUser(ParamID,TimeValue,Interval&,int) instead; it supports a validity interval and is more robust in case of invalid parameter IDs.

◆ GetAssetUser() [2/2]

MaxSDK::AssetManagement::AssetUser GetAssetUser	(	const ParamID	id,
		const TimeValue	t,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

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.
[in,out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	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

 {
     MaxSDK::AssetManagement::AssetUser val;
     DbgVerify(GetValue(id, t, val, validity, tabIndex));
     return val;
 }

◆ GetPB2Value()

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

pure virtual

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.

◆ Count()

virtual int Count ( ParamID id )

pure virtual

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

Parameters

id	The permanent ID of the parameter.

◆ ZeroCount()

virtual void ZeroCount ( ParamID id )

pure virtual

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

Parameters

id	The permanent ID of the parameter.

◆ SetCount()

virtual void SetCount	(	ParamID	id,
		int	n
	)

pure virtual

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.

◆ Delete()

virtual int Delete	(	ParamID	id,
		int	start,
		int	num
	)

pure virtual

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.

◆ Resize()

virtual int Resize	(	ParamID	id,
		int	num
	)

pure virtual

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.

◆ Shrink()

virtual void Shrink ( ParamID id )

pure virtual

Remarks: Reallocate so there is no wasted space.

Parameters

id	The permanent ID of the parameter.

◆ Sort()

virtual void Sort	(	ParamID	id,
		CompareFnc	cmp
	)

pure virtual

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 )

{

const MCHAR *a = (const MCHAR *)elem1;

const MCHAR *b = (const MCHAR *)elem2;

return(_tcscmp(a,b));

}

◆ Insert() [1/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		float *	el
	)

pure virtual

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.

◆ Insert() [2/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Point2 **	el
	)

pure virtual

Remarks: Insert num Point2* \ Point3* \ Point4* 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.

◆ Insert() [3/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Point3 **	el
	)

pure virtual

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.

◆ Insert() [4/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Point4 **	el
	)

pure virtual

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.

◆ Insert() [5/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Color **	el
	)

pure virtual

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.

◆ Insert() [6/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		AColor **	el
	)

pure virtual

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.

◆ Insert() [7/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		TimeValue *	el
	)

pure virtual

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.

◆ Insert() [8/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		MCHAR **	vel
	)

pure virtual

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.

◆ Insert() [9/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		const MCHAR **	vel
	)

pure virtual

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.

◆ Insert() [10/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Mtl **	el
	)

pure virtual

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.

◆ Insert() [11/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Texmap **	el
	)

pure virtual

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.

◆ Insert() [12/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		PBBitmap **	el
	)

pure virtual

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.

◆ Insert() [13/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		INode **	v
	)

pure virtual

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.

◆ Insert() [14/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		ReferenceTarget **	el
	)

pure virtual

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.

◆ Insert() [15/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		IParamBlock2 **	el
	)

pure virtual

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.

◆ Insert() [16/16]

virtual int Insert	(	ParamID	id,
		int	at,
		int	num,
		Matrix3 **	el
	)

pure virtual

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.

◆ Append() [1/16]

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

pure virtual

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.

◆ Append() [2/16]

virtual int Append	(	ParamID	id,
		int	num,
		Point2 **	el,
		int	allocExtra = `0`
	)

pure virtual

Remarks: Append num Point2* \ Point3* \ Point4* 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.

◆ Append() [3/16]

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

pure virtual

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.

◆ Append() [4/16]

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

pure virtual

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.

◆ Append() [5/16]

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

pure virtual

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.

◆ Append() [6/16]

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

pure virtual

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.

◆ Append() [7/16]

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

pure virtual

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.

◆ Append() [8/16]

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

pure virtual

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.

◆ Append() [9/16]

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

pure virtual

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.

◆ Append() [10/16]

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

pure virtual

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.

◆ Append() [11/16]

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

pure virtual

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.

◆ Append() [12/16]

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

pure virtual

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.

◆ Append() [13/16]

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

pure virtual

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.

◆ Append() [14/16]

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

pure virtual

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.

◆ Append() [15/16]

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

pure virtual

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.

◆ Append() [16/16]

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

pure virtual

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.

◆ KeyFrameAtTimeByIndex()

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

inlinevirtual

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.

1550 { return FALSE; }

◆ KeyFrameAtTimeByID()

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

inlinevirtual

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.

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

IParamBlock2::KeyFrameAtTimeByIndex

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.

Definition: iparamb2.h:1550

IParamBlock2::IDtoIndex

virtual int IDtoIndex(ParamID id)=0

◆ RemoveControllerByIndex()

virtual void RemoveControllerByIndex	(	int	i,
		int	tabIndex
	)

pure virtual

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.

◆ GetControllerByID()

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

pure virtual

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.

◆ GetControllerByIndex()

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

pure virtual

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.

◆ SetControllerByIndex()

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

pure virtual

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.

◆ SetControllerByID()

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

inlinevirtual

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.

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

IParamBlock2::SetControllerByIndex

virtual void SetControllerByIndex(int i, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE)=0

Sets the indexed parameter controller to the one specified.

◆ SwapControllers()

virtual void SwapControllers	(	int	i1,
		int	tabIndex1,
		int	i2,
		int	tabIndex2
	)

pure virtual

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.

◆ GetRefNum()

virtual int GetRefNum	(	int	i,
		int	tabIndex = `0`
	)

pure virtual

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.

◆ GetControllerRefNum()

virtual int GetControllerRefNum	(	int	i,
		int	tabIndex = `0`
	)

pure virtual

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.

◆ GetAnimNum()

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

pure virtual

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.

◆ AnimNumToParamNum()

virtual int AnimNumToParamNum	(	int	animNum,
		int &	tabIndex
	)

pure virtual

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.

◆ GetParamDimension()

virtual ParamDimension* GetParamDimension ( int subAnim )

pure virtual

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.

◆ RescaleParam()

virtual void RescaleParam	(	int	paramNum,
		int	tabIndex,
		float	f
	)

pure virtual

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 parameter 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.

◆ LastNotifyParamID() [1/2]

virtual ParamID LastNotifyParamID ( )

pure virtual

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.

◆ LastNotifyParamID() [2/2]

virtual ParamID LastNotifyParamID ( int & tabIndex )

pure virtual

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.

◆ EnableNotifications()

virtual void EnableNotifications ( BOOL onOff )

pure virtual

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.

◆ IsNotificationEnabled()

virtual BOOL IsNotificationEnabled ( )

pure virtual

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

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

◆ RefDeleted()

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

pure virtual

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.

◆ SetMap()

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

pure virtual

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. If the parameter block is not a multimap parameter block (the P_MULTIMAP flag of its descriptor is false) and you pass a nonzero map_id, the map_id will be converted to zero because the parameter block only contains one map.

◆ GetMap()

virtual IParamMap2* GetMap ( MapID map_id = 0 )

pure virtual

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

Parameters

map_id Specifies the ID of the map to get. If the parameter block is not a multimap parameter block (the P_MULTIMAP flag of its descriptor is false) and you pass a nonzero map_id, the map_id will be converted to zero because the parameter block only contains one map.

◆ SetRolloutOpen()

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

pure virtual

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. If the parameter block is not a multimap parameter block (the P_MULTIMAP flag of its descriptor is false) and you pass a nonzero map_id, the map_id will be converted to zero because the parameter block only contains one map.

◆ GetRolloutOpen()

virtual BOOL GetRolloutOpen ( MapID map_id = 0 )

pure virtual

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. If the parameter block is not a multimap parameter block (the P_MULTIMAP flag of its descriptor is false) and you pass a nonzero map_id, the map_id will be converted to zero because the parameter block only contains one map.

◆ SetRolloutScrollPos()

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

pure virtual

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. If the parameter block is not a multimap parameter block (the P_MULTIMAP flag of its descriptor is false) and you pass a nonzero map_id, the map_id will be converted to zero because the parameter block only contains one map.

◆ GetRolloutScrollPos()

virtual int GetRolloutScrollPos ( MapID map_id = 0 )

pure virtual

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. If the parameter block is not a multimap parameter block (the P_MULTIMAP flag of its descriptor is false) and you pass a nonzero map_id, the map_id will be converted to zero because the parameter block only contains one map.

◆ GetMParamDlg()

virtual IAutoMParamDlg* GetMParamDlg ( )

pure virtual

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

◆ GetEParamDlg()

virtual IAutoEParamDlg* GetEParamDlg ( )

pure virtual

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

◆ InitMSParameters()

virtual void InitMSParameters ( )

pure virtual

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.

◆ DefineParamAlias()

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

pure virtual

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.

◆ FindParamAlias() [1/2]

virtual ParamAlias* FindParamAlias ( const MCHAR * alias_name )

pure virtual

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

Parameters

alias_name The name of the alias to find.

◆ FindParamAlias() [2/2]

virtual const MCHAR* FindParamAlias	(	ParamID	id,
		int	tabIndex = `-1`
	)

pure virtual

Remarks: Finds the name of a parameter 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.

◆ ClearParamAliases()

virtual void ClearParamAliases ( )

pure virtual

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

◆ ParamAliasCount()

virtual int ParamAliasCount ( )

pure virtual

Remarks: Returns the number of aliases currently defined.

◆ GetParamAlias()

virtual ParamAlias* GetParamAlias ( int i )

pure virtual

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

Parameters

i	The zero based index of the alias to return.

◆ SetSubAnimNum()

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

pure virtual

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.

◆ ClearSubAnimMap()

virtual void ClearSubAnimMap ( )

pure virtual

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

◆ Assign()

virtual void Assign	(	ParamID	id,
		IParamBlock2 *	src,
		ParamID	src_id
	)

pure virtual

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.

◆ FindRefParam()

virtual ParamID FindRefParam	(	ReferenceTarget *	ref,
		int &	tabIndex
	)

pure virtual

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

◆ ResetAll()

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

pure virtual

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 interface; FALSE to not update.
callSetHandlers	TRUE to call PBAccessor::Set() for all the parameters; otherwise FALSE.

◆ Reset()

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

pure virtual

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 interface 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.

◆ CallSet()

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

pure virtual

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.

◆ CallGet()

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

pure virtual

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.

◆ CallSets()

virtual void CallSets ( )

pure virtual

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.

◆ CallGets()

virtual void CallGets ( )

pure virtual

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.

◆ GetValidity()

virtual void GetValidity	(	TimeValue	t,
		Interval &	valid
	)

pure virtual

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 validity interval to update. The intersection of the provided "valid" interval with the interval for the provided TimeValue and returned as the updated interval value.

◆ SetValueByName()

bool SetValueByName	(	const MCHAR *const	paramName,
		const T &	value,
		const TimeValue	t,
		const int	tabIndex = `0`
	)

inline

Set a parameter value using the parameter name.

This method finds the parameter with the matching internal name (see ParamDef::int_name) and calls SetValue() on that parameter. The method asserts and returns false if the parameter is not found. Otherwise, it returns the result of the call to SetValue().

Remarks: The name comparison is case-insensitive.; This method performs a linear search over the parameters in the parameter block; it may therefore be expensive to call.

Parameters

paramName	The internal name of the parameter to be set (see ParamDef::int_name)
value	The value to be set
t	The time at which to set the value
tabIndex	The index of the value to set, if the parameter is of TAB type.

 {
     // Find the parameter that matches the given name
     ParamBlockDesc2* const pbdesc = GetDesc();
     if(DbgVerify(pbdesc != nullptr))
     {
         const int param_index = pbdesc->NameToIndex(paramName);
         if(DbgVerify(param_index >= 0))
         {
             const ParamDef* const param_def = pbdesc->GetParamDefByIndex(param_index);
             if(DbgVerify(param_def != nullptr))
             {
                 return DbgVerify(SetValue(param_def->ID, t, value, tabIndex) != 0);
             }
         }
     }
  
     return false;
 }

◆ GetValueByName()

bool GetValueByName	(	const MCHAR *const	paramName,
		const TimeValue	t,
		T &	value,
		Interval &	validity,
		const int	tabIndex = `0`
	)

inline

Get a parameter value using the parameter name.

This method finds the parameter with the matching internal name (see ParamDef::int_name) and calls GetValue() on that parameter. The method asserts and returns false if the parameter is not found. Otherwise, it returns the result of the call to GetValue().

Remarks: The name comparison is case-insensitive.; This method performs a linear search over the parameters in the parameter block; it may therefore be expensive to call.

Parameters

	paramName	The internal name of the parameter to get (see ParamDef::int_name)
	value	The value to get
[out]	validity	The validity of the returned value is intersected into the input value of this parameter.
	t	The time at which to get the value
	tabIndex	The index of the value to get, if the parameter is of TAB type.

 {
     // Find the parameter that matches the given name
     ParamBlockDesc2* const pbdesc = GetDesc();
     if(DbgVerify(pbdesc != nullptr))
     {
         const int param_index = pbdesc->NameToIndex(paramName);
         if(DbgVerify(param_index >= 0))
         {
             const ParamDef* const param_def = pbdesc->GetParamDefByIndex(param_index);
             if(DbgVerify(param_def != nullptr))
             {
                 return DbgVerify(GetValue(param_def->ID, t, value, validity, tabIndex) != 0);
             }
         }
     }
  
     return false;
 }

◆ begin()

IParamBlock2::ParameterIterator begin ( )

inline

Returns an iterator to the first parameter in the block.

The begin() and end() methods enable standard C++ iteration on the block's parameters. For example:

IParamBlock2* const param_block = <...>;
for(const ParamDef& param_def : *param_block)
{
    switch(param_def.type)
    {
        <...>
    }
 }

Remarks: If there are no parameters, then begin() == end().

See also: end()

 {
     return ParameterIterator(*this, 0);
 }

◆ end()

IParamBlock2::ParameterIterator end ( )

inline

Returns an iterator that is one past the last valid parameter.

Remarks: If there are no parameters, then end() == begin().

See also: begin()

 {
     return ParameterIterator(*this, NumParams());
 }

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetVersion()

◆ NumParams()

◆ GetLocalName() [1/2]

◆ GetParamDef()

◆ ID()

◆ GetOwner()

◆ GetParamDefByIndex()

◆ GetDesc()

◆ ReleaseDesc()

◆ SetDesc()

◆ IDtoIndex()

◆ IndextoID()

◆ GetAnimParamControlType()

◆ GetParamControlType()

◆ GetParameterType()

◆ GetLocalName() [2/2]

◆ SetValue() [1/16]

◆ SetValue() [2/16]

◆ SetValue() [3/16]

◆ SetValue() [4/16]

◆ SetValue() [5/16]

◆ SetValue() [6/16]

◆ SetValue() [7/16]

◆ SetValue() [8/16]

◆ SetValue() [9/16]

◆ SetValue() [10/16]

◆ SetValue() [11/16]

◆ SetValue() [12/16]

◆ SetValue() [13/16]

◆ SetValue() [14/16]

◆ SetValue() [15/16]

◆ SetValue() [16/16]

◆ GetValue() [1/17]

◆ GetValue() [2/17]

◆ GetValue() [3/17]

◆ GetValue() [4/17]

◆ GetValue() [5/17]

◆ GetValue() [6/17]

◆ GetValue() [7/17]

◆ GetValue() [8/17]

◆ GetValue() [9/17]

◆ GetValue() [10/17]

◆ GetValue() [11/17]

◆ GetValue() [12/17]

◆ GetValue() [13/17]

◆ GetValue() [14/17]

◆ GetValue() [15/17]

◆ GetValue() [16/17]

◆ GetValue() [17/17]

◆ GetColor() [1/2]

◆ GetColor() [2/2]

◆ GetAColor() [1/2]

◆ GetAColor() [2/2]

◆ GetPoint2() [1/2]

◆ GetPoint2() [2/2]

◆ GetPoint3() [1/2]

◆ GetPoint3() [2/2]

◆ GetPoint4() [1/2]

◆ GetPoint4() [2/2]

◆ GetInt() [1/2]

◆ GetInt() [2/2]

◆ GetFloat() [1/2]

◆ GetFloat() [2/2]

◆ GetTimeValue() [1/2]

◆ GetTimeValue() [2/2]

◆ GetStr() [1/2]

◆ GetStr() [2/2]

◆ GetMtl() [1/2]

◆ GetMtl() [2/2]

◆ GetTexmap() [1/2]

◆ GetTexmap() [2/2]

◆ GetBitmap() [1/2]

◆ GetBitmap() [2/2]

◆ GetINode() [1/2]

◆ GetINode() [2/2]