Function set for the addition or removal keys on a curve.
Captures the addition or removal of key on a curve. keyIndex(...) will return the index of the key that was added or removed.
#include <MFnKeyframeDeltaAddRemove.h>
Public Types | |
enum | DeltaType { kAdded, kRemoved, kReplaced } |
Type of change. More... | |
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. | |
virtual | ~MFnKeyframeDeltaAddRemove () |
Destructor. | |
MFnKeyframeDeltaAddRemove () | |
Default constructor. | |
MFnKeyframeDeltaAddRemove (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. | |
DeltaType | deltaType (MStatus *ReturnStatus=NULL) const |
Indicates the type of change that this class instance represents. | |
double | value (MStatus *ReturnStatus=NULL) const |
The value of the key that was added or removed. | |
MTime | time (MStatus *ReturnStatus=NULL) const |
The time value of the key that was added or removed. | |
virtual unsigned int | keyIndex (MStatus *ReturnStatus=NULL) const |
The index of this key on the animation curve. | |
double | replacedValue (MStatus *ReturnStatus=NULL) const |
The value of the key that was replaced. | |
MFnKeyframeDeltaAddRemove (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. | |
Protected Member Functions | |
virtual const char * | className () const |
Class name. |
enum DeltaType |
Type of change.
MFnKeyframeDeltaAddRemove | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
Constructor.
Class constructor that initializes the function set to the given MObject.
[in] | object | The MObject to attach the function set to |
[out] | ReturnStatus | the return status |
MFnKeyframeDeltaAddRemove | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
Constructor.
Class constructor that initializes the function set to the given MObject.
[in] | object | The MObject to attach the function set to |
[out] | ReturnStatus | the return status |
MFn::Type type | ( | ) | const [virtual] |
Function set type.
Return the class type : MFn::kKeyframeDeltaAddRemove.
Reimplemented from MFnKeyframeDelta.
const char * className | ( | ) | const [protected, virtual] |
Class name.
Return the class name : "MFnKeyframeDeltaAddRemove".
Reimplemented from MFnKeyframeDelta.
MFnKeyframeDeltaAddRemove::DeltaType deltaType | ( | MStatus * | ReturnStatus = NULL | ) | const |
Indicates the type of change that this class instance represents.
[out] | ReturnStatus |
double value | ( | MStatus * | ReturnStatus = NULL | ) | const |
The value of the key that was added or removed.
[out] | ReturnStatus | Return code. |
The time value of the key that was added or removed.
[out] | ReturnStatus | Return code. |
unsigned int keyIndex | ( | MStatus * | ReturnStatus = NULL | ) | const [virtual] |
The index of this key on the animation curve.
[out] | ReturnStatus | Return code. |
Reimplemented from MFnKeyframeDelta.
double replacedValue | ( | MStatus * | ReturnStatus = NULL | ) | const |
The value of the key that was replaced.
This method is only applicable to the kReplaced operation. Otherwise it will return 0.
[out] | ReturnStatus | Return code. |