OpenMayaUI.MDrawRequest Class Reference

Class Description

This class encapsulates all the information needed to fulfill a request to draw an object or part of an object.
This class is used by the draw methods of MPxSurfaceShapeUI derived objects.
+ Inheritance diagram for OpenMayaUI.MDrawRequest:

Public Member Functions

__init__ ()
 
planeColor ()
 
setPlaneColor ()
 

Properties

 color
 
 component
 
 displayCullOpposite
 
 displayCulling
 
 displayStatus
 
 displayStyle
 
 drawData
 
 drawLast
 
 isTransparent
 
 material
 
 matrix
 
 multiPath
 
 token
 
 view
 

Constructor & Destructor Documentation

OpenMayaUI.MDrawRequest.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMayaUI.MDrawRequest.planeColor ( )
planeColor(table) -> int

Get which color is used for the specified color table.

* table (int) - color table

See M3dView.colorAtIndex() for a list of color tables.
OpenMayaUI.MDrawRequest.setPlaneColor ( )
setPlaneColor(value, table) -> self

Set which color to use for the specified color table.

* value (int) - index into the color table
* table (int) - color table

See M3dView.colorAtIndex() for a list of color tables.

Property Documentation

OpenMayaUI.MDrawRequest.color
static
 The RGBA wireframe display color.
OpenMayaUI.MDrawRequest.component
static
 An optional component. If set draw the components that are specified, otherwise draw all components of this type for the object.
OpenMayaUI.MDrawRequest.displayCulling
static
 The state of the culling flag for the object.
OpenMayaUI.MDrawRequest.displayCullOpposite
static
 The state of the opposite culling flag for the object.
OpenMayaUI.MDrawRequest.displayStatus
static
 The state of object (active, dormant, etc.).
 See M3dView.displayStatus() for a list of display status.
OpenMayaUI.MDrawRequest.displayStyle
static
 How the object should be drawn (wireframe, shaded, etc.).
 See M3dView.displayStyle() for a list of display styles.
OpenMayaUI.MDrawRequest.drawData
static
 The object specific draw data.
OpenMayaUI.MDrawRequest.drawLast
static
 The order in which this object will be drawn.
OpenMayaUI.MDrawRequest.isTransparent
static
 The transparency state of the object.
OpenMayaUI.MDrawRequest.material
static
 The shaded material.
OpenMayaUI.MDrawRequest.matrix
static
 The draw matrix.
OpenMayaUI.MDrawRequest.multiPath
static
 The path to the object to be drawn.
OpenMayaUI.MDrawRequest.token
static
 The user-defined draw token for this request.
 The token is used to identify a particular part of an object to draw. It is also used to distinguish draw requests generated by derived UI objects from those generated by base classes.
 It some cases, it provides a way of indicating that a component should be displayed without creating a component MObject.
OpenMayaUI.MDrawRequest.view
static
 The view where drawing will be done.