Wrapper for a clipboard item.
More...
#include <MAnimCurveClipboardItem.h>
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.
Copy Constructor.
- Parameters
-
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] | ReturnStatus | Status 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] | rowCount | The clipboard item's row count |
[out] | childCount | The clipboard item's child count |
[out] | attributeCount | The 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 |
const MString & leafAttributeName |
( |
MStatus * |
ReturnStatus = NULL | ) |
const |
Returns the attribute's leaf name.
- Parameters
-
[out] | ReturnStatus | Status 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.
MStatus setAddressingInfo |
( |
unsigned int |
rowCount, |
|
|
unsigned int |
childCount, |
|
|
unsigned int |
attributeCount |
|
) |
| |
Sets the clipboard item's addressing info.
- Parameters
-
[in] | rowCount | The clipboard item's row count |
[in] | childCount | The clipboard item's child count |
[in] | attributeCount | The 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.
Sets the clipboard item's name info.
- Parameters
-
[in] | nodeName | The clipboard item's node name |
[in] | fullName | The clipboard item's full attribute name |
[in] | leafName | The 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.
Compare the individual members for equality.
- Parameters
-
- 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:
- MAnimCurveClipboardItem.h
- MAnimCurveClipboardItem.cpp