45 , mLayerGeometryType( layer->geometryType() )
46 , mRenderer( layer->renderer() )
47 , mFields( layer->fields() )
48 , mCrs( layer->
crs() )
50 mName = layerName.isEmpty() ? layer->
id() : layerName;
52 if ( withFeatureLoop )
54 mSource = qgis::make_unique<QgsVectorLayerFeatureSource>(
layer );
123 QSet<QString> attrNames;
124 if ( !
prepare( ctx, attrNames ) )
125 return QList<QgsLabelFeature *>();
154 if ( !symbols.isEmpty() )
156 symbol = symbols.at( 0 );
188 std::unique_ptr< QgsAbstractGeometry > obstacleGeom;
190 obstacleGeom = qgis::make_unique< QgsMultiPolygon >();
216 const auto constSymbols = symbols;
221 if ( bounds.isValid() )
222 bounds = bounds.united( static_cast< QgsMarkerSymbol * >( symbol )->bounds( pt, context, fet ) );
224 bounds =
static_cast< QgsMarkerSymbol *
>( symbol )->bounds( pt, context, fet );
229 QVector< double > bX;
230 bX << bounds.left() << bounds.right() << bounds.right() << bounds.left();
231 QVector< double > bY;
232 bY << bounds.top() << bounds.top() << bounds.bottom() << bounds.bottom();
233 std::unique_ptr< QgsLineString > boundLineString = qgis::make_unique< QgsLineString >( bX, bY );
237 for (
int i = 0; i < boundLineString->numPoints(); ++i )
240 static_cast<int>( boundLineString->yAt( i ) ) );
241 boundLineString->setXAt( i, point.
x() );
242 boundLineString->setYAt( i, point.
y() );
255 boundLineString->close();
260 boundLineString->filterVertices( [](
const QgsPoint & point )->
bool 262 return std::isfinite( point.
x() ) && std::isfinite( point.
y() );
264 if ( !boundLineString->isRing() )
268 std::unique_ptr< QgsPolygon > obstaclePolygon = qgis::make_unique< QgsPolygon >();
269 obstaclePolygon->setExteriorRing( boundLineString.release() );
273 static_cast<QgsMultiPolygon *
>( obstacleGeom.get() )->addGeometry( obstaclePolygon.release() );
277 obstacleGeom = std::move( obstaclePolygon );
292 drawCallout( context, label );
310 QRectF rect( outPt.x(), outPt.y(), outPt2.
x() - outPt.x(), outPt2.
y() - outPt.y() );
333 const QMap< QgsPalLayerSettings::Property, QVariant > &ddValues = lf->
dataDefinedValues();
338 QgsDebugMsgLevel( QStringLiteral(
"PAL font definedFont: %1, Style: %2" ).arg( dFont.toString(), dFont.styleName() ), 4 );
345 format.
setSize( dFont.pixelSize() );
354 case LabelPosition::QuadrantAboveLeft:
355 case LabelPosition::QuadrantLeft:
356 case LabelPosition::QuadrantBelowLeft:
359 case LabelPosition::QuadrantAbove:
360 case LabelPosition::QuadrantOver:
361 case LabelPosition::QuadrantBelow:
364 case LabelPosition::QuadrantAboveRight:
365 case LabelPosition::QuadrantRight:
366 case LabelPosition::QuadrantBelowRight:
373 QgsPalLabeling::dataDefinedTextStyle( tmpLyr, ddValues );
376 QgsPalLabeling::dataDefinedTextBuffer( tmpLyr, ddValues );
379 QgsPalLabeling::dataDefinedTextMask( tmpLyr, ddValues );
382 QgsPalLabeling::dataDefinedTextFormatting( tmpLyr, ddValues );
385 QgsPalLabeling::dataDefinedShapeBackground( tmpLyr, ddValues );
388 QgsPalLabeling::dataDefinedDropShadow( tmpLyr, ddValues );
396 drawCallout( context, label );
457 QPainter *painter = context.
painter();
475 QRectF rect( 0, 0, outPt2.
x() - outPt.x(), outPt2.
y() - outPt.y() );
477 painter->setRenderHint( QPainter::Antialiasing,
false );
478 painter->translate( QPointF( outPt.x(), outPt.y() ) );
479 painter->rotate( -label->
getAlpha() * 180 / M_PI );
483 painter->setBrush( QColor( 255, 0, 0, 100 ) );
484 painter->setPen( QColor( 255, 0, 0, 150 ) );
488 painter->setBrush( QColor( 0, 255, 0, 100 ) );
489 painter->setPen( QColor( 0, 255, 0, 150 ) );
492 painter->drawRect( rect );
501 QgsTextRenderer::Component component;
502 component.dpiRatio = dpiRatio;
503 component.origin = outPt;
504 component.rotation = label->
getAlpha();
511 QPointF centerPt( outPt );
515 double xc = outPt2.
x() - outPt.x();
516 double yc = outPt2.
y() - outPt.y();
518 double angle = -component.rotation;
519 double xd = xc * std::cos( angle ) - yc * std::sin( angle );
520 double yd = xc * std::sin( angle ) + yc * std::cos( angle );
522 centerPt.setX( centerPt.x() + xd );
523 centerPt.setY( centerPt.y() + yd );
525 component.center = centerPt;
531 component.size = QSizeF( labelWidthPx, labelHeightPx );
556 bool prependSymb =
false;
582 symb = symb + QStringLiteral(
"\n" );
587 symb = QStringLiteral(
"\n" ) + symb;
609 QgsTextRenderer::Component component;
610 component.origin = outPt;
611 component.rotation = label->
getAlpha();
613 QgsTextRenderer::drawTextInternal( drawType, context, tmpLyr.
format(), component, multiLineList, labelfm,
QgsAbstractLabelProvider * provider() const
Returns pointer to the associated provider.
QList< QgsLabelFeature * > mLabels
List of generated.
QColor unplacedLabelColor() const
Returns the color to use when rendering unplaced labels.
LabelPosition * nextPart() const
Returns the next part of this label position (i.e.
static QgsExpressionContextScope * updateSymbolScope(const QgsSymbol *symbol, QgsExpressionContextScope *symbolScope=nullptr)
Updates a symbol scope related to a QgsSymbol to an expression context.
Wrapper for iterator of features from vector data provider or vector layer.
QgsLabelObstacleSettings::ObstacleType mObstacleType
Type of the obstacle of feature geometries.
QgsVectorLayerLabelProvider(QgsVectorLayer *layer, const QString &providerId, bool withFeatureLoop, const QgsPalLayerSettings *settings, const QString &layerName=QString())
Convenience constructor to initialize the provider from given vector layer.
QString labelText() const
Text of the label.
A rectangle specified with double values.
QString leftDirectionSymbol
String to use for left direction arrows.
QgsWkbTypes::GeometryType mLayerGeometryType
Geometry type of layer.
void setMapRotation(double degrees, double cx, double cy)
Set map rotation in degrees (clockwise)
QgsTextShadowSettings::ShadowPlacement shadowPlacement() const
Returns the placement for the drop shadow.
QgsPalLayerSettings::Placement mPlacement
Placement strategy.
void registerFeature(const QgsFeature &f, QgsRenderContext &context, QgsLabelFeature **labelFeature=nullptr, QgsGeometry obstacleGeometry=QgsGeometry(), const QgsSymbol *symbol=nullptr)
Register a feature for labeling.
QgsFeatureId featureId() const
Returns the unique ID of the feature.
Abstract base class for all rendered symbols.
void render(QgsRenderContext &context, QRectF rect, const double angle, const QgsGeometry &anchor, QgsCalloutContext &calloutContext)
Renders the callout onto the specified render context.
std::unique_ptr< QgsAbstractFeatureSource > mSource
Layer's feature source.
QgsLabelFeature * feature()
Returns the parent feature.
virtual bool prepare(QgsRenderContext &context, QSet< QString > &attributeNames)
Prepare for registration of features.
const QgsLabelingEngine * mEngine
Associated labeling engine.
Contains additional contextual information about the context in which a callout is being rendered...
Draw shadow under buffer.
UpsideDownLabels upsidedownLabels
Controls whether upside down labels are displayed and how they are handled.
Place direction symbols on below label.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
double mPriority
Default priority of labels.
QgsTextShadowSettings & shadow()
Returns a reference to the text drop shadow settings.
double getY(int i=0) const
Returns the down-left y coordinate.
A class to represent a 2D point.
HAlignment
Horizontal alignment.
void setFont(const QFont &font)
Sets the font used for rendering text.
void stopRender(QgsRenderContext &context) override
To be called after rendering is complete.
const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > & dataDefinedValues() const
Gets data-defined values.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
Class that adds extra information to QgsLabelFeature for text labels.
GEOSGeometry * geometry() const
Gets access to the associated geometry.
bool addDirectionSymbol
If true, '<' or '>' (or custom strings set via leftDirectionSymbol and rightDirectionSymbol) will be ...
A geometry is the spatial representation of a feature.
Whether to only draw the label rect and not the actual label text (used for unit tests) ...
bool drawLabels
Whether to draw labels for this layer.
bool mergeLines
true if connected line features with identical label text should be merged prior to generating label ...
MultiLineAlign multilineAlign
Horizontal alignment of multi-line labels.
virtual DrawOrder drawOrder() const
Returns the desired drawing order (stacking) to use while rendering this callout. ...
Label-specific draw mode.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
const QgsCoordinateReferenceSystem & crs
bool hasGeometry() const
Returns true if the feature has an associated geometry.
int autoWrapLength
If non-zero, indicates that label text should be automatically wrapped to (ideally) the specified num...
QgsCoordinateTransform ct
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)
bool reverseDirectionSymbol
True if direction symbols should be reversed.
A marker symbol type, for rendering Point and MultiPoint geometries.
ShapeType type() const
Returns the type of background shape (e.g., square, ellipse, SVG).
void setFormat(const QgsTextFormat &format)
Sets the label text formatting settings, e.g., font settings, buffer settings, etc.
virtual QgsSymbolList originalSymbolsForFeature(const QgsFeature &feature, QgsRenderContext &context) const
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbol...
bool isActive(int key) const override
Returns true if the collection contains an active property with the specified key.
Whether adjacent lines (with the same label text) should be merged.
The QgsMapSettings class contains configuration for rendering of the map.
QList< QgsLabelFeature * > labelFeatures(QgsRenderContext &context) override
Returns list of label features (they are owned by the provider and thus deleted on its destruction) ...
QgsMapLayer * layer() const
Returns the associated layer, or nullptr if no layer is associated with the provider.
void transformInPlace(double &x, double &y) const
Transform device coordinates to map coordinates.
void init()
initialization method - called from constructors
void setCurrentMaskId(int id)
Stores a mask id as the "current" one.
Perform transforms between map coordinates and device coordinates.
QgsPointXY transform(const QgsPointXY &p) const
Transform the point from map (world) coordinates to device coordinates.
QgsExpressionContextScope * lastScope()
Returns the last scope added to the context.
QList< QgsSymbol * > QgsSymbolList
bool displayAll
If true, all features will be labelled even when overlaps occur.
void setSize(double size)
Sets the size for rendered text.
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
const QgsLabelingEngineSettings & engineSettings() const
Gets associated labeling engine settings.
static std::unique_ptr< QgsAbstractGeometry > fromGeos(const GEOSGeometry *geos)
Create a geometry from a GEOSGeometry.
FeaturePart * getFeaturePart() const
Returns the feature corresponding to this labelposition.
Utility class for identifying a unique vertex within a geometry.
#define QgsDebugMsgLevel(str, level)
Render callouts below their individual associated labels, some callouts may be drawn over other label...
const QgsRectangle & extent() const
When rendering a map layer, calling this method returns the "clipping" extent for the layer (in the l...
QgsPalLayerSettings mSettings
Layer's labeling configuration.
const QgsPalLayerSettings & settings() const
Returns the layer's settings.
void setColor(const QColor &color)
Sets the color that text will be rendered in.
Layer * layer()
Returns the layer that feature belongs to.
This class wraps a request for features to a vector layer (or directly its vector data provider)...
Flags mFlags
Flags altering drawing and registration of features.
Whether location of centroid must be inside of polygons.
bool allFeaturePartsLabeled
true if all parts of associated feature were labeled
Quadrant getQuadrant() const
QgsFeatureRequest & setFilterRect(const QgsRectangle &rectangle)
Sets the rectangle from which features will be taken.
QgsTextBackgroundSettings & background()
Returns a reference to the text background settings.
QgsTextBufferSettings & buffer()
Returns a reference to the text buffer settings.
void setSizeUnit(QgsUnitTypes::RenderUnit unit)
Sets the units for the size of rendered text.
QgsCoordinateTransform coordinateTransform() const
Returns the current coordinate transform for the context.
QString text(int partId) const
Returns the text component corresponding to a specified label part.
Whether all features will be labelled even though overlaps occur.
Single scope for storing variables and functions for use within a QgsExpressionContext.
Render callouts below all labels.
Point geometry type, with support for z-dimension and m-values.
The QgsAbstractLabelProvider class is an interface class.
QString layerId() const
Returns ID of associated layer, or empty string if no layer is associated with the provider...
const QgsTextFormat & format() const
Returns the label text formatting settings, e.g., font settings, buffer settings, etc...
Place direction symbols on above label.
Draw shadow below all text components.
virtual void registerFeature(const QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry=QgsGeometry(), const QgsSymbol *symbol=nullptr)
Register a feature for labeling as one or more QgsLabelFeature objects stored into mLabels...
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
QgsExpressionContext & expressionContext()
Gets the expression context.
QString wrapChar
Wrapping character string.
bool valueAsBool(int key, const QgsExpressionContext &context, bool defaultValue=false, bool *ok=nullptr) const
Calculates the current value of the property with the specified key and interprets it as an boolean...
TextPart
Components of text.
QgsFields mFields
Layer's fields.
QString rightDirectionSymbol
String to use for right direction arrows.
Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon'...
Contains information about the context of a rendering operation.
double convertToPainterUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
Converts a size from the specified units to painter units (pixels).
QFont definedFont()
Font to be used for rendering.
bool enabled() const
Returns true if the the callout is enabled.
bool hasFixedPosition() const
Whether the label should use a fixed position instead of being automatically placed.
QPainter * painter()
Returns the destination QPainter for the render operation.
The QgsLabelFeature class describes a feature that should be used within the labeling engine...
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
double getAlpha() const
Returns the angle to rotate text (in rad).
Multi polygon geometry collection.
QString mName
Name of the layer.
bool enabled() const
Returns whether the shadow is enabled.
Struct for storing maximum and minimum scales for measurements in map units.
QgsCoordinateReferenceSystem mCrs
Layer's CRS.
bool conflictsWithObstacle() const
Returns whether the position is marked as conflicting with an obstacle feature.
double getX(int i=0) const
Returns the down-left x coordinate.
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)
Must be called when a new render cycle is started.
const QgsLabelObstacleSettings & obstacleSettings() const
Returns the label obstacle settings.
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
~QgsVectorLayerLabelProvider() override
const QgsMapSettings & mapSettings() const
Gets associated map settings.
bool enabled() const
Returns whether the background is enabled.
bool testFlag(Flag f) const
Test whether a particular flag is enabled.
int maskId(const QString &labelLayerId=QString(), const QString &labelRuleId=QString()) const
Returns the mask id associated with a label layer and its optional label rule.
QgsLabelingResults * results() const
For internal use by the providers.
virtual void stopRender(QgsRenderContext &context)
Must be called when a render cycle has finished, to allow the renderer to clean up.
QString mProviderId
Associated provider ID (one layer may have multiple providers, e.g. in rule-based labeling) ...
LabelPosition is a candidate feature label position.
virtual void startRender(QgsRenderContext &context)
To be called before rendering of labels begins.
bool enabled() const
Returns whether the buffer is enabled.
QgsPalLayerSettings::UpsideDownLabels mUpsidedownLabels
How to handle labels that would be upside down.
void setShadowPlacement(QgsTextShadowSettings::ShadowPlacement placement)
Sets the placement for the drop shadow.
QString providerId() const
Returns provider ID - useful in case there is more than one label provider within a layer (e...
Draw shadow under background shape.
void startRender(QgsRenderContext &context)
Prepares the label settings for rendering.
QgsCallout * callout() const
Returns the label callout renderer, responsible for drawing label callouts.
Whether the labels should be rendered.
QgsWkbTypes::GeometryType type
Custom exception class for Coordinate Reference System related exceptions.
ObstacleType type() const
Returns how features act as obstacles for labels.
QgsExpressionContextScope * popScope()
Removes the last scope from the expression context and return it.
bool nextFeature(QgsFeature &f)
void drawLabelBackground(QgsRenderContext &context, pal::LabelPosition *label) const override
Draw the background for the specified label.
void startRender(QgsRenderContext &context) override
To be called before rendering of labels begins.
Container for all settings relating to text rendering.
QFontMetricsF * labelFontMetrics()
Metrics of the font for rendering.
bool centroidInside
true if centroid positioned labels must be placed inside their corresponding feature polygon...
virtual void stopRender(QgsRenderContext &context)
To be called after rendering is complete.
virtual QgsPoint vertexAt(QgsVertexId id) const =0
Returns the point corresponding to a specified vertex id.
virtual int nCoordinates() const
Returns the number of nodes contained in the geometry.
Represents a vector layer which manages a vector based data sets.
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for the context.
QString mLayerId
Associated layer's ID, if applicable.
bool labelAllParts() const
Returns true if all parts of the feature should be labeled.
QFont font() const
Returns the font used for rendering text.
bool prepare(QgsRenderContext &context, QSet< QString > &attributeNames, const QgsFields &fields, const QgsMapSettings &mapSettings, const QgsCoordinateReferenceSystem &crs)
Prepare for registration of features.
int priority
Label priority.
QgsFeatureRenderer * mRenderer
QgsPointXY toMapCoordinates(int x, int y) const
Transform device coordinates to map (world) coordinates.
void drawLabel(QgsRenderContext &context, pal::LabelPosition *label) const override
Draw this label at the position determined by the labeling engine.
void drawLabelPrivate(pal::LabelPosition *label, QgsRenderContext &context, QgsPalLayerSettings &tmpLyr, QgsTextRenderer::TextPart drawType, double dpiRatio=1.0) const
Internal label drawing method.
bool useMaxLineLengthForAutoWrap
If true, indicates that when auto wrapping label text the autoWrapLength length indicates the maximum...
static QStringList splitToLines(const QString &text, const QString &wrapCharacter, int autoWrapLength=0, bool useMaxLineLengthWhenAutoWrapping=true)
Splits a text string to a list of separate lines, using a specified wrap character (wrapCharacter)...
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the label's property collection, used for data defined overrides.
const QgsMaskIdProvider * maskIdProvider() const
Returns the mask id provider attached to the context.
static QgsGeometry getPointObstacleGeometry(QgsFeature &fet, QgsRenderContext &context, const QgsSymbolList &symbols)
Returns the geometry for a point feature which should be used as an obstacle for labels.
void stopRender(QgsRenderContext &context)
Finalises the label settings after use.
DirectionSymbols placeDirectionSymbol
Placement option for direction symbols.
void drawUnplacedLabel(QgsRenderContext &context, pal::LabelPosition *label) const override
Draw an unplaced label.