Public Member Functions | Protected Member Functions

MFnKeyframeDelta Class Reference

Search for all occurrences

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

#include <MFnKeyframeDelta.h>

Inheritance diagram for MFnKeyframeDelta:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnKeyframeDelta ()
 Destructor.
 MFnKeyframeDelta ()
 Default constructor.
 MFnKeyframeDelta (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject paramCurve (MStatus *ReturnStatus=NULL) const
 Return the Animation Curve MObject that this key belongs to.
virtual unsigned int keyIndex (MStatus *ReturnStatus=NULL) const
 The index of this key on the animation curve.
 MFnKeyframeDelta (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnKeyframeDelta ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnKeyframeDelta ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]
MObject paramCurve ( MStatus ReturnStatus = NULL) const

Return the Animation Curve MObject that this key belongs to.

Parameters:
[out]ReturnStatusReturn code.
Returns:
A MObject, readable by MFnAnimCurve.
Status Codes:
unsigned int keyIndex ( MStatus ReturnStatus = NULL) const [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]ReturnStatusReturn code.
Returns:
An unsigned int representing the position of the key on the curve.
Status Codes:

Reimplemented in MFnKeyframeDeltaAddRemove, and MFnKeyframeDeltaMove.


MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta
MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta MFnKeyframeDelta