Public Member Functions | Protected Member Functions

MFnKeyframeDeltaTangent Class Reference

Search for all occurrences

Detailed Description

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.

#include <MFnKeyframeDeltaTangent.h>

Inheritance diagram for MFnKeyframeDeltaTangent:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnKeyframeDeltaTangent ()
 Destructor.
 MFnKeyframeDeltaTangent ()
 Default constructor.
 MFnKeyframeDeltaTangent (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MFnAnimCurve::TangentType previousTangentType (MStatus *ReturnStatus=NULL) const
 Returns the previous tangent type.
MFnAnimCurve::TangentType currentTangentType (MStatus *ReturnStatus=NULL) const
 Returns the current tangent type that the key represents.
MStatus getPreviousPosition (float &x, float &y) const
 Get the values of the previous time/value position of the tangent for this key.
MStatus getCurrentPosition (float &x, float &y) const
 Get the values of the current time/value position of the tangent for this key.
bool isInTangent (MStatus *ReturnStatus=NULL) const
 Key's have two tangents, in-bound and out-bound.
 MFnKeyframeDeltaTangent (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnKeyframeDeltaTangent ( 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:
MFnKeyframeDeltaTangent ( 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]

Function set type.

Return the class type : MFn::kKeyframeDeltaTangent.

Reimplemented from MFnKeyframeDelta.

const char * className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnKeyframeDeltaTangent".

Reimplemented from MFnKeyframeDelta.

MFnAnimCurve::TangentType previousTangentType ( MStatus ReturnStatus = NULL) const

Returns the previous tangent type.

Parameters:
[out]ReturnStatusReturn code.
Returns:
The previous tangent type.
Status Codes:
MFnAnimCurve::TangentType currentTangentType ( MStatus ReturnStatus = NULL) const

Returns the current tangent type that the key represents.

Parameters:
[out]ReturnStatusReturn code.
Returns:
The current tangent type.
Status Codes:
MStatus getPreviousPosition ( float &  x,
float &  y 
) const

Get the values of the previous time/value position of the tangent for this key.

Parameters:
[out]xThe x component of the position.
[out]yThe y component of the position.
Returns:
MStatus based on the success or failure of the method.
Status Codes:
MStatus getCurrentPosition ( float &  x,
float &  y 
) const

Get the values of the current time/value position of the tangent for this key.

Parameters:
[out]xThe x component of the position.
[out]yThe y component of the position.
Returns:
A MStatus based on the success or failure of the method.
Status Codes:
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.

Parameters:
[out]ReturnStatusReturn code.
Returns:
  • true if the incoming tangent was modified.
  • false if the outgoing tangent was modified.
Status Codes:

MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent
MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent MFnKeyframeDeltaTangent