C++ API Reference
MFnKeyframeDeltaTangent Class Reference

Function set for changes to a key's tangent. More...

#include <MFnKeyframeDeltaTangent.h>

+ Inheritance diagram for MFnKeyframeDeltaTangent:

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

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.

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:
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
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:
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

Member Function Documentation

MFn::Type type ( ) const
virtual

Function set type.

Return the class type : MFn::kKeyframeDeltaTangent.

Returns
the class type.

Reimplemented from MFnKeyframeDelta.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnKeyframeDeltaTangent".

Returns
Name of this class.
MFnAnimCurve::TangentType previousTangentType ( MStatus ReturnStatus = NULL) const

Returns the previous tangent type.

Parameters
[out]ReturnStatusReturn code.
Returns
The previous tangent type.
Status Codes:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
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:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
MStatus getPreviousPosition ( MFnAnimCurve::TangentValue x,
MFnAnimCurve::TangentValue 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:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
MStatus getCurrentPosition ( MFnAnimCurve::TangentValue x,
MFnAnimCurve::TangentValue 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:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
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:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.

The documentation for this class was generated from the following files: