QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
qgslabelfeature.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslabelfeature.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 QGSLABELFEATURE_H
16#define QGSLABELFEATURE_H
17
18#define SIP_NO_FILE
19
20#include "qgis_core.h"
21#include "geos_c.h"
22#include "qgsgeos.h"
23#include "qgsmargins.h"
26#include "qgslabeling.h"
27#include "qgsfeature.h"
29
30namespace pal
31{
32 class Layer;
33}
34
37class QgsGeometry;
38
39
57class CORE_EXPORT QgsLabelFeature
58{
59 public:
60
72 QgsLabelFeature( QgsFeatureId id, geos::unique_ptr geometry, QSizeF size );
73
74 virtual ~QgsLabelFeature();
75
77 QgsFeatureId id() const { return mId; }
78
80 GEOSGeometry *geometry() const { return mGeometry.get(); }
81
91 void setPermissibleZone( const QgsGeometry &geometry );
92
101 QgsGeometry permissibleZone() const { return mPermissibleZone; }
102
108 //TODO - remove when QgsGeometry caches GEOS preparedness
109 const GEOSPreparedGeometry *permissibleZonePrepared() const { return mPermissibleZoneGeosPrepared.get(); }
110
112 QSizeF size( double angle = 0.0 ) const;
113
121 QRectF outerBounds() const { return mOuterBounds; }
122
130 void setOuterBounds( const QRectF &bounds ) { mOuterBounds = bounds; }
131
142 void setVisualMargin( const QgsMargins &margin ) { mVisualMargin = margin; }
143
148 const QgsMargins &visualMargin() const { return mVisualMargin; }
149
156 void setSymbolSize( QSizeF size ) { mSymbolSize = size; }
157
165 const QSizeF &symbolSize() const { return mSymbolSize; }
166
173 double priority() const { return mPriority; }
174
182 void setPriority( double priority ) { mPriority = priority; }
183
190 double zIndex() const { return mZIndex; }
191
199 void setZIndex( double zIndex ) { mZIndex = zIndex; }
200
202 bool hasFixedPosition() const { return mHasFixedPosition; }
204 void setHasFixedPosition( bool enabled ) { mHasFixedPosition = enabled; }
206 QgsPointXY fixedPosition() const { return mFixedPosition; }
207
209 void setFixedPosition( const QgsPointXY &point ) { mFixedPosition = point; }
210
217 QgsPointXY anchorPosition() const;
218
225 void setAnchorPosition( const QgsPointXY &anchorPosition );
226
228 bool hasFixedAngle() const { return mHasFixedAngle; }
230 void setHasFixedAngle( bool enabled ) { mHasFixedAngle = enabled; }
232 double fixedAngle() const { return mFixedAngle; }
234 void setFixedAngle( double angle ) { mFixedAngle = angle; }
235
242 bool hasFixedQuadrant() const { return mHasFixedQuadrant; }
243
250 void setHasFixedQuadrant( bool enabled ) { mHasFixedQuadrant = enabled; }
251
258 QPointF quadOffset() const { return mQuadOffset; }
259
264 void setQuadOffset( QPointF quadOffset ) { mQuadOffset = quadOffset; }
265
270 QgsPointXY positionOffset() const { return mPositionOffset; }
271
276 void setPositionOffset( const QgsPointXY &offset ) { mPositionOffset = offset; }
277
284 Qgis::LabelOffsetType offsetType() const { return mOffsetType; }
285
292 void setOffsetType( Qgis::LabelOffsetType type ) { mOffsetType = type; }
293
298 double distLabel() const { return mDistLabel; }
299
304 void setDistLabel( double dist ) { mDistLabel = dist; }
305
311 QVector< Qgis::LabelPredefinedPointPosition > predefinedPositionOrder() const { return mPredefinedPositionOrder; }
312
318 void setPredefinedPositionOrder( const QVector< Qgis::LabelPredefinedPointPosition > &order ) { mPredefinedPositionOrder = order; }
319
324 double repeatDistance() const { return mRepeatDistance; }
325
330 void setRepeatDistance( double dist ) { mRepeatDistance = dist; }
331
333 bool alwaysShow() const { return mAlwaysShow; }
335 void setAlwaysShow( bool enabled ) { mAlwaysShow = enabled; }
336
341 QgsLabeling::LinePlacementFlags arrangementFlags() const { return mArrangementFlags; }
342
348 void setArrangementFlags( QgsLabeling::LinePlacementFlags flags ) { mArrangementFlags = flags; }
349
356 QgsLabeling::PolygonPlacementFlags polygonPlacementFlags() const { return mPolygonPlacementFlags; }
357
364 void setPolygonPlacementFlags( QgsLabeling::PolygonPlacementFlags flags ) { mPolygonPlacementFlags = flags; }
365
372 QString labelText() const { return mLabelText; }
374 void setLabelText( const QString &text ) { mLabelText = text; }
375
377 pal::Layer *layer() const { return mLayer; }
379 void setLayer( pal::Layer *layer ) { mLayer = layer; }
380
382 QgsAbstractLabelProvider *provider() const;
383
390 QgsFeature feature() const;
391
398 void setFeature( const QgsFeature &feature );
399
406 const QgsSymbol *symbol() const { return mSymbol; }
407
415 void setSymbol( const QgsSymbol *symbol ) { mSymbol = symbol; }
416
425 double overrunDistance() const;
426
435 void setOverrunDistance( double distance );
436
445 double overrunSmoothDistance() const;
446
455 void setOverrunSmoothDistance( double distance );
456
469 double lineAnchorPercent() const { return mLineAnchorPercent; }
470
483 void setLineAnchorPercent( double percent ) { mLineAnchorPercent = percent; }
484
492 QgsLabelLineSettings::AnchorType lineAnchorType() const { return mLineAnchorType; }
493
501 void setLineAnchorType( QgsLabelLineSettings::AnchorType type ) { mLineAnchorType = type; }
502
511 QgsLabelLineSettings::AnchorTextPoint lineAnchorTextPoint() const;
512
521 void setLineAnchorTextPoint( QgsLabelLineSettings::AnchorTextPoint point ) { mAnchorTextPoint = point; }
522
528 bool labelAllParts() const { return mLabelAllParts; }
529
535 void setLabelAllParts( bool labelAllParts ) { mLabelAllParts = labelAllParts; }
536
542 void setRotatedSize( QSizeF size ) { mRotatedSize = size; }
543
550 const QgsLabelObstacleSettings &obstacleSettings() const;
551
558 void setObstacleSettings( const QgsLabelObstacleSettings &settings );
559
566 QgsCoordinateReferenceSystem originalFeatureCrs() const;
567
574 void setOriginalFeatureCrs( const QgsCoordinateReferenceSystem &crs );
575
583 double minimumSize() const { return mMinimumSize; }
584
592 void setMinimumSize( double size ) { mMinimumSize = size; }
593
600 Qgis::LabelOverlapHandling overlapHandling() const { return mOverlapHandling; }
601
608 void setOverlapHandling( Qgis::LabelOverlapHandling handling ) { mOverlapHandling = handling; }
609
620 bool allowDegradedPlacement() const { return mAllowDegradedPlacement; }
621
632 void setAllowDegradedPlacement( bool allow ) { mAllowDegradedPlacement = allow; }
633
634 protected:
636 pal::Layer *mLayer = nullptr;
637
645 QSizeF mSize;
655 double mPriority = -1;
657 double mZIndex = 0;
659 bool mHasFixedPosition = false;
663 bool mHasFixedAngle = false;
665 double mFixedAngle = 0;
667 bool mHasFixedQuadrant = false;
669 QPointF mQuadOffset;
673 double mDistLabel = 0;
677 QVector< Qgis::LabelPredefinedPointPosition > mPredefinedPositionOrder;
679 double mRepeatDistance = 0;
681 bool mAlwaysShow = false;
683 QString mLabelText;
684
686 double mOverrunDistance = 0;
688 double mOverrunSmoothDistance = 0;
689
690 QgsLabeling::LinePlacementFlags mArrangementFlags = QgsLabeling::LinePlacementFlags();
691 QgsLabeling::PolygonPlacementFlags mPolygonPlacementFlags = QgsLabeling::PolygonPlacementFlag::AllowPlacementInsideOfPolygon;
692
693 private:
694
696 geos::unique_ptr mPermissibleZoneGeos;
697
698 // TODO - not required when QgsGeometry caches geos preparedness
699 geos::prepared_unique_ptr mPermissibleZoneGeosPrepared;
700
701 QgsFeature mFeature;
702
703 const QgsSymbol *mSymbol = nullptr;
704
705 bool mLabelAllParts = false;
706
707 QgsLabelObstacleSettings mObstacleSettings{};
708
709 QgsPointXY mAnchorPosition;
710
711 double mLineAnchorPercent = 0.5;
714
716 bool mAllowDegradedPlacement = false;
717
718 QgsCoordinateReferenceSystem mOriginalFeatureCrs;
719
720 double mMinimumSize = 0.0;
721
722};
723
724#endif // QGSLABELFEATURE_H
LabelOffsetType
Behavior modifier for label offset and distance, only applies in some label placement modes.
Definition: qgis.h:608
@ FromPoint
Offset distance applies from point geometry.
LabelOverlapHandling
Label overlap handling.
Definition: qgis.h:546
@ PreventOverlap
Do not allow labels to overlap other labels.
The QgsAbstractLabelProvider class is an interface class.
This class represents a coordinate reference system (CRS).
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:164
The QgsLabelFeature class describes a feature that should be used within the labeling engine.
void setMinimumSize(double size)
Sets the minimum size (in map unit) for a feature to be labelled.
QSizeF mSymbolSize
Size of associated rendered symbol, if applicable.
void setDistLabel(double dist)
Applies to "around point" placement strategy or linestring features.
void setArrangementFlags(QgsLabeling::LinePlacementFlags flags)
Sets the feature's arrangement flags.
void setAlwaysShow(bool enabled)
Sets whether label should be always shown (sets very high label priority)
QgsPointXY mFixedPosition
fixed position for the label (instead of automatic placement)
QSizeF mRotatedSize
Width and height of the label when rotated between 45 to 135 and 235 to 315 degrees;.
void setRepeatDistance(double dist)
Applies only to linestring features - set after what distance (in map units) the labels should be rep...
QVector< Qgis::LabelPredefinedPointPosition > mPredefinedPositionOrder
Ordered list of predefined positions for label (only for OrderedPositionsAroundPoint placement)
double fixedAngle() const
Angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns true)
const QSizeF & symbolSize() const
Returns the size of the rendered symbol associated with this feature, if applicable.
QVector< Qgis::LabelPredefinedPointPosition > predefinedPositionOrder() const
Returns the priority ordered list of predefined positions for label candidates.
double repeatDistance() const
Applies only to linestring features - after what distance (in map units) the labels should be repeate...
void setSymbolSize(QSizeF size)
Sets the size of the rendered symbol associated with this feature.
QgsLabeling::PolygonPlacementFlags polygonPlacementFlags() const
Returns the polygon placement flags, which dictate how polygon labels can be placed.
QgsPointXY positionOffset() const
Applies only to "offset from point" placement strategy.
void setLayer(pal::Layer *layer)
Assign PAL layer to the label feature. Should be only used internally in PAL.
QgsMargins mVisualMargin
Visual margin of label contents.
bool hasFixedQuadrant() const
Returns whether the quadrant for the label is fixed.
void setZIndex(double zIndex)
Sets the label's z-index.
void setLineAnchorType(QgsLabelLineSettings::AnchorType type)
Sets the line anchor type, which dictates how the lineAnchorPercent() setting is handled.
bool hasFixedAngle() const
Whether the label should use a fixed angle instead of using angle from automatic placement.
pal::Layer * layer() const
Gets PAL layer of the label feature. Should be only used internally in PAL.
QgsFeatureId mId
Associated ID unique within the parent label provider.
QgsLabeling::LinePlacementFlags arrangementFlags() const
Returns the feature's arrangement flags.
bool alwaysShow() const
Whether label should be always shown (sets very high label priority)
double lineAnchorPercent() const
Returns the percent along the line at which labels should be placed, for line labels only.
void setOffsetType(Qgis::LabelOffsetType type)
Sets the offset type, which determines how offsets and distance to label behaves.
const GEOSPreparedGeometry * permissibleZonePrepared() const
Returns a GEOS prepared geometry representing the label's permissibleZone().
void setLabelAllParts(bool labelAllParts)
Sets whether all parts of the feature should be labeled.
void setSymbol(const QgsSymbol *symbol)
Sets the feature symbol associated with this label.
void setHasFixedAngle(bool enabled)
Sets whether the label should use a fixed angle instead of using angle from automatic placement.
void setOuterBounds(const QRectF &bounds)
Sets the extreme outer bounds of the label feature, including any surrounding content like borders or...
QgsLabelLineSettings::AnchorType lineAnchorType() const
Returns the line anchor type, which dictates how the lineAnchorPercent() setting is handled.
double distLabel() const
Applies to "around point" placement strategy or linestring features.
GEOSGeometry * geometry() const
Gets access to the associated geometry.
void setPredefinedPositionOrder(const QVector< Qgis::LabelPredefinedPointPosition > &order)
Sets the priority ordered list of predefined positions for label candidates.
bool allowDegradedPlacement() const
Returns true if the label can be placed in inferior fallback positions if it cannot otherwise be plac...
QPointF quadOffset() const
Applies to "offset from point" placement strategy and "around point" (in case hasFixedQuadrant() retu...
QgsGeometry mPermissibleZone
Optional geometry to use for label's permissible zone.
void setPositionOffset(const QgsPointXY &offset)
Applies only to "offset from point" placement strategy.
Qgis::LabelOverlapHandling overlapHandling() const
Returns the technique to use for handling overlapping labels for the feature.
QgsPointXY mPositionOffset
offset of label from the feature (only for "offset from point" placement)
void setOverlapHandling(Qgis::LabelOverlapHandling handling)
Sets the technique to use for handling overlapping labels for the feature.
void setLineAnchorPercent(double percent)
Sets the percent along the line at which labels should be placed, for line labels only.
void setLineAnchorTextPoint(QgsLabelLineSettings::AnchorTextPoint point)
Sets the line anchor text point, which dictates which part of the label text should be placed at the ...
QgsFeatureId id() const
Identifier of the label (unique within the parent label provider)
QPointF mQuadOffset
whether the side of the label is fixed (only for "around point" placement)
QSizeF mSize
Width and height of the label.
double priority() const
Returns the feature's labeling priority.
void setAllowDegradedPlacement(bool allow)
Sets whether the label can be placed in inferior fallback positions if it cannot otherwise be placed.
double zIndex() const
Returns the label's z-index.
void setHasFixedQuadrant(bool enabled)
Sets whether the quadrant for the label must be respected.
void setPriority(double priority)
Sets the priority for labeling the feature.
void setQuadOffset(QPointF quadOffset)
Set which side of the point to use.
double minimumSize() const
Returns the minimum size (in map unit) for a feature to be labelled.
QgsGeometry permissibleZone() const
Returns the label's permissible zone geometry.
void setPolygonPlacementFlags(QgsLabeling::PolygonPlacementFlags flags)
Sets the polygon placement flags, which dictate how polygon labels can be placed.
bool hasFixedPosition() const
Whether the label should use a fixed position instead of being automatically placed.
void setHasFixedPosition(bool enabled)
Sets whether the label should use a fixed position instead of being automatically placed.
geos::unique_ptr mGeometry
Geometry of the feature to be labelled.
const QgsMargins & visualMargin() const
Returns the visual margin for the label feature.
void setFixedPosition(const QgsPointXY &point)
Sets coordinates of the fixed position (relevant only if hasFixedPosition() returns true)
QString labelText() const
Text of the label.
QRectF mOuterBounds
Extreme outer bounds of the label feature, including any surrounding content like borders or backgrou...
void setVisualMargin(const QgsMargins &margin)
Sets the visual margin for the label feature.
Qgis::LabelOffsetType offsetType() const
Returns the offset type, which determines how offsets and distance to label behaves.
void setLabelText(const QString &text)
Sets text of the label.
QRectF outerBounds() const
Returns the extreme outer bounds of the label feature, including any surrounding content like borders...
const QgsSymbol * symbol() const
Returns the feature symbol associated with this label.
void setRotatedSize(QSizeF size)
Sets an alternate label size to be used when a label rotation angle is between 45 to 135 and 235 to 3...
bool labelAllParts() const
Returns true if all parts of the feature should be labeled.
QString mLabelText
text of the label
QgsPointXY fixedPosition() const
Coordinates of the fixed position (relevant only if hasFixedPosition() returns true)
void setFixedAngle(double angle)
Sets angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns true)
AnchorType
Line anchor types.
@ HintOnly
Line anchor is a hint for preferred placement only, but other placements close to the hint are permit...
AnchorTextPoint
Anchor point of label text.
@ CenterOfText
Anchor using center of text.
Contains settings related to how the label engine treats features as obstacles.
The QgsMargins class defines the four margins of a rectangle.
Definition: qgsmargins.h:38
A class to represent a 2D point.
Definition: qgspointxy.h:59
Contains information about the context of a rendering operation.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:93
A set of features which influence the labeling process.
Definition: layer.h:63
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< const GEOSPreparedGeometry, GeosDeleter > prepared_unique_ptr
Scoped GEOS prepared geometry pointer.
Definition: qgsgeos.h:79
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
const QgsCoordinateReferenceSystem & crs