QGIS API Documentation 3.37.0-Master (49cede7946b)
Loading...
Searching...
No Matches
qgsannotationlinetextitem.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsannotationlinetextitem.cpp
3 ----------------
4 begin : March 2023
5 copyright : (C) 2023 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
21#include "qgsrendercontext.h"
22#include "qgscurve.h"
23#include "qgslinestring.h"
24#include "qgstextrenderer.h"
25#include "qgsunittypes.h"
26#include "qgssymbollayerutils.h"
27
30 , mText( text )
31 , mCurve( curve )
32{
33
34}
35
37{
38 // in truth this should depend on whether the text format is scale dependent or not!
40}
41
43
45{
46 return QStringLiteral( "linetext" );
47}
48
50{
51 // TODO -- expose as an option!
52 QgsGeometry smoothed( mCurve->clone() );
53 smoothed = smoothed.smooth( );
54
55 QPolygonF pts = smoothed.asQPolygonF();
56
57 //transform the QPolygonF to screen coordinates
58 if ( context.coordinateTransform().isValid() )
59 {
60 try
61 {
63 }
64 catch ( QgsCsException & )
65 {
66 // we don't abort the rendering here, instead we remove any invalid points and just plot those which ARE valid
67 }
68 }
69
70 // remove non-finite points, e.g. infinite or NaN points caused by reprojecting errors
71 pts.erase( std::remove_if( pts.begin(), pts.end(),
72 []( const QPointF point )
73 {
74 return !std::isfinite( point.x() ) || !std::isfinite( point.y() );
75 } ), pts.end() );
76
77 QPointF *ptr = pts.data();
78 for ( int i = 0; i < pts.size(); ++i, ++ptr )
79 {
80 context.mapToPixel().transformInPlace( ptr->rx(), ptr->ry() );
81 }
82
83 const QString displayText = QgsExpression::replaceExpressionText( mText, &context.expressionContext(), &context.distanceArea() );
84
85 const double offsetFromLine = context.convertToPainterUnits( mOffsetFromLineDistance, mOffsetFromLineUnit, mOffsetFromLineScale );
86
87 QgsTextRenderer::drawTextOnLine( pts, displayText, context, mTextFormat, 0, offsetFromLine );
88}
89
90bool QgsAnnotationLineTextItem::writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const
91{
92 element.setAttribute( QStringLiteral( "wkt" ), mCurve->asWkt() );
93 element.setAttribute( QStringLiteral( "text" ), mText );
94
95 element.setAttribute( QStringLiteral( "offsetFromLine" ), qgsDoubleToString( mOffsetFromLineDistance ) );
96 element.setAttribute( QStringLiteral( "offsetFromLineUnit" ), QgsUnitTypes::encodeUnit( mOffsetFromLineUnit ) );
97 element.setAttribute( QStringLiteral( "offsetFromLineScale" ), QgsSymbolLayerUtils::encodeMapUnitScale( mOffsetFromLineScale ) );
98
99 QDomElement textFormatElem = document.createElement( QStringLiteral( "lineTextFormat" ) );
100 textFormatElem.appendChild( mTextFormat.writeXml( document, context ) );
101 element.appendChild( textFormatElem );
102
103 writeCommonProperties( element, document, context );
104
105 return true;
106}
107
108QList<QgsAnnotationItemNode> QgsAnnotationLineTextItem::nodes() const
109{
110 QList< QgsAnnotationItemNode > res;
111 int i = 0;
112 for ( auto it = mCurve->vertices_begin(); it != mCurve->vertices_end(); ++it, ++i )
113 {
114 res.append( QgsAnnotationItemNode( it.vertexId(), QgsPointXY( ( *it ).x(), ( *it ).y() ), Qgis::AnnotationItemNodeType::VertexHandle ) );
115 }
116 return res;
117}
118
120{
121 switch ( operation->type() )
122 {
124 {
125 QgsAnnotationItemEditOperationMoveNode *moveOperation = qgis::down_cast< QgsAnnotationItemEditOperationMoveNode * >( operation );
126 if ( mCurve->moveVertex( moveOperation->nodeId(), QgsPoint( moveOperation->after() ) ) )
128 break;
129 }
130
132 {
133 QgsAnnotationItemEditOperationDeleteNode *deleteOperation = qgis::down_cast< QgsAnnotationItemEditOperationDeleteNode * >( operation );
134 if ( mCurve->deleteVertex( deleteOperation->nodeId() ) )
136 break;
137 }
138
140 {
141 QgsAnnotationItemEditOperationAddNode *addOperation = qgis::down_cast< QgsAnnotationItemEditOperationAddNode * >( operation );
142
143 QgsPoint segmentPoint;
144 QgsVertexId endOfSegmentVertex;
145 mCurve->closestSegment( addOperation->point(), segmentPoint, endOfSegmentVertex );
146 if ( mCurve->insertVertex( endOfSegmentVertex, segmentPoint ) )
148 break;
149 }
150
152 {
153 QgsAnnotationItemEditOperationTranslateItem *moveOperation = qgis::down_cast< QgsAnnotationItemEditOperationTranslateItem * >( operation );
154 const QTransform transform = QTransform::fromTranslate( moveOperation->translationX(), moveOperation->translationY() );
155 mCurve->transform( transform );
157 }
158 }
159
161}
162
164{
165 switch ( operation->type() )
166 {
168 {
169 QgsAnnotationItemEditOperationMoveNode *moveOperation = dynamic_cast< QgsAnnotationItemEditOperationMoveNode * >( operation );
170 std::unique_ptr< QgsCurve > modifiedCurve( mCurve->clone() );
171 if ( modifiedCurve->moveVertex( moveOperation->nodeId(), QgsPoint( moveOperation->after() ) ) )
172 {
173 return new QgsAnnotationItemEditOperationTransientResults( QgsGeometry( std::move( modifiedCurve ) ) );
174 }
175 break;
176 }
177
179 {
180 QgsAnnotationItemEditOperationTranslateItem *moveOperation = qgis::down_cast< QgsAnnotationItemEditOperationTranslateItem * >( operation );
181 const QTransform transform = QTransform::fromTranslate( moveOperation->translationX(), moveOperation->translationY() );
182 std::unique_ptr< QgsCurve > modifiedCurve( mCurve->clone() );
183 modifiedCurve->transform( transform );
184 return new QgsAnnotationItemEditOperationTransientResults( QgsGeometry( std::move( modifiedCurve ) ) );
185 }
186
189 break;
190 }
191 return nullptr;
192}
193
198
199bool QgsAnnotationLineTextItem::readXml( const QDomElement &element, const QgsReadWriteContext &context )
200{
201 const QString wkt = element.attribute( QStringLiteral( "wkt" ) );
203 if ( const QgsCurve *curve = qgsgeometry_cast< const QgsCurve * >( geometry.constGet() ) )
204 mCurve.reset( curve->clone() );
205
206 mText = element.attribute( QStringLiteral( "text" ) );
207 const QDomElement textFormatElem = element.firstChildElement( QStringLiteral( "lineTextFormat" ) );
208 if ( !textFormatElem.isNull() )
209 {
210 const QDomNodeList textFormatNodeList = textFormatElem.elementsByTagName( QStringLiteral( "text-style" ) );
211 const QDomElement textFormatElem = textFormatNodeList.at( 0 ).toElement();
212 mTextFormat.readXml( textFormatElem, context );
213 }
214
215 mOffsetFromLineDistance = element.attribute( QStringLiteral( "offsetFromLine" ) ).toDouble();
216 bool ok = false;
217 mOffsetFromLineUnit = QgsUnitTypes::decodeRenderUnit( element.attribute( QStringLiteral( "offsetFromLineUnit" ) ), &ok );
218 if ( !ok )
219 mOffsetFromLineUnit = Qgis::RenderUnit::Millimeters;
220
221 mOffsetFromLineScale = QgsSymbolLayerUtils::decodeMapUnitScale( element.attribute( QStringLiteral( "offsetFromLineScale" ) ) );
222
223 readCommonProperties( element, context );
224
225 return true;
226}
227
229{
230 return mCurve->boundingBox();
231}
232
234{
235 const QString displayText = QgsExpression::replaceExpressionText( mText, &context.expressionContext(), &context.distanceArea() );
236
237 const double lineOffsetInMapUnits = std::fabs( context.convertToMapUnits( mOffsetFromLineDistance, mOffsetFromLineUnit, mOffsetFromLineScale ) );
238
239 const double heightInPixels = QgsTextRenderer::textHeight( context, mTextFormat, { displayText} );
240
241 // text size has already been calculated using any symbology reference scale factor above -- we need
242 // to temporarily remove the reference scale here or we'll be undoing the scaling
243 QgsScopedRenderContextReferenceScaleOverride resetScaleFactor( context, -1.0 );
244 const double heightInMapUnits = context.convertToMapUnits( heightInPixels, Qgis::RenderUnit::Pixels );
245
246 return mCurve->boundingBox().buffered( heightInMapUnits + lineOffsetInMapUnits );
247}
248
250{
251 std::unique_ptr< QgsAnnotationLineTextItem > item = std::make_unique< QgsAnnotationLineTextItem >( mText, mCurve->clone() );
252 item->setFormat( mTextFormat );
253 item->setOffsetFromLine( mOffsetFromLineDistance );
254 item->setOffsetFromLineUnit( mOffsetFromLineUnit );
255 item->setOffsetFromLineMapUnitScale( mOffsetFromLineScale );
256 item->copyCommonProperties( this );
257 return item.release();
258}
259
261{
262 mCurve.reset( geometry );
263}
264
266{
267 return mTextFormat;
268}
269
271{
272 mTextFormat = format;
273}
@ VertexHandle
Node is a handle for manipulating vertices.
@ ScaleDependentBoundingBox
Item's bounding box will vary depending on map scale.
AnnotationItemEditOperationResult
Results from an edit operation on an annotation item.
Definition qgis.h:2135
@ Invalid
Operation has invalid parameters for the item, no change occurred.
@ Success
Item was modified successfully.
@ ItemCleared
The operation results in the item being cleared, and the item should be removed from the layer as a r...
QFlags< AnnotationItemFlag > AnnotationItemFlags
Annotation item flags.
Definition qgis.h:2100
@ Millimeters
Millimeters.
Abstract base class for annotation item edit operations.
@ TranslateItem
Translate (move) an item.
virtual Type type() const =0
Returns the operation type.
Annotation item edit operation consisting of adding a node.
QgsPoint point() const
Returns the node position (in layer coordinates).
Annotation item edit operation consisting of deleting a node.
QgsVertexId nodeId() const
Returns the deleted node ID.
Annotation item edit operation consisting of moving a node.
QgsPoint after() const
Returns the node position after the move occurred (in layer coordinates).
QgsVertexId nodeId() const
Returns the associated node ID.
Encapsulates the transient results of an in-progress annotation edit operation.
Annotation item edit operation consisting of translating (moving) an item.
double translationY() const
Returns the y-axis translation, in layer units.
double translationX() const
Returns the x-axis translation, in layer units.
Contains information about a node used for editing an annotation item.
Abstract base class for annotation items which are drawn with QgsAnnotationLayers.
bool writeCommonProperties(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
Writes common properties from the base class into an XML element.
bool readCommonProperties(const QDomElement &element, const QgsReadWriteContext &context)
Reads common properties from the base class from the given DOM element.
An annotation item which renders text along a line geometry.
double offsetFromLine() const
Returns the offset distance from the line geometry() to the text's baseline.
void setGeometry(QgsCurve *geometry)
Sets the geometry of the item.
void render(QgsRenderContext &context, QgsFeedback *feedback) override
Renders the item to the specified render context.
QgsRectangle boundingBox() const override
Returns the bounding box of the item's geographic location, in the parent layer's coordinate referenc...
const QgsCurve * geometry() const
Returns the geometry of the item.
QList< QgsAnnotationItemNode > nodes() const override
Returns the nodes for the item, used for editing the item.
QString type() const override
Returns a unique (untranslated) string identifying the type of item.
static QgsAnnotationLineTextItem * create()
Creates a new linestring annotation item.
QgsAnnotationLineTextItem * clone() const override
Returns a clone of the item.
QgsAnnotationLineTextItem(const QString &text, QgsCurve *curve)
Constructor for QgsAnnotationLineTextItem, with the specified curve and text.
bool writeXml(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
Writes the item's state into an XML element.
~QgsAnnotationLineTextItem() override
Qgis::AnnotationItemEditOperationResult applyEdit(QgsAbstractAnnotationItemEditOperation *operation) override
Applies an edit operation to the item.
Qgis::AnnotationItemFlags flags() const override
Returns item flags.
void setFormat(const QgsTextFormat &format)
Sets the text format used to render the text.
QgsTextFormat format() const
Returns the text format used to render the text.
QgsAnnotationItemEditOperationTransientResults * transientEditResults(QgsAbstractAnnotationItemEditOperation *operation) override
Retrieves the results of a transient (in progress) edit operation on the item.
bool readXml(const QDomElement &element, const QgsReadWriteContext &context) override
Reads the item's state from the given DOM element.
void transformPolygon(QPolygonF &polygon, Qgis::TransformDirection direction=Qgis::TransformDirection::Forward) const
Transforms a polygon to the destination coordinate system.
bool isValid() const
Returns true if the coordinate transform is valid, ie both the source and destination CRS have been s...
Custom exception class for Coordinate Reference System related exceptions.
Abstract base class for curved geometry type.
Definition qgscurve.h:35
static QString replaceExpressionText(const QString &action, const QgsExpressionContext *context, const QgsDistanceArea *distanceArea=nullptr)
This function replaces each expression between [% and %] in the string with the result of its evaluat...
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
A geometry is the spatial representation of a feature.
QPolygonF asQPolygonF() const
Returns contents of the geometry as a QPolygonF.
static Q_INVOKABLE QgsGeometry fromWkt(const QString &wkt)
Creates a new geometry from a WKT string.
QgsGeometry smooth(unsigned int iterations=1, double offset=0.25, double minimumDistance=-1.0, double maxAngle=180.0) const
Smooths a geometry by rounding off corners using the Chaikin algorithm.
Line string geometry type, with support for z-dimension and m-values.
void transformInPlace(double &x, double &y) const
Transforms device coordinates to map coordinates.
A class to represent a 2D point.
Definition qgspointxy.h:60
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
Contains information about the context of a rendering operation.
double convertToMapUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
Converts a size from the specified units to map units.
double convertToPainterUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
const QgsDistanceArea & distanceArea() const
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
QgsExpressionContext & expressionContext()
Gets the expression context.
const QgsMapToPixel & mapToPixel() const
Returns the context's map to pixel transform, which transforms between map coordinates and device coo...
QgsCoordinateTransform coordinateTransform() const
Returns the current coordinate transform for the context.
Scoped object for temporary override of the symbologyReferenceScale property of a QgsRenderContext.
static QString encodeMapUnitScale(const QgsMapUnitScale &mapUnitScale)
static QgsMapUnitScale decodeMapUnitScale(const QString &str)
Container for all settings relating to text rendering.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Read settings from a DOM element.
QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const
Write settings into a DOM element.
static void drawTextOnLine(const QPolygonF &line, const QString &text, QgsRenderContext &context, const QgsTextFormat &format, double offsetAlongLine=0, double offsetFromLine=0)
Draws text along a line using the specified settings.
static double textHeight(const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines, Qgis::TextLayoutMode mode=Qgis::TextLayoutMode::Point, QFontMetricsF *fontMetrics=nullptr, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags(), double maxLineWidth=0)
Returns the height of a text based on a given format.
static Q_INVOKABLE Qgis::RenderUnit decodeRenderUnit(const QString &string, bool *ok=nullptr)
Decodes a render unit from a string.
static Q_INVOKABLE QString encodeUnit(Qgis::DistanceUnit unit)
Encodes a distance unit to a string.
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Definition qgis.h:5362
Utility class for identifying a unique vertex within a geometry.
Definition qgsvertexid.h:30