Class: QgsPointCloudRendererRegistry¶
- class qgis.core.QgsPointCloudRendererRegistry¶
Bases:
sip.wrapper
Registry of 2D renderers for point clouds.
QgsPointCloudRendererRegistry
is not usually directly created, but rather accessed throughQgsApplication.pointCloudRendererRegistry()
.New in version 3.18:
Methods
Adds a renderer to the registry.
Returns a new default point cloud renderer for a layer with the specified
provider
.Removes a renderer from registry.
Returns the metadata for a specified renderer.
Returns a list of available renderers.
- addRenderer(self, metadata: QgsPointCloudRendererAbstractMetadata) bool ¶
Adds a renderer to the registry. Takes ownership of the metadata object.
- Parameters
metadata (QgsPointCloudRendererAbstractMetadata) – 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(provider: QgsPointCloudDataProvider) QgsPointCloudRenderer ¶
Returns a new default point cloud renderer for a layer with the specified
provider
.Caller takes ownership of the returned renderer.
- Parameters
provider (QgsPointCloudDataProvider) –
- Return type
- 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, orFalse
if matching renderer could not be found
- rendererMetadata(self, rendererName: str) QgsPointCloudRendererAbstractMetadata ¶
Returns the metadata for a specified renderer. Returns
None
if a matching renderer was not found in the registry.- Parameters
rendererName (str) –
- Return type
- renderersList(self) List[str] ¶
Returns a list of available renderers.
- Return type
List[str]