MFcurveEdit Class Reference

This reference page is linked to from the following overview topics: Extension for Autodesk Maya 2013.

---

Search for all occurrences

---

Detailed Description

Class for describing fcurve edits.

This class is used to return information about fcurve edits. Such edits occur when a file is referenced and changes are made to fcurves within the file reference. When a reference is unloaded, not all the queries on this method will work. In particular, the fcurve node itself cannot be returned since it no longer exists in Maya.

The MItEdits class may be used to iterate over all the edits on a given reference or assembly.

#include <MFcurveEdit.h>

Inheritance diagram for MFcurveEdit:

List of all members.

Public Member Functions
MObject	fcurve (MStatus *ReturnStatus=NULL) const
	Returns the fcurve node that was modified for this edit.
MString	fcurveName (MStatus *ReturnStatus=NULL) const
	Returns the name of the fcurve that was modified in this edit.
virtual EditType	editType (MStatus *ReturnStatus=NULL) const
	Virtual method used to return the edit type of this edit, which is MEdit::kFcurveEdit.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class.
Friends
class	MItEdits Search for all occurrences

---

Member Function Documentation

MObject fcurve

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

Returns the fcurve node that was modified for this edit.

The node can only be returned when the related reference is loaded. When the reference or assembly is unloaded, only the fcurve name string can be queried.

Parameters:

[out]

ReturnStatus

Status Code

Returns:

The fcurve that was modified for this edit

Status Codes:

• MS::kSuccess Node was successfully returned
• MS::kFailure Related reference or assembly was not loaded.

MString fcurveName

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

Returns the name of the fcurve that was modified in this edit.

Parameters:

[out]

ReturnStatus

Status Code

Returns:

The name of the fcurve node that was modified in this edit

Status Codes:

• MS::kSuccess Fcurve name was successfully returned
• MS::kFailure Edit was not initialized successfully

MEdit::EditType editType

(

MStatus *

ReturnStatus = NULL

)

const [virtual]

Search for all occurrences

Virtual method used to return the edit type of this edit, which is MEdit::kFcurveEdit.

Parameters:

[out]

ReturnStatus

return status

Returns:

MEdit::kFcurveEdit

Status Codes:

• MS::kSuccess Operation successful

Reimplemented from MEdit.

const char * className

(

)

[static]

Search for all occurrences

Returns the name of this class.

Returns:

The name of this class.

Reimplemented from MEdit.