Public Types | Public Member Functions | Protected Member Functions

MFnKeyframeDeltaBlockAddRemove Class Reference

Search for all occurrences

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.

#include <MFnKeyframeDeltaBlockAddRemove.h>

Inheritance diagram for MFnKeyframeDeltaBlockAddRemove:
Inheritance graph
[legend]

List of all members.

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
 Indicates the type of change, i.e.
MTime startTime (MStatus *ReturnStatus=NULL) const
 An MTime value indicating the start time of the add/remove.
MTime endTime (MStatus *ReturnStatus=NULL) const
 Returns an MTime value indicating the endTime of the add/remove.
unsigned int numKeys (MStatus *ReturnStatus=NULL) const
 Total number of keys involved in this add or remove operation.
void getValues (MDoubleArray &values, MStatus *ReturnStatus=NULL) const
 Returns the values of all keys involved in the group add or remove.
void getTimes (MTimeArray &times, MStatus *ReturnStatus=NULL) const
 Returns the times of all keys involved in the group add or remove.
 MFnKeyframeDeltaBlockAddRemove (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 

Keys were added.

kRemoved 

Keys were removed.


Constructor & Destructor Documentation

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

Reimplemented from MFnKeyframeDelta.

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

Class name.

Return the class name : "MFnKeyframeDeltaBlockAddRemove".

Reimplemented from MFnKeyframeDelta.

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

Indicates the type of change, i.e.

keys added or removed, that this class instance represents.

Parameters:
[out]ReturnStatusReturn code.
Returns:
  • kAdded - a block of keys were added.
  • kRemoved - a block of keys were removed.
Status Codes:
MTime startTime ( MStatus ReturnStatus = NULL) const

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

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

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

Parameters:
[out]ReturnStatusReturn code.
Returns:
An MTime value indicating the end of the add/remove.
Status Codes:
unsigned int numKeys ( MStatus ReturnStatus = NULL) const

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

Parameters:
[out]ReturnStatusReturn code.
Returns:
Status Codes:
void getValues ( MDoubleArray values,
MStatus ReturnStatus = NULL 
) const

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

Parameters:
[in]valuesMDoubleArray to store values.
[out]ReturnStatusStatus code.
Returns:
Status Codes:
void getTimes ( MTimeArray times,
MStatus ReturnStatus = NULL 
) const

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

Parameters:
[in]timesMTimeArray to store all time values.
[out]ReturnStatusReturn code.
Returns:
Status Codes:

MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove
MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove MFnKeyframeDeltaBlockAddRemove