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

#include <MContainerMessage.h>

Inheritance diagram for MContainerMessage:

Inheritance graph
[legend]
Collaboration diagram for MContainerMessage:

Collaboration graph
[legend]

List of all members.


Detailed Description

Container-related messages.

The container node in Maya bundles together a group of related nodes. The user can then publish attribute names to the container, and bind attributes from nodes in the container to the published names.

MContainerMessage class allows the API user to register callbacks that inform them about changes to published attributes on containers.

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 addPublishAttrCallback (MMessage::MNodeStringBoolFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL)
static MCallbackId addBoundAttrCallback (MMessage::MNodeStringBoolFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL)


Member Function Documentation

MCallbackId MContainerMessage::addPublishAttrCallback ( MMessage::MNodeStringBoolFunction  func,
void *  clientData = NULL,
MStatus ReturnStatus = NULL 
) [static]

This method registers a callback that is called whenever an attribute is published or unpublished from a container.

Parameters:
[in] func the callback function
  • node The container node
  • publishedName Name of the published attr
  • clientData User defined data passed to the callback function
[in] clientData User defined data passed to the callback function
[out] ReturnStatus status code
Returns:
Identifier used for removing the callback.
Status Codes:

MCallbackId MContainerMessage::addBoundAttrCallback ( MMessage::MNodeStringBoolFunction  func,
void *  clientData = NULL,
MStatus ReturnStatus = NULL 
) [static]

This method registers a callback that is called whenever an attribute is bound or unbound on a container.

Parameters:
[in] func the callback function
  • node The container node
  • publishedName Name of the bound attr
  • clientData User defined data passed to the callback function
[in] clientData User defined data passed to the callback function
[out] ReturnStatus status code
Returns:
Identifier used for removing the callback.
Status Codes:


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