Public Types | Public Member Functions | Protected Member Functions

MFnKeyframeDeltaAddRemove Class Reference

Search for all occurrences

Detailed Description

Function set for the addition or removal keys on a curve.

Captures the addition or removal of key on a curve. keyIndex(...) will return the index of the key that was added or removed.

#include <MFnKeyframeDeltaAddRemove.h>

Inheritance diagram for MFnKeyframeDeltaAddRemove:
Inheritance graph
[legend]

List of all members.

Public Types

enum  DeltaType { kAdded, kRemoved, kReplaced }
 

Type of change.

More...

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnKeyframeDeltaAddRemove ()
 Destructor.
 MFnKeyframeDeltaAddRemove ()
 Default constructor.
 MFnKeyframeDeltaAddRemove (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
DeltaType deltaType (MStatus *ReturnStatus=NULL) const
 Indicates the type of change that this class instance represents.
double value (MStatus *ReturnStatus=NULL) const
 The value of the key that was added or removed.
MTime time (MStatus *ReturnStatus=NULL) const
 The time value of the key that was added or removed.
virtual unsigned int keyIndex (MStatus *ReturnStatus=NULL) const
 The index of this key on the animation curve.
double replacedValue (MStatus *ReturnStatus=NULL) const
 The value of the key that was replaced.
 MFnKeyframeDeltaAddRemove (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Member Enumeration Documentation

enum DeltaType

Type of change.

Enumerator:
kAdded 

Key added.

kRemoved 

Key removed.

kReplaced 

Key replaced.


Constructor & Destructor Documentation

MFnKeyframeDeltaAddRemove ( 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:
MFnKeyframeDeltaAddRemove ( 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::kKeyframeDeltaAddRemove.

Reimplemented from MFnKeyframeDelta.

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

Class name.

Return the class name : "MFnKeyframeDeltaAddRemove".

Reimplemented from MFnKeyframeDelta.

MFnKeyframeDeltaAddRemove::DeltaType deltaType ( MStatus ReturnStatus = NULL) const

Indicates the type of change that this class instance represents.

Parameters:
[out]ReturnStatus
Returns:
  • kAdded - a key has been added.
  • kRemoved - a key has been removed.
Status Codes:
double value ( MStatus ReturnStatus = NULL) const

The value of the key that was added or removed.

Parameters:
[out]ReturnStatusReturn code.
Returns:
A double value
Status Codes:
MTime time ( MStatus ReturnStatus = NULL) const

The time value of the key that was added or removed.

Parameters:
[out]ReturnStatusReturn code.
Returns:
A MTime value of the added/removed key.
Status Codes:
unsigned int keyIndex ( MStatus ReturnStatus = NULL) const [virtual]

The index of this key on the animation curve.

Parameters:
[out]ReturnStatusReturn code.
Returns:
An unsigned int representing the position of the key on the curve.
Status Codes:

Reimplemented from MFnKeyframeDelta.

double replacedValue ( MStatus ReturnStatus = NULL) const

The value of the key that was replaced.

This method is only applicable to the kReplaced operation. Otherwise it will return 0.

Parameters:
[out]ReturnStatusReturn code.
Returns:
A double value
Status Codes:

MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove
MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove MFnKeyframeDeltaAddRemove