MParentingEdit Class Reference

#include <MParentingEdit.h>

Class 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.

Inheritance diagram for MParentingEdit:

Public Member Functions
MObject	parentedObject (MStatus *ReturnStatus=NULL) const
	Returns the dag object which was parented in this edit. More...
MObject	parent (MStatus *ReturnStatus=NULL) const
	Returns the parent dag object involved in this edit. More...
MString	parentedObjectName (MStatus *ReturnStatus=NULL) const
	Returns the dag object which was parented in this edit. More...
MString	parentName (MStatus *ReturnStatus=NULL) const
	Returns the name of the parent dag object involved in this edit. More...
virtual EditType	editType (MStatus *ReturnStatus=NULL) const
	Virtual method used to return the edit type of this edit, which is MEdit::kParentEdit. 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

MObject parentedObject

(

MStatus *

ReturnStatus = NULL

)

const

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.

MObject parent

(

MStatus *

ReturnStatus = NULL

)

const

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.

MString parentedObjectName

(

MStatus *

ReturnStatus = NULL

)

const

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.

MString parentName

(

MStatus *

ReturnStatus = NULL

)

const

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

Returns the name of this class.

Returns

The name of this class.

---

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

• MParentingEdit.h
• MParentingEdit.cpp