QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
|
The QgsLabelingEngine class provides map labeling functionality. More...
#include <qgslabelingengine.h>
Public Member Functions | |
QgsLabelingEngine () | |
Construct the labeling engine with default settings. More... | |
QgsLabelingEngine (const QgsLabelingEngine &rh)=delete | |
QgsLabelingEngine cannot be copied. More... | |
virtual | ~QgsLabelingEngine () |
Clean up everything (especially the registered providers) More... | |
void | addProvider (QgsAbstractLabelProvider *provider) |
Add provider of label features. Takes ownership of the provider. More... | |
const QgsLabelingEngineSettings & | engineSettings () const |
Gets associated labeling engine settings. More... | |
const QgsMapSettings & | mapSettings () const |
Gets associated map settings. More... | |
QgsLabelingEngine & | operator= (const QgsLabelingEngine &rh)=delete |
QgsLabelingEngine cannot be copied. More... | |
QStringList | participatingLayerIds () const |
Returns a list of layer IDs for layers with providers in the engine. More... | |
QList< QgsMapLayer * > | participatingLayers () const |
Returns a list of layers with providers in the engine. More... | |
void | removeProvider (QgsAbstractLabelProvider *provider) |
Remove provider if the provider's initialization failed. Provider instance is deleted. More... | |
QgsLabelingResults * | results () const |
For internal use by the providers. More... | |
virtual void | run (QgsRenderContext &context)=0 |
Runs the labeling job. More... | |
void | setMapSettings (const QgsMapSettings &mapSettings) |
Associate map settings instance. More... | |
QgsLabelingResults * | takeResults () |
Returns pointer to recently computed results and pass the ownership of results to the caller. More... | |
Protected Member Functions | |
void | cleanup () |
Cleans up the engine following a call to registerLabels() or solve(). More... | |
void | drawLabels (QgsRenderContext &context, const QString &layerId=QString()) |
Draws labels to the specified render context. More... | |
void | processProvider (QgsAbstractLabelProvider *provider, QgsRenderContext &context, pal::Pal &p) |
void | registerLabels (QgsRenderContext &context) |
Runs the label registration step. More... | |
void | solve (QgsRenderContext &context) |
Solves the label problem. More... | |
Protected Attributes | |
QList< pal::LabelPosition * > | mLabels |
QgsMapSettings | mMapSettings |
Associated map settings instance. More... | |
std::unique_ptr< pal::Pal > | mPal |
std::unique_ptr< pal::Problem > | mProblem |
QList< QgsAbstractLabelProvider * > | mProviders |
List of providers (the are owned by the labeling engine) More... | |
std::unique_ptr< QgsLabelingResults > | mResults |
Resulting labeling layout. More... | |
QList< QgsAbstractLabelProvider * > | mSubProviders |
QList< pal::LabelPosition * > | mUnlabeled |
The QgsLabelingEngine class provides map labeling functionality.
The input for the engine is a list of label provider objects and map settings. Based on the input, the engine computes layout of labels for the given map view with no collisions between the labels. Drawing of resulting labels is done again by label providers.
The labeling engine is used for the map rendering in QgsMapRendererJob instances, individual map layer renderers may add label providers - for example, QgsVectorLayerRenderer may add text label provider and diagram provider (if labeling / diagrams were configured for such vector layer).
The labeling engine may also be used independently from map rendering loop:
Definition at line 342 of file qgslabelingengine.h.
QgsLabelingEngine::QgsLabelingEngine | ( | ) |
Construct the labeling engine with default settings.
Definition at line 84 of file qgslabelingengine.cpp.
|
virtual |
Clean up everything (especially the registered providers)
Definition at line 88 of file qgslabelingengine.cpp.
|
delete |
QgsLabelingEngine cannot be copied.
void QgsLabelingEngine::addProvider | ( | QgsAbstractLabelProvider * | provider | ) |
Add provider of label features. Takes ownership of the provider.
Definition at line 194 of file qgslabelingengine.cpp.
|
protected |
Cleans up the engine following a call to registerLabels() or solve().
Definition at line 544 of file qgslabelingengine.cpp.
|
protected |
Draws labels to the specified render context.
If layerId is specified, only labels from the matching layer will be rendered.
Must be preceded by a call to registerLabels() and solve()
Definition at line 415 of file qgslabelingengine.cpp.
|
inline |
Gets associated labeling engine settings.
Definition at line 361 of file qgslabelingengine.h.
|
inline |
Gets associated map settings.
Definition at line 358 of file qgslabelingengine.h.
|
delete |
QgsLabelingEngine cannot be copied.
QStringList QgsLabelingEngine::participatingLayerIds | ( | ) | const |
Returns a list of layer IDs for layers with providers in the engine.
Definition at line 148 of file qgslabelingengine.cpp.
QList< QgsMapLayer * > QgsLabelingEngine::participatingLayers | ( | ) | const |
Returns a list of layers with providers in the engine.
Definition at line 102 of file qgslabelingengine.cpp.
|
protected |
Definition at line 209 of file qgslabelingengine.cpp.
|
protected |
Runs the label registration step.
Must be called by subclasses prior to solve() and drawLabels()
Definition at line 258 of file qgslabelingengine.cpp.
void QgsLabelingEngine::removeProvider | ( | QgsAbstractLabelProvider * | provider | ) |
Remove provider if the provider's initialization failed. Provider instance is deleted.
Definition at line 200 of file qgslabelingengine.cpp.
|
inline |
For internal use by the providers.
Definition at line 394 of file qgslabelingengine.h.
|
pure virtual |
Runs the labeling job.
Depending on the concrete labeling engine class, this will either run the whole labeling job, including rendering the labels themselves, OR possibly just run the labeling job but leave the rendering to a future, deferred stage.
Implemented in QgsDefaultLabelingEngine, and QgsStagedRenderLabelingEngine.
void QgsLabelingEngine::setMapSettings | ( | const QgsMapSettings & | mapSettings | ) |
Associate map settings instance.
Definition at line 94 of file qgslabelingengine.cpp.
|
protected |
Solves the label problem.
Must be called by subclasses prior to drawLabels(), and must be preceded by a call to registerLabels()
Definition at line 299 of file qgslabelingengine.cpp.
QgsLabelingResults * QgsLabelingEngine::takeResults | ( | ) |
Returns pointer to recently computed results and pass the ownership of results to the caller.
Definition at line 552 of file qgslabelingengine.cpp.
|
protected |
Definition at line 450 of file qgslabelingengine.h.
|
protected |
Associated map settings instance.
Definition at line 438 of file qgslabelingengine.h.
|
protected |
Definition at line 447 of file qgslabelingengine.h.
|
protected |
Definition at line 448 of file qgslabelingengine.h.
|
protected |
List of providers (the are owned by the labeling engine)
Definition at line 441 of file qgslabelingengine.h.
|
protected |
Resulting labeling layout.
Definition at line 445 of file qgslabelingengine.h.
|
protected |
Definition at line 442 of file qgslabelingengine.h.
|
protected |
Definition at line 449 of file qgslabelingengine.h.