C++ API Reference
|
Function set for changes to a key's tangent. More...
#include <MFnKeyframeDeltaTangent.h>
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. More... | |
virtual | ~MFnKeyframeDeltaTangent () |
Destructor. | |
MFnKeyframeDeltaTangent () | |
Default constructor. | |
MFnKeyframeDeltaTangent (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
MFnAnimCurve::TangentType | previousTangentType (MStatus *ReturnStatus=NULL) const |
Returns the previous tangent type. More... | |
MFnAnimCurve::TangentType | currentTangentType (MStatus *ReturnStatus=NULL) const |
Returns the current tangent type that the key represents. More... | |
MStatus | getPreviousPosition (MFnAnimCurve::TangentValue &x, MFnAnimCurve::TangentValue &y) const |
Get the values of the previous time/value position of the tangent for this key. More... | |
MStatus | getCurrentPosition (MFnAnimCurve::TangentValue &x, MFnAnimCurve::TangentValue &y) const |
Get the values of the current time/value position of the tangent for this key. More... | |
bool | isInTangent (MStatus *ReturnStatus=NULL) const |
Key's have two tangents, in-bound and out-bound. More... | |
MFnKeyframeDeltaTangent (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. More... | |
Public Member Functions inherited from MFnKeyframeDelta | |
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=nullptr) 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... | |
Static Public Member Functions | |
static const char * | className () |
Returns the name of this class. More... | |
Static Public Member Functions inherited from MFnKeyframeDelta | |
static const char * | className () |
Returns the name of this class. More... | |
Static Public Member Functions inherited from MFnBase | |
static const char * | className () |
Returns the name of this class. More... | |
static const char * | typeString (MFn::Type) |
Returns the type string for a given type. More... | |
static bool | isValid (MFn::Type) |
Returns true if type is in the range of valid types. More... | |
Function set for changes to a key's tangent.
A MFnKeyframeDeltaTangent function allows API programmers to read changes in keyframe tangent values. It captures changes in tangent type, as well as, changes in tangent time/value pair.
MFnKeyframeDeltaTangents are generated by a MAnimMessage::addAnimKeyframeEditedCallback. Because a key's tangent may be unbroken. It is possible to receive to MFnKeyframeDeltaTangent values per key – one for the incoming tangent and one for the outgoing tangent. The API programmer should use the isInTangent method to determine if the tangent change affects the in-bound tangent or out-bound tangent.
MFnKeyframeDeltaTangent | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnKeyframeDeltaTangent | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kKeyframeDeltaTangent.
Reimplemented from MFnKeyframeDelta.
|
static |
Returns the name of this class.
Return the class name : "MFnKeyframeDeltaTangent".
MFnAnimCurve::TangentType previousTangentType | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the previous tangent type.
[out] | ReturnStatus | Return code. |
MFnAnimCurve::TangentType currentTangentType | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the current tangent type that the key represents.
[out] | ReturnStatus | Return code. |
MStatus getPreviousPosition | ( | MFnAnimCurve::TangentValue & | x, |
MFnAnimCurve::TangentValue & | y | ||
) | const |
Get the values of the previous time/value position of the tangent for this key.
[out] | x | The x component of the position. |
[out] | y | The y component of the position. |
MStatus getCurrentPosition | ( | MFnAnimCurve::TangentValue & | x, |
MFnAnimCurve::TangentValue & | y | ||
) | const |
Get the values of the current time/value position of the tangent for this key.
[out] | x | The x component of the position. |
[out] | y | The y component of the position. |
bool isInTangent | ( | MStatus * | ReturnStatus = NULL | ) | const |
Key's have two tangents, in-bound and out-bound.
A MFnKeyframeTangent object can created once for each tangent. Use this method to determine which tangent was modified.
[out] | ReturnStatus | Return code. |