OpenMayaRender.MHUDRender Class Reference

Inheritance diagram for OpenMayaRender.MHUDRender:

Public Member Functions
def	__init__ ()
def	addUIDrawables ()
def	hasUIDrawables ()
def	name ()
Public Member Functions inherited from OpenMayaRender.MRenderOperation
def	__init__ ()
def	enableSRGBWrite ()
def	name ()
def	operationType ()
def	targetOverrideList ()
def	viewportRectangleOverride ()

Static Public Member Functions
def	__new__ ()
Static Public Member Functions inherited from OpenMayaRender.MRenderOperation
def	__new__ ()

Additional Inherited Members
Static Public Attributes inherited from OpenMayaRender.MRenderOperation
int	kClear = 0
int	kHUDRender = 4
int	kPresentTarget = 5
int	kQuadRender = 2
int	kSceneRender = 1
int	kUserDefined = 3

Detailed Description

Class which defines rendering the 2D heads-up-display.

Method resolution order:
-   MHUDRender
-   MRenderOperation
-   builtins.object

Constructor & Destructor Documentation

def OpenMayaRender.MHUDRender.__init__

(

)

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

Member Function Documentation

def OpenMayaRender.MHUDRender.__new__ ( )

static

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

def OpenMayaRender.MHUDRender.addUIDrawables

(

)

addUIDrawables(drawManager2D, frameContext) -> self

Provides access to the 2D version of MUIDrawManager, which can be used to queue up operations to draw simple UI shapes like lines, circles, text, etc.

This method will only be called when hasUIDrawables() is overridden to return true.

* drawManager2D (MUIDrawManager) - A UI draw manager which can be used to draw simple 2D geometry, including text. When passing coordinates to the draw manager's methods, only X and Y have meaning. The origin (0, 0) is in the lower-left corner of the view.
* frameContext (MFrameContext) - Frame level context information.

def OpenMayaRender.MHUDRender.hasUIDrawables

(

)

hasUIDrawables() -> bool

Query whether addUIDrawables() should be called or not.

def OpenMayaRender.MHUDRender.name

(

)

name() -> string

Returns the unique name for a hud render operation.
Note that all HUD operations share the same name since they need not be distinguished from one another.