Class: QgsTiledSceneRenderer

Abstract base class for 2d tiled scene renderers.

Added in version 3.34.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: clone(), renderLine(), renderTriangle(), save(), type()

Class Hierarchy

Subclasses

QgsTiledSceneTextureRenderer	Renders tiled scene layers using textures.
QgsTiledSceneWireframeRenderer	Renders tiled scene layers using the raw primitive wireframes.

Abstract Methods

clone	Create a deep copy of this renderer.
renderLine	Renders a line.
renderTriangle	Renders a triangle.
save	Saves the renderer configuration to an XML element.
type	Returns the identifier of the renderer type.

Methods

copyCommonProperties	Copies common tiled scene renderer properties (such as screen error) to the destination renderer.
isTileBorderRenderingEnabled	Returns whether to render also borders of tiles.
maximumScreenError	Returns the maximum screen error allowed when rendering the tiled scene.
maximumScreenErrorUnit	Returns the unit for the maximum screen error allowed when rendering the tiled scene.
restoreCommonProperties	Restores common renderer properties (such as screen error) from the specified DOM element.
saveCommonProperties	Saves common renderer properties (such as point size and screen error) to the specified DOM element.
setMaximumScreenError	Sets the maximum screen error allowed when rendering the tiled scene.
setMaximumScreenErrorUnit	Sets the unit for the maximum screen error allowed when rendering the tiled scene.
setTileBorderRenderingEnabled	Sets whether to render the borders of tiles.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsTiledSceneRenderer. See the FAQ for more details.

createLegendNodes	Creates a set of legend nodes representing the renderer.
flags	Returns flags which control how the renderer behaves.
legendRuleKeys	Returns a list of all rule keys for legend nodes created by the renderer.
startRender	Must be called when a new render cycle is started.
stopRender	Must be called when a render cycle has finished, to allow the renderer to clean up.

Static Methods

load	Creates a renderer from an XML element.

class qgis.core.QgsTiledSceneRenderer

Bases: object

abstract clone(self) → QgsTiledSceneRenderer | None

Create a deep copy of this renderer. Should be implemented by all subclasses and generate a proper subclass.

Return type:

Optional[QgsTiledSceneRenderer]

copyCommonProperties(self, destination: QgsTiledSceneRenderer | None)

Copies common tiled scene renderer properties (such as screen error) to the destination renderer.

Parameters:

destination (Optional[QgsTiledSceneRenderer])

virtual createLegendNodes(self, nodeLayer: QgsLayerTreeLayer | None) → List[QgsLayerTreeModelLegendNode]

Creates a set of legend nodes representing the renderer.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])

Return type:

List[QgsLayerTreeModelLegendNode]

virtual flags(self) → Qgis.TiledSceneRendererFlags

Returns flags which control how the renderer behaves.

Return type:

Qgis.TiledSceneRendererFlags

isTileBorderRenderingEnabled(self) → bool

Returns whether to render also borders of tiles.

see setTileBorderRenderingEnabled()

Return type:

bool

virtual legendRuleKeys(self) → List[str]

Returns a list of all rule keys for legend nodes created by the renderer.

Return type:

List[str]

static load(element: QDomElement, context: QgsReadWriteContext) → QgsTiledSceneRenderer | None

Creates a renderer from an XML element.

Caller takes ownership of the returned renderer.

See also

save()

Parameters:

• element (QDomElement)

• context (QgsReadWriteContext)

Return type:

Optional[QgsTiledSceneRenderer]

maximumScreenError(self) → float

Returns the maximum screen error allowed when rendering the tiled scene.

Larger values result in a faster render with less detailed features rendered.

Units are retrieved via maximumScreenErrorUnit().

See also

setMaximumScreenError()

See also

maximumScreenErrorUnit()

Return type:

float

maximumScreenErrorUnit(self) → Qgis.RenderUnit

Returns the unit for the maximum screen error allowed when rendering the tiled scene.

See also

maximumScreenError()

See also

setMaximumScreenErrorUnit()

Return type:

Qgis.RenderUnit

abstract renderLine(self, context: QgsTiledSceneRenderContext, line: QPolygonF)

Renders a line.

Parameters:

• context (QgsTiledSceneRenderContext)

• line (QPolygonF)

abstract renderTriangle(self, context: QgsTiledSceneRenderContext, triangle: QPolygonF)

Renders a triangle.

Parameters:

• context (QgsTiledSceneRenderContext)

• triangle (QPolygonF)

restoreCommonProperties(self, element: QDomElement, context: QgsReadWriteContext)

Restores common renderer properties (such as screen error) from the specified DOM element.

See also

saveCommonProperties()

Parameters:

• element (QDomElement)

• context (QgsReadWriteContext)

abstract save(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement

Saves the renderer configuration to an XML element.

See also

load()

Parameters:

• doc (QDomDocument)

• context (QgsReadWriteContext)

Return type:

QDomElement

saveCommonProperties(self, element: QDomElement, context: QgsReadWriteContext)

Saves common renderer properties (such as point size and screen error) to the specified DOM element.

See also

restoreCommonProperties()

Parameters:

• element (QDomElement)

• context (QgsReadWriteContext)

setMaximumScreenError(self, error: float)

Sets the maximum screen error allowed when rendering the tiled scene.

Larger values result in a faster render with less detailed features rendered.

Units are set via setMaximumScreenErrorUnit().

See also

maximumScreenError()

See also

setMaximumScreenErrorUnit()

Parameters:

error (float)

setMaximumScreenErrorUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the maximum screen error allowed when rendering the tiled scene.

See also

setMaximumScreenError()

See also

maximumScreenErrorUnit()

Parameters:

unit (Qgis.RenderUnit)

setTileBorderRenderingEnabled(self, enabled: bool)

Sets whether to render the borders of tiles.

See also

isTileBorderRenderingEnabled()

Parameters:

enabled (bool)

virtual startRender(self, context: QgsTiledSceneRenderContext)

Must be called when a new render cycle is started. A call to startRender() must always be followed by a corresponding call to stopRender() after all features have been rendered.

See also

stopRender()

Warning

This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.

Parameters:

context (QgsTiledSceneRenderContext)

virtual stopRender(self, context: QgsTiledSceneRenderContext)

Must be called when a render cycle has finished, to allow the renderer to clean up.

Calls to stopRender() must always be preceded by a call to startRender().

Warning

This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.

See also

startRender()

Parameters:

context (QgsTiledSceneRenderContext)

abstract type(self) → str

Returns the identifier of the renderer type.

Return type:

str