MEventMessage Class Reference
[OpenMaya - API module for common classes]

#include <MEventMessage.h>
Inheritance diagram for MEventMessage:
Inheritance graph
Collaboration diagram for MEventMessage:
Collaboration graph

List of all members.

Detailed Description

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.

Static Public Member Functions

static MCallbackId  addEventCallback (const MString &event, MMessage::MBasicFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL)
static MStatus  getEventNames (MStringArray &names)

Member Function Documentation

MCallbackId MEventMessage::addEventCallback ( const MString eventName,
MMessage::MBasicFunction  func,
void *  clientData = NULL,
MStatus ReturnStatus = NULL  
) [static]

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.

[in]  eventName  the event to register the callback for
[in]  func  the callback function
  • clientData User defined data passed to the callback function
[in]  clientData  User defined data that will be passed to the callback function
[out]  ReturnStatus  status code
Identifier used for removing the callback.
Status Codes:

MStatus MEventMessage::getEventNames ( MStringArray names  )  [static]

This method returns the list of available event names.

[out]  names  set to the array of available event names.

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6