MFnKeyframeDelta Class Reference
[OpenMayaAnim - API module for animationFunctionSet classes]

#include <MFnKeyframeDelta.h>

Inheritance diagram for MFnKeyframeDelta:

Inheritance graph
[legend]
Collaboration diagram for MFnKeyframeDelta:

Collaboration graph
[legend]

List of all members.


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.

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
virtual unsigned int keyIndex (MStatus *ReturnStatus=NULL) const
 MFnKeyframeDelta (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.


Constructor & Destructor Documentation

MFnKeyframeDelta::MFnKeyframeDelta ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in] object The MObject to attach the function set to
[out] ReturnStatus the return status
Status Codes:

MFnKeyframeDelta::MFnKeyframeDelta ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in] object The MObject to attach the function set to
[out] ReturnStatus the return status
Status Codes:


Member Function Documentation

MFn::Type MFnKeyframeDelta::type (  )  const [virtual]

MObject MFnKeyframeDelta::paramCurve ( MStatus ReturnStatus = NULL  )  const

Return the Animation Curve MObject that this key belongs to.

Parameters:
[out] ReturnStatus Return code.
Returns:
A MObject, readable by MFnAnimCurve.
Status Codes:

unsigned int MFnKeyframeDelta::keyIndex ( MStatus ReturnStatus = NULL  )  const [virtual]

The index of this key on the animation curve.

Parameters:
[out] ReturnStatus Return code.
Returns:
An unsigned int representing the position of the key on the curve.
Status Codes:

Reimplemented in MFnKeyframeDeltaAddRemove, and MFnKeyframeDeltaMove.


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6