C++ API Reference
MConnectDisconnectAttrEdit Class Reference

Class for describing connection and disconnection edits. More...

#include <MConnectDisconnectAttrEdit.h>

+ Inheritance diagram for MConnectDisconnectAttrEdit:

Public Member Functions

MPlug srcPlug (MStatus *ReturnStatus=NULL) const
 Returns the source plug that was connected or disconnected for this edit. More...
 
MPlug dstPlug (MStatus *ReturnStatus=NULL) const
 Returns the destination plug that was connected or disconnected for this edit. More...
 
MString srcPlugName (MStatus *ReturnStatus=NULL) const
 Returns the name of the source plug that was connected or disconnected. More...
 
MString dstPlugName (MStatus *ReturnStatus=NULL) const
 Returns the name of the destination plug that was connected or disconnected. More...
 
bool isConnection () const
 Returns true if this edit is for a connection, false for a disconnection. More...
 
EditType editType (MStatus *ReturnStatus=NULL) const override
 Virtual method used to return the edit type of this edit, which is MEdit::kConnectDisconnectEdit. 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...
 

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.

Member Function Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MPlug srcPlug ( MStatus ReturnStatus = NULL) const

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]ReturnStatusStatus 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.
MPlug dstPlug ( MStatus ReturnStatus = NULL) const

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]ReturnStatusStatus 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.
MString srcPlugName ( MStatus ReturnStatus = NULL) const

Returns the name of the source plug that was connected or disconnected.

Parameters
[out]ReturnStatusStatus Code
Returns
The name of the source plug
Status Codes:
  • MS::kSuccess Plug name was returned successfully
  • MS::kFailure Edit was not initialized successfully
MString dstPlugName ( MStatus ReturnStatus = NULL) const

Returns the name of the destination plug that was connected or disconnected.

Parameters
[out]ReturnStatusStatus 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
overridevirtual

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

Parameters
[out]ReturnStatusreturn status
Returns
MEdit::kConnectDisconnectEdit
Status Codes:
  • MS::kSuccess Operation successful

Reimplemented from MEdit.

const char * className ( )
static

Returns the name of this class.

Returns
The name of this class.

The documentation for this class was generated from the following files: