MSetAttrEdit 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 setAttr edits.

This class is used to return information about setAttr edits. Such edits occur when a file is referenced and changes are made to attributes within the file reference. When a reference is unloaded, only the plug name may be queried successfully. When the referenced file is loaded, the plug itself may also be queried.

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

#include <MSetAttrEdit.h>

Inheritance diagram for MSetAttrEdit:

List of all members.

Public Member Functions
MPlug	plug (MStatus *ReturnStatus=NULL) const
	Returns the plug that was set for this edit.
MString	plugName (MStatus *ReturnStatus=NULL) const
	Returns the name of the plug that was set for this edit.
virtual EditType	editType (MStatus *ReturnStatus=NULL) const
	Virtual method used to return the edit type of this edit, which is MEdit::kSetAttrEdit.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class.
Friends
class	MItEdits Search for all occurrences

---

Member Function Documentation

MPlug plug

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

Returns the plug that was set for this edit.

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

Parameters:

[out]

ReturnStatus

Status Code

Returns:

The plug that was set for this edit

Status Codes:

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

MString plugName

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

Returns the name of the plug that was set for this edit.

Parameters:

[out]

ReturnStatus

Status Code

Returns:

The name of the plug that was set for this edit

Status Codes:

• MS::kSuccess Plug name was returned successfully
• 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::kSetAttrEdit.

Parameters:

[out]

ReturnStatus

return status

Returns:

MEdit::kSetAttrEdit

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.