Detailed Description
Function set for changes in a key's breakdown state.
Delta keyframe object for changes in breakdown state of a key.
#include <MFnKeyframeDeltaBreakdown.h>
Public Member Functions |
|
| virtual MFn::Type | type () const |
| Function set type. |
|
| virtual | ~MFnKeyframeDeltaBreakdown () |
| Destructor. |
|
| MFnKeyframeDeltaBreakdown () | |
| Default constructor. |
|
| MFnKeyframeDeltaBreakdown (MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. |
|
| bool | wasBreakdown (MStatus *ReturnStatus=NULL) const |
| Returns the previous breakdown state of the
key. |
|
| bool | isBreakdown (MStatus *ReturnStatus=NULL) const |
| Returns the current breakdown state of the
key. |
|
| MFnKeyframeDeltaBreakdown (const MObject &object, MStatus *ReturnStatus=NULL) | |
| Constructor. |
|
Protected Member Functions |
|
| virtual const char * | className () const |
| Class name. |
|
Constructor & Destructor Documentation
| MFnKeyframeDeltaBreakdown | ( | 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:
-
- 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
| MFnKeyframeDeltaBreakdown | ( | 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:
-
- 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::kKeyframeDeltaBreakdown.
Reimplemented from MFnKeyframeDelta.
| const char * className | ( | ) | const [protected, virtual] |
Class name.
Return the class name : "MFnKeyframeDeltaBreakdown".
Reimplemented from MFnKeyframeDelta.
| bool wasBreakdown | ( | MStatus * | ReturnStatus =
NULL |
) | const |
Returns the previous breakdown state of the key.
It will return false if the key was converted to a breakdown key.
- Parameters:
-
[out] ReturnStatus Return code.
- Returns:
- true or false depending on the key's breakdown state.
- Status Codes:
-
- MS::kSuccess The operation succeeded.
- MS::kFailure An object error has occurred.
| bool isBreakdown | ( | MStatus * | ReturnStatus =
NULL |
) | const |
Returns the current breakdown state of the key.
It will return true if the key was converted to a breakdown key.
- Parameters:
-
[out] ReturnStatus Return code.
- Returns:
- true or false depending on the key's breakdown state.
- Status Codes:
-
- MS::kSuccess The operation succeeded.
- MS::kFailure An object error has occurred.
