MFnKeyframeDelta Class Reference
#include <MFnKeyframeDelta.h>
Class Description
Base function set for keyframe deltas.
Keyframe delta objects are returned via the MAnimMessage::animKeyframeEditedCallback( ... ). They describe atomic changes to keyframes as a result of a curve edit operation. Refer to the documentation in MAnimMessage class for further information.
Base function set for all keyframe delta objects. A keyframe delta object is generated from the MAnimMessage::addAnimKeyframeEditedCallback.
Inheritance diagram for MFnKeyframeDelta:
Public Member Functions | |
| virtual MFn::Type | type () const |
| Function set type. | |
| virtual | ~MFnKeyframeDelta () |
| Destructor. | |
| MFnKeyframeDelta () | |
| Default constructor. | |
| MFnKeyframeDelta (MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. More... | |
| MObject | paramCurve (MStatus *ReturnStatus=NULL) const |
| Return the Animation Curve MObject that this key belongs to. More... | |
| virtual unsigned int | keyIndex (MStatus *ReturnStatus=NULL) const |
| The index of this key on the animation curve. More... | |
| MFnKeyframeDelta (const MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. More... | |
| Public Member Functions inherited from MFnBase | |
| virtual | ~MFnBase () |
| Class Destructor. More... | |
| bool | hasObj (MFn::Type) const |
| Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
| bool | hasObj (const MObject &) const |
| Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
| MObject | object (MStatus *ReturnStatus=NULL) const |
| Returns the MObject that is attached to the Function Set. More... | |
| virtual MStatus | setObject (MObject &object) |
| Attaches the Function Set to the specified Maya Object. More... | |
| virtual MStatus | setObject (const MObject &object) |
| NO SCRIPT SUPPORT. More... | |
Protected Member Functions | |
| virtual const char * | className () const |
| Class name. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MFnBase | |
| static const char * | className () |
| Returns the name of this class. More... | |
Constructor & Destructor Documentation
| MFnKeyframeDelta | ( | MObject & | object, |
| MStatus * | ReturnStatus = NULL |
||
| ) |
| MFnKeyframeDelta | ( | const MObject & | object, |
| MStatus * | ReturnStatus = NULL |
||
| ) |
Member Function Documentation
Return the Animation Curve MObject that this key belongs to.
- Parameters
-
[out] ReturnStatus Return code.
- Returns
- A MObject, readable by MFnAnimCurve.
- Status Codes:
- MS::kSuccess The operation succeeded.
- MS::kFailure An object error has occurred.
|
virtual |
The index of this key on the animation curve.
Note that when keys are added and then moved in a single action, the delta for the added key may refer to a key that no longer exists. In this case, the index returned related to the add operation will be the index where the key would be if it still existed on the curve. For example, if an animation curve has keys at frames 1 and 10, and a key is added at frame 12 and then moved to frame 11 in a single action, when the callback for the addition is received, the key at frame 12 will no longer exist. In this case, the keyIndex returned will be 3, to indicate that the key would be at index 3 if it existed.
- Parameters
-
[out] ReturnStatus Return code.
- Returns
- An unsigned int representing the position of the key on the curve.
- Status Codes:
- MS::kSuccess The operation succeeded.
- MS::kFailure An object error has occurred.
- MS::kInvalidParameter key index is not available for this delta object.
Reimplemented in MFnKeyframeDeltaAddRemove, and MFnKeyframeDeltaMove.
The documentation for this class was generated from the following files:
- MFnKeyframeDelta.h
- MFnKeyframeDelta.cpp