C++ API Reference
MFnKeyframeDeltaBlockAddRemove Class Reference

Function set for block add or removal of keys. More...

#include <MFnKeyframeDeltaBlockAddRemove.h>

+ Inheritance diagram for MFnKeyframeDeltaBlockAddRemove:

Public Types

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

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnKeyframeDeltaBlockAddRemove ()
 Destructor.
 
 MFnKeyframeDeltaBlockAddRemove ()
 Default constructor.
 
 MFnKeyframeDeltaBlockAddRemove (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
DeltaType deltaType (MStatus *ReturnStatus=NULL) const
 Indicates the type of change, i.e. More...
 
MTime startTime (MStatus *ReturnStatus=NULL) const
 An MTime value indicating the start time of the add/remove. More...
 
MTime endTime (MStatus *ReturnStatus=NULL) const
 Returns an MTime value indicating the endTime of the add/remove. More...
 
unsigned int numKeys (MStatus *ReturnStatus=NULL) const
 Total number of keys involved in this add or remove operation. More...
 
void getValues (MDoubleArray &values, MStatus *ReturnStatus=NULL) const
 Returns the values of all keys involved in the group add or remove. More...
 
void getTimes (MTimeArray &times, MStatus *ReturnStatus=NULL) const
 Returns the times of all keys involved in the group add or remove. More...
 
 MFnKeyframeDeltaBlockAddRemove (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
- Public Member Functions inherited from MFnKeyframeDelta
virtual ~MFnKeyframeDelta ()
 Destructor.
 
 MFnKeyframeDelta ()
 Default constructor.
 
 MFnKeyframeDelta (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MObject paramCurve (MStatus *ReturnStatus=NULL) const
 Return the Animation Curve MObject that this key belongs to. More...
 
virtual unsigned int keyIndex (MStatus *ReturnStatus=NULL) const
 The index of this key on the animation curve. More...
 
 MFnKeyframeDelta (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
- Public Member Functions inherited from MFnBase
virtual ~MFnBase ()
 Class Destructor. More...
 
bool hasObj (MFn::Type) const
 Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
 
bool hasObj (const MObject &) const
 Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
 
MObject object (MStatus *ReturnStatus=nullptr) const
 Returns the MObject that is attached to the Function Set. More...
 
virtual MStatus setObject (MObject &object)
 Attaches the Function Set to the specified Maya Object. More...
 
virtual MStatus setObject (const MObject &object)
 NO SCRIPT SUPPORT. More...
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 
- Static Public Member Functions inherited from MFnKeyframeDelta
static const char * className ()
 Returns the name of this class. More...
 
- Static Public Member Functions inherited from MFnBase
static const char * className ()
 Returns the name of this class. More...
 
static const char * typeString (MFn::Type)
 Returns the type string for a given type. More...
 
static bool isValid (MFn::Type)
 Returns true if type is in the range of valid types. More...
 

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.

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:
  • 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
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:
  • 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

Member Function Documentation

MFn::Type type ( ) const
virtual

Function set type.

Return the class type : MFn::kKeyframeDeltaBlockAddRemove.

Returns
the class type.

Reimplemented from MFnKeyframeDelta.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnKeyframeDeltaBlockAddRemove".

Returns
Name of this class.
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:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
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:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
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:
  • 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]ReturnStatusReturn code.
Returns
Status Codes:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
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:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.
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:
  • MS::kSuccess The operation succeeded.
  • MS::kFailure An object error has occurred.

The documentation for this class was generated from the following files: