QGIS API Documentation 3.43.0-Master (c67cf405802)
qgsmeshlayerlabelprovider.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmeshlayerlabelprovider.h
3 ---------------------
4 begin : November 2023
5 copyright : (C) 2023 by Alexander Bruy
6 email : alexander dot bruy at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSMESHLAYERLABELPROVIDER_H
19#define QGSMESHLAYERLABELPROVIDER_H
20
21#define SIP_NO_FILE
22
23#include "qgis_core.h"
24#include "qgslabelingengine.h"
25#include "qgsrenderer.h"
26#include "qgspallabeling.h"
27
28class QgsMeshLayer;
29
42{
43 public:
44
47 const QString &providerId,
48 const QgsPalLayerSettings *settings,
49 const QString &layerName = QString(),
50 bool labelFaces = false );
51
53
54 QList<QgsLabelFeature *> labelFeatures( QgsRenderContext &context ) override;
55
56 //void drawLabelBackground( QgsRenderContext &context, pal::LabelPosition *label ) const override;
57 void drawLabel( QgsRenderContext &context, pal::LabelPosition *label ) const override;
58 //void drawUnplacedLabel( QgsRenderContext &context, pal::LabelPosition *label ) const override;
59 void startRender( QgsRenderContext &context ) override;
60 void stopRender( QgsRenderContext &context ) override;
61
68 virtual bool prepare( QgsRenderContext &context, QSet<QString> &attributeNames );
69
84 virtual QList< QgsLabelFeature * > registerFeature( const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry = QgsGeometry(), const QgsSymbol *symbol = nullptr );
85
89 const QgsPalLayerSettings &settings() const;
90
92 bool labelFaces() const { return mLabelFaces; }
93
94 protected:
96 void init();
98 void drawLabelPrivate( pal::LabelPosition *label, QgsRenderContext &context, QgsPalLayerSettings &tmpLyr, Qgis::TextComponent drawType, double dpiRatio = 1.0 ) const;
99
100 protected:
103
104 bool mLabelFaces = false;
105
108
110 QList<QgsLabelFeature *> mLabels;
111
112 private:
113 std::unique_ptr<QgsVectorLayerLabelProvider> mVectorLabelProvider;
114
115 friend class TestQgsLabelingEngine;
116};
117
118#endif // QGSMESHLAYERLABELPROVIDER_H
TextComponent
Text components.
Definition qgis.h:2833
An abstract interface class for label providers.
virtual QList< QgsLabelFeature * > labelFeatures(QgsRenderContext &context)=0
Returns list of label features (they are owned by the provider and thus deleted on its destruction)
virtual void stopRender(QgsRenderContext &context)
To be called after rendering is complete.
virtual void drawLabel(QgsRenderContext &context, pal::LabelPosition *label) const =0
Draw this label at the position determined by the labeling engine.
virtual void startRender(QgsRenderContext &context)
To be called before rendering of labels begins.
Represents a coordinate reference system (CRS).
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
A geometry is the spatial representation of a feature.
Implements a label provider for mesh layers.
QgsCoordinateReferenceSystem mCrs
Layer's CRS.
bool labelFaces() const
Returns false if labeling mesh vertices, true if labeling mesh faces.
void drawLabelPrivate(pal::LabelPosition *label, QgsRenderContext &context, QgsPalLayerSettings &tmpLyr, Qgis::TextComponent drawType, double dpiRatio=1.0) const
Internal label drawing method.
QList< QgsLabelFeature * > mLabels
List of generated.
QgsPalLayerSettings mSettings
Layer's labeling configuration.
Represents a mesh layer supporting display of data on structured or unstructured meshes.
Contains settings for how a map layer will be labeled.
Contains information about the context of a rendering operation.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231
LabelPosition is a candidate feature label position.