|
enum | Action { kDefaultAction,
kDoNotDoAction,
kDoAction
} |
| Callback result action codes. More...
|
|
typedef void(* | MBasicFunction) (void *clientData) |
| Pointer to a basic callback function. More...
|
|
typedef void(* | MElapsedTimeFunction) (float elapsedTime, float lastTime, void *clientData) |
| Pointer to an elapsed time callback function. More...
|
|
typedef void(* | MCheckFunction) (bool *retCode, void *clientData) |
| Pointer to callback function which returns a true/false result. More...
|
|
typedef void(* | MCheckFileFunction) (bool *retCode, MFileObject &file, void *clientData) |
| Pointer to a callback function which takes a file object and returns a result. More...
|
|
typedef void(* | MCheckPlugFunction) (bool *retCode, MPlug &plug, void *clientData) |
| Pointer to a callback function which takes a plug and returns a result. More...
|
|
typedef void(* | MComponentFunction) (MUintArray componentIds[], unsigned int count, void *clientData) |
| Pointer to a callback function which takes an array of component ids. More...
|
|
typedef void(* | MNodeFunction) (MObject &node, void *clientData) |
| Pointer to a callback function which takes a dependency node. More...
|
|
typedef void(* | MStringFunction) (const MString &str, void *clientData) |
| Pointer to callback function which takes a string. More...
|
|
typedef void(* | MTwoStringFunction) (const MString &str1, const MString &str2, void *clientData) |
| Pointer to a callback function which takes two strings. More...
|
|
typedef void(* | MThreeStringFunction) (const MString &str1, const MString &str2, const MString &str3, void *clientData) |
| Pointer to a callback function which takes three strings. More...
|
|
typedef void(* | MStringIntBoolIntFunction) (const MString &str, unsigned int index, bool flag, unsigned int type, void *clientData) |
| Pointer to callback function which takes a string, an index, a flag and a type. More...
|
|
typedef void(* | MStringIndexFunction) (const MString &, unsigned int index, void *clientData) |
| Pointer to callback function which takes a string and index. More...
|
|
typedef void(* | MNodeStringBoolFunction) (MObject &node, const MString &, bool, void *clientData) |
| Pointer to a callback function which takes a node, a string and a boolean. More...
|
|
typedef void(* | MStateFunction) (bool state, void *clientData) |
| Pointer to a callback function which takes a boolean state. More...
|
|
typedef void(* | MTimeFunction) (MTime &time, void *clientData) |
| Pointer to callback function which takes a time. More...
|
|
typedef void(* | MPlugFunction) (MPlug &srcPlug, MPlug &destPlug, bool made, void *clientData) |
| Pointer to plug connection callback function. More...
|
|
typedef void(* | MNodePlugFunction) (MObject &node, MPlug &plug, void *clientData) |
| Pointer to a callback function which takes a dependency node and a plug. More...
|
|
typedef void(* | MNodeStringFunction) (MObject &node, const MString &str, void *clientData) |
| Pointer to a callback function which takes a dependency node and a string. More...
|
|
typedef void(* | MParentChildFunction) (MDagPath &child, MDagPath &parent, void *clientData) |
| Pointer to to a callback function which takes two DAG nodes in a parent/child relationship. More...
|
|
typedef void(* | MModifierFunction) (MDGModifier &modifier, void *clientData) |
| Pointer to a callback function which takes a DG modifier. More...
|
|
typedef void(* | MStringArrayFunction) (const MStringArray &strs, void *clientData) |
| Pointer to a callback function which takes a string array. More...
|
|
typedef void(* | MNodeModifierFunction) (MObject &node, MDGModifier &modifier, void *clientData) |
| Pointer to a callback function which takes a dependency node and a DG modifier. More...
|
|
typedef void(* | MObjArray) (MObjectArray &objects, void *clientData) |
| Pointer to a callback function which takes an array of objects. More...
|
|
typedef void(* | MNodeObjArray) (MObject &node, MObjectArray &objects, void *clientData) |
| Pointer to a callback function which takes a dependency node and an array of objects. More...
|
|
typedef void(* | MStringNode) (const MString &str, MObject &node, void *clientData) |
| Pointer to a callback function which takes a string and a dependency node. More...
|
|
typedef void(* | MCameraLayerFunction) (MObject &cameraSetNode, unsigned int multiIndex, bool added, void *clientData) |
| Pointer to a callback function which takes a dependency node, an unsigned integer, and a boolean value. More...
|
|
typedef void(* | MCameraLayerCameraFunction) (MObject &cameraSetNode, unsigned int multiIndex, MObject &oldCamera, MObject &newCamera, void *clientData) |
| Pointer to a callback function which takes a dependency node, an unsigned integer, and two camera transform nodes. More...
|
|
typedef void(* | MConnFailFunction) (MPlug &srcPlug, MPlug &destPlug, const MString &srcPlugName, const MString &dstPlugName, void *clientData) |
| Pointer to connection-failed callback function. More...
|
|
typedef void(* | MPlugsDGModFunction) (MPlugArray &plugs, MDGModifier &modifier, void *clientData) |
| Pointer to a callback function which takes an array of MPlugs and an MDGModifier. More...
|
|
typedef void(* | MNodeUuidFunction) (MObject &node, const MUuid &uuid, void *clientData) |
| Pointer to a callback function which takes a dependency node and a UUID. More...
|
|
typedef Action(* | MCheckNodeUuidFunction) (bool doAction, MObject &node, MUuid &uuid, void *clientData) |
| Pointer to a callback function which takes a dependency node and a UUID, and returns a result. More...
|
|
typedef void(* | MObjectFileFunction) (const MObject &object, const MFileObject &file, void *clientData) |
| Pointer to a callback function which takes an object and a file object. More...
|
|
typedef void(* | MCheckObjectFileFunction) (bool *retCode, const MObject &referenceNode, MFileObject &file, void *clientData) |
| Pointer to a callback function which takes an object and a file object and returns a result. More...
|
|
typedef void(* | MRenderTileFunction) (int originX, int originY, int tileMaxX, int tileMaxY, const void *tileData) |
| Pointer to a callback function which receives origin, size and image data. More...
|
|
Event messages.
This class is used to register callbacks for specific events.
The first parameter passed to the add callback method is the name of the event that will trigger the callback. The list of available event names can be retrieved by calling the getEventNames method or by using the -listEvents flag on the scriptJob command.
The add callback method returns an id which is used to remove the callback.
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.