QGIS API Documentation 3.99.0-Master (a5475b57e34)
Loading...
Searching...
No Matches
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
22#include "qgis_core.h"
23#include "qgslabelingengine.h"
24#include "qgspallabeling.h"
25#include "qgsrenderer.h"
26
27#define SIP_NO_FILE
28
29class QgsMeshLayer;
30
43{
44 public:
45
48 const QString &providerId,
50 const QString &layerName = QString(),
51 bool labelFaces = false );
52
54
55 QList<QgsLabelFeature *> labelFeatures( QgsRenderContext &context ) override;
56
57 //void drawLabelBackground( QgsRenderContext &context, pal::LabelPosition *label ) const override;
58 void drawLabel( QgsRenderContext &context, pal::LabelPosition *label ) const override;
59 //void drawUnplacedLabel( QgsRenderContext &context, pal::LabelPosition *label ) const override;
60 void startRender( QgsRenderContext &context ) override;
61 void stopRender( QgsRenderContext &context ) override;
62
69 virtual bool prepare( QgsRenderContext &context, QSet<QString> &attributeNames );
70
85 virtual QList< QgsLabelFeature * > registerFeature( const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry = QgsGeometry(), const QgsSymbol *symbol = nullptr );
86
90 const QgsPalLayerSettings &settings() const;
91
93 bool labelFaces() const { return mLabelFaces; }
94
95 protected:
97 void init();
99 void drawLabelPrivate( pal::LabelPosition *label, QgsRenderContext &context, QgsPalLayerSettings &tmpLyr, Qgis::TextComponent drawType, double dpiRatio = 1.0 ) const;
100
101 protected:
104
105 bool mLabelFaces = false;
106
109
111 QList<QgsLabelFeature *> mLabels;
112
113 private:
114 std::unique_ptr<QgsVectorLayerLabelProvider> mVectorLabelProvider;
115
117};
118
119#endif // QGSMESHLAYERLABELPROVIDER_H
TextComponent
Text components.
Definition qgis.h:2991
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.
QgsMapLayer * layer() const
Returns the associated layer, or nullptr if no layer is associated with the provider.
virtual void startRender(QgsRenderContext &context)
To be called before rendering of labels begins.
QString providerId() const
Returns provider ID - useful in case there is more than one label provider within a layer (e....
QgsAbstractLabelProvider(QgsMapLayer *layer, const QString &providerId=QString())
Construct the provider with default values.
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:60
A geometry is the spatial representation of a feature.
const QgsPalLayerSettings & settings() const
Returns the layer's settings.
QgsCoordinateReferenceSystem mCrs
Layer's CRS.
QgsMeshLayerLabelProvider(QgsMeshLayer *layer, const QString &providerId, const QgsPalLayerSettings *settings, const QString &layerName=QString(), bool labelFaces=false)
Convenience constructor to initialize the provider from given mesh layer.
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.
virtual QList< QgsLabelFeature * > registerFeature(const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry=QgsGeometry(), const QgsSymbol *symbol=nullptr)
Register a feature for labeling as one or more QgsLabelFeature objects stored into mLabels.
QList< QgsLabelFeature * > mLabels
List of generated.
QgsPalLayerSettings mSettings
Layer's labeling configuration.
virtual bool prepare(QgsRenderContext &context, QSet< QString > &attributeNames)
Prepare for registration of features.
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.