MFnKeyframeDeltaBreakdown Class Reference

#include <MFnKeyframeDeltaBreakdown.h>

Class Description

Function set for changes in a key's breakdown state.

Delta keyframe object for changes in breakdown state of a key.

+ Inheritance diagram for MFnKeyframeDeltaBreakdown:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnKeyframeDeltaBreakdown ()
 Destructor.
 
 MFnKeyframeDeltaBreakdown ()
 Default constructor.
 
 MFnKeyframeDeltaBreakdown (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
bool wasBreakdown (MStatus *ReturnStatus=NULL) const
 Returns the previous breakdown state of the key. More...
 
bool isBreakdown (MStatus *ReturnStatus=NULL) const
 Returns the current breakdown state of the key. More...
 
 MFnKeyframeDeltaBreakdown (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=NULL) 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...
 

Protected Member Functions

virtual const char * className () const
 Class name. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MFnBase
static const char * className ()
 Returns the name of this class. More...
 

Constructor & Destructor Documentation

MFnKeyframeDeltaBreakdown ( 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
MFnKeyframeDeltaBreakdown ( 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::kKeyframeDeltaBreakdown.

Reimplemented from MFnKeyframeDelta.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( ) const
protectedvirtual

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]ReturnStatusReturn 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]ReturnStatusReturn 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.

The documentation for this class was generated from the following files:
  • MFnKeyframeDeltaBreakdown.h
  • MFnKeyframeDeltaBreakdown.cpp