Class MultCurveList
See Also: Class ReferenceTarget, Class Control.
class MultCurveList : public ReferenceTarget
Description:
This class is a list of multiplier curves.
The macro used to access this class is defined as follows:
#define GetMultListInterface(anim) ((MultCurveList*)anim->GetInterface(I_MULTLIST))
This may be used to access the methods of this class as follows:
MultCurveList *ml = GetMultListInterface(client);
if (ml) {
int num = ml->NumMultCurves();
// ...
All methods of this class are implemented by the system.
Methods:
Prototype:
MultCurveList();
Remarks:
Constructor.
Prototype:
~MultCurveList();
Remarks:
Destructor. All referrences are removed from this class.
Prototype:
float GetMultVal(TimeValue t,Interval &valid);
Remarks:
This method starts with a value of 1.0f, mutiplies it by each enabled mutiplier curve value in the list, and returns the resulting value.
Parameters:
TimeValue t
The time at which to get the multipler values.
Interval &valid
The interval that is adjusted to reflect the validity of all the multipler curve controllers validity.
Prototype:
void AppendMultCurve(Control *cont);
Remarks:
Adds the specified multiplier curve to the end of the multiplier curve list.
Parameters:
Control *cont
Points to the multiplier curve to append.
Prototype:
void DeleteMultCurve(int i);
Remarks:
Deletes the 'i-th' multiplier curve.
Parameters:
int i
The index of the multiplier curve to delete.
Prototype:
void DisableMultCurve(int i);
Remarks:
Disables the 'i-th' multiplier curve.
Parameters:
int i
The index of the multiplier curve to disable.
Prototype:
void EnableMultCurve(int i);
Remarks:
Enables the 'i-th' multiplier curve.
Parameters:
int i
The index of the multiplier curve to enable.
Prototype:
BOOL IsMultEnabled(int i);
Remarks:
Returns TRUE if the 'i-th' multiplier curve is enabled; otherwise FALSE.
Parameters:
int i
The index of the multiplier curve to check.
Prototype:
int NumMultCurves();
Remarks:
Returns the number of multiplier curves in the list.