Public Member Functions | Static Public Member Functions

MAnimCurveClipboardItem Class Reference

Search for all occurrences

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:

animFileUtils.cpp, animFileUtils.h, and animImportExport.h.

#include <MAnimCurveClipboardItem.h>

List of all members.

Public Member Functions

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

Static Public Member Functions

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

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:
Examples:
animFileUtils.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:
animFileUtils.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:
Examples:
animFileUtils.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:
Examples:
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:
Examples:
animFileUtils.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:
animFileUtils.cpp.
MStatus setAnimCurve ( const MObject curve)

Sets the clipboard item's animCurve.

Parameters:
[in]curveThe animCurve
Returns:
Examples:
animFileUtils.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:
Examples:
animFileUtils.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:
Examples:
animFileUtils.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.

MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem
MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem MAnimCurveClipboardItem