C++ API Reference: MFnKeyframeDeltaBlockAddRemove Class Reference
Function set for block add or removal of keys.
More...
#include <MFnKeyframeDeltaBlockAddRemove.h>
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.
Type of change.
Enumerator kAdded
Keys were added.
kRemoved
Keys were removed.
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:
MS::kSuccess if the function set is successfully attached
MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
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:
MS::kSuccess if the function set is successfully attached
MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject
OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className
(
)
static
Returns the name of this class.
Return the class name : "MFnKeyframeDeltaBlockAddRemove".
Returns Name of this class.
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:
MS::kSuccess The operation succeeded.
MS::kFailure An object error has occurred.
An MTime value indicating the start time of the add/remove.
Parameters
[out] ReturnStatus Return code.
Returns An MTime value.
Status Codes:
MS::kSuccess The operation succeeded.
MS::kFailure An object error has occurred.
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:
MS::kSuccess The operation succeeded.
MS::kFailure An object error has occurred.
unsigned int numKeys
(
MStatus *
ReturnStatus = NULL
)
const
Total number of keys involved in this add or remove operation.
Parameters
[out] ReturnStatus Return code.
Returns
Status Codes:
MS::kSuccess The operation succeeded.
MS::kFailure An object error has occurred.
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:
MS::kSuccess The operation succeeded.
MS::kFailure An object error has occurred.
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:
MS::kSuccess The operation succeeded.
MS::kFailure An object error has occurred.
The documentation for this class was generated from the following files:
MFnKeyframeDeltaBlockAddRemove.h
MFnKeyframeDeltaBlockAddRemove.cpp