MDrawRequestQueue Class Reference
[OpenMayaUI - API module for user interface]

#include <MDrawRequestQueue.h>

List of all members.

Detailed Description

Drawing queue used in MPxSurfaceShapeUI::getDrawRequests.

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.


apiMeshShapeUI.cpp, apiMeshShapeUI.h, apiSimpleShapeUI.cpp, apiSimpleShapeUI.h, and quadricShape.cpp.

Public Member Functions

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

Constructor & Destructor Documentation

MDrawRequestQueue::MDrawRequestQueue (  ) 


MDrawRequestQueue::~MDrawRequestQueue (  ) 


MDrawRequestQueue::MDrawRequestQueue ( const MDrawRequestQueue queue  ) 

Copy Constructor

Member Function Documentation

bool MDrawRequestQueue::isEmpty (  )  const

Returns true if the queu is empty.

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

void MDrawRequestQueue::add ( MDrawRequest request  ) 

Adds a draw request to the draw queue.

[in]  request  the draw request to add

MDrawRequest MDrawRequestQueue::remove (  ) 

Removes a draw request from the draw queue.

The draw request that was removed

MDrawRequestQueue & MDrawRequestQueue::operator= ( const MDrawRequestQueue queue  ) 

Assignment operator

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6