31 static bool _palIsCanceled(
void *ctx )
33 return ( reinterpret_cast< QgsRenderContext * >( ctx ) )->renderingStopped();
46 : mMapSettings( mapSettings )
58 QStringList layerIds = mMapSettings.
layerIds();
61 if ( layer1Pos != layer2Pos && layer1Pos >= 0 && layer2Pos >= 0 )
62 return layer1Pos > layer2Pos;
65 return lf1->
size().width() * lf1->
size().height() > lf2->
size().width() * lf2->
size().height();
86 QSet< QgsMapLayer * > layers;
89 if ( provider->
layer() )
90 layers << provider->
layer();
94 if ( provider->
layer() )
95 layers << provider->
layer();
97 return layers.toList();
117 QgsAbstractLabelProvider::Flags flags = provider->
flags();
157 Q_ASSERT(
"unsupported upside-down label setting" &&
false );
163 QList<QgsLabelFeature *> features = provider->
labelFeatures( context );
171 catch ( std::exception &e )
174 QgsDebugMsgLevel( QString(
"Ignoring feature %1 due PAL exception:" ).arg( feature->
id() ) + QString::fromLatin1( e.what() ), 4 );
216 int candPoint, candLine, candPolygon;
228 bool appendedLayerScope =
false;
231 appendedLayerScope =
true;
235 if ( appendedLayerScope )
242 QPainter *painter = context.
painter();
246 visiblePoly.append( visiblePoly.at( 0 ) );
266 std::unique_ptr< pal::Problem > problem;
271 catch ( std::exception &e )
274 QgsDebugMsgLevel(
"PAL EXCEPTION :-( " + QString::fromLatin1( e.what() ), 4 );
300 painter->setBrush( Qt::NoBrush );
301 for (
int i = 0; i < problem->getNumFeatures(); i++ )
303 for (
int j = 0; j < problem->getFeatureCandidateCount( i ); j++ )
315 QgsDebugMsgLevel( QString(
"LABELING work: %1 ms ... labels# %2" ).arg( t.elapsed() ).arg( labels.size() ), 4 );
322 painter->setRenderHint( QPainter::Antialiasing );
343 painter->setCompositionMode( QPainter::CompositionMode_SourceOver );
345 QgsDebugMsgLevel( QString(
"LABELING draw: %1 ms" ).arg( t.elapsed() ), 4 );
358 return mLayer ? mLayer->provider() :
nullptr;
363 : mLayerId( layer ? layer->id() : QString() )
365 , mProviderId( providerId )
366 , mFlags( DrawLabels )
368 , mLinePlacementFlags( 0 )
382 QStringList predefinedOrderString;
388 predefinedOrderString << QStringLiteral(
"TL" );
391 predefinedOrderString << QStringLiteral(
"TSL" );
394 predefinedOrderString << QStringLiteral(
"T" );
397 predefinedOrderString << QStringLiteral(
"TSR" );
400 predefinedOrderString << QStringLiteral(
"TR" );
403 predefinedOrderString << QStringLiteral(
"L" );
406 predefinedOrderString << QStringLiteral(
"R" );
409 predefinedOrderString << QStringLiteral(
"BL" );
412 predefinedOrderString << QStringLiteral(
"BSL" );
415 predefinedOrderString << QStringLiteral(
"B" );
418 predefinedOrderString << QStringLiteral(
"BSR" );
421 predefinedOrderString << QStringLiteral(
"BR" );
425 return predefinedOrderString.join( QStringLiteral(
"," ) );
430 QVector<QgsPalLayerSettings::PredefinedPointPosition> result;
431 QStringList predefinedOrderList = positionString.split(
',' );
432 Q_FOREACH (
const QString &position, predefinedOrderList )
434 QString cleaned = position.trimmed().toUpper();
435 if ( cleaned == QLatin1String(
"TL" ) )
437 else if ( cleaned == QLatin1String(
"TSL" ) )
439 else if ( cleaned == QLatin1String(
"T" ) )
441 else if ( cleaned == QLatin1String(
"TSR" ) )
443 else if ( cleaned == QLatin1String(
"TR" ) )
445 else if ( cleaned == QLatin1String(
"L" ) )
447 else if ( cleaned == QLatin1String(
"R" ) )
449 else if ( cleaned == QLatin1String(
"BL" ) )
451 else if ( cleaned == QLatin1String(
"BSL" ) )
453 else if ( cleaned == QLatin1String(
"B" ) )
455 else if ( cleaned == QLatin1String(
"BSR" ) )
457 else if ( cleaned == QLatin1String(
"BR" ) )
Label below point, slightly right of center.
void processProvider(QgsAbstractLabelProvider *provider, QgsRenderContext &context, pal::Pal &p)
Layer * addLayer(QgsAbstractLabelProvider *provider, const QString &layerName, QgsPalLayerSettings::Placement arrangement, double defaultPriority, bool active, bool toLabel, bool displayAll=false)
add a new layer
A rectangle specified with double values.
Base class for all map layer types.
Label on bottom-left of point.
void setMapRotation(double degrees, double cx, double cy)
Set map rotation in degrees (clockwise)
void addProvider(QgsAbstractLabelProvider *provider)
Add provider of label features. Takes ownership of the provider.
QList< QgsAbstractLabelProvider * > mProviders
List of providers (the are owned by the labeling engine)
QgsFeatureId id() const
Identifier of the label (unique within the parent label provider)
void removeProvider(QgsAbstractLabelProvider *provider)
Remove provider if the provider's initialization failed. Provider instance is deleted.
QgsLabelFeature * feature()
Returns the parent feature.
double rotation() const
Returns the rotation of the resulting map image, in degrees clockwise.
QStringList layerIds() const
Get list of layer IDs for map rendering The layers are stored in the reverse order of how they are re...
QgsAbstractLabelProvider * provider() const
Return provider of this instance.
Label on top-left of point.
QgsAbstractLabelProvider(QgsMapLayer *layer, const QString &providerId=QString())
Construct the provider with default values.
static void drawLabelCandidateRect(pal::LabelPosition *lp, QPainter *painter, const QgsMapToPixel *xform, QList< QgsLabelCandidate > *candidates=nullptr)
A set of features which influence the labeling process.
PredefinedPointPosition
Positions for labels when using the QgsPalLabeling::OrderedPositionsAroundPoint placement mode...
OperationResult rotate(double rotation, const QgsPointXY ¢er)
Rotate this geometry around the Z axis.
QgsPalLayerSettings::ObstacleType obstacleType() const
How the feature geometries will work as obstacles.
Whether to use also label candidates that are partially outside of the map view.
QgsLabelingEngine()
Construct the labeling engine with default settings.
QList< QgsAbstractLabelProvider * > mSubProviders
bool renderingStopped() const
Is slower and best than TABU, worse and faster than TABU_CHAIN.
Label on top of point, slightly right of center.
A geometry is the spatial representation of a feature.
void setUpsidedownLabels(UpsideDownLabels ud)
Sets how upside down labels will be handled within the layer.
void setShowPartial(bool show)
Set flag show partial label.
Whether to label each part of multi-part features separately.
FeaturePart * getFeaturePart()
return the feature corresponding to this labelposition
virtual QList< QgsLabelFeature * > labelFeatures(QgsRenderContext &context)=0
Return list of label features (they are owned by the provider and thus deleted on its destruction) ...
void setObstacleType(QgsPalLayerSettings::ObstacleType obstacleType)
Sets the obstacle type, which controls how features within the layer act as obstacles for labels...
QgsRectangle visibleExtent() const
Return the actual extent derived from requested extent that takes takes output image size into accoun...
bool qgsDoubleNear(double a, double b, double epsilon=4 *DBL_EPSILON)
Compare two doubles (but allow some difference)
void setCentroidInside(bool forceInside)
Sets whether labels placed at the centroid of features within the layer are forced to be placed insid...
Is a little bit better than CHAIN but slower.
Whether adjacent lines (with the same label text) should be merged.
std::unique_ptr< Problem > extractProblem(const QgsRectangle &extent, const QgsGeometry &mapBoundary)
Extracts the labeling problem for the specified map extent - only features within this extent will be...
The QgsMapSettings class contains configuration for rendering of the map.
QgsMapLayer * layer() const
Returns the associated layer, or nullptr if no layer is associated with the provider.
Perform transforms between map coordinates and device coordinates.
Whether to draw all labels even if there would be collisions.
unsigned int linePlacementFlags() const
For layers with linestring geometries - extra placement flags (or-ed combination of QgsPalLayerSettin...
static QgsGeometry fromRect(const QgsRectangle &rect)
Creates a new geometry from a QgsRectangle.
double zIndex() const
Returns the label's z-index.
#define QgsDebugMsgLevel(str, level)
Show upside down for all labels, including dynamic ones.
bool operator()(pal::LabelPosition *lp1, pal::LabelPosition *lp2) const
void setPointP(int point_p)
set # candidates to generate for points features Higher the value is, longer Pal::labeller will spend...
Whether location of centroid must be inside of polygons.
void setLineP(int line_p)
set maximum # candidates to generate for lines features Higher the value is, longer Pal::labeller wil...
Upside-down labels (90 <= angle < 270) are shown upright.
QList< QgsMapLayer *> participatingLayers() const
Returns a list of layers with providers in the engine.
Whether all features will be labelled even though overlaps occur.
QgsPalLayerSettings::Placement placement() const
What placement strategy to use for the labels.
const QgsMapToPixel & mapToPixel() const
The QgsAbstractLabelProvider class is an interface class.
Whether to draw rectangles of generated candidates (good for debugging)
QString layerId() const
Returns ID of associated layer, or empty string if no layer is associated with the provider...
QSizeF size() const
Size of the label (in map units)
QgsPalLayerSettings::UpsideDownLabels upsidedownLabels() const
How to handle labels that would be upside down.
void numCandidatePositions(int &candPoint, int &candLine, int &candPolygon) const
Get number of candidate positions that will be generated for each label feature (default to 8) ...
QgsLabelSorter(const QgsMapSettings &mapSettings)
QgsExpressionContext & expressionContext()
Gets the expression context.
~QgsLabelingEngine()
Clean up everything (especially the registered providers)
bool registerFeature(QgsLabelFeature *label)
Register a feature in the layer.
Flags flags() const
Flags associated with the provider.
static QString encodePredefinedPositionOrder(const QVector< QgsPalLayerSettings::PredefinedPointPosition > &positions)
Encodes an ordered list of predefined point label positions to a string.
void run(QgsRenderContext &context)
compute the labeling with given map settings and providers
virtual QList< QgsAbstractLabelProvider * > subProviders()
Return list of child providers - useful if the provider needs to put labels into more layers with dif...
Contains information about the context of a rendering operation.
QPainter * painter()
Returns the destination QPainter for the render operation.
The QgsLabelFeature class describes a feature that should be used within the labeling engine...
QString name() const
Name of the layer (for statistics, debugging etc.) - does not need to be unique.
std::unique_ptr< QgsLabelingResults > mResults
Resulting labeling layout.
void setPolyP(int poly_p)
set maximum # candidates to generate for polygon features Higher the value is, longer Pal::labeller w...
QgsMapSettings mMapSettings
Associated map settings instance.
void registerCancelationCallback(FnIsCanceled fnCanceled, void *context)
Register a function that returns whether this job has been canceled - PAL calls it during the computa...
QgsLabelingResults * takeResults()
Return pointer to recently computed results and pass the ownership of results to the caller...
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
Stores global configuration for labeling engine.
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
QList< LabelPosition * > solveProblem(Problem *prob, bool displayAll)
void setLabelMode(LabelMode mode)
Sets the layer's labeling mode.
Label below point, slightly left of center.
Helper class for sorting labels into correct draw order.
double priority() const
Default priority of labels (may be overridden by individual labels)
bool testFlag(Flag f) const
Test whether a particular flag is enabled.
static QgsGeometry fromQPolygonF(const QPolygonF &polygon)
Construct geometry from a QPolygonF.
LabelPosition is a candidate feature label position.
Label on top of point, slightly left of center.
void setArrangementFlags(LineArrangementFlags flags)
Sets the layer's arrangement flags.
Whether the labels should be rendered.
Class that stores computed placement from labeling engine.
QPolygonF visiblePolygon() const
Return the visible area as a polygon (may be rotated)
static QVector< QgsPalLayerSettings::PredefinedPointPosition > decodePredefinedPositionOrder(const QString &positionString)
Decodes a string to an ordered list of predefined point label positions.
QgsPointXY center() const
Returns the center point of the rectangle.
SearchMethod
Search method to use.
QgsExpressionContextScope * popScope()
Removes the last scope from the expression context and return it.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
Show upside down when rotation is layer- or data-defined.
virtual void drawLabel(QgsRenderContext &context, pal::LabelPosition *label) const =0
draw this label at the position determined by the labeling engine
Is the worst but fastest method.
void setSearch(SearchMethod method)
Select the search method to use.
void setEngine(const QgsLabelingEngine *engine)
Associate provider with a labeling engine (should be only called internally from QgsLabelingEngine) ...
Search searchMethod() const
Which search method to use for removal collisions between labels.
const QgsLabelingEngineSettings & labelingEngineSettings() const
Returns global configuration of the labeling engine.
void setMergeConnectedLines(bool merge)
Sets whether connected lines should be merged before labeling.