#include
<MDagMessage.h>
This class is used to register callbacks for dependency graph messages.
There are 6 types of add callback methods which will add callbacks for the following messages
To remove a callback use MMessage::removeCallback. All callbacks that are registered by a plug-in must be removed by that plug-in when it is unloaded. Failure to do so will result in a fatal error.
NOTE: It is possible to get Parent Added and Child Added messages before the node name has been set. This can happen if the node is newly created. Additionally, the MDagPath string path names passed to the callback may not be set as yet if the node has not been added to the model.
Public Types |
|
enum | DagMessage
{ kInvalidMsg = -1, kParentAdded, kParentRemoved, kChildAdded, kChildRemoved, kChildReordered, kInstanceAdded, kInstanceRemoved, kLast } |
The type of DAG changed messages that have
occurred. More... |
|
typedef void(* | MMessageParentChildFunction )(MDagMessage::DagMessage msgType, MDagPath &child, MDagPath &parent, void *clientData) |
Pointer to a callback function which takes
an MDagMessage, two MDagPaths and a
clientData pointer. |
|
Static Public Member Functions |
|
static MCallbackId | addParentAddedCallback (MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addParentAddedDagPathCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addParentRemovedCallback (MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addParentRemovedDagPathCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addChildAddedCallback (MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addChildAddedDagPathCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addChildRemovedCallback (MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addChildRemovedDagPathCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addChildReorderedCallback (MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addChildReorderedDagPathCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addDagCallback (DagMessage msgType, MDagMessage::MMessageParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
This method is obsolete. This
method is not available in Python. |
|
static MCallbackId | addDagDagPathCallback (MDagPath &node, DagMessage msgType, MDagMessage::MMessageParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addAllDagChangesCallback (MDagMessage::MMessageParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addAllDagChangesDagPathCallback (MDagPath &node, MDagMessage::MMessageParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addInstanceAddedCallback (MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addInstanceAddedDagPathCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addInstanceRemovedCallback (MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addInstanceRemovedDagPathCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
static MCallbackId | addParentAddedCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Obsolete and no script support. |
|
static MCallbackId | addParentRemovedCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Obsolete and no script support. |
|
static MCallbackId | addChildAddedCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
obsolete and no script support |
|
static MCallbackId | addChildRemovedCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Obsolete and no script support. |
|
static MCallbackId | addChildReorderedCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Obsolete and no script support. |
|
static MCallbackId | addInstanceAddedCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Obsolete and no script support. |
|
static MCallbackId | addInstanceRemovedCallback (MDagPath &node, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Obsolete and no script support. |
|
static MCallbackId | addDagCallback (DagMessage msgType, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Obsolete and no script support. |
|
static MCallbackId | addDagCallback (MDagPath &node, DagMessage msgType, MMessage::MParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Obsolete and no script support. |
|
static MCallbackId | addDagCallback (MDagPath &node, DagMessage msgType, MDagMessage::MMessageParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
obsolete and no script support |
|
static MCallbackId | addAllDagChangesCallback (MDagPath &node, MDagMessage::MMessageParentChildFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL) |
Obsolete and no script support. |
typedef void(* MDagMessage::MMessageParentChildFunction)(MDagMessage::DagMessage msgType, MDagPath &child, MDagPath &parent, void *clientData) |
Pointer to a callback function which takes an MDagMessage, two MDagPaths and a clientData pointer.
[in] | msgType | Type of message which caused the function to be called. |
[in,out] | child | First DAG path, usually used to pass the child of a parent/child pair. |
[in,out] | parent | Second DAG path, usually use to pass the parent of a parent/child pair. |
[in,out] | clientData | User-defined data which was supplied when the callback was added. |
The type of DAG changed messages that have occurred.
MCallbackId MDagMessage::addParentAddedCallback | ( | MMessage::MParentChildFunction | func, | |
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a parent is added in the DAG.
Please see the note in the Description section about this callback.
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addParentAddedDagPathCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a parent is added to the specified DAG node..
Please see the note in the Description section about this callback.
[in] | node | The DAG node to register the callback for |
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addParentRemovedCallback | ( | MMessage::MParentChildFunction | func, | |
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a parent is removed in the DAG.
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addParentRemovedDagPathCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a parent is removed from the specified DAG node.
[in] | node | The DAG node to register the callback for |
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addChildAddedCallback | ( | MMessage::MParentChildFunction | func, | |
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a child is added in the DAG.
Please see the note in the Description section about this callback.
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addChildAddedDagPathCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a child is added to the specified DAG node.
Please see the note in the Description section about this callback.
[in] | node | The DAG node to register the callback for |
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addChildRemovedCallback | ( | MMessage::MParentChildFunction | func, | |
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a child is removed in the DAG.
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addChildRemovedDagPathCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a child is removed from the specified DAG node.
[in] | node | The DAG node to register the callback for |
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addChildReorderedCallback | ( | MMessage::MParentChildFunction | func, | |
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a child is reordered in the DAG.
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addChildReorderedDagPathCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a child of the specified DAG node is reordered.
[in] | node | The DAG node to register the callback for |
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addDagCallback | ( | DagMessage | msgType, | |
MDagMessage::MMessageParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method is obsolete. This method is not available in Python.
This method registers a callback that is called whenever a DAG change is made.
Please see the note in the Description section about this callback if Parent Added or Child Added messages are being used.
[in] | msgType | The type of DAG change to trigger the callback |
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
[in] | msgType | The type of DAG change to trigger the callback |
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addDagDagPathCallback | ( | MDagPath & | node, | |
DagMessage | msgType, | |||
MDagMessage::MMessageParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called for specified a DAG change is made to the specified DAG path. The callback receives the DagMessage as well.
Please see the note in the Description section about this callback if Parent Added or Child Added messages are being used.
[in] | node | The DAG node to register the callback for. |
[in] | msgType | The type of DAG change to trigger the callback. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addAllDagChangesCallback | ( | MDagMessage::MMessageParentChildFunction | func, | |
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever any DAG change is made to any DAG node.
Please see the note in the Description section about this callback if Parent Added or Child Added messages are being used.
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addAllDagChangesDagPathCallback | ( | MDagPath & | node, | |
MDagMessage::MMessageParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever a DAG change is made to the specified DAG path.
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addInstanceAddedCallback | ( | MMessage::MParentChildFunction | func, | |
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever any node in the DAG is instanced
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addInstanceAddedDagPathCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever the specified node is instanced
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addInstanceRemovedCallback | ( | MMessage::MParentChildFunction | func, | |
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever an instance of any DAG node is removed or deleted.
[in] | func | the callback function |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | status code |
MCallbackId MDagMessage::addInstanceRemovedDagPathCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
This method registers a callback that is called whenever an instance of the specified node is removed.
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addParentAddedCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
Obsolete and no script support.
This method is obsolete. This method is not available in Python.
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addParentRemovedCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
Obsolete and no script support.
This method is obsolete. This method is not available in Python.
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addChildAddedCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
obsolete and no script support
This method is obsolete. This method is not available in Python.
Please see the note in the Description section about this callback.
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addChildRemovedCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
Obsolete and no script support.
This method is obsolete. This method is not available in Python.
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addChildReorderedCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
Obsolete and no script support.
This method is obsolete. This method is not available in Python.
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addInstanceAddedCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
Obsolete and no script support.
This method is obsolete. This method is not available in Python.
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addInstanceRemovedCallback | ( | MDagPath & | node, | |
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
Obsolete and no script support.
This method is obsolete. This method is not available in Python.
[in] | node | The DAG node to register the callback for. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addDagCallback | ( | MDagPath & | node, | |
DagMessage | msgType, | |||
MMessage::MParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
Obsolete and no script support.
This method is obsolete. This method is not available in Python.
This method registers a callback that is called whenever a DAG change is made to a specified node.
Please see the note in the Description section about this callback if Parent Added or Child Added messages are being used.
[in] | node | The DAG node to register the callback for. |
[in] | msgType | The type of DAG change to trigger the callback. |
[in] | func | The callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
MCallbackId MDagMessage::addAllDagChangesCallback | ( | MDagPath & | node, | |
MDagMessage::MMessageParentChildFunction | func, | |||
void * | clientData = NULL , |
|||
MStatus * | ReturnStatus =
NULL |
|||
) | [static] |
Obsolete and no script support.
This method is obsolete. This method is not available in Python.
[in] | node | The DAG node to register the callback for. |
[in] | func | the callback function. |
[in] | clientData | User defined data passed to the callback function. |
[out] | ReturnStatus | Status code. |
Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. | Generated with 1.5.6 |