QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
qgslabelingenginesettings.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgslabelingenginesettings.cpp
3 --------------------------------------
4 Date : April 2017
5 Copyright : (C) 2017 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
16#include "qgslabelingenginesettings.h"
17
18#include "qgsproject.h"
19#include "qgssymbollayerutils.h"
20
21QgsLabelingEngineSettings::QgsLabelingEngineSettings()
22{
23}
24
25void QgsLabelingEngineSettings::clear()
26{
27 *this = QgsLabelingEngineSettings();
28}
29
30void QgsLabelingEngineSettings::readSettingsFromProject( QgsProject *prj )
31{
32 bool saved = false;
33 mSearchMethod = static_cast< Search >( prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/SearchMethod" ), static_cast< int >( Chain ), &saved ) );
34 mMaxLineCandidatesPerCm = prj->readDoubleEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesLinePerCM" ), 5, &saved );
35 mMaxPolygonCandidatesPerCmSquared = prj->readDoubleEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesPolygonPerCM" ), 2.5, &saved );
36
37 mFlags = Qgis::LabelingFlags();
38 if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingCandidates" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::DrawCandidates;
39 if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawRectOnly" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::DrawLabelRectOnly;
40 if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingAllLabels" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::UseAllLabels;
41 if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingPartialsLabels" ), true, &saved ) ) mFlags |= Qgis::LabelingFlag::UsePartialCandidates;
42 if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawUnplaced" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::DrawUnplacedLabels;
43 if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawLabelMetrics" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::DrawLabelMetrics;
44
45 mDefaultTextRenderFormat = Qgis::TextRenderFormat::AlwaysOutlines;
46 // if users have disabled the older PAL "DrawOutlineLabels" setting, respect that
47 if ( !prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawOutlineLabels" ), true ) )
48 mDefaultTextRenderFormat = Qgis::TextRenderFormat::AlwaysText;
49 // otherwise, prefer the new setting
50 const int projectTextFormat = prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/TextFormat" ), -1 );
51 if ( projectTextFormat >= 0 )
52 mDefaultTextRenderFormat = static_cast< Qgis::TextRenderFormat >( projectTextFormat );
53
54 mUnplacedLabelColor = QgsSymbolLayerUtils::decodeColor( prj->readEntry( QStringLiteral( "PAL" ), QStringLiteral( "/UnplacedColor" ), QStringLiteral( "#ff0000" ) ) );
55
56 mPlacementVersion = static_cast< Qgis::LabelPlacementEngineVersion >( prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/PlacementEngineVersion" ), static_cast< int >( Qgis::LabelPlacementEngineVersion::Version1 ) ) );
57}
58
59void QgsLabelingEngineSettings::writeSettingsToProject( QgsProject *project )
60{
61 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/SearchMethod" ), static_cast< int >( mSearchMethod ) );
62 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesLinePerCM" ), mMaxLineCandidatesPerCm );
63 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesPolygonPerCM" ), mMaxPolygonCandidatesPerCmSquared );
64
65 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingCandidates" ), mFlags.testFlag( Qgis::LabelingFlag::DrawCandidates ) );
66 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawRectOnly" ), mFlags.testFlag( Qgis::LabelingFlag::DrawLabelRectOnly ) );
67 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawUnplaced" ), mFlags.testFlag( Qgis::LabelingFlag::DrawUnplacedLabels ) );
68 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingAllLabels" ), mFlags.testFlag( Qgis::LabelingFlag::UseAllLabels ) );
69 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingPartialsLabels" ), mFlags.testFlag( Qgis::LabelingFlag::UsePartialCandidates ) );
70 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawLabelMetrics" ), mFlags.testFlag( Qgis::LabelingFlag::DrawLabelMetrics ) );
71
72 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/TextFormat" ), static_cast< int >( mDefaultTextRenderFormat ) );
73
74 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/UnplacedColor" ), QgsSymbolLayerUtils::encodeColor( mUnplacedLabelColor ) );
75
76 project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/PlacementEngineVersion" ), static_cast< int >( mPlacementVersion ) );
77}
78
79QColor QgsLabelingEngineSettings::unplacedLabelColor() const
80{
81 return mUnplacedLabelColor;
82}
83
84void QgsLabelingEngineSettings::setUnplacedLabelColor( const QColor &unplacedLabelColor )
85{
86 mUnplacedLabelColor = unplacedLabelColor;
87}
88
89Qgis::LabelPlacementEngineVersion QgsLabelingEngineSettings::placementVersion() const
90{
91 return mPlacementVersion;
92}
93
94void QgsLabelingEngineSettings::setPlacementVersion( Qgis::LabelPlacementEngineVersion placementVersion )
95{
96 mPlacementVersion = placementVersion;
97}
98
99
Qgis::LabelingFlag::DrawCandidates
@ DrawCandidates
Whether to draw rectangles of generated candidates (good for debugging)
Qgis::LabelingFlag::DrawLabelMetrics
@ DrawLabelMetrics
Whether to render label metric guides (for debugging). Since QGIS 3.30.
Qgis::LabelingFlag::DrawUnplacedLabels
@ DrawUnplacedLabels
Whether to render unplaced labels as an indicator/warning for users.
Qgis::LabelingFlag::UseAllLabels
@ UseAllLabels
Whether to draw all labels even if there would be collisions.
Qgis::LabelingFlag::DrawLabelRectOnly
@ DrawLabelRectOnly
Whether to only draw the label rect and not the actual label text (used for unit tests)
Qgis::LabelingFlag::UsePartialCandidates
@ UsePartialCandidates
Whether to use also label candidates that are partially outside of the map view.
Qgis::TextRenderFormat
TextRenderFormat
Options for rendering text.
Definition: qgis.h:1885
Qgis::LabelPlacementEngineVersion
LabelPlacementEngineVersion
Labeling placement engine version.
Definition: qgis.h:1930
QgsLabelingEngineSettings::writeSettingsToProject
void writeSettingsToProject(QgsProject *project)
Write configuration of the labeling engine to a project.
Definition: qgslabelingenginesettings.cpp:59
QgsLabelingEngineSettings::setPlacementVersion
void setPlacementVersion(Qgis::LabelPlacementEngineVersion version)
Sets the placement engine version, which dictates how the label placement problem is solved.
Definition: qgslabelingenginesettings.cpp:94
QgsLabelingEngineSettings::Search
Search
Search methods in the PAL library to remove colliding labels (methods have different processing speed...
Definition: qgslabelingenginesettings.h:41
QgsLabelingEngineSettings::unplacedLabelColor
QColor unplacedLabelColor() const
Returns the color to use when rendering unplaced labels.
Definition: qgslabelingenginesettings.cpp:79
QgsLabelingEngineSettings::placementVersion
Qgis::LabelPlacementEngineVersion placementVersion() const
Returns the placement engine version, which dictates how the label placement problem is solved.
Definition: qgslabelingenginesettings.cpp:89
QgsLabelingEngineSettings::clear
void clear()
Returns the configuration to the defaults.
Definition: qgslabelingenginesettings.cpp:25
QgsLabelingEngineSettings::setUnplacedLabelColor
void setUnplacedLabelColor(const QColor &color)
Sets the color to use when rendering unplaced labels.
Definition: qgslabelingenginesettings.cpp:84
QgsLabelingEngineSettings::readSettingsFromProject
void readSettingsFromProject(QgsProject *project)
Read configuration of the labeling engine from a project.
Definition: qgslabelingenginesettings.cpp:30
QgsProject
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition: qgsproject.h:107
QgsProject::readNumEntry
int readNumEntry(const QString &scope, const QString &key, int def=0, bool *ok=nullptr) const
Reads an integer from the specified scope and key.
Definition: qgsproject.cpp:3381
QgsProject::readEntry
QString readEntry(const QString &scope, const QString &key, const QString &def=QString(), bool *ok=nullptr) const
Reads a string from the specified scope and key.
Definition: qgsproject.cpp:3353
QgsProject::readBoolEntry
bool readBoolEntry(const QString &scope, const QString &key, bool def=false, bool *ok=nullptr) const
Reads a boolean from the specified scope and key.
Definition: qgsproject.cpp:3434
QgsProject::readDoubleEntry
double readDoubleEntry(const QString &scope, const QString &key, double def=0, bool *ok=nullptr) const
Reads a double from the specified scope and key.
Definition: qgsproject.cpp:3410
QgsProject::writeEntry
bool writeEntry(const QString &scope, const QString &key, bool value)
Write a boolean value to the project file.
Definition: qgsproject.cpp:3256
QgsSymbolLayerUtils::decodeColor
static QColor decodeColor(const QString &str)
Definition: qgssymbollayerutils.cpp:69
QgsSymbolLayerUtils::encodeColor
static QString encodeColor(const QColor &color)
Definition: qgssymbollayerutils.cpp:64
Generated on Sun Jun 25 2023 11:54:04 for QGIS API Documentation by doxygen 1.9.4