C++ API Reference
MAnimCurveClipboardItem Class Reference

Wrapper for a clipboard item. More...

#include <MAnimCurveClipboardItem.h>

Public Member Functions

 MAnimCurveClipboardItem ()
 Default Constructor.
 
 MAnimCurveClipboardItem (const MAnimCurveClipboardItem &r)
 Copy Constructor. More...
 
 ~MAnimCurveClipboardItem ()
 Class Destructor.
 
const MObject animCurve (MStatus *ReturnStatus=NULL) const
 Returns the animCurve held by this clipboard item as an MObject. More...
 
MStatus getAddressingInfo (unsigned int &rowCount, unsigned int &childCount, unsigned int &attributeCount) const
 Returns the addressing information for this clipboard item,. More...
 
const MStringfullAttributeName (MStatus *ReturnStatus=NULL) const
 Returns the attribute's full name. More...
 
const MStringleafAttributeName (MStatus *ReturnStatus=NULL) const
 Returns the attribute's leaf name. More...
 
const MStringnodeName (MStatus *ReturnStatus=NULL) const
 Returns the node name. More...
 
MFnAnimCurve::AnimCurveType animCurveType (MStatus *ReturnStatus=NULL) const
 Returns the animCurve type. More...
 
MStatus setAnimCurve (const MObject &curve)
 Sets the clipboard item's animCurve. More...
 
MStatus setAddressingInfo (unsigned int rowCount, unsigned int childCount, unsigned int attributeCount)
 Sets the clipboard item's addressing info. More...
 
MStatus setNameInfo (const MString &nodeName, const MString &fullName, const MString &leafName)
 Sets the clipboard item's name info. More...
 
MAnimCurveClipboardItemoperator= (const MAnimCurveClipboardItem &from)
 Operator= overloading. More...
 
bool operator== (const MAnimCurveClipboardItem &rhs) const
 Compare the individual members for equality. More...
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 

Detailed Description

Wrapper for a clipboard item.

This class provides a wrapper for a clipboard item. Common convenience functions are available, and the implementation is compatible with the internal Maya implementation so that it can be passed efficiently between plugins and internal maya data structures.

Examples:
animImportExport/animFileUtils.cpp, animImportExport/animFileUtils.h, atomImportExport/atomFileUtils.cpp, and atomImportExport/atomFileUtils.h.

Constructor & Destructor Documentation

Copy Constructor.

Parameters
[in]rMAnimCurveClipboardItem to copy from.

Member Function Documentation

const MObject animCurve ( MStatus ReturnStatus = NULL) const

Returns the animCurve held by this clipboard item as an MObject.

Note that the returned MObject is const because you must not modify the animCurve referenced by this MObject.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
An MObject for the animCurve. On failure, the MObject will be NULL. Be aware that the clipboard may be holding onto NULL animCurves (which are placeholder objects).
Status Codes:
  • MS::kSuccess the animCurve was returned successfully
  • MS::kFailure the animCurve was not returned successfully
Examples:
animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
MStatus getAddressingInfo ( unsigned int &  rowCount,
unsigned int &  childCount,
unsigned int &  attributeCount 
) const

Returns the addressing information for this clipboard item,.

Parameters
[out]rowCountThe clipboard item's row count
[out]childCountThe clipboard item's child count
[out]attributeCountThe clipboard item's attribute count
Returns
  • MS::kSuccess the addressing info was returned successfully
  • MS::kFailure the addressing info was not returned successfully
Examples:
animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
const MString & fullAttributeName ( MStatus ReturnStatus = NULL) const

Returns the attribute's full name.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The attribute's full name
Status Codes:
  • MS::kSuccess the full name was returned successfully
  • MS::kFailure the full name was not returned successfully
Examples:
animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
const MString & leafAttributeName ( MStatus ReturnStatus = NULL) const

Returns the attribute's leaf name.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The attribute's leaf name.
Status Codes:
  • MS::kSuccess the leaf name was returned successfully
  • MS::kFailure the leaf name was not returned successfully
Examples:
animImportExport/animFileUtils.cpp.
const MString & nodeName ( MStatus ReturnStatus = NULL) const

Returns the node name.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The node name.
Status Codes:
  • MS::kSuccess the node name was returned successfully
  • MS::kFailure the node name was not returned successfully
Examples:
animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
MFnAnimCurve::AnimCurveType animCurveType ( MStatus ReturnStatus = NULL) const

Returns the animCurve type.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The animCurve type.
Status Codes:
  • MS::kSuccess the animCurve type was returned successfully
  • MS::kFailure the animCurve type was not returned successfully
Examples:
animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
MStatus setAnimCurve ( const MObject curve)

Sets the clipboard item's animCurve.

Parameters
[in]curveThe animCurve
Returns
  • MS::kSuccess the animCurve was set successfully
  • MS::kFailure the animCurve was not set successfully
Examples:
animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
MStatus setAddressingInfo ( unsigned int  rowCount,
unsigned int  childCount,
unsigned int  attributeCount 
)

Sets the clipboard item's addressing info.

Parameters
[in]rowCountThe clipboard item's row count
[in]childCountThe clipboard item's child count
[in]attributeCountThe clipboard item's attribute count
Returns
  • MS::kSuccess the addressing info was set successfully
  • MS::kFailure the addressing info was not set successfully
Examples:
animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
MStatus setNameInfo ( const MString nodeName,
const MString fullName,
const MString leafName 
)

Sets the clipboard item's name info.

Parameters
[in]nodeNameThe clipboard item's node name
[in]fullNameThe clipboard item's full attribute name
[in]leafNameThe clipboard item's leaf attribute name
Returns
  • MS::kSuccess the name info was set successfully
  • MS::kFailure the name info was not set successfully
Examples:
animImportExport/animFileUtils.cpp, and atomImportExport/atomFileUtils.cpp.
MAnimCurveClipboardItem & operator= ( const MAnimCurveClipboardItem from)

Operator= overloading.

Parameters
[in]fromThe MAnimCurveClipboardItem to be copied
Returns
The copied MAnimCurveClipboardItem
bool operator== ( const MAnimCurveClipboardItem rhs) const

Compare the individual members for equality.

Parameters
[in]rhsThe MAnimCurveClipboardItem to be compared against.
Returns
const char * className ( )
static

Returns the name of this class.

Returns
The name of this class.

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