Python API 2.0 Reference: OpenMayaRender.MHUDRender Class Reference

+ Inheritance diagram for OpenMayaRender.MHUDRender:

Public Member Functions

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

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
-   __builtin__.object

Constructor & Destructor Documentation

OpenMayaRender.MHUDRender.__init__ ( )
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Member Function Documentation

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.
OpenMayaRender.MHUDRender.hasUIDrawables ( )
hasUIDrawables() -> bool

Query whether addUIDrawables() should be called or not.
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.