MFnKeyframeDeltaAddRemove Class Reference
[OpenMayaAnim - API module for animationFunctionSet classes]

#include <MFnKeyframeDeltaAddRemove.h>

Inheritance diagram for MFnKeyframeDeltaAddRemove:

Inheritance graph
[legend]
Collaboration diagram for MFnKeyframeDeltaAddRemove:

Collaboration graph
[legend]

List of all members.


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.

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
double value (MStatus *ReturnStatus=NULL) const
MTime time (MStatus *ReturnStatus=NULL) const
virtual unsigned int keyIndex (MStatus *ReturnStatus=NULL) const
double replacedValue (MStatus *ReturnStatus=NULL) const
 MFnKeyframeDeltaAddRemove (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.


Member Enumeration Documentation

Type of change.

Enumerator:
kAdded  Key added.
kRemoved  Key removed.
kReplaced  Key replaced.


Constructor & Destructor Documentation

MFnKeyframeDeltaAddRemove::MFnKeyframeDeltaAddRemove ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in] object The MObject to attach the function set to
[out] ReturnStatus the return status
Status Codes:

MFnKeyframeDeltaAddRemove::MFnKeyframeDeltaAddRemove ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in] object The MObject to attach the function set to
[out] ReturnStatus the return status
Status Codes:


Member Function Documentation

MFn::Type MFnKeyframeDeltaAddRemove::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kKeyframeDeltaAddRemove

Reimplemented from MFnKeyframeDelta.

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

Class name.

Return the class name : "MFnKeyframeDeltaAddRemove"

Reimplemented from MFnKeyframeDelta.

MFnKeyframeDeltaAddRemove::DeltaType MFnKeyframeDeltaAddRemove::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 MFnKeyframeDeltaAddRemove::value ( MStatus ReturnStatus = NULL  )  const

The value of the key that was added or removed.

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

MTime MFnKeyframeDeltaAddRemove::time ( MStatus ReturnStatus = NULL  )  const

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

Parameters:
[out] ReturnStatus Return code.
Returns:
A MTime value of the added/removed key.
Status Codes:

unsigned int MFnKeyframeDeltaAddRemove::keyIndex ( MStatus ReturnStatus = NULL  )  const [virtual]

The index of this key on the animation curve.

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

Reimplemented from MFnKeyframeDelta.

double MFnKeyframeDeltaAddRemove::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] ReturnStatus Return code.
Returns:
A double value
Status Codes:


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6