This reference page is linked to from the following overview topics: Custom Attributes, Exposing Parameter Blocks to 3ds Max, Creating Parameter Blocks, Exposing and Managing References, Lesson 6: Parameter Blocks, Overview: Parameter Blocks, Getting and Setting Parameter Block Version, Supporting Save to Previous, Strong References, Changing Bitmap Texture Map Gamma, Translation of Texture Map and Materials, Manual Parameter Translation, Major New Features, Managing Modifier Parameters, Incremental Improvements, Parameter Types, Controllers and Parameter Blocks, Parameter Blocks, Getting and Setting Parameter Block Values, Animation Track Locking, Parameter Block Flags, Parameter Block 1, IIKChainControl, Tips and Tricks.
#include <iparamb2.h>
Public Member Functions |
|
virtual DWORD | GetVersion ()=0 |
virtual int | NumParams ()=0 |
virtual const MCHAR * | GetLocalName ()=0 |
virtual ParamBlockDesc2 * | GetDesc ()=0 |
virtual void | ReleaseDesc ()=0 |
virtual void | SetDesc (ParamBlockDesc2 *desc)=0 |
virtual ParamDef & | GetParamDef (ParamID id)=0 |
virtual BlockID | ID ()=0 |
virtual int | IDtoIndex (ParamID id)=0 |
virtual ParamID | IndextoID (int i)=0 |
virtual ReferenceMaker * | GetOwner ()=0 |
virtual SClass_ID | GetAnimParamControlType (int anim)=0 |
virtual SClass_ID | GetParamControlType (ParamID id)=0 |
virtual ParamType2 | GetParameterType (ParamID id)=0 |
virtual MSTR | GetLocalName (ParamID id, int tabIndex=-1)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, float v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, int v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, Point3 &v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, Point4 &v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, Color &v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, AColor &v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, const MCHAR *v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, Mtl *v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, Texmap *v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, PBBitmap *v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, INode *v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, ReferenceTarget *v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, IParamBlock2 *v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, Matrix3 &v, int tabIndex=0)=0 |
virtual BOOL | SetValue (ParamID id, TimeValue t, const MaxSDK::AssetManagement::AssetUser &v, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, float &v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, int &v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, Point3 &v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, Point4 &v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, Color &v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, AColor &v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, const MCHAR *&v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, Mtl *&v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, Texmap *&v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, PBBitmap *&v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, INode *&v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, ReferenceTarget *&v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, IParamBlock2 *&v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, Matrix3 &v, Interval &ivalid, int tabIndex=0)=0 |
virtual BOOL | GetValue (ParamID id, TimeValue t, MaxSDK::AssetManagement::AssetUser &v, Interval &ivalid, int tabIndex=0)=0 |
virtual Color | GetColor (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual AColor | GetAColor (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual Point3 | GetPoint3 (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual Point4 | GetPoint4 (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual int | GetInt (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual float | GetFloat (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual TimeValue | GetTimeValue (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual const MCHAR * | GetStr (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual Mtl * | GetMtl (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual Texmap * | GetTexmap (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual PBBitmap * | GetBitmap (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual INode * | GetINode (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual ReferenceTarget * | GetReferenceTarget (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual IParamBlock2 * | GetParamBlock2 (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual Matrix3 | GetMatrix3 (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual MaxSDK::AssetManagement::AssetUser |
GetAssetUser (ParamID id, TimeValue t=0, int tabIndex=0)=0 |
virtual PB2Value & | GetPB2Value (ParamID id, int tabIndex=0)=0 |
virtual int | Count (ParamID id)=0 |
virtual void | ZeroCount (ParamID id)=0 |
virtual void | SetCount (ParamID id, int n)=0 |
virtual int | Delete (ParamID id, int start, int num)=0 |
virtual int | Resize (ParamID id, int num)=0 |
virtual void | Shrink (ParamID id)=0 |
virtual void | Sort (ParamID id, CompareFnc cmp)=0 |
virtual int | Insert (ParamID id, int at, int num, float *el)=0 |
virtual int | Insert (ParamID id, int at, int num, Point3 **el)=0 |
virtual int | Insert (ParamID id, int at, int num, Point4 **el)=0 |
virtual int | Insert (ParamID id, int at, int num, Color **el)=0 |
virtual int | Insert (ParamID id, int at, int num, AColor **el)=0 |
virtual int | Insert (ParamID id, int at, int num, TimeValue *el)=0 |
virtual int | Insert (ParamID id, int at, int num, MCHAR **vel)=0 |
virtual int | Insert (ParamID id, int at, int num, const MCHAR **vel)=0 |
virtual int | Insert (ParamID id, int at, int num, Mtl **el)=0 |
virtual int | Insert (ParamID id, int at, int num, Texmap **el)=0 |
virtual int | Insert (ParamID id, int at, int num, PBBitmap **el)=0 |
virtual int | Insert (ParamID id, int at, int num, INode **v)=0 |
virtual int | Insert (ParamID id, int at, int num, ReferenceTarget **el)=0 |
virtual int | Insert (ParamID id, int at, int num, IParamBlock2 **el)=0 |
virtual int | Insert (ParamID id, int at, int num, Matrix3 **el)=0 |
virtual int | Append (ParamID id, int num, float *el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, Point3 **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, Point4 **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, Color **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, AColor **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, TimeValue *el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, MCHAR **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, const MCHAR **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, Mtl **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, Texmap **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, PBBitmap **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, INode **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, ReferenceTarget **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, IParamBlock2 **el, int allocExtra=0)=0 |
virtual int | Append (ParamID id, int num, Matrix3 **el, int allocExtra=0)=0 |
virtual BOOL | KeyFrameAtTimeByIndex (int i, TimeValue t, int tabIndex=0) |
Checks to see if a keyframe exists for the
given parameter at the given time. |
|
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. |
|
virtual void | RemoveControllerByIndex (int i, int tabIndex)=0 |
Removes the 'i-th' controller. |
|
virtual Control * | GetControllerByID (ParamID id, int tabIndex=0)=0 |
Gets a pointer to the controller of the
specified parameter. |
|
virtual Control * | GetControllerByIndex (int i, int tabIndex=0)=0 |
Gets a pointer to the controller of the
specified parameter. |
|
virtual void | SetControllerByIndex (int i, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE)=0 |
Sets the indexed parameter controller to the
one specified. |
|
virtual void | SetControllerByID (ParamID id, int tabIndex, Control *c, BOOL preserveFrame0Value=TRUE) |
Sets the parameter with the given id to the
specified controller. |
|
virtual void | SwapControllers (int i1, int tabIndex1, int i2, int tabIndex2)=0 |
Swaps the two controllers of the parameters
whose indices are passed. |
|
virtual int | GetRefNum (int i, int tabIndex=0)=0 |
virtual int | GetControllerRefNum (int i, int tabIndex=0)=0 |
virtual int | GetAnimNum (ParamID id, int tabIndex=0)=0 |
virtual int | AnimNumToParamNum (int animNum, int &tabIndex)=0 |
virtual ParamDimension * | GetParamDimension (int subAnim)=0 |
virtual void | RescaleParam (int paramNum, int tabIndex, float f)=0 |
virtual ParamID | LastNotifyParamID ()=0 |
virtual ParamID | LastNotifyParamID (int &tabIndex)=0 |
virtual void | EnableNotifications (BOOL onOff)=0 |
virtual BOOL | IsNotificationEnabled ()=0 |
This method returns a BOOL value to indicate
whether the notifications are globally enabled. |
|
virtual void | RefDeleted (ParamID id, int tabIndex=0)=0 |
virtual void | SetMap (IParamMap2 *m, MapID map_id=0)=0 |
virtual IParamMap2 * | GetMap (MapID map_id=0)=0 |
virtual void | SetRolloutOpen (BOOL open, MapID map_id=0)=0 |
virtual BOOL | GetRolloutOpen (MapID map_id=0)=0 |
virtual void | SetRolloutScrollPos (int pos, MapID map_id=0)=0 |
virtual int | GetRolloutScrollPos (MapID map_id=0)=0 |
virtual IAutoMParamDlg * | GetMParamDlg ()=0 |
virtual IAutoEParamDlg * | GetEParamDlg ()=0 |
virtual void | InitMSParameters ()=0 |
virtual void | DefineParamAlias (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 |
virtual void | SetSubAnimNum (ParamID id, int subAnimNum, int tabIndex=0)=0 |
virtual void | ClearSubAnimMap ()=0 |
virtual void | Assign (ParamID id, IParamBlock2 *src, ParamID src_id)=0 |
virtual ParamID | FindRefParam (ReferenceTarget *ref, int &tabIndex)=0 |
virtual void | ResetAll (BOOL updateUI=TRUE, BOOL callSetHandlers=TRUE)=0 |
virtual void | Reset (ParamID id, int tabIndex=-1, BOOL updateUI=TRUE, BOOL callSetHandlers=TRUE)=0 |
virtual void | CallSet (ParamID id, int tabIndex=-1)=0 |
virtual void | CallGet (ParamID id, int tabIndex=-1)=0 |
virtual void | CallSets ()=0 |
virtual void | CallGets ()=0 |
virtual void | GetValidity (TimeValue t, Interval &valid)=0 |
virtual DWORD GetVersion | ( | ) | [pure virtual] |
virtual int NumParams | ( | ) | [pure virtual] |
virtual const MCHAR* GetLocalName | ( | ) | [pure virtual] |
virtual ParamBlockDesc2* GetDesc | ( | ) | [pure virtual] |
virtual void ReleaseDesc | ( | ) | [pure virtual] |
virtual void SetDesc | ( | ParamBlockDesc2 * | desc | ) | [pure virtual] |
desc | Points to the descriptor to set. |
id | The parameter ID. |
virtual BlockID ID | ( | ) | [pure virtual] |
virtual int IDtoIndex | ( | ParamID | id | ) | [pure virtual] |
id | The parameter ID whose index to return. |
virtual ParamID IndextoID | ( | int | i | ) | [pure virtual] |
i | The index of the parameter whose ID is to be returned. |
virtual ReferenceMaker* GetOwner | ( | ) | [pure virtual] |
virtual SClass_ID GetAnimParamControlType | ( | int | anim | ) | [pure virtual] |
anim | The sub-anim index of the parameter. |
id | The ID of the parameter. |
virtual ParamType2 GetParameterType | ( | ParamID | id | ) | [pure virtual] |
id | The ID of the parameter. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
virtual BOOL SetValue | ( | ParamID | id, |
TimeValue | t, | ||
ReferenceTarget * | v, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL SetValue | ( | ParamID | id, |
TimeValue | t, | ||
IParamBlock2 * | v, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
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. |
virtual BOOL SetValue | ( | ParamID | id, |
TimeValue | t, | ||
const MaxSDK::AssetManagement::AssetUser & | v, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
float & | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
int & | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
Point3 & | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
Point4 & | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
Color & | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
AColor & | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
const MCHAR *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
Mtl *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
Texmap *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
PBBitmap *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
INode *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
ReferenceTarget *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
IParamBlock2 *& | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
Matrix3 & | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual BOOL GetValue | ( | ParamID | id, |
TimeValue | t, | ||
MaxSDK::AssetManagement::AssetUser & | v, | ||
Interval & | ivalid, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
virtual ReferenceTarget* GetReferenceTarget | ( | ParamID | id, |
TimeValue | t = 0 , |
||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual IParamBlock2* GetParamBlock2 | ( | ParamID | id, |
TimeValue | t = 0 , |
||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
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. |
virtual MaxSDK::AssetManagement::AssetUser GetAssetUser | ( | ParamID | id, |
TimeValue | t = 0 , |
||
int | tabIndex = 0 |
||
) | [pure virtual] |
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. |
virtual int Count | ( | ParamID | id | ) | [pure virtual] |
id | The permanent ID of the parameter. |
virtual void ZeroCount | ( | ParamID | id | ) | [pure virtual] |
id | The permanent ID of the parameter. |
virtual void SetCount | ( | ParamID | id, |
int | n | ||
) | [pure virtual] |
id | The permanent ID of the parameter. |
n | The number of elements to set. |
virtual int Delete | ( | ParamID | id, |
int | start, | ||
int | num | ||
) | [pure virtual] |
id | The permanent ID of the parameter. |
start | The start position for element deletion. |
num | The number of elements to delete. |
virtual int Resize | ( | ParamID | id, |
int | num | ||
) | [pure virtual] |
id | The permanent ID of the parameter. |
num | The new size of the table. |
virtual void Shrink | ( | ParamID | id | ) | [pure virtual] |
id | The permanent ID of the parameter. |
virtual void Sort | ( | ParamID | id, |
CompareFnc | cmp | ||
) | [pure virtual] |
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 |
virtual int Insert | ( | ParamID | id, |
int | at, | ||
int | num, | ||
float * | el | ||
) | [pure virtual] |
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. |
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. |
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. |
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. |
virtual int Insert | ( | ParamID | id, |
int | at, | ||
int | num, | ||
MCHAR ** | vel | ||
) | [pure virtual] |
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. |
virtual int Insert | ( | ParamID | id, |
int | at, | ||
int | num, | ||
const MCHAR ** | vel | ||
) | [pure virtual] |
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. |
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. |
id | The permanent ID of the parameter. |
at | Zero based array index where to insert the elements. |
num | |
el | Array of elements to insert. |
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. |
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. |
virtual int Insert | ( | ParamID | id, |
int | at, | ||
int | num, | ||
ReferenceTarget ** | el | ||
) | [pure virtual] |
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. |
virtual int Insert | ( | ParamID | id, |
int | at, | ||
int | num, | ||
IParamBlock2 ** | el | ||
) | [pure virtual] |
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. |
virtual int Append | ( | ParamID | id, |
int | num, | ||
float * | el, | ||
int | allocExtra =
0 |
||
) | [pure virtual] |
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. |
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. |
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. |
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. |
virtual int Append | ( | ParamID | id, |
int | num, | ||
MCHAR ** | el, | ||
int | allocExtra =
0 |
||
) | [pure virtual] |
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. |
virtual int Append | ( | ParamID | id, |
int | num, | ||
const MCHAR ** | el, | ||
int | allocExtra =
0 |
||
) | [pure virtual] |
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. |
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. |
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. |
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. |
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. |
virtual int Append | ( | ParamID | id, |
int | num, | ||
ReferenceTarget ** | el, | ||
int | allocExtra =
0 |
||
) | [pure virtual] |
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. |
virtual int Append | ( | ParamID | id, |
int | num, | ||
IParamBlock2 ** | el, | ||
int | allocExtra =
0 |
||
) | [pure virtual] |
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. |
virtual BOOL KeyFrameAtTimeByIndex | ( | int | i, |
TimeValue | t, | ||
int | tabIndex = 0 |
||
) | [inline, virtual] |
Checks to see if a keyframe exists for the given parameter at the given time.
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. |
{ return FALSE; }
Checks to see if a keyframe exists for the given parameter at the given time.
Note this method is slower than KeyFrameAtTimeByIndex.
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. |
{ return KeyFrameAtTimeByIndex(IDtoIndex(id), t, tabIndex); }
virtual void RemoveControllerByIndex | ( | int | i, |
int | tabIndex | ||
) | [pure virtual] |
Removes the 'i-th' controller.
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. |
Gets a pointer to the controller of the specified parameter.
Note this method is slower than GetControllerByIndex.
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. |
virtual Control* GetControllerByIndex | ( | int | i, |
int | tabIndex = 0 |
||
) | [pure virtual] |
Gets a pointer to the controller of the specified parameter.
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. |
virtual void SetControllerByIndex | ( | int | i, |
int | tabIndex, | ||
Control * | c, | ||
BOOL | preserveFrame0Value =
TRUE |
||
) | [pure virtual] |
Sets the indexed parameter controller to the one specified.
i | Specifies which controller using the zero based index of the parameter in the block. |
tabIndex | If the parameter is a table this is the zero based index of the element in the table. |
c | The controller to set. |
preserveFrame0Value | If TRUE the controllers value at frame 0 is preserved. |
virtual void SetControllerByID | ( | ParamID | id, |
int | tabIndex, | ||
Control * | c, | ||
BOOL | preserveFrame0Value =
TRUE |
||
) | [inline, virtual] |
Sets the parameter with the given id to the specified controller.
Note that this is slower than calling SetControllerByIndex.
id | The parameter id of the controller to be set. |
tabIndex | If the parameter is a table this is the zero based index of the element in the table. |
c | The controller to set. |
preserveFrame0Value | If TRUE the controllers value at frame 0 is preserved. |
{ SetControllerByIndex(IDtoIndex(id), tabIndex, c, preserveFrame0Value); }
virtual void SwapControllers | ( | int | i1, |
int | tabIndex1, | ||
int | i2, | ||
int | tabIndex2 | ||
) | [pure virtual] |
Swaps the two controllers of the parameters whose indices are passed.
i1 | The zero based index of one of the parameters in the parameter block. |
tabIndex1 | If the parameter is a table this is the zero based index of the element in the table. |
i2 | The zero based index of one of the other parameters in the parameter block. |
tabIndex2 | If the parameter is a table this is the zero based index of the element in the table. |
virtual int GetRefNum | ( | int | i, |
int | tabIndex = 0 |
||
) | [pure virtual] |
i | The zero based index of the parameter in the parameter block. |
tabIndex | If the parameter is a table this is the zero based index of the element in the table. |
virtual int GetControllerRefNum | ( | int | i, |
int | tabIndex = 0 |
||
) | [pure virtual] |
i | The zero based index into the parameter definitions array of the parameter. |
tabIndex | If the parameter is a Tab<> this is the zero based index in the table of the parameter. |
virtual int GetAnimNum | ( | ParamID | id, |
int | tabIndex = 0 |
||
) | [pure virtual] |
id | The parameter ID of the parameter. |
tabIndex | If the parameter is a Tab<> this is the zero based index in the table of the parameter. |
virtual int AnimNumToParamNum | ( | int | animNum, |
int & | tabIndex | ||
) | [pure virtual] |
animNum | The zero based sub-anim index of the parameter. |
tabIndex | If the parameter is a Tab<> this is the zero based index into the table of the parameter. |
virtual ParamDimension* GetParamDimension | ( | int | subAnim | ) | [pure virtual] |
subAnim | The zero based sub-anim index of the parameter. |
Reimplemented from Animatable.
virtual void RescaleParam | ( | int | paramNum, |
int | tabIndex, | ||
float | f | ||
) | [pure virtual] |
paramNum | The index into the parmeter block of the parameter to rescale. |
tabIndex | If the parameter is a Tab<> this is the zero based index into the table of the parameter. |
f | The value to scale by. |
virtual ParamID LastNotifyParamID | ( | ) | [pure virtual] |
virtual ParamID LastNotifyParamID | ( | int & | tabIndex | ) | [pure virtual] |
tabIndex | The index of the changing element for Tab<> parameters is returned here. |
virtual void EnableNotifications | ( | BOOL | onOff | ) | [pure virtual] |
pblock->EnableNotifications(FALSE); ... param change code ... pblock->EnableNotifications(TRUE);
onOff | TRUE to enable notifications, FALSE to disable them. |
virtual BOOL IsNotificationEnabled | ( | ) | [pure virtual] |
This method returns a BOOL value to indicate whether the notifications are globally enabled.
virtual void RefDeleted | ( | ParamID | id, |
int | tabIndex = 0 |
||
) | [pure virtual] |
id | The ID of the reference target parameter. |
tabIndex | If the parameter is a Tab<> this is the zero based index into the table of the parameter. |
virtual void SetMap | ( | IParamMap2 * | m, |
MapID | map_id = 0 |
||
) | [pure virtual] |
m | Points to the parameter map. |
map_id | Specifies the ID of the map to set. |
virtual IParamMap2* GetMap | ( | MapID | map_id = 0 |
) | [pure virtual] |
map_id | Specifies the ID of the map to get. |
virtual void SetRolloutOpen | ( | BOOL | open, |
MapID | map_id = 0 |
||
) | [pure virtual] |
open | TRUE for open; FALSE for closed. |
map_id | Specifies the ID of the map/rollout to set open/closed state for. |
virtual BOOL GetRolloutOpen | ( | MapID | map_id = 0 |
) | [pure virtual] |
map_id | Specifies the ID of the map/rollout to get open/closed state for. |
virtual void SetRolloutScrollPos | ( | int | pos, |
MapID | map_id = 0 |
||
) | [pure virtual] |
pos | The position to set. |
map_id | Specifies the ID of the map/rollout to set scroll position for. |
virtual int GetRolloutScrollPos | ( | MapID | map_id = 0 |
) | [pure virtual] |
map_id | Specifies the ID of the map/rollout to get scroll position for. |
virtual IAutoMParamDlg* GetMParamDlg | ( | ) | [pure virtual] |
virtual IAutoEParamDlg* GetEParamDlg | ( | ) | [pure virtual] |
virtual void InitMSParameters | ( | ) | [pure virtual] |
virtual void DefineParamAlias | ( | const MCHAR * | alias_name, |
ParamID | id, | ||
int | tabIndex =
-1 |
||
) | [pure virtual] |
alias_name | The name of the alias. |
id | The permanent ID of the parameter. |
tabIndex | If the parameter is a Tab<> this is the zero based index of the parameter in the table. |
virtual ParamAlias* FindParamAlias | ( | const MCHAR * | alias_name | ) | [pure virtual] |
alias_name | The name of the alias to find. |
virtual const MCHAR* FindParamAlias | ( | ParamID | id, |
int | tabIndex =
-1 |
||
) | [pure virtual] |
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. |
virtual void ClearParamAliases | ( | ) | [pure virtual] |
virtual int ParamAliasCount | ( | ) | [pure virtual] |
virtual ParamAlias* GetParamAlias | ( | int | i | ) | [pure virtual] |
i | The zero based index of the alias to return. |
virtual void SetSubAnimNum | ( | ParamID | id, |
int | subAnimNum, | ||
int | tabIndex = 0 |
||
) | [pure virtual] |
id | The permanent parameter ID |
subAnimNum | The zero based sub-anim number. |
tabIndex | The zero based index into the table of the parameter. |
virtual void ClearSubAnimMap | ( | ) | [pure virtual] |
virtual void Assign | ( | ParamID | id, |
IParamBlock2 * | src, | ||
ParamID | src_id | ||
) | [pure virtual] |
id | This ID specifies the destination parameter. |
src | Points to the source parameter block 2. |
src_id | The source parameter ID. |
virtual ParamID FindRefParam | ( | ReferenceTarget * | ref, |
int & | tabIndex | ||
) | [pure virtual] |
ref | The reference target to find. |
tabIndex | The table index if the parameter is a Tab<>. |
virtual void ResetAll | ( | BOOL | updateUI = TRUE , |
BOOL | callSetHandlers =
TRUE |
||
) | [pure virtual] |
updateUI | TRUE to update the user inteface; FALSE to not update. |
callSetHandlers | TRUE to call PBAccessor::Set() for all the parameters; otherwise FALSE. |
virtual void Reset | ( | ParamID | id, |
int | tabIndex = -1 , |
||
BOOL | updateUI = TRUE , |
||
BOOL | callSetHandlers =
TRUE |
||
) | [pure virtual] |
id | The ID of the parameter to reset. |
tabIndex | If the parameter is a Tab<> this is the index into the table of the parameter to reset. A value of -1 causes all the elements in the table to be reset. |
updateUI | Determines if the user inteface is updated for the parameter. TRUE to update; FALSE to not update. |
callSetHandlers | Determines if the method PBAccessor::Set() should be called on the parameter. TRUE to call it; FALSE to not call it. |
virtual void CallSet | ( | ParamID | id, |
int | tabIndex =
-1 |
||
) | [pure virtual] |
id | The ID of the parameter. |
tabIndex | If the parameter is a Tab<> parameter this is the zero based index into the table of the element. A value of -1 causes all the appropriate Set() methods to be called. |
virtual void CallGet | ( | ParamID | id, |
int | tabIndex =
-1 |
||
) | [pure virtual] |
id | The ID of the parameter. |
tabIndex | If the parameter is a Tab<> parameter this is the zero based index into the table of the element. A value of -1 causes all the appropriate Get() methods to be called. |
virtual void CallSets | ( | ) | [pure virtual] |
virtual void CallGets | ( | ) | [pure virtual] |
t | The time about which the interval is computed. |
valid | The interval to update. |