Uranium
Application Framework
UM.View.View.View Class Reference

Abstract base class for view objects. More...

Inheritance diagram for UM.View.View.View:
UM.PluginObject.PluginObject

Public Member Functions

def __init__
 
def name (self)
 
def addDisplayComponent
 Add a QML component that is provided by this View. More...
 
def getDisplayComponent
 Get a QUrl by name. More...
 
def getController (self)
 Get the controller object associated with this View. More...
 
def getRenderer (self)
 Get the Renderer instance for this View. More...
 
def setRenderer
 Set the renderer object to use with this View. More...
 
def beginRendering (self)
 Begin the rendering process. More...
 
def endRendering (self)
 Perform any steps needed when ending the rendering process. More...
 
def event
 Handle an event. More...
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def __init__ (self, args, kwags)
 
def getId (self)
 
def setPluginId
 
def setMetaData
 
def getMetaData (self)
 
def getPluginId (self)
 
def setVersion
 
def getVersion (self)
 

Detailed Description

Abstract base class for view objects.

Member Function Documentation

def UM.View.View.View.addDisplayComponent (   self,
  name 
)

Add a QML component that is provided by this View.

def UM.View.View.View.beginRendering (   self,
  None 
)

Begin the rendering process.

This should queue all the meshes that should be rendered.

def UM.View.View.View.endRendering (   self,
  None 
)

Perform any steps needed when ending the rendering process.

If there is any cleanup or other tasks that need to be performed after rendering this method should be used.

def UM.View.View.View.event (   self,
  event 
)

Handle an event.

Parameters
eventEvent The event to handle.
See also
Event
def UM.View.View.View.getController (   self,
  Controller 
)

Get the controller object associated with this View.

See also
Controller
def UM.View.View.View.getDisplayComponent (   self,
  name 
)

Get a QUrl by name.

def UM.View.View.View.getRenderer (   self,
  Optional,
  Renderer 
)

Get the Renderer instance for this View.

def UM.View.View.View.setRenderer (   self,
  renderer 
)

Set the renderer object to use with this View.

Parameters
rendererRenderer The renderer to use.

The documentation for this class was generated from the following file: