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__ (self, parent=None)
 
str name (self)
 
None addDisplayComponent (self, str name, Union[str, QUrl] source)
 Add a QML component that is provided by this View. More...
 
QUrl getDisplayComponent (self, str name)
 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...
 
None setRenderer (self, Renderer renderer)
 Set the renderer object to use with this View. More...
 
None beginRendering (self)
 Begin the rendering process. More...
 
None endRendering (self)
 Perform any steps needed when ending the rendering process. More...
 
def event (self, event)
 Handle an event. More...
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
None __init__ (self)
 
str getPluginId (self)
 
None setPluginId (self, str plugin_id)
 
None setVersion (self, str version)
 
str getVersion (self)
 

Static Public Attributes

 str
 
 constant
 

Detailed Description

Abstract base class for view objects.

Member Function Documentation

◆ addDisplayComponent()

None UM.View.View.View.addDisplayComponent (   self,
str  name,
Union[str, QUrl]  source 
)

Add a QML component that is provided by this View.

◆ beginRendering()

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

Begin the rendering process.

This should queue all the meshes that should be rendered.

◆ endRendering()

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

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.

◆ event()

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

Handle an event.

Parameters
eventEvent The event to handle.
See also
Event

◆ getController()

def UM.View.View.View.getController (   self)

Get the controller object associated with this View.

See also
Controller

◆ getDisplayComponent()

QUrl UM.View.View.View.getDisplayComponent (   self,
str  name 
)

Get a QUrl by name.

◆ getRenderer()

def UM.View.View.View.getRenderer (   self)

Get the Renderer instance for this View.

◆ setRenderer()

None UM.View.View.View.setRenderer (   self,
Renderer  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: