MSetAttrEdit Class Reference
Related help topics: #include <MSetAttrEdit.h>
Class 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.
Inheritance diagram for MSetAttrEdit:
Public Member Functions | |
| MPlug | plug (MStatus *ReturnStatus=NULL) const |
| Returns the plug that was set for this edit. More... | |
| MString | plugName (MStatus *ReturnStatus=NULL) const |
| Returns the name of the plug that was set for this edit. More... | |
| virtual EditType | editType (MStatus *ReturnStatus=NULL) const |
| Virtual method used to return the edit type of this edit, which is MEdit::kSetAttrEdit. More... | |
| Public Member Functions inherited from MEdit | |
| MString | getString (MStatus *ReturnStatus=NULL) const |
| Returns the ASCII string related to the current edit. More... | |
| bool | isApplied (MStatus *ReturnStatus=NULL) const |
| Query if we attempted to apply the edit. More... | |
| bool | isFailed (MStatus *ReturnStatus=NULL) const |
| Query if the edit is applied successfully. More... | |
| bool | isTopLevel (MStatus *ReturnStatus=NULL) const |
| Query if the edit was made from the top-level. More... | |
| MStatus | setApplied (bool isApplied) |
| This method is obsolete. More... | |
| MStatus | setFailed (bool failed) |
| This method is obsolete. More... | |
| bool | hasEditData () const |
| Query if the edit has any user-defined editData associated with it. More... | |
| bool | matches (const MPxEditData *editData) const |
| Query if the edit has user-defined editData associated with it that matches the given editData object. More... | |
Static Public Member Functions | |
| static const char * | className () |
| Returns the name of this class. More... | |
| Static Public Member Functions inherited from MEdit | |
| static const char * | className () |
| Returns the name of this class. More... | |
Friends | |
| class | MItEdits |
Additional Inherited Members | |
| Public Types inherited from MEdit | |
| enum | EditType { kNullEdit, kSetAttrEdit, kConnectDisconnectEdit, kAddRemoveAttrEdit, kParentEdit, kFcurveEdit } |
| Type of edit. More... | |
Member Function Documentation
Returns the plug that was set for this edit.
The plug can only be returned when the related reference or assembly is loaded and the edit was made from the top-level. Otherwise, only the plug name string can be queried, using MSetAttrEdit::plugName.
- 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 or edit is not top level.
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
|
virtual |
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.
|
static |
Returns the name of this class.
- Returns
- The name of this class.
The documentation for this class was generated from the following files:
- MSetAttrEdit.h
- MSetAttrEdit.cpp