QGIS API Documentation 3.27.0-Master (c6eca784ad)
qgsgeos.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsgeos.h
3 -------------------------------------------------------------------
4Date : 22 Sept 2014
5Copyright : (C) 2014 by Marco Hugentobler
6email : marco.hugentobler at sourcepole 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
16#ifndef QGSGEOS_H
17#define QGSGEOS_H
18
19#define SIP_NO_FILE
20
21#include "qgis_core.h"
22#include "qgsgeometryengine.h"
23#include "qgsgeometry.h"
24#include <geos_c.h>
25
26class QgsLineString;
27class QgsPolygon;
28class QgsGeometry;
30
36namespace geos
37{
38
44 {
45
50 void CORE_EXPORT operator()( GEOSGeometry *geom ) const;
51
56 void CORE_EXPORT operator()( const GEOSPreparedGeometry *geom ) const;
57
62 void CORE_EXPORT operator()( GEOSBufferParams *params ) const;
63
68 void CORE_EXPORT operator()( GEOSCoordSequence *sequence ) const;
69 };
70
74 using unique_ptr = std::unique_ptr< GEOSGeometry, GeosDeleter>;
75
79 using prepared_unique_ptr = std::unique_ptr< const GEOSPreparedGeometry, GeosDeleter>;
80
84 using buffer_params_unique_ptr = std::unique_ptr< GEOSBufferParams, GeosDeleter>;
85
89 using coord_sequence_unique_ptr = std::unique_ptr< GEOSCoordSequence, GeosDeleter>;
90
91}
92
98class CORE_EXPORT QgsGeos: public QgsGeometryEngine
99{
100 public:
101
107 QgsGeos( const QgsAbstractGeometry *geometry, double precision = 0 );
108
113 static QgsGeometry geometryFromGeos( GEOSGeometry *geos );
114
118 static QgsGeometry geometryFromGeos( const geos::unique_ptr &geos );
119
128 std::unique_ptr< QgsAbstractGeometry > makeValid( Qgis::MakeValidMethod method = Qgis::MakeValidMethod::Linework, bool keepCollapsed = false, QString *errorMsg = nullptr ) const;
129
136 static Qgis::GeometryOperationResult addPart( QgsGeometry &geometry, GEOSGeometry *newPart );
137
138 void geometryChanged() override;
139 void prepareGeometry() override;
140
141 QgsAbstractGeometry *intersection( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr, const QgsGeometryParameters &parameters = QgsGeometryParameters() ) const override;
142 QgsAbstractGeometry *difference( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr, const QgsGeometryParameters &parameters = QgsGeometryParameters() ) const override;
143
148 std::unique_ptr< QgsAbstractGeometry > clip( const QgsRectangle &rectangle, QString *errorMsg = nullptr ) const;
149
168 std::unique_ptr< QgsAbstractGeometry > subdivide( int maxNodes, QString *errorMsg = nullptr, const QgsGeometryParameters &parameters = QgsGeometryParameters() ) const;
169
170 QgsAbstractGeometry *combine( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr, const QgsGeometryParameters &parameters = QgsGeometryParameters() ) const override;
171 QgsAbstractGeometry *combine( const QVector<QgsAbstractGeometry *> &geomList, QString *errorMsg, const QgsGeometryParameters &parameters = QgsGeometryParameters() ) const override;
172 QgsAbstractGeometry *combine( const QVector< QgsGeometry > &, QString *errorMsg = nullptr, const QgsGeometryParameters &parameters = QgsGeometryParameters() ) const override;
173 QgsAbstractGeometry *symDifference( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr, const QgsGeometryParameters &parameters = QgsGeometryParameters() ) const override;
174 QgsAbstractGeometry *buffer( double distance, int segments, QString *errorMsg = nullptr ) const override;
175 QgsAbstractGeometry *buffer( double distance, int segments, Qgis::EndCapStyle endCapStyle, Qgis::JoinStyle joinStyle, double miterLimit, QString *errorMsg = nullptr ) const override;
176 QgsAbstractGeometry *simplify( double tolerance, QString *errorMsg = nullptr ) const override;
177 QgsAbstractGeometry *interpolate( double distance, QString *errorMsg = nullptr ) const override;
178 QgsAbstractGeometry *envelope( QString *errorMsg = nullptr ) const override;
179 QgsPoint *centroid( QString *errorMsg = nullptr ) const override;
180 QgsPoint *pointOnSurface( QString *errorMsg = nullptr ) const override;
181 QgsAbstractGeometry *convexHull( QString *errorMsg = nullptr ) const override;
182 double distance( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
183 bool distanceWithin( const QgsAbstractGeometry *geom, double maxdistance, QString *errorMsg = nullptr ) const override;
184
192 bool contains( double x, double y, QString *errorMsg = nullptr ) const;
193
201 double distance( double x, double y, QString *errorMsg = nullptr ) const;
202
218 double hausdorffDistance( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const;
219
236 double hausdorffDistanceDensify( const QgsAbstractGeometry *geom, double densifyFraction, QString *errorMsg = nullptr ) const;
237
250 double frechetDistance( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const;
251
274 double frechetDistanceDensify( const QgsAbstractGeometry *geom, double densifyFraction, QString *errorMsg = nullptr ) const;
275
276 bool intersects( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
277 bool touches( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
278 bool crosses( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
279 bool within( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
280 bool overlaps( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
281 bool contains( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
282 bool disjoint( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
283 QString relate( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
284 bool relatePattern( const QgsAbstractGeometry *geom, const QString &pattern, QString *errorMsg = nullptr ) const override;
285 double area( QString *errorMsg = nullptr ) const override;
286 double length( QString *errorMsg = nullptr ) const override;
287 bool isValid( QString *errorMsg = nullptr, bool allowSelfTouchingHoles = false, QgsGeometry *errorLoc = nullptr ) const override;
288 bool isEqual( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const override;
289 bool isEmpty( QString *errorMsg = nullptr ) const override;
290 bool isSimple( QString *errorMsg = nullptr ) const override;
291
293 QVector<QgsGeometry> &newGeometries,
294 bool topological,
295 QgsPointSequence &topologyTestPoints,
296 QString *errorMsg = nullptr, bool skipIntersectionCheck = false ) const override;
297
298 QgsAbstractGeometry *offsetCurve( double distance, int segments, Qgis::JoinStyle joinStyle, double miterLimit, QString *errorMsg = nullptr ) const override;
299
313 std::unique_ptr< QgsAbstractGeometry > singleSidedBuffer( double distance, int segments, Qgis::BufferSide side,
314 Qgis::JoinStyle joinStyle, double miterLimit,
315 QString *errorMsg = nullptr ) const;
316
341 std::unique_ptr< QgsAbstractGeometry > maximumInscribedCircle( double tolerance, QString *errorMsg = nullptr ) const;
342
366 std::unique_ptr< QgsAbstractGeometry > largestEmptyCircle( double tolerance, const QgsAbstractGeometry *boundary = nullptr, QString *errorMsg = nullptr ) const;
367
382 std::unique_ptr< QgsAbstractGeometry > minimumWidth( QString *errorMsg = nullptr ) const;
383
405 double minimumClearance( QString *errorMsg = nullptr ) const;
406
418 std::unique_ptr< QgsAbstractGeometry > minimumClearanceLine( QString *errorMsg = nullptr ) const;
419
430 std::unique_ptr< QgsAbstractGeometry > node( QString *errorMsg = nullptr ) const;
431
446 std::unique_ptr< QgsAbstractGeometry > sharedPaths( const QgsAbstractGeometry *other, QString *errorMsg = nullptr ) const;
447
455 std::unique_ptr< QgsAbstractGeometry > reshapeGeometry( const QgsLineString &reshapeWithLine, EngineOperationResult *errorCode, QString *errorMsg = nullptr ) const;
456
466 QgsGeometry mergeLines( QString *errorMsg = nullptr ) const;
467
473 QgsGeometry closestPoint( const QgsGeometry &other, QString *errorMsg = nullptr ) const;
474
480 QgsGeometry shortestLine( const QgsGeometry &other, QString *errorMsg = nullptr ) const;
481
487 QgsGeometry shortestLine( const QgsAbstractGeometry *other, QString *errorMsg = nullptr ) const;
488
499 double lineLocatePoint( const QgsPoint &point, QString *errorMsg = nullptr ) const;
500
513 double lineLocatePoint( double x, double y, QString *errorMsg = nullptr ) const;
514
524 static QgsGeometry polygonize( const QVector<const QgsAbstractGeometry *> &geometries, QString *errorMsg = nullptr );
525
541 QgsGeometry voronoiDiagram( const QgsAbstractGeometry *extent = nullptr, double tolerance = 0.0, bool edgesOnly = false, QString *errorMsg = nullptr ) const;
542
552 QgsGeometry delaunayTriangulation( double tolerance = 0.0, bool edgesOnly = false, QString *errorMsg = nullptr ) const;
553
575 QgsAbstractGeometry *concaveHull( double targetPercent, bool allowHoles = false, QString *errorMsg = nullptr ) const;
576
581 static std::unique_ptr< QgsAbstractGeometry > fromGeos( const GEOSGeometry *geos );
582 static std::unique_ptr< QgsPolygon > fromGeosPolygon( const GEOSGeometry *geos );
583
584
590 static geos::unique_ptr asGeos( const QgsGeometry &geometry, double precision = 0 );
591
597 static geos::unique_ptr asGeos( const QgsAbstractGeometry *geometry, double precision = 0 );
598 static QgsPoint coordSeqPoint( const GEOSCoordSequence *cs, int i, bool hasZ, bool hasM );
599
600 static GEOSContextHandle_t getGEOSHandler();
601
602
603 private:
604 mutable geos::unique_ptr mGeos;
605 geos::prepared_unique_ptr mGeosPrepared;
606 double mPrecision = 0.0;
607
608 enum Overlay
609 {
610 OverlayIntersection,
611 OverlayDifference,
612 OverlayUnion,
613 OverlaySymDifference
614 };
615
616 enum Relation
617 {
618 RelationIntersects,
619 RelationTouches,
620 RelationCrosses,
621 RelationWithin,
622 RelationOverlaps,
623 RelationContains,
624 RelationDisjoint
625 };
626
627 //geos util functions
628 void cacheGeos() const;
629
637 std::unique_ptr< QgsAbstractGeometry > overlay( const QgsAbstractGeometry *geom, Overlay op, QString *errorMsg = nullptr, const QgsGeometryParameters &parameters = QgsGeometryParameters() ) const;
638 bool relation( const QgsAbstractGeometry *geom, Relation r, QString *errorMsg = nullptr ) const;
639 static GEOSCoordSequence *createCoordinateSequence( const QgsCurve *curve, double precision, bool forceClose = false );
640 static std::unique_ptr< QgsLineString > sequenceToLinestring( const GEOSGeometry *geos, bool hasZ, bool hasM );
641 static int numberOfGeometries( GEOSGeometry *g );
642 static geos::unique_ptr nodeGeometries( const GEOSGeometry *splitLine, const GEOSGeometry *geom );
643 int mergeGeometriesMultiTypeSplit( QVector<GEOSGeometry *> &splitResult ) const;
644
648 static geos::unique_ptr createGeosCollection( int typeId, const QVector<GEOSGeometry *> &geoms );
649
650 static geos::unique_ptr createGeosPointXY( double x, double y, bool hasZ, double z, bool hasM, double m, int coordDims, double precision );
651 static geos::unique_ptr createGeosPoint( const QgsAbstractGeometry *point, int coordDims, double precision );
652 static geos::unique_ptr createGeosLinestring( const QgsAbstractGeometry *curve, double precision );
653 static geos::unique_ptr createGeosPolygon( const QgsAbstractGeometry *poly, double precision );
654
655 //utils for geometry split
656 bool topologicalTestPointsSplit( const GEOSGeometry *splitLine, QgsPointSequence &testPoints, QString *errorMsg = nullptr ) const;
657 geos::unique_ptr linePointDifference( GEOSGeometry *GEOSsplitPoint ) const;
658 EngineOperationResult splitLinearGeometry( GEOSGeometry *splitLine, QVector<QgsGeometry > &newGeometries, bool skipIntersectionCheck ) const;
659 EngineOperationResult splitPolygonGeometry( GEOSGeometry *splitLine, QVector<QgsGeometry > &newGeometries, bool skipIntersectionCheck ) const;
660
661 //utils for reshape
662 static geos::unique_ptr reshapeLine( const GEOSGeometry *line, const GEOSGeometry *reshapeLineGeos, double precision );
663 static geos::unique_ptr reshapePolygon( const GEOSGeometry *polygon, const GEOSGeometry *reshapeLineGeos, double precision );
664 static int lineContainedInLine( const GEOSGeometry *line1, const GEOSGeometry *line2 );
665 static int pointContainedInLine( const GEOSGeometry *point, const GEOSGeometry *line );
666 static int geomDigits( const GEOSGeometry *geom );
667 void subdivideRecursive( const GEOSGeometry *currentPart, int maxNodes, int depth, QgsGeometryCollection *parts, const QgsRectangle &clipRect, double gridSize = -1 ) const;
668};
669
671
672
673class GEOSException : public std::runtime_error
674{
675 public:
676 explicit GEOSException( const QString &message )
677 : std::runtime_error( message.toUtf8().constData() )
678 {
679 }
680};
681
683
684#endif // QGSGEOS_H
BufferSide
Side of line to buffer.
Definition: qgis.h:988
GeometryOperationResult
Success or failure of a geometry operation.
Definition: qgis.h:935
JoinStyle
Join styles for buffers.
Definition: qgis.h:1013
EndCapStyle
End cap styles for buffers.
Definition: qgis.h:1000
MakeValidMethod
Algorithms to use when repairing invalid geometries.
Definition: qgis.h:1026
@ Linework
Combines all rings into a set of noded lines and then extracts valid polygons from that linework.
Abstract base class for all geometries.
Abstract base class for curved geometry type.
Definition: qgscurve.h:36
Geometry collection.
A geometry engine is a low-level representation of a QgsAbstractGeometry object, optimised for use wi...
virtual bool isEqual(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Checks if this is equal to geom.
virtual double area(QString *errorMsg=nullptr) const =0
virtual QgsGeometryEngine::EngineOperationResult splitGeometry(const QgsLineString &splitLine, QVector< QgsGeometry > &newGeometries, bool topological, QgsPointSequence &topologyTestPoints, QString *errorMsg=nullptr, bool skipIntersectionCheck=false) const
Splits this geometry according to a given line.
virtual void geometryChanged()=0
Should be called whenever the geometry associated with the engine has been modified and the engine mu...
virtual bool intersects(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Checks if geom intersects this.
virtual QgsAbstractGeometry * symDifference(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr, const QgsGeometryParameters &parameters=QgsGeometryParameters()) const =0
Calculate the symmetric difference of this and geom.
virtual QgsAbstractGeometry * buffer(double distance, int segments, QString *errorMsg=nullptr) const =0
virtual QgsAbstractGeometry * offsetCurve(double distance, int segments, Qgis::JoinStyle joinStyle, double miterLimit, QString *errorMsg=nullptr) const =0
Offsets a curve.
virtual double distance(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Calculates the distance between this and geom.
virtual QgsAbstractGeometry * intersection(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr, const QgsGeometryParameters &parameters=QgsGeometryParameters()) const =0
Calculate the intersection of this and geom.
virtual bool distanceWithin(const QgsAbstractGeometry *geom, double maxdistance, QString *errorMsg=nullptr) const =0
Checks if geom is within maxdistance distance from this geometry.
virtual QgsAbstractGeometry * interpolate(double distance, QString *errorMsg=nullptr) const =0
virtual QgsAbstractGeometry * simplify(double tolerance, QString *errorMsg=nullptr) const =0
virtual bool isValid(QString *errorMsg=nullptr, bool allowSelfTouchingHoles=false, QgsGeometry *errorLoc=nullptr) const =0
Returns true if the geometry is valid.
virtual QgsPoint * pointOnSurface(QString *errorMsg=nullptr) const =0
Calculate a point that is guaranteed to be on the surface of this.
virtual bool touches(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Checks if geom touches this.
virtual QgsAbstractGeometry * envelope(QString *errorMsg=nullptr) const =0
EngineOperationResult
Success or failure of a geometry operation.
virtual bool isEmpty(QString *errorMsg) const =0
virtual bool crosses(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Checks if geom crosses this.
virtual QgsAbstractGeometry * difference(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr, const QgsGeometryParameters &parameters=QgsGeometryParameters()) const =0
Calculate the difference of this and geom.
virtual QString relate(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Returns the Dimensional Extended 9 Intersection Model (DE-9IM) representation of the relationship bet...
virtual bool relatePattern(const QgsAbstractGeometry *geom, const QString &pattern, QString *errorMsg=nullptr) const =0
Tests whether two geometries are related by a specified Dimensional Extended 9 Intersection Model (DE...
virtual bool isSimple(QString *errorMsg=nullptr) const =0
Determines whether the geometry is simple (according to OGC definition).
virtual QgsAbstractGeometry * convexHull(QString *errorMsg=nullptr) const =0
Calculate the convex hull of this.
virtual QgsAbstractGeometry * combine(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr, const QgsGeometryParameters &parameters=QgsGeometryParameters()) const =0
Calculate the combination of this and geom.
virtual bool overlaps(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Checks if geom overlaps this.
virtual bool within(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Checks if geom is within this.
virtual void prepareGeometry()=0
Prepares the geometry, so that subsequent calls to spatial relation methods are much faster.
virtual bool contains(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Checks if geom contains this.
virtual double length(QString *errorMsg=nullptr) const =0
virtual QgsPoint * centroid(QString *errorMsg=nullptr) const =0
Calculates the centroid of this.
virtual bool disjoint(const QgsAbstractGeometry *geom, QString *errorMsg=nullptr) const =0
Checks if geom is disjoint from this.
Encapsulates parameters under which a geometry operation is performed.
Definition: qgsgeometry.h:111
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:164
Does vector analysis using the geos library and handles import, export, exception handling*.
Definition: qgsgeos.h:99
Line string geometry type, with support for z-dimension and m-values.
Definition: qgslinestring.h:45
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:49
Polygon geometry type.
Definition: qgspolygon.h:34
A rectangle specified with double values.
Definition: qgsrectangle.h:42
Contains geos related utilities and functions.
Definition: qgsgeos.h:37
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
std::unique_ptr< GEOSCoordSequence, GeosDeleter > coord_sequence_unique_ptr
Scoped GEOS coordinate sequence pointer.
Definition: qgsgeos.h:89
std::unique_ptr< GEOSBufferParams, GeosDeleter > buffer_params_unique_ptr
Scoped GEOS buffer params pointer.
Definition: qgsgeos.h:84
QVector< QgsPoint > QgsPointSequence
int precision
Destroys the GEOS geometry geom, using the static QGIS geos context.
Definition: qgsgeos.h:44
void CORE_EXPORT operator()(GEOSGeometry *geom) const
Destroys the GEOS geometry geom, using the static QGIS geos context.
void CORE_EXPORT operator()(GEOSBufferParams *params) const
Destroys the GEOS buffer params params, using the static QGIS geos context.
void CORE_EXPORT operator()(GEOSCoordSequence *sequence) const
Destroys the GEOS coordinate sequence sequence, using the static QGIS geos context.
void CORE_EXPORT operator()(const GEOSPreparedGeometry *geom) const
Destroys the GEOS prepared geometry geom, using the static QGIS geos context.