This reference page is linked to from the following overview topics: Extension for Autodesk Maya 2013.
Detailed Description
Class for describing edits to parenting.
This class is used to represent information about edits to parenting. Such edits occur when a file is referenced and changes are made to the dag hierarchy of nodes within that reference. When a reference is unloaded, only the name of the nodes involved may be queried successfully. When the referenced file is loaded, the nodes themselves may also be queried.
The MItEdits class may be used to iterate over all the edits on a given reference or assembly.
#include <MParentingEdit.h>
Public Member Functions | |
| MObject | parentedObject (MStatus *ReturnStatus=NULL) const |
| Returns the dag object which was parented in this edit. | |
| MObject | parent (MStatus *ReturnStatus=NULL) const |
| Returns the parent dag object involved in this edit. | |
| MString | parentedObjectName (MStatus *ReturnStatus=NULL) const |
| Returns the dag object which was parented in this edit. | |
| MString | parentName (MStatus *ReturnStatus=NULL) const |
| Returns the name of the parent dag object involved in this edit. | |
| virtual EditType | editType (MStatus *ReturnStatus=NULL) const |
| Virtual method used to return the edit type of this edit, which is MEdit::kParentEdit. | |
Static Public Member Functions | |
| static const char * | className () |
| Returns the name of this class. | |
Friends | |
| class | MItEdits |
Member Function Documentation
Returns the dag object which was parented in this edit.
The parented object can only be returned when the related reference or assembly is loaded. When the reference or assembly is unloaded, only the name of the parented object may be queried successfully. queried.
- Parameters:
-
[out] ReturnStatus Status Code
- Returns:
- The dag object which was parented in this edit
- Status Codes:
- MS::kSuccess Parent was successfully returned
- MS::kFailure Related reference or assembly was not loaded.
Returns the parent dag object involved in this edit.
The parent can only be returned when the related reference or assembly is loaded. When the reference or assembly is unloaded, only the parent name string may be queried successfully.
- Parameters:
-
[out] ReturnStatus Status Code
- Returns:
- The parent dag object involved in this edit
- Status Codes:
- MS::kSuccess Parent was successfully returned
- MS::kFailure Related reference or assembly was not loaded.
Returns the dag object which was parented in this edit.
The parented object can only be returned when the related reference or assembly is loaded. When the reference or assembly is unloaded, only the name of the parented object may be queried successfully. queried.
- Parameters:
-
[out] ReturnStatus Status Code
- Returns:
- The dag object which was parented in this edit
- Status Codes:
- MS::kSuccess Parent was successfully returned
- MS::kFailure Related reference or assembly was not loaded.
Returns the name of the parent dag object involved in this edit.
- Parameters:
-
[out] ReturnStatus Status Code
- Returns:
- The name of the parent dag object involved in this edit
- Status Codes:
- MS::kSuccess Parent name was successfully returned
- MS::kFailure Edit was not initialized successfully
| MEdit::EditType editType | ( | MStatus * | ReturnStatus = NULL | ) | const [virtual] |
Virtual method used to return the edit type of this edit, which is MEdit::kParentEdit.
- Parameters:
-
[out] ReturnStatus return status
- Returns:
- MEdit::kParentEdit
- Status Codes:
- MS::kSuccess Operation successful
Reimplemented from MEdit.
| const char * className | ( | ) | [static] |
