class MHwrCallback

Jump to documentation

Rendering Callbacks (OpenMayaRender) (OpenMayaRender.py)

public members:

MHwrCallback ()
virtual ~MHwrCallback ()
virtual void deviceNew ()
virtual void deviceLost ()
virtual void deviceReset ()
virtual void deviceDeleted ()
static void addCallback ( MHwrCallback *, int priority = 0)
static void removeCallback ( MHwrCallback *)

Documentation

Rendering Callbacks (OpenMayaRender) (OpenMayaRender.py)
Description

This class is used to register callbacks to gain access to Maya's Hardware Rendering device status. You can be notified of device creation, lost reset and deletion.

To register callbacks, inherit from this class and override deviceNew, deviceLost, deviceReset, deviceDeleted. Any number of these methods can be overridden by the callback. Then register the callbacks by calling the addCallback() method.

If multiple callbacks need to be registered, the order of invocation can be set by adding each callback with a priority number, 0 being the highest priority.

Functions

MHwrCallback:: MHwrCallback ()
Description

Default Constructor

MHwrCallback:: ~MHwrCallback ()
Description

Default Destructor

void MHwrCallback:: deviceNew ()
Description

Method to override for being notified of new device creation

Arguments

  • None

Return Value

  • None

void MHwrCallback:: deviceLost ()
Description

Method to override for being notified of device Lost.

Arguments

  • None

Return Value

  • None

void MHwrCallback:: deviceReset ()
Description

Method to override for being notified of device Reset.

Arguments

  • None

Return Value

  • None

void MHwrCallback:: deviceDeleted ()
Description

Method to override for being notified of device Deletion.

Arguments

  • None

Return Value

  • None

void MHwrCallback:: addCallback ( MHwrCallback * callback, int priority )
Description

Static procedure to add a rendering callback. The callbacks are stored internally in a sorted list and are invoked following the appropriate device state change depending on which methods are overridden. Adding the same callback more than once will have no effect.

Arguments

  • callback object to add to the list of callbacks to invoke
  • priority priority for this callback, lower priorities are invoked first

void MHwrCallback:: removeCallback ( MHwrCallback * callback)
Description

Static procedure to remove a rendering callback. The callback will be removed from the list of callbacks, but its up to the client to actually delete the object. Unstability may result if a callback is deleted and not removed from the callback list.Removing an un-installed callback will have no effect.

Arguments

  • callback object to remove from the list of callbacks

This class has no child classes.


Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright