QGIS API Documentation 3.29.0-Master (006c3c0232)
qgstextlabelfeature.h
Go to the documentation of this file.
1/***************************************************************************
2 qgstextlabelfeature.h
3 ---------------------
4 begin : December 2015
5 copyright : (C) 2015 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSTEXTLABELFEATURE_H
16#define QGSTEXTLABELFEATURE_H
17
18#define SIP_NO_FILE
19
20#include "qgslabelfeature.h"
21#include "qgstextdocument.h"
22#include "qgstextmetrics.h"
24#include "qgspallabeling.h"
25#include <optional>
26
28
35class CORE_EXPORT QgsTextLabelFeature : public QgsLabelFeature
36{
37 public:
39 QgsTextLabelFeature( QgsFeatureId id, geos::unique_ptr geometry, QSizeF size );
40
43
50 QString text( int partId ) const;
51
60 QgsTextCharacterFormat characterFormat( int partId ) const;
61
67 bool hasCharacterFormat( int partId ) const;
68
70 const QMap< QgsPalLayerSettings::Property, QVariant > &dataDefinedValues() const { return mDataDefinedValues; }
72 void setDataDefinedValues( const QMap< QgsPalLayerSettings::Property, QVariant > &values ) { mDataDefinedValues = values; }
73
75 void setDefinedFont( const QFont &f ) { mDefinedFont = f; }
77 QFont definedFont() const { return mDefinedFont; }
78
87 const QgsPrecalculatedTextMetrics *textMetrics() const { return mTextMetrics.has_value() ? &mTextMetrics.value() : nullptr; }
88
95 void setTextMetrics( const QgsPrecalculatedTextMetrics &metrics ) { mTextMetrics = metrics; }
96
102 static QgsPrecalculatedTextMetrics calculateTextMetrics( const QgsMapToPixel *xform, const QgsRenderContext &context, const QFont &baseFont, const QFontMetricsF &fontMetrics, double letterSpacing,
103 double wordSpacing, const QString &text = QString(), QgsTextDocument *document = nullptr, QgsTextDocumentMetrics *metrics = nullptr );
104
110 QgsTextDocument document() const;
111
118 QgsTextDocumentMetrics documentMetrics() const;
119
126 void setDocument( const QgsTextDocument &document, const QgsTextDocumentMetrics &metrics );
127
134 void setMaximumCharacterAngleInside( double angle ) { mMaximumCharacterAngleInside = angle; }
135
142 double maximumCharacterAngleInside() const { return mMaximumCharacterAngleInside; }
143
150 void setMaximumCharacterAngleOutside( double angle ) { mMaximumCharacterAngleOutside = angle; }
151
158 double maximumCharacterAngleOutside() const { return mMaximumCharacterAngleOutside; }
159
160 protected:
161
164
166 QMap< QgsPalLayerSettings::Property, QVariant > mDataDefinedValues;
167
170
171 double mMaximumCharacterAngleInside = 0;
172 double mMaximumCharacterAngleOutside = 0;
173
174 std::optional< QgsPrecalculatedTextMetrics > mTextMetrics;
175
176};
177
178#endif //QGSTEXTLABELFEATURE_H
The QgsLabelFeature class describes a feature that should be used within the labeling engine.
Perform transforms between map coordinates and device coordinates.
Definition: qgsmaptopixel.h:39
Contains precalculated properties regarding text metrics for text to be renderered at a later stage.
Contains information about the context of a rendering operation.
Stores information relating to individual character formatting.
Contains pre-calculated metrics of a QgsTextDocument.
Represents a document consisting of one or more QgsTextBlock objects.
Class that adds extra information to QgsLabelFeature for text labels.
const QgsPrecalculatedTextMetrics * textMetrics() const
Returns additional info required for curved label placement.
void setMaximumCharacterAngleInside(double angle)
Sets the maximum angle (in radians) between inside curved label characters.
double maximumCharacterAngleInside() const
Returns the maximum angle (in radians) between inside curved label characters.
void setDefinedFont(const QFont &f)
Sets font to be used for rendering.
QFont definedFont() const
Font to be used for rendering.
void setTextMetrics(const QgsPrecalculatedTextMetrics &metrics)
Sets additional text metrics required for curved label placement.
QgsTextDocument mDocument
~QgsTextLabelFeature() override
Clean up.
void setMaximumCharacterAngleOutside(double angle)
Sets the maximum angle (in radians) between outside curved label characters.
void setDataDefinedValues(const QMap< QgsPalLayerSettings::Property, QVariant > &values)
Sets data-defined values.
QFont mDefinedFont
Font for rendering.
QgsTextDocumentMetrics mDocumentMetrics
QMap< QgsPalLayerSettings::Property, QVariant > mDataDefinedValues
Stores attribute values for data defined properties.
const QMap< QgsPalLayerSettings::Property, QVariant > & dataDefinedValues() const
Gets data-defined values.
double maximumCharacterAngleOutside() const
Returns the maximum angle (in radians) between outside curved label characters.
std::optional< QgsPrecalculatedTextMetrics > mTextMetrics
double ANALYSIS_EXPORT angle(QgsPoint *p1, QgsPoint *p2, QgsPoint *p3, QgsPoint *p4)
Calculates the angle between two segments (in 2 dimension, z-values are ignored)
Definition: MathUtils.cpp:786
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
Definition: qgsgeos.h:74
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28