class MDrawRequestQueue

Jump to documentation

Drawing queue used in MPxSurfaceShapeUI::getDrawRequests (OpenMayaUI) (OpenMayaUI.py)

public members:

MDrawRequestQueue ()
~MDrawRequestQueue ()
bool isEmpty () const
void add ( MDrawRequest & )
MDrawRequest remove ()

Documentation

Drawing queue used in MPxSurfaceShapeUI::getDrawRequests (OpenMayaUI) (OpenMayaUI.py)
Description

This class defines a simple interface for a collection of MDrawRequest objects.

An MDrawRequestQueue object is passed to the getDrawRequests method of a user defined shape's UI class (MPxSurfaceShapeUI). This queue keeps track of all the things that need to get draw when a refresh of the view occurs.

Maya will call the getDrawRequest methods of all the visible DAG objects before a refresh happens. Then as the refresh happens, each draw request will be processed and the corresponding draw method for each DAG object will get called. For user defined shapes MPxSurfaceShapeUI::draw will get called.

Functions

MDrawRequestQueue:: MDrawRequestQueue ()

Description

Constructor.

MDrawRequestQueue:: ~MDrawRequestQueue ()

Description

Destructor.

bool MDrawRequestQueue:: isEmpty () const

Description

Returns true if the queu is empty.

Return Value

  • true the draw queue is empty
  • false the draw queue is not empty

void MDrawRequestQueue:: add ( MDrawRequest & request )

Description

Adds a draw request to the draw queue.

Arguments

  • request the draw request to add

MDrawRequest MDrawRequestQueue:: remove ()

Description

Removes a draw request from the draw queue.

Return Value

  • the draw request that was removed

This class has no child classes.


Autodesk® Maya® 8.0 © 1997-2006 Autodesk, Inc. All rights reserved. doc++ Copyright