class MObjectSetMessage

Jump to documentation

Inheritance:

MObjectSetMessage < MMessage

public members:

static MCallbackId

addSetMembersModifiedCallback ( MObject & node, MMessage::MNodeFunction func, void * clientData = NULL, MStatus * ReturnStatus = NULL )

Inherited from MMessage:

public members:

static MStatus	removeCallback ( MCallbackId id )
static MStatus	removeCallbacks ( MCallbackIdArray &ids )
static MCallbackId	currentCallbackId ( MStatus * ReturnStatus = NULL )
static MStatus	nodeCallbacks ( MObject & node, MCallbackIdArray & ids )
static void	setRegisteringCallableScript ()
static bool	registeringCallableScript ()
static MStatus	removeCallbacks ( MIntArray &ids )
static MStatus	nodeCallbacks ( MObject & node, MIntArray & ids )

Documentation

Description

This class is used to register callbacks for object set messages received by specific sets.

There is 1 add callback method which will add callbacks for the following message

• Set Members Modified

The first parameter passed to each of the add callback methods is the object set depenency node that will trigger the callback. The second parameter specifies the callback function and the optional third parameter specifies the callback argument.

Each 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.

Functions

MCallbackId MObjectSetMessage:: addSetMembersModifiedCallback ( MObject & node, MMessage::MNodeFunction func, void* clientData, MStatus * ReturnStatus )

Description

Registers callbacks for set modified messages.

Arguments

• node the set to register the callback for
• func the callback function
  • node the set that has triggered a setModified event
  • clientData User defined data passed to the callback function
• clientData User defined data that will be passed to the callback function
• ReturnStatus status code

Return Value

• identifier used for removing the callback.

Status Codes

• MS::kSuccess Operation succeeded
• MS::kInsufficientMemory No memory available
• MS::kFailure Error adding callback

This class has no child classes.