OpenMaya.MConditionMessage Class Reference

Class Description

Class used to register callbacks for condition related messages.

Method resolution order:
-   MConditionMessage
-   MMessage
-   __builtin__.object

Inheritance diagram for OpenMaya.MConditionMessage:

Static Public Member Functions
	addConditionCallback ()
	getConditionNames ()
	getConditionState ()
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.MConditionMessage.addConditionCallback ( )

static

addConditionCallback(conditionName, function, clientData=None) -> id

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.

 * conditionName (string) - the condition to register the 
callback for
 * function - callable which will be passed a bool indicating
   the new state of the condition, and the clientData object.
 * clientData - User defined data passed to the callback function

 * return: Identifier used for removing the callback.

OpenMaya.MConditionMessage.getConditionNames ( )

static

getConditionNames() -> (string, string, ...)

This method returns the list of available condition names.

 * return: tuple of available condition names.

OpenMaya.MConditionMessage.getConditionState ( )

static

getConditionState(name) -> bool

This method returns the current state of a condition.

 * name (string) - the name of the condition.


 * return: The current state of the condition.