QGIS API Documentation  3.21.0-Master (909859188c)
Public Member Functions | Static Public Member Functions | List of all members
QgsPointCloudRendererRegistry Class Reference

Registry of 2D renderers for point clouds. More...

#include <qgspointcloudrendererregistry.h>

Public Member Functions

 QgsPointCloudRendererRegistry ()
 
 QgsPointCloudRendererRegistry (const QgsPointCloudRendererRegistry &rh)=delete
 QgsPointCloudRendererRegistry cannot be copied. More...
 
 ~QgsPointCloudRendererRegistry ()
 
bool addRenderer (QgsPointCloudRendererAbstractMetadata *metadata)
 Adds a renderer to the registry. More...
 
QgsPointCloudRendererRegistryoperator= (const QgsPointCloudRendererRegistry &rh)=delete
 QgsPointCloudRendererRegistry cannot be copied. More...
 
bool removeRenderer (const QString &rendererName)
 Removes a renderer from registry. More...
 
QgsPointCloudRendererAbstractMetadatarendererMetadata (const QString &rendererName)
 Returns the metadata for a specified renderer. More...
 
QStringList renderersList () const
 Returns a list of available renderers. More...
 

Static Public Member Functions

static QgsPointCloudRendererdefaultRenderer (const QgsPointCloudDataProvider *provider)
 Returns a new default point cloud renderer for a layer with the specified provider. More...
 

Detailed Description

Registry of 2D renderers for point clouds.

QgsPointCloudRendererRegistry is not usually directly created, but rather accessed through QgsApplication::pointCloudRendererRegistry().

Since
QGIS 3.18

Definition at line 183 of file qgspointcloudrendererregistry.h.

Constructor & Destructor Documentation

◆ QgsPointCloudRendererRegistry() [1/2]

QgsPointCloudRendererRegistry::QgsPointCloudRendererRegistry ( )

Definition at line 25 of file qgspointcloudrendererregistry.cpp.

◆ ~QgsPointCloudRendererRegistry()

QgsPointCloudRendererRegistry::~QgsPointCloudRendererRegistry ( )

Definition at line 42 of file qgspointcloudrendererregistry.cpp.

◆ QgsPointCloudRendererRegistry() [2/2]

QgsPointCloudRendererRegistry::QgsPointCloudRendererRegistry ( const QgsPointCloudRendererRegistry rh)
delete

QgsPointCloudRendererRegistry cannot be copied.

Member Function Documentation

◆ addRenderer()

bool QgsPointCloudRendererRegistry::addRenderer ( QgsPointCloudRendererAbstractMetadata metadata)

Adds a renderer to the registry.

Takes ownership of the metadata object.

Parameters
metadatarenderer metadata
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)

Definition at line 47 of file qgspointcloudrendererregistry.cpp.

◆ defaultRenderer()

QgsPointCloudRenderer * QgsPointCloudRendererRegistry::defaultRenderer ( const QgsPointCloudDataProvider provider)
static

Returns a new default point cloud renderer for a layer with the specified provider.

Caller takes ownership of the returned renderer.

Definition at line 85 of file qgspointcloudrendererregistry.cpp.

◆ operator=()

QgsPointCloudRendererRegistry& QgsPointCloudRendererRegistry::operator= ( const QgsPointCloudRendererRegistry rh)
delete

QgsPointCloudRendererRegistry cannot be copied.

◆ removeRenderer()

bool QgsPointCloudRendererRegistry::removeRenderer ( const QString &  rendererName)

Removes a renderer from registry.

Parameters
rendererNamename of renderer to remove from registry
Returns
true if renderer was successfully removed, or false if matching renderer could not be found

Definition at line 57 of file qgspointcloudrendererregistry.cpp.

◆ rendererMetadata()

QgsPointCloudRendererAbstractMetadata * QgsPointCloudRendererRegistry::rendererMetadata ( const QString &  rendererName)

Returns the metadata for a specified renderer.

Returns nullptr if a matching renderer was not found in the registry.

Definition at line 68 of file qgspointcloudrendererregistry.cpp.

◆ renderersList()

QStringList QgsPointCloudRendererRegistry::renderersList ( ) const

Returns a list of available renderers.

Definition at line 73 of file qgspointcloudrendererregistry.cpp.


The documentation for this class was generated from the following files: