OpenMayaUI.MUiMessage Class Reference

Inheritance diagram for OpenMayaUI.MUiMessage:

Static Public Member Functions
def	add3dViewDestroyMsgCallback ()
def	add3dViewPostRenderMsgCallback ()
def	add3dViewPreRenderMsgCallback ()
def	add3dViewRenderOverrideChangedCallback ()
def	add3dViewRendererChangedCallback ()
def	addCameraChangedCallback ()
def	addUiDeletedCallback ()
Static Public Member Functions inherited from OpenMaya.MMessage
def	currentCallbackId ()
def	nodeCallbacks ()
def	removeCallback ()
def	removeCallbacks ()

Additional Inherited Members
Static Public Attributes inherited from OpenMaya.MMessage
int	kDefaultAction = 0
int	kDoAction = 2
int	kDoNotDoAction = 1

Detailed Description

Class used to register callbacks for UI related messages.

Method resolution order:
-   MUiMessage
-   OpenMaya.MMessage
-   builtins.object

Member Function Documentation

def OpenMayaUI.MUiMessage.add3dViewDestroyMsgCallback ( )

static

add3dViewDestroyMsgCallback(panelName, function, clientData=None) -> id

        This method registers a callback for when a particular 3d view gets
destroyed. The callback is called before the destruction of the view.

The callback function will be passed any client data that was
provided when the callback was registered

 * panelName (string) - Name of panel to which to attach the callback
 * function - callable which will be passed a string indicating the name
   of the panel that contain the 3d view and the clientData object
 * clientData - User defined data passed to the callback function

 * return: Identifier used for removing the callback.

def OpenMayaUI.MUiMessage.add3dViewPostRenderMsgCallback ( )

static

add3dViewPostRenderMsgCallback(panelName, function, clientData=None) -> id

This method registers a callback for when the 3d view is
about to display it's rendered contents to the viewport.
It is called for every refresh of the view, after the scene is drawn,
but before any 2d adornments are drawn.

The callback function will be passed any client data that was
provided when the callback was registered.

 * panelName (string) - Name of panel to which to attach the callback
 * function - callable which will be passed a string indicating the name
   of the panel that contain the 3d view and the clientData object
 * clientData - User defined data passed to the callback function

 * return: Identifier used for removing the callback.

def OpenMayaUI.MUiMessage.add3dViewPreRenderMsgCallback ( )

static

add3dViewPreRenderMsgCallback(panelName, function, clientData=None) -> id

This method registers a callback for when a particular 3d view is
about to render it's contents. It is called before the scene is drawn,
but after the background has been drawn.

The callback function will be passed any client data that was
provided when the callback was registered.

 * panelName (string) - Name of panel to which to attach the callback
 * function - callable which will be passed a string indicating the name
   of the panel that contain the 3d view and the clientData object
 * clientData - User defined data passed to the callback function

 * return: Identifier used for removing the callback.

def OpenMayaUI.MUiMessage.add3dViewRendererChangedCallback ( )

static

add3dViewRendererChangedCallback(panelName, function, clientData=None) -> id

This method registers a callback for when the renderer for a particular 3d
view changes.

The callback function will be passed any client data that was
provided when the callback was registered.

 * panelName (string) - Name of panel to which to attach the callback
 * function - callable which will be passed 3 strings indicating: the name
   of the panel that contain the 3d view, the name of the old renderer used
   to draw the 3d view, the name of the new renderer used to draw the 3d view
   , and the clientData object
 * clientData - User defined data passed to the callback function

 * return: Identifier used for removing the callback.

def OpenMayaUI.MUiMessage.add3dViewRenderOverrideChangedCallback ( )

static

add3dViewRenderOverrideChangedCallback(panelName, function, clientData=None) -> id

This method registers a callback for when the render override for a
particular 3d view changes.

The callback function will be passed any client data that was
provided when the callback was registered.

 * panelName (string) - Name of panel to which to attach the callback
 * function - callable which will be passed 3 strings indicating: the name of
   the panel that contain the 3d view, the name of the old override used to draw
   in the 3d view, the name of the new override used to draw in the 3d view
   , and the clientData object
 * clientData - User defined data passed to the callback function

 * return: Identifier used for removing the callback.

def OpenMayaUI.MUiMessage.addCameraChangedCallback ( )

static

addCameraChangedCallback(panelName, function, clientData=None) -> id

This method registers a callback for cameras being changed in
3d views.  The callback is called when the camera changes for the
given panel, not when attributes on the panel's camera change.

The callback function will be passed any client data that was
provided when the callback was registered.

 * panelName (string) - the name of panel to which to attach the
   callback.
 * function - callable which will be passed a string indicating the
   name of the panel that had the camera change, a MObject containing
   the current camera used by the panel and the clientData object
 * clientData - User defined data passed to the callback function

 * return: Identifier used for removing the callback.

def OpenMayaUI.MUiMessage.addUiDeletedCallback ( )

static

addUiDeletedCallback(uiName, function, clientData=None) -> id

This method registers a callback for UI deleted messages.
The callback function will be passed any client data that was
provided when the callback was registered.

 * uiName (string) - the name of the UI object to register the
   callback for
 * function - callable which will be passed the clientData object
 * clientData - User defined data passed to the callback function

 * return: Identifier used for removing the callback.