Public Member Functions | Protected Member Functions

MFnKeyframeDeltaMove Class Reference

Search for all occurrences

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.

#include <MFnKeyframeDeltaMove.h>

Inheritance diagram for MFnKeyframeDeltaMove:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnKeyframeDeltaMove ()
 Destructor.
 MFnKeyframeDeltaMove ()
 Default constructor.
 MFnKeyframeDeltaMove (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MTime previousTime (MStatus *ReturnStatus=NULL) const
 The previous time value of this key.
MTime currentTime (MStatus *ReturnStatus=NULL) const
 The current/current time value.
double previousValue (MStatus *ReturnStatus=NULL) const
 The previous value of the key prior to the change.
double currentValue (MStatus *ReturnStatus=NULL) const
 The current value of the key.
unsigned int previousIndex (MStatus *ReturnStatus=NULL) const
 The previous index value of this key.
virtual unsigned int keyIndex (MStatus *ReturnStatus=NULL) const
 The current index value of this key.
 MFnKeyframeDeltaMove (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

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

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kKeyframeDeltaMove.

Reimplemented from MFnKeyframeDelta.

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

Class name.

Return the class name : "MFnKeyframeDeltaMove".

Reimplemented from MFnKeyframeDelta.

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:
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:
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:
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:
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:
unsigned int keyIndex ( MStatus ReturnStatus = NULL) const [virtual]

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:

Reimplemented from MFnKeyframeDelta.


MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove
MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove MFnKeyframeDeltaMove