OpenMayaUI.MDrawRequest Class Reference

Inheritance diagram for OpenMayaUI.MDrawRequest:

Public Member Functions
def	__init__ ()
def	planeColor ()
def	setPlaneColor ()

Static Public Member Functions
def	__new__ ()

Properties
	color = property(...)
	component = property(...)
	displayCullOpposite = property(...)
	displayCulling = property(...)
	displayStatus = property(...)
	displayStyle = property(...)
	drawData = property(...)
	drawLast = property(...)
	isTransparent = property(...)
	material = property(...)
	matrix = property(...)
	multiPath = property(...)
	token = property(...)
	view = property(...)

Detailed 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.

Constructor & Destructor Documentation

def OpenMayaUI.MDrawRequest.__init__

(

)

Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaUI.MDrawRequest.__new__ ( )

static

Create and return a new object.  See help(type) for accurate signature.

def 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.

def 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 = property(...)

static

 The RGBA wireframe display color.

OpenMayaUI.MDrawRequest.component = property(...)

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 = property(...)

static

 The state of the culling flag for the object.

OpenMayaUI.MDrawRequest.displayCullOpposite = property(...)

static

 The state of the opposite culling flag for the object.

OpenMayaUI.MDrawRequest.displayStatus = property(...)

static

 The state of object (active, dormant, etc.).
 See M3dView.displayStatus() for a list of display status.

OpenMayaUI.MDrawRequest.displayStyle = property(...)

static

 How the object should be drawn (wireframe, shaded, etc.).
 See M3dView.displayStyle() for a list of display styles.

OpenMayaUI.MDrawRequest.drawData = property(...)

static

 The object specific draw data.

OpenMayaUI.MDrawRequest.drawLast = property(...)

static

 The order in which this object will be drawn.

OpenMayaUI.MDrawRequest.isTransparent = property(...)

static

 The transparency state of the object.

OpenMayaUI.MDrawRequest.material = property(...)

static

 The shaded material.

OpenMayaUI.MDrawRequest.matrix = property(...)

static

 The draw matrix.

OpenMayaUI.MDrawRequest.multiPath = property(...)

static

 The path to the object to be drawn.

OpenMayaUI.MDrawRequest.token = property(...)

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 = property(...)

static

 The view where drawing will be done.