Class: QgsTiledSceneRendererRegistry

class qgis.core.QgsTiledSceneRendererRegistry

Bases: sip.wrapper

Registry of 2D renderers for tiled scenes.

QgsTiledSceneRendererRegistry is not usually directly created, but rather accessed through QgsApplication.tiledSceneRendererRegistry().

Added in version 3.34:

Methods

addRenderer

Adds a renderer to the registry.

defaultRenderer

Returns a new default tiled scene renderer for a specified layer.

removeRenderer

Removes a renderer from registry.

rendererMetadata

Returns the metadata for a specified renderer.

renderersList

Returns a list of available renderers.

addRenderer(self, metadata: QgsTiledSceneRendererAbstractMetadata) bool

Adds a renderer to the registry. Takes ownership of the metadata object.

Parameters:

metadata (QgsTiledSceneRendererAbstractMetadata) – renderer metadata

Return type:

bool

Returns:

True if renderer was added successfully, or False if renderer could not be added (e.g., a renderer with a duplicate name already exists)

defaultRenderer(layer: QgsTiledSceneLayer) QgsTiledSceneRenderer

Returns a new default tiled scene renderer for a specified layer.

Caller takes ownership of the returned renderer.

Parameters:

layer (QgsTiledSceneLayer)

Return type:

QgsTiledSceneRenderer

removeRenderer(self, rendererName: str) bool

Removes a renderer from registry.

Parameters:

rendererName (str) – name of renderer to remove from registry

Return type:

bool

Returns:

True if renderer was successfully removed, or False if matching renderer could not be found

rendererMetadata(self, rendererName: str) QgsTiledSceneRendererAbstractMetadata

Returns the metadata for a specified renderer. Returns None if a matching renderer was not found in the registry.

Parameters:

rendererName (str)

Return type:

QgsTiledSceneRendererAbstractMetadata

renderersList(self) List[str]

Returns a list of available renderers.

Return type:

List[str]