OpenMaya.MEventMessage Class Reference

OpenMaya.MEventMessage Class Reference

Class Description

Class used to register callbacks for event related messages.

Method resolution order:
-   MEventMessage
-   MMessage
-   __builtin__.object
+ Inheritance diagram for OpenMaya.MEventMessage:

Static Public Member Functions

addEventCallback ()
 
getEventNames ()
 
- Static Public Member Functions inherited from OpenMaya.MMessage
currentCallbackId ()
 
nodeCallbacks ()
 
removeCallback ()
 
removeCallbacks ()
 

Additional Inherited Members

- Static Public Attributes inherited from OpenMaya.MMessage
int kDefaultAction = 0
 
int kDoAction = 2
 
int kDoNotDoAction = 1
 

Member Function Documentation

OpenMaya.MEventMessage.addEventCallback ( )
static
addEventCallback(eventName, function, clientData=None) -> id

This method registers a callback for event occurred messages.
The callback function will be passed the any client data that
was provided when the callback was registered.

 * eventName (string) - the event to register the 
callback for
 * function - callable which will be passed the clientData object
 * clientData - User defined data passed to the callback function

 * return: Identifier used for removing the callback.
OpenMaya.MEventMessage.getEventNames ( )
static
getEventNames() -> (string, string, ...)

This method returns the list of available event names.

 * return: tuple of available event names.