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 throughQgsApplication.tiledSceneRendererRegistry()
.Added in version 3.34:
Methods
Adds a renderer to the registry.
Returns a new default tiled scene renderer for a specified
layer
.Removes a renderer from registry.
Returns the metadata for a specified renderer.
Returns a list of available renderers.
- addRenderer(self, metadata: QgsTiledSceneRendererAbstractMetadata | None) bool ¶
Adds a renderer to the registry. Takes ownership of the metadata object.
- Parameters:
metadata (Optional[QgsTiledSceneRendererAbstractMetadata]) – renderer metadata
- Return type:
bool
- Returns:
True
if renderer was added successfully, orFalse
if renderer could not be added (e.g., a renderer with a duplicate name already exists)
- defaultRenderer(layer: QgsTiledSceneLayer | None) QgsTiledSceneRenderer | None ¶
Returns a new default tiled scene renderer for a specified
layer
.Caller takes ownership of the returned renderer.
- Parameters:
layer (Optional[QgsTiledSceneLayer])
- Return type:
Optional[QgsTiledSceneRenderer]
- removeRenderer(self, rendererName: str | None) bool ¶
Removes a renderer from registry.
- Parameters:
rendererName (Optional[str]) – name of renderer to remove from registry
- Return type:
bool
- Returns:
True
if renderer was successfully removed, orFalse
if matching renderer could not be found
- rendererMetadata(self, rendererName: str | None) QgsTiledSceneRendererAbstractMetadata | None ¶
Returns the metadata for a specified renderer. Returns
None
if a matching renderer was not found in the registry.- Parameters:
rendererName (Optional[str])
- Return type:
Optional[QgsTiledSceneRendererAbstractMetadata]
- renderersList(self) List[str] ¶
Returns a list of available renderers.
- Return type:
List[str]