QGIS API Documentation  3.27.0-Master (bef583a8ef)
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"
23 #include "qgspallabeling.h"
24 #include <optional>
25 
27 
34 class CORE_EXPORT QgsTextLabelFeature : public QgsLabelFeature
35 {
36  public:
38  QgsTextLabelFeature( QgsFeatureId id, geos::unique_ptr geometry, QSizeF size );
39 
42 
49  QString text( int partId ) const;
50 
59  QgsTextCharacterFormat characterFormat( int partId ) const;
60 
66  bool hasCharacterFormat( int partId ) const;
67 
69  const QMap< QgsPalLayerSettings::Property, QVariant > &dataDefinedValues() const { return mDataDefinedValues; }
71  void setDataDefinedValues( const QMap< QgsPalLayerSettings::Property, QVariant > &values ) { mDataDefinedValues = values; }
72 
74  void setDefinedFont( const QFont &f ) { mDefinedFont = f; }
76  QFont definedFont() const { return mDefinedFont; }
77 
83  QFontMetricsF *labelFontMetrics() { return mFontMetrics.has_value() ? &mFontMetrics.value() : nullptr; }
84 
88  void setFontMetrics( const QFontMetricsF &metrics );
89 
98  const QgsPrecalculatedTextMetrics *textMetrics() const { return mTextMetrics.has_value() ? &mTextMetrics.value() : nullptr; }
99 
106  void setTextMetrics( const QgsPrecalculatedTextMetrics &metrics ) { mTextMetrics = metrics; }
107 
113  static QgsPrecalculatedTextMetrics calculateTextMetrics( const QgsMapToPixel *xform, const QFontMetricsF &fontMetrics, double letterSpacing,
114  double wordSpacing, const QString &text = QString(), QgsTextDocument *document = nullptr );
115 
121  QgsTextDocument document() const;
122 
128  void setDocument( const QgsTextDocument &document );
129 
136  void setMaximumCharacterAngleInside( double angle ) { mMaximumCharacterAngleInside = angle; }
137 
144  double maximumCharacterAngleInside() const { return mMaximumCharacterAngleInside; }
145 
152  void setMaximumCharacterAngleOutside( double angle ) { mMaximumCharacterAngleOutside = angle; }
153 
160  double maximumCharacterAngleOutside() const { return mMaximumCharacterAngleOutside; }
161 
162  protected:
163 
166 
168  std::optional< QFontMetricsF > mFontMetrics;
169 
171  QMap< QgsPalLayerSettings::Property, QVariant > mDataDefinedValues;
172 
174 
175  double mMaximumCharacterAngleInside = 0;
176  double mMaximumCharacterAngleOutside = 0;
177 
178  std::optional< QgsPrecalculatedTextMetrics > mTextMetrics;
179 
180 };
181 
182 #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.
Stores information relating to individual character formatting.
Represents a document consisting of one or more QgsTextBlock objects.
Class that adds extra information to QgsLabelFeature for text labels.
const QMap< QgsPalLayerSettings::Property, QVariant > & dataDefinedValues() const
Gets data-defined values.
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.
QMap< QgsPalLayerSettings::Property, QVariant > mDataDefinedValues
Stores attribute values for data defined properties.
const QgsPrecalculatedTextMetrics * textMetrics() const
Returns additional info required for curved label placement.
double maximumCharacterAngleOutside() const
Returns the maximum angle (in radians) between outside curved label characters.
std::optional< QFontMetricsF > mFontMetrics
Metrics of the font for rendering.
QFontMetricsF * labelFontMetrics()
Metrics of the font for rendering.
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:79
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28