QRendererGui¶

class QRendererGui(gui, design: QDesign, initiate=True, fig=None, ax=None)[source]¶

Abstract base class for the GUI rendering.

Extends QRenderer. An interface class.

Parameters:

gui (MetalGUI) – the GUI.
design (QDesign) – The design.
initiate (bool) – True to initiate the renderer. Defaults to True.
fig (figure) – current figure. Defaults to None.
ax (ax) – current ax. Defaults to None.

Attributes

`QRendererGui.design`	Return a reference to the parent design object.
`QRendererGui.element_extensions`	Element extensions dictionary
`QRendererGui.element_table_data`	Element table data.
`QRendererGui.logger`	Returns the logger.
`QRendererGui.name`	Name
`QRendererGui.options`	Options for the QRenderer.

Methods

`QRendererGui.add_table_data_to_QDesign`(...)	During init of renderer, this needs to happen.
`QRendererGui.clear_axis`()	Clear the axis.
`QRendererGui.clear_figure`()	Clear the figure.
`QRendererGui.get_renderer`(name)	Returns an already loaded and instantiated renderer.
`QRendererGui.get_template_options`(design[, ...])	Creates template options for the Metal QRenderer class required for the class to function, based on the design template; i.e., be created, made, and rendered.
`QRendererGui.get_unique_component_ids`([...])	Confirm the list doesn't have names of components repeated.
`QRendererGui.load`()	Load the renderer and register all its extensions.
`QRendererGui.parse_value`(value)	Same as design.parse_value.
`QRendererGui.populate_element_extensions`()	Populate cls.element_extensions which will be used to create columns for tables in QGeometry tables.
`QRendererGui.render_component`(component)	Render the given component.
`QRendererGui.render_connectors`()	Render connectors.
`QRendererGui.render_design`([selection])	Render the design.
`QRendererGui.render_shapely`()	Render shapely.
`QRendererGui.set_ax`(ax)	Set the given ax.
`QRendererGui.set_fig`(fig)	Set the given figure.
`QRendererGui.setup_fig`(fig)	Setup the given figure.
`QRendererGui.start`([force])	Call any initialization (single run) step required to setup the renderer for the first execution, such as connecting to some API or COM, or importing the correct material libraries, etc.
`QRendererGui.stop`()	Any calls that one may want to make after a rendering is complete.
`QRendererGui.style_axis`(ax)	Style the axis.
`QRendererGui.update_options`([...])	If template options has not been set for this renderer, then gather all the default options for children and add to design.