This reference page is linked to from the following overview topics: Extension for Autodesk Maya 2013.
Detailed Description
Class for describing connection and disconnection edits.
This class is used to query information about connection and disconnection edits. Such edits occur when a file reference or assembly is loaded and connections are made or broken to attributes within the loaded nodes.
Please note that when a reference or assembly is unloaded, plugs related to operations cannot be returned since the plugs themselves do not exist. Thus for unloaded references, only the plug names may be queried successfully.
The MItEdits class may be used to iterate over all the edits on a given reference or assembly.
#include <MConnectDisconnectAttrEdit.h>
Public Member Functions | |
| MPlug | srcPlug (MStatus *ReturnStatus=NULL) const |
| Returns the source plug that was connected or disconnected for this edit. | |
| MPlug | dstPlug (MStatus *ReturnStatus=NULL) const |
| Returns the destination plug that was connected or disconnected for this edit. | |
| MString | srcPlugName (MStatus *ReturnStatus=NULL) const |
| Returns the name of the source plug that was connected or disconnected. | |
| MString | dstPlugName (MStatus *ReturnStatus=NULL) const |
| Returns the name of the destination plug that was connected or disconnected. | |
| bool | isConnection () const |
| Returns true if this edit is for a connection, false for a disconnection. | |
| virtual EditType | editType (MStatus *ReturnStatus=NULL) const |
| Virtual method used to return the edit type of this edit, which is MEdit::kConnectDisconnectEdit. | |
Static Public Member Functions | |
| static const char * | className () |
| Returns the name of this class. | |
Friends | |
| class | MItEdits |
Member Function Documentation
Returns the source plug that was connected or disconnected 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 source plug for this edit
- Status Codes:
- MS::kSuccess Plug was successfully returned
- MS::kFailure Related reference or assembly was not loaded.
Returns the destination plug that was connected or disconnected 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 destination plug for this edit
- Status Codes:
- MS::kSuccess Plug was successfully returned
- MS::kFailure Related reference or assembly was not loaded.
Returns the name of the source plug that was connected or disconnected.
- Parameters:
-
[out] ReturnStatus Status Code
- Returns:
- The name of the source plug
- Status Codes:
- MS::kSuccess Plug name was returned successfully
- MS::kFailure Edit was not initialized successfully
Returns the name of the destination plug that was connected or disconnected.
- Parameters:
-
[out] ReturnStatus Status Code
- Returns:
- The name of the destination plug
- Status Codes:
- MS::kSuccess Plug name was returned successfully
- MS::kFailure Edit was not initialized successfully
| bool isConnection | ( | ) | const |
Returns true if this edit is for a connection, false for a disconnection.
- Returns:
- True for a connection, false for a disconnection
| MEdit::EditType editType | ( | MStatus * | ReturnStatus = NULL | ) | const [virtual] |
Virtual method used to return the edit type of this edit, which is MEdit::kConnectDisconnectEdit.
- Parameters:
-
[out] ReturnStatus return status
- Returns:
- MEdit::kConnectDisconnectEdit
- Status Codes:
- MS::kSuccess Operation successful
Reimplemented from MEdit.
| const char * className | ( | ) | [static] |
