QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
QgsTiledSceneRendererRegistry Class Reference

Registry of 2D renderers for tiled scenes. More...

#include <qgstiledscenerendererregistry.h>

Public Member Functions

 QgsTiledSceneRendererRegistry ()
 
 QgsTiledSceneRendererRegistry (const QgsTiledSceneRendererRegistry &rh)=delete
 
 ~QgsTiledSceneRendererRegistry ()
 
bool addRenderer (QgsTiledSceneRendererAbstractMetadata *metadata)
 Adds a renderer to the registry.
 
QgsTiledSceneRendererRegistryoperator= (const QgsTiledSceneRendererRegistry &rh)=delete
 
bool removeRenderer (const QString &rendererName)
 Removes a renderer from registry.
 
QgsTiledSceneRendererAbstractMetadatarendererMetadata (const QString &rendererName)
 Returns the metadata for a specified renderer.
 
QStringList renderersList () const
 Returns a list of available renderers.
 

Static Public Member Functions

static QgsTiledSceneRendererdefaultRenderer (const QgsTiledSceneLayer *layer)
 Returns a new default tiled scene renderer for a specified layer.
 

Detailed Description

Registry of 2D renderers for tiled scenes.

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

Since
QGIS 3.34

Definition at line 181 of file qgstiledscenerendererregistry.h.

Constructor & Destructor Documentation

◆ QgsTiledSceneRendererRegistry() [1/2]

QgsTiledSceneRendererRegistry::QgsTiledSceneRendererRegistry ( )

Definition at line 22 of file qgstiledscenerendererregistry.cpp.

◆ ~QgsTiledSceneRendererRegistry()

QgsTiledSceneRendererRegistry::~QgsTiledSceneRendererRegistry ( )

Definition at line 33 of file qgstiledscenerendererregistry.cpp.

◆ QgsTiledSceneRendererRegistry() [2/2]

QgsTiledSceneRendererRegistry::QgsTiledSceneRendererRegistry ( const QgsTiledSceneRendererRegistry rh)
delete

Member Function Documentation

◆ addRenderer()

bool QgsTiledSceneRendererRegistry::addRenderer ( QgsTiledSceneRendererAbstractMetadata 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 38 of file qgstiledscenerendererregistry.cpp.

◆ defaultRenderer()

QgsTiledSceneRenderer * QgsTiledSceneRendererRegistry::defaultRenderer ( const QgsTiledSceneLayer layer)
static

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

Caller takes ownership of the returned renderer.

Definition at line 76 of file qgstiledscenerendererregistry.cpp.

◆ operator=()

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

◆ removeRenderer()

bool QgsTiledSceneRendererRegistry::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 48 of file qgstiledscenerendererregistry.cpp.

◆ rendererMetadata()

QgsTiledSceneRendererAbstractMetadata * QgsTiledSceneRendererRegistry::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 59 of file qgstiledscenerendererregistry.cpp.

◆ renderersList()

QStringList QgsTiledSceneRendererRegistry::renderersList ( ) const

Returns a list of available renderers.

Definition at line 64 of file qgstiledscenerendererregistry.cpp.


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