Uranium
Application Framework
Loading...
Searching...
No Matches
UM.View.View.View Class Reference
Inheritance diagram for UM.View.View.View:
UM.PluginObject.PluginObject

Public Member Functions

None __init__ (self, parent=None)
 
str name (self)
 
None addDisplayComponent (self, str name, Union[str, QUrl] source)
 
QUrl getDisplayComponent (self, str name)
 
"Controller" getController (self)
 
Optional["Renderer"] getRenderer (self)
 
None setRenderer (self, Renderer renderer)
 
None beginRendering (self)
 
None endRendering (self)
 
bool event (self, "Event" event)
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
str getId (self)
 
None setPluginId (self, str plugin_id)
 
None setMetaData (self, Dict[str, Any] metadata)
 
Dict[str, Any] getMetaData (self)
 
str getPluginId (self)
 
None setVersion (self, str version)
 
str getVersion (self)
 

Protected Attributes

 _renderer
 
 _controller
 
 _components
 
- Protected Attributes inherited from UM.PluginObject.PluginObject
 _plugin_id
 
 _version
 
 _metadata
 
 _name
 

Detailed Description

Abstract base class for view objects.

Constructor & Destructor Documentation

◆ __init__()

None UM.View.View.View.__init__ ( self,
parent = None )

Reimplemented from UM.PluginObject.PluginObject.

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.

◆ getController()

"Controller" UM.View.View.View.getController ( self)
Get the controller object associated with this View.
:sa Controller

◆ getDisplayComponent()

QUrl UM.View.View.View.getDisplayComponent ( self,
str name )
Get a QUrl by name.

◆ getRenderer()

Optional["Renderer"] 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.

:param renderer: :type{Renderer} The renderer to use.

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