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

#include <MFnKeyframeDeltaBlockAddRemove.h>

Inheritance diagram for MFnKeyframeDeltaBlockAddRemove:

Inheritance graph
[legend]
Collaboration diagram for MFnKeyframeDeltaBlockAddRemove:

Collaboration graph
[legend]

List of all members.


Detailed Description

Function set for block add or removal of keys.

Certain keyframe editing operations work on group of keys rather than an single key. These operations require this function set to retrieve changes.

Function set for reading a block of keyframe changes. They are used internally to set a large group of keys quickly. Because changes occur in groups using base class keyframe methods on this derived class do not make sense. Therefore, methods describing where the block of keys were added or removed are available though methods on this class.

Public Types

enum  DeltaType { kAdded, kRemoved }
 Type of change. More...

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnKeyframeDeltaBlockAddRemove ()
 Destructor.
 MFnKeyframeDeltaBlockAddRemove ()
 Default constructor.
 MFnKeyframeDeltaBlockAddRemove (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
DeltaType deltaType (MStatus *ReturnStatus=NULL) const
MTime startTime (MStatus *ReturnStatus=NULL) const
MTime endTime (MStatus *ReturnStatus=NULL) const
unsigned int numKeys (MStatus *ReturnStatus=NULL) const
void getValues (MDoubleArray &values, MStatus *ReturnStatus=NULL) const
void getTimes (MTimeArray &times, MStatus *ReturnStatus=NULL) const
 MFnKeyframeDeltaBlockAddRemove (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  Keys were added.
kRemoved  Keys were removed.


Constructor & Destructor Documentation

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

MFnKeyframeDeltaBlockAddRemove::MFnKeyframeDeltaBlockAddRemove ( 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 MFnKeyframeDeltaBlockAddRemove::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kKeyframeDeltaBlockAddRemove

Reimplemented from MFnKeyframeDelta.

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

Class name.

Return the class name : "MFnKeyframeDeltaBlockAddRemove"

Reimplemented from MFnKeyframeDelta.

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

Indicates the type of change, i.e. keys added or removed, that this class instance represents.

Parameters:
[out] ReturnStatus Return code.
Returns:
  • kAdded - a block of keys were added.
  • kRemoved - a block of keys were removed.
Status Codes:

MTime MFnKeyframeDeltaBlockAddRemove::startTime ( MStatus ReturnStatus = NULL  )  const

An MTime value indicating the start time of the add/remove.

Parameters:
[out] ReturnStatus Return code.
Returns:
An MTime value.
Status Codes:

MTime MFnKeyframeDeltaBlockAddRemove::endTime ( MStatus ReturnStatus = NULL  )  const

Returns an MTime value indicating the endTime of the add/remove.

Parameters:
[out] ReturnStatus Return code.
Returns:
An MTime value indicating the end of the add/remove.
Status Codes:

unsigned int MFnKeyframeDeltaBlockAddRemove::numKeys ( MStatus ReturnStatus = NULL  )  const

Total number of keys involved in this add or remove operation.

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

void MFnKeyframeDeltaBlockAddRemove::getValues ( MDoubleArray values,
MStatus ReturnStatus = NULL 
) const

Returns the values of all keys involved in the group add or remove.

Parameters:
[in] values MDoubleArray to store values.
[out] ReturnStatus Status code.
Returns:
Status Codes:

void MFnKeyframeDeltaBlockAddRemove::getTimes ( MTimeArray times,
MStatus ReturnStatus = NULL 
) const

Returns the times of all keys involved in the group add or remove.

Parameters:
[in] times MTimeArray to store all time values.
[out] ReturnStatus Return code.
Returns:
Status Codes:


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