C++ API Reference
MFnKeyframeDeltaMove Class Reference

Function set for change in keyframe value or time. More...

#include <MFnKeyframeDeltaMove.h>

+ Inheritance diagram for MFnKeyframeDeltaMove:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnKeyframeDeltaMove ()
 Destructor.
 
 MFnKeyframeDeltaMove ()
 Default constructor.
 
 MFnKeyframeDeltaMove (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MTime previousTime (MStatus *ReturnStatus=NULL) const
 The previous time value of this key. More...
 
MTime currentTime (MStatus *ReturnStatus=NULL) const
 The current/current time value. More...
 
double previousValue (MStatus *ReturnStatus=NULL) const
 The previous value of the key prior to the change. More...
 
double currentValue (MStatus *ReturnStatus=NULL) const
 The current value of the key. More...
 
unsigned int previousIndex (MStatus *ReturnStatus=NULL) const
 The previous index value of this key. More...
 
unsigned int keyIndex (MStatus *ReturnStatus=NULL) const override
 The current index value of this key. More...
 
 MFnKeyframeDeltaMove (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...
 
 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 change in keyframe value or time.

This function set is used for keyframe deltas of type MFn::kKeyframeDeltaMove. These keyframe deltas are generated from 'move' events. For example, the user drags or scales a key from one position to another.

Constructor & Destructor Documentation

MFnKeyframeDeltaMove ( 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
MFnKeyframeDeltaMove ( 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::kKeyframeDeltaMove.

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 : "MFnKeyframeDeltaMove".

Returns
Name of this class.
MTime previousTime ( MStatus ReturnStatus = NULL) const

The previous time value of this key.

Parameters
[out]ReturnStatusReturn Code
Returns
A MTime containing the previous time of this key.
Status Codes:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
MTime currentTime ( MStatus ReturnStatus = NULL) const

The current/current time value.

Parameters
[out]ReturnStatusStatus code.
Returns
A MTime containing the current time of this key.
Status Codes:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
double previousValue ( MStatus ReturnStatus = NULL) const

The previous value of the key prior to the change.

The value corresponds to the units of the animation curve.

Parameters
[out]ReturnStatusReturn code.
Returns
A double representing the previous value of the key.
Status Codes:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
double currentValue ( MStatus ReturnStatus = NULL) const

The current value of the key.

The value corresponds to the units of the animation curve.

Parameters
[out]ReturnStatusReturn code.
Returns
A double representing the current value of the key.
Status Codes:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
unsigned int previousIndex ( MStatus ReturnStatus = NULL) const

The previous index value of this key.

If a key has been moved over another key then you can use this previous index to figure out where the key was moved from.

Parameters
[out]ReturnStatusReturn code.
Returns
An unsigned value representing the previous index of this key on the curve.
Status Codes:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
unsigned int keyIndex ( MStatus ReturnStatus = NULL) const
overridevirtual

The current index value of this key.

Parameters
[out]ReturnStatusReturn code.
Returns
An unsigned value representing the current index of this key on the curve.
Status Codes:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.

Reimplemented from MFnKeyframeDelta.


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