MConditionMessage Class Reference

Condition change messages. More...

#include <MConditionMessage.h>

Inheritance diagram for MConditionMessage:

Static Public Member Functions
static MCallbackId	addConditionCallback (const MString &conditionName, MMessage::MStateFunction func, void *clientData=NULL, MStatus *ReturnStatus=NULL)
	This method registers a callback for condition changed messages. More...
static MStatus	getConditionNames (MStringArray &names)
	This method returns the list of available condition names. More...
static bool	getConditionState (const MString &name, MStatus *ReturnStatus=NULL)
	This method returns the current state of a condition. More...
static const char *	className ()
	Returns the name of this class. More...
Static Public Member Functions inherited from MMessage
static MStatus	removeCallback (MCallbackId id)
	Remove the specified callback from maya. More...
static MStatus	removeCallbacks (MCallbackIdArray &ids)
	Remove all of the specified callbacks from maya. More...
static MCallbackId	currentCallbackId (MStatus *ReturnStatus=NULL)
	Return the callback ID of the currently executing callback. More...
static MStatus	nodeCallbacks (MObject &node, MCallbackIdArray &ids)
	Returns a list of callback IDs associated registered to a given node. More...
static void	setRegisteringCallableScript ()
	Mark this MMessage object as one that will be passed callbacks defined in script.
static bool	registeringCallableScript ()
	Return true if this MMessage object has its callbacks defined in script.
static void	stopRegisteringCallableScript ()
	Stop this MMessage object from being passed. More...
static const char *	className ()
	Returns the name of this class. More...
static MStatus	removeCallbacks (MIntArray &ids)
	This method is obsolete. More...
static MStatus	nodeCallbacks (MObject &node, MIntArray &ids)
	This method is obsolete. More...

Additional Inherited Members
Public Types inherited from MMessage
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...

Detailed Description

Condition change messages.

This class is used to register callbacks for changes to specific conditions.

The addConditionCallback method will add callback a callback for condition changed messages.

The first parameter passed to the addConditionCallback method is the name of the condition that will trigger the callback. The list of available condition names can be retrieved by calling the getConditionNames method or by using the -listConditions flag on the scriptJob command.

Callbacks that are registered for conditions will be passed a bool value as a parameter. This value indicates the new state of the condition.

The addConditionCallback 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.

The getConditionState method is used to return the current state of the specified condition.

Member Function Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MCallbackId addConditionCallback ( const MString &  conditionName, MMessage::MStateFunction  func, void *  clientData = NULL, MStatus *  ReturnStatus = NULL  )

static

This method registers a callback for condition changed messages.

The callback function will be passed the new state of the condition and any client data that the user wishes to pass in.

Example callback ( prints out a message when a condition changes ) :

void userCB( bool state, void* )
{
    if (state) {
        cout << "Condition: true" << endl;
    } else {
        cout << "Condition: false" << endl;
    }
}

Parameters

[in]	conditionName	the condition to register the callback for
[in]	func	the callback function

• state the new state of the condition triggering the callback
• clientData User defined data passed to the callback function

Parameters

[in]	clientData	User defined data that will be passed to the callback function
[out]	ReturnStatus	status code

Returns

Identifier used for removing the callback.

Status Codes:

• MS::kSuccess Operation succeeded
• MS::kUnknownParameter The named condition could not be found
• MS::kInsufficientMemory No memory available
• MS::kFailure Error adding callback

Examples:

conditionTest/conditionTest.cpp.

MStatus getConditionNames ( MStringArray &  names )

static

This method returns the list of available condition names.

Parameters

[out]

names

set to the array of available condition names.

Returns

• MS::kSuccess Operation succeeded
• MS::kInsufficientMemory No memory available
• MS::kFailure Error retrieving condition names

Examples:

conditionTest/conditionTest.cpp.

bool getConditionState ( const MString &  name, MStatus *  ReturnStatus = NULL  )

static

This method returns the current state of a condition.

Parameters

[in]	name	the name of the condition.
[out]	ReturnStatus	status code

Returns

The current state of the condition.

Status Codes:

• MS::kSuccess Operation succeeded
• MS::kUnknownParameter The named condition could not be found
• MS::kInsufficientMemory No memory available
• MS::kFailure Error retrieving condition state

Examples:

conditionTest/conditionTest.cpp.

const char * className ( )

static

Returns the name of this class.

Returns

The name of this class.

---

The documentation for this class was generated from the following files:

• MConditionMessage.h
• MConditionMessage.cpp