api/3.38/qgslabelingenginesettings_8cpp_source.html

/***************************************************************************

  qgslabelingenginesettings.cpp

  --------------------------------------

  Date                 : April 2017

  Copyright            : (C) 2017 by Martin Dobias

  Email                : wonder dot sk at gmail dot com

 ***************************************************************************

 *                                                                         *

 *   This program is free software; you can redistribute it and/or modify  *

 *   it under the terms of the GNU General Public License as published by  *

 *   the Free Software Foundation; either version 2 of the License, or     *

 *   (at your option) any later version.                                   *

 *                                                                         *

 ***************************************************************************/


#include "qgslabelingenginesettings.h"


#include "qgsproject.h"

#include "qgscolorutils.h"


QgsLabelingEngineSettings::QgsLabelingEngineSettings()

{

}


void QgsLabelingEngineSettings::clear()

{

  *this = QgsLabelingEngineSettings();

}


void QgsLabelingEngineSettings::readSettingsFromProject( QgsProject *prj )

{

  bool saved = false;

  mSearchMethod = static_cast< Search >( prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/SearchMethod" ), static_cast< int >( Chain ), &saved ) );

  mMaxLineCandidatesPerCm = prj->readDoubleEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesLinePerCM" ), 5, &saved );

  mMaxPolygonCandidatesPerCmSquared = prj->readDoubleEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesPolygonPerCM" ), 2.5, &saved );


  mFlags = Qgis::LabelingFlags();

  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingCandidates" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::DrawCandidates;

  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawRectOnly" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::DrawLabelRectOnly;

  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingAllLabels" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::UseAllLabels;

  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingPartialsLabels" ), true, &saved ) ) mFlags |= Qgis::LabelingFlag::UsePartialCandidates;

  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawUnplaced" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::DrawUnplacedLabels;

  if ( prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawLabelMetrics" ), false, &saved ) ) mFlags |= Qgis::LabelingFlag::DrawLabelMetrics;


  mDefaultTextRenderFormat = Qgis::TextRenderFormat::AlwaysOutlines;

  // if users have disabled the older PAL "DrawOutlineLabels" setting, respect that

  if ( !prj->readBoolEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawOutlineLabels" ), true ) )

    mDefaultTextRenderFormat = Qgis::TextRenderFormat::AlwaysText;

  // otherwise, prefer the new setting

  const int projectTextFormat = prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/TextFormat" ), -1 );

  if ( projectTextFormat >= 0 )

    mDefaultTextRenderFormat = static_cast< Qgis::TextRenderFormat >( projectTextFormat );


  mUnplacedLabelColor = QgsColorUtils::colorFromString( prj->readEntry( QStringLiteral( "PAL" ), QStringLiteral( "/UnplacedColor" ), QStringLiteral( "#ff0000" ) ) );


  mPlacementVersion = static_cast< Qgis::LabelPlacementEngineVersion >( prj->readNumEntry( QStringLiteral( "PAL" ), QStringLiteral( "/PlacementEngineVersion" ), static_cast< int >( Qgis::LabelPlacementEngineVersion::Version1 ) ) );

}


void QgsLabelingEngineSettings::writeSettingsToProject( QgsProject *project )

{

  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/SearchMethod" ), static_cast< int >( mSearchMethod ) );

  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesLinePerCM" ), mMaxLineCandidatesPerCm );

  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/CandidatesPolygonPerCM" ), mMaxPolygonCandidatesPerCmSquared );


  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingCandidates" ), mFlags.testFlag( Qgis::LabelingFlag::DrawCandidates ) );

  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawRectOnly" ), mFlags.testFlag( Qgis::LabelingFlag::DrawLabelRectOnly ) );

  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawUnplaced" ), mFlags.testFlag( Qgis::LabelingFlag::DrawUnplacedLabels ) );

  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingAllLabels" ), mFlags.testFlag( Qgis::LabelingFlag::UseAllLabels ) );

  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/ShowingPartialsLabels" ), mFlags.testFlag( Qgis::LabelingFlag::UsePartialCandidates ) );

  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/DrawLabelMetrics" ), mFlags.testFlag( Qgis::LabelingFlag::DrawLabelMetrics ) );


  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/TextFormat" ), static_cast< int >( mDefaultTextRenderFormat ) );


  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/UnplacedColor" ), QgsColorUtils::colorToString( mUnplacedLabelColor ) );


  project->writeEntry( QStringLiteral( "PAL" ), QStringLiteral( "/PlacementEngineVersion" ), static_cast< int >( mPlacementVersion ) );

}


QColor QgsLabelingEngineSettings::unplacedLabelColor() const

{

  return mUnplacedLabelColor;

}


void QgsLabelingEngineSettings::setUnplacedLabelColor( const QColor &unplacedLabelColor )

{

  mUnplacedLabelColor = unplacedLabelColor;

}


Qgis::LabelPlacementEngineVersion QgsLabelingEngineSettings::placementVersion() const

{

  return mPlacementVersion;

}


void QgsLabelingEngineSettings::setPlacementVersion( Qgis::LabelPlacementEngineVersion placementVersion )

{

  mPlacementVersion = placementVersion;

}


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:2404

Qgis::TextRenderFormat::AlwaysOutlines
@ AlwaysOutlines
Always render text using path objects (AKA outlines/curves). This setting guarantees the best quality...

Qgis::TextRenderFormat::AlwaysText
@ AlwaysText
Always render text as text objects. While this mode preserves text objects as text for post-processin...

Qgis::LabelingFlags
QFlags< LabelingFlag > LabelingFlags
Flags that affect drawing and placement of labels.
Definition qgis.h:2438

Qgis::LabelPlacementEngineVersion
LabelPlacementEngineVersion
Labeling placement engine version.
Definition qgis.h:2449

Qgis::LabelPlacementEngineVersion::Version1
@ Version1
Version 1, matches placement from QGIS <= 3.10.1.

QgsColorUtils::colorFromString
static QColor colorFromString(const QString &string)
Decodes a string into a color value.
Definition qgscolorutils.cpp:295

QgsColorUtils::colorToString
static QString colorToString(const QColor &color)
Encodes a color into a string value.
Definition qgscolorutils.cpp:192

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::QgsLabelingEngineSettings
QgsLabelingEngineSettings()
Definition qgslabelingenginesettings.cpp:21

QgsLabelingEngineSettings::Search
Search
Search methods in the PAL library to remove colliding labels (methods have different processing speed...
Definition qgslabelingenginesettings.h:40

QgsLabelingEngineSettings::Chain
@ Chain
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:3658

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:3630

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:3711

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:3687

QgsProject::writeEntry
bool writeEntry(const QString &scope, const QString &key, bool value)
Write a boolean value to the project file.
Definition qgsproject.cpp:3533

qgscolorutils.h

qgslabelingenginesettings.h

qgsproject.h