class MAnimCurveClipboardItem

Jump to documentation

public members:

	MAnimCurveClipboardItem ()
	MAnimCurveClipboardItem ( const MAnimCurveClipboardItem &r)
	~MAnimCurveClipboardItem ()
const MObject	animCurve ( MStatus * ReturnStatus = NULL ) const
MStatus	getAddressingInfo ( unsigned int &rowCount, unsigned int &childCount, unsigned int &attributeCount) const
const MString &	fullAttributeName ( MStatus * ReturnStatus=NULL ) const
const MString &	leafAttributeName ( MStatus * ReturnStatus=NULL ) const
const MString &	nodeName ( MStatus * ReturnStatus=NULL ) const
MFnAnimCurve::AnimCurveType	animCurveType ( MStatus * ReturnStatus=NULL ) const
MStatus	setAnimCurve ( const MObject & curve )
MStatus	setAddressingInfo ( unsigned int rowCount, unsigned int childCount, unsigned int attributeCount )
MStatus	setNameInfo ( const MString & nodeName , const MString & fullName, const MString & leafName )
MAnimCurveClipboardItem &	operator = (const MAnimCurveClipboardItem &from)
bool	operator == (const MAnimCurveClipboardItem &rhs) const

Documentation

Description

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.

Functions

MAnimCurveClipboardItem:: MAnimCurveClipboardItem ()

Description

Default Constructor.

MAnimCurveClipboardItem:: MAnimCurveClipboardItem ( const MAnimCurveClipboardItem &r )

Description

Copy Constructor.

Arguments

• r The source to copy from.

MAnimCurveClipboardItem:: ~MAnimCurveClipboardItem ()

Description

Class Destructor

const MObject MAnimCurveClipboardItem:: animCurve ( MStatus * ReturnStatus ) const

Description

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.

Arguments

• ReturnStatus Status Code (see below)

Return Value

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

MStatus MAnimCurveClipboardItem:: getAddressingInfo ( unsigned int &rowCount, unsigned int &childCount, unsigned int &attributeCount ) const

Description

Returns the addressing information for this clipboard item,

Arguments

• rowCount The clipboard item's row count
• childCount The clipboard item's child count
• attributeCount The clipboard item's attribute count

Return Value

• MS::kSuccess the addressing info was returned successfully
• MS::kFailure the addressing info was not returned successfully

const MString & MAnimCurveClipboardItem:: fullAttributeName ( MStatus * ReturnStatus ) const

Description

Returns the attribute's full name

Arguments

• ReturnStatus Status Code (see below)

Return Value

The attribute's full name

Status Codes

• MS::kSuccess the full name was returned successfully
• MS::kFailure the full name was not returned successfully

const MString & MAnimCurveClipboardItem:: leafAttributeName ( MStatus * ReturnStatus ) const

Description

Returns the attribute's leaf name

Arguments

• ReturnStatus Status Code (see below)

Return Value

The attribute's leaf name.

Status Codes

• MS::kSuccess the leaf name was returned successfully
• MS::kFailure the leaf name was not returned successfully

const MString & MAnimCurveClipboardItem:: nodeName ( MStatus * ReturnStatus ) const

Description

Returns the node name

Arguments

• ReturnStatus Status Code (see below)

Return Value

The node name.

Status Codes

• MS::kSuccess the node name was returned successfully
• MS::kFailure the node name was not returned successfully

MFnAnimCurve::AnimCurveType MAnimCurveClipboardItem:: animCurveType ( MStatus * ReturnStatus ) const

Description

Returns the animCurve type

Arguments

• ReturnStatus Status Code (see below)

Return Value

The animCurve type.

Status Codes

• MS::kSuccess the animCurve type was returned successfully
• MS::kFailure the animCurve type was not returned successfully

MStatus MAnimCurveClipboardItem:: setAnimCurve ( const MObject &curve )

Description

Sets the clipboard item's animCurve

Arguments

• curve The animCurve

Return Value

• MS::kSuccess the animCurve was set successfully
• MS::kFailure the animCurve was not set successfully

MStatus MAnimCurveClipboardItem:: setAddressingInfo ( unsigned int rowCount, unsigned int childCount, unsigned int attributeCount )

Description

Sets the clipboard item's addressing info

Arguments

• rowCount The clipboard item's row count
• childCount The clipboard item's child count
• attributeCount The clipboard item's attribute count

Return Value

• MS::kSuccess the addressing info was set successfully
• MS::kFailure the addressing info was not set successfully

MStatus MAnimCurveClipboardItem:: setNameInfo ( const MString & nodeName , const MString &fullName, const MString &leafName )

Description

Sets the clipboard item's name info

Arguments

• nodeName The clipboard item's node name
• fullName The clipboard item's full attribute name
• leafName The clipboard item's leaf attribute name

Return Value

• MS::kSuccess the name info was set successfully
• MS::kFailure the name info was not set successfully

MAnimCurveClipboardItem & MAnimCurveClipboardItem:: operator = ( const MAnimCurveClipboardItem &from )

Description

Operator= overloading.

Arguments

• type The MAnimCurveClipboardItem to be copied

Return Value The copied MAnimCurveClipboardItem

bool MAnimCurveClipboardItem:: operator == ( const MAnimCurveClipboardItem &rhs) const

Description

Compare the individual members for equality.

Arguments

• type The MAnimCurveClipboardItem to be compared against.

Return Value

• true the MAnimCurveClipboard items are equal
• false the MAnimCurveClipboard items are not equal

This class has no child classes.