MFnKeyframeDeltaBreakdown Class Reference
[OpenMayaAnim - API module for animationFunctionSet classes]

#include <MFnKeyframeDeltaBreakdown.h>
Inheritance diagram for MFnKeyframeDeltaBreakdown:
Inheritance graph
[legend]
Collaboration diagram for MFnKeyframeDeltaBreakdown:
Collaboration graph
[legend]

List of all members.


Detailed Description

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

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


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
bool  isBreakdown (MStatus *ReturnStatus=NULL) const
  MFnKeyframeDeltaBreakdown (const MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

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

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

Member Function Documentation

MFn::Type MFnKeyframeDeltaBreakdown::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kKeyframeDeltaBreakdown

Reimplemented from MFnKeyframeDelta.

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

Class name.

Return the class name : "MFnKeyframeDeltaBreakdown"

Reimplemented from MFnKeyframeDelta.

bool MFnKeyframeDeltaBreakdown::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:

bool MFnKeyframeDeltaBreakdown::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:

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6