QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
qgsannotationpolygonitem.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsannotationpolygonitem.cpp
3 ----------------
4 begin : July 2020
5 copyright : (C) 2020 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
19
22#include "qgscurve.h"
23#include "qgscurvepolygon.h"
24#include "qgsfillsymbol.h"
25#include "qgspolygon.h"
26#include "qgssymbol.h"
27#include "qgssymbollayerutils.h"
28
31 , mPolygon( polygon )
32 , mSymbol( std::make_unique< QgsFillSymbol >() )
33{
34
35}
36
38
40{
41 return QStringLiteral( "polygon" );
42}
43
45{
46
47 auto transformRing = [&context]( QPolygonF & pts )
48 {
49 //transform the QPolygonF to screen coordinates
50 if ( context.coordinateTransform().isValid() )
51 {
52 try
53 {
55 }
56 catch ( QgsCsException & )
57 {
58 // we don't abort the rendering here, instead we remove any invalid points and just plot those which ARE valid
59 }
60 }
61
62 // remove non-finite points, e.g. infinite or NaN points caused by reprojecting errors
63 pts.erase( std::remove_if( pts.begin(), pts.end(),
64 []( const QPointF point )
65 {
66 return !std::isfinite( point.x() ) || !std::isfinite( point.y() );
67 } ), pts.end() );
68
69 QPointF *ptr = pts.data();
70 for ( int i = 0; i < pts.size(); ++i, ++ptr )
71 {
72 context.mapToPixel().transformInPlace( ptr->rx(), ptr->ry() );
73 }
74 };
75
76 QPolygonF exterior = mPolygon->exteriorRing()->asQPolygonF();
77 transformRing( exterior );
78 QVector<QPolygonF> rings;
79 rings.reserve( mPolygon->numInteriorRings() );
80 for ( int i = 0; i < mPolygon->numInteriorRings(); ++i )
81 {
82 QPolygonF ring = mPolygon->interiorRing( i )->asQPolygonF();
83 transformRing( ring );
84 rings.append( ring );
85 }
86
87 mSymbol->startRender( context );
88 mSymbol->renderPolygon( exterior, rings.empty() ? nullptr : &rings, nullptr, context );
89 mSymbol->stopRender( context );
90}
91
92bool QgsAnnotationPolygonItem::writeXml( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const
93{
94 element.setAttribute( QStringLiteral( "wkt" ), mPolygon->asWkt() );
95 element.appendChild( QgsSymbolLayerUtils::saveSymbol( QStringLiteral( "lineSymbol" ), mSymbol.get(), document, context ) );
96
97 writeCommonProperties( element, document, context );
98 return true;
99}
100
101QList<QgsAnnotationItemNode> QgsAnnotationPolygonItem::nodesV2( const QgsAnnotationItemEditContext & ) const
102{
103 QList< QgsAnnotationItemNode > res;
104
105 auto processRing = [&res]( const QgsCurve * ring, int ringId )
106 {
107 // we don't want a duplicate node for the closed ring vertex
108 const int count = ring->isClosed() ? ring->numPoints() - 1 : ring->numPoints();
109 res.reserve( res.size() + count );
110 for ( int i = 0; i < count; ++i )
111 {
112 res << QgsAnnotationItemNode( QgsVertexId( 0, ringId, i ), QgsPointXY( ring->xAt( i ), ring->yAt( i ) ), Qgis::AnnotationItemNodeType::VertexHandle );
113 }
114 };
115
116 if ( const QgsCurve *ring = mPolygon->exteriorRing() )
117 {
118 processRing( ring, 0 );
119 }
120 for ( int i = 0; i < mPolygon->numInteriorRings(); ++i )
121 {
122 processRing( mPolygon->interiorRing( i ), i + 1 );
123 }
124
125 return res;
126}
127
129{
130 switch ( operation->type() )
131 {
133 {
134 QgsAnnotationItemEditOperationMoveNode *moveOperation = qgis::down_cast< QgsAnnotationItemEditOperationMoveNode * >( operation );
135 if ( mPolygon->moveVertex( moveOperation->nodeId(), QgsPoint( moveOperation->after() ) ) )
137 break;
138 }
139
141 {
142 QgsAnnotationItemEditOperationDeleteNode *deleteOperation = qgis::down_cast< QgsAnnotationItemEditOperationDeleteNode * >( operation );
143 if ( mPolygon->deleteVertex( deleteOperation->nodeId() ) )
145 break;
146 }
147
149 {
150 QgsAnnotationItemEditOperationAddNode *addOperation = qgis::down_cast< QgsAnnotationItemEditOperationAddNode * >( operation );
151
152 QgsPoint segmentPoint;
153 QgsVertexId endOfSegmentVertex;
154 mPolygon->closestSegment( addOperation->point(), segmentPoint, endOfSegmentVertex );
155 if ( mPolygon->insertVertex( endOfSegmentVertex, segmentPoint ) )
157 break;
158 }
159
161 {
162 QgsAnnotationItemEditOperationTranslateItem *moveOperation = qgis::down_cast< QgsAnnotationItemEditOperationTranslateItem * >( operation );
163 const QTransform transform = QTransform::fromTranslate( moveOperation->translationX(), moveOperation->translationY() );
164 mPolygon->transform( transform );
166 }
167 }
168
170}
171
173{
174 switch ( operation->type() )
175 {
177 {
178 QgsAnnotationItemEditOperationMoveNode *moveOperation = qgis::down_cast< QgsAnnotationItemEditOperationMoveNode * >( operation );
179 std::unique_ptr< QgsCurvePolygon > modifiedPolygon( mPolygon->clone() );
180 if ( modifiedPolygon->moveVertex( moveOperation->nodeId(), QgsPoint( moveOperation->after() ) ) )
181 {
182 return new QgsAnnotationItemEditOperationTransientResults( QgsGeometry( std::move( modifiedPolygon ) ) );
183 }
184 break;
185 }
186
188 {
189 QgsAnnotationItemEditOperationTranslateItem *moveOperation = qgis::down_cast< QgsAnnotationItemEditOperationTranslateItem * >( operation );
190 const QTransform transform = QTransform::fromTranslate( moveOperation->translationX(), moveOperation->translationY() );
191 std::unique_ptr< QgsCurvePolygon > modifiedPolygon( mPolygon->clone() );
192 modifiedPolygon->transform( transform );
193 return new QgsAnnotationItemEditOperationTransientResults( QgsGeometry( std::move( modifiedPolygon ) ) );
194 }
195
198 break;
199 }
200 return nullptr;
201}
202
207
212
213bool QgsAnnotationPolygonItem::readXml( const QDomElement &element, const QgsReadWriteContext &context )
214{
215 const QString wkt = element.attribute( QStringLiteral( "wkt" ) );
217 if ( const QgsCurvePolygon *polygon = qgsgeometry_cast< const QgsCurvePolygon * >( geometry.constGet() ) )
218 mPolygon.reset( polygon->clone() );
219
220 const QDomElement symbolElem = element.firstChildElement( QStringLiteral( "symbol" ) );
221 if ( !symbolElem.isNull() )
222 setSymbol( QgsSymbolLayerUtils::loadSymbol< QgsFillSymbol >( symbolElem, context ).release() );
223
224 readCommonProperties( element, context );
225 return true;
226}
227
229{
230 auto item = std::make_unique< QgsAnnotationPolygonItem >( mPolygon->clone() );
231 item->setSymbol( mSymbol->clone() );
232 item->copyCommonProperties( this );;
233 return item.release();
234}
235
237{
238 return mPolygon->boundingBox();
239}
240
245
247{
248 return mSymbol.get();
249}
250
252{
253 mSymbol.reset( symbol );
254}
@ VertexHandle
Node is a handle for manipulating vertices.
Definition qgis.h:2508
@ SupportsReferenceScale
Item supports reference scale based rendering.
Definition qgis.h:2466
AnnotationItemEditOperationResult
Results from an edit operation on an annotation item.
Definition qgis.h:2519
@ Invalid
Operation has invalid parameters for the item, no change occurred.
Definition qgis.h:2521
@ Success
Item was modified successfully.
Definition qgis.h:2520
@ ItemCleared
The operation results in the item being cleared, and the item should be removed from the layer as a r...
Definition qgis.h:2522
QFlags< AnnotationItemFlag > AnnotationItemFlags
Annotation item flags.
Definition qgis.h:2470
Abstract base class for annotation item edit operations.
virtual Type type() const =0
Returns the operation type.
Encapsulates the context for an annotation item edit operation.
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.
virtual bool writeCommonProperties(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
Writes common properties from the base class into an XML element.
virtual bool readCommonProperties(const QDomElement &element, const QgsReadWriteContext &context)
Reads common properties from the base class from the given DOM element.
Qgis::AnnotationItemEditOperationResult applyEditV2(QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context) override
Applies an edit operation to the item.
bool readXml(const QDomElement &element, const QgsReadWriteContext &context) override
Reads the item's state from the given DOM element.
void render(QgsRenderContext &context, QgsFeedback *feedback) override
Renders the item to the specified render context.
const QgsCurvePolygon * geometry() const
Returns the geometry of the item.
void setSymbol(QgsFillSymbol *symbol)
Sets the symbol used to render the polygon item.
const QgsFillSymbol * symbol() const
Returns the symbol used to render the item.
QgsRectangle boundingBox() const override
Returns the bounding box of the item's geographic location, in the parent layer's coordinate referenc...
QString type() const override
Returns a unique (untranslated) string identifying the type of item.
bool writeXml(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
Writes the item's state into an XML element.
void setGeometry(QgsCurvePolygon *geometry)
Sets the geometry of the item.
Qgis::AnnotationItemFlags flags() const override
Returns item flags.
QgsAnnotationPolygonItem * clone() const override
Returns a clone of the item.
QList< QgsAnnotationItemNode > nodesV2(const QgsAnnotationItemEditContext &context) const override
Returns the nodes for the item, used for editing the item.
~QgsAnnotationPolygonItem() override
static QgsAnnotationPolygonItem * create()
Creates a new polygon annotation item.
QgsAnnotationPolygonItem(QgsCurvePolygon *polygon)
Constructor for QgsAnnotationPolygonItem, with the specified polygon geometry.
QgsAnnotationItemEditOperationTransientResults * transientEditResultsV2(QgsAbstractAnnotationItemEditOperation *operation, const QgsAnnotationItemEditContext &context) override
Retrieves the results of a transient (in progress) edit operation on the item.
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.
Curve polygon geometry type.
Abstract base class for curved geometry type.
Definition qgscurve.h:36
virtual int numPoints() const =0
Returns the number of points in the curve.
virtual bool isClosed() const
Returns true if the curve is closed.
Definition qgscurve.cpp:54
virtual double xAt(int index) const =0
Returns the x-coordinate of the specified node in the line string.
virtual double yAt(int index) const =0
Returns the y-coordinate of the specified node in the line string.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
A geometry is the spatial representation of a feature.
static Q_INVOKABLE QgsGeometry fromWkt(const QString &wkt)
Creates a new geometry from a WKT string.
void transformInPlace(double &x, double &y) const
Transforms map coordinates to device coordinates.
Represents a 2D point.
Definition qgspointxy.h:60
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
Polygon geometry type.
Definition qgspolygon.h:33
A container for the context for various read/write operations on objects.
A rectangle specified with double values.
Contains information about the context of a rendering operation.
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.
static std::unique_ptr< QgsSymbol > loadSymbol(const QDomElement &element, const QgsReadWriteContext &context)
Attempts to load a symbol from a DOM element.
static QDomElement saveSymbol(const QString &symbolName, const QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context)
Writes a symbol definition to XML.
T qgsgeometry_cast(QgsAbstractGeometry *geom)
Utility class for identifying a unique vertex within a geometry.
Definition qgsvertexid.h:30