QGIS API Documentation  2.13.0-Master
qgsgeometry.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometry.h - Geometry (stored as Open Geospatial Consortium WKB)
3  -------------------------------------------------------------------
4 Date : 02 May 2005
5 Copyright : (C) 2005 by Brendan Morley
6 email : morb at ozemail dot com dot au
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 QGSGEOMETRY_H
17 #define QGSGEOMETRY_H
18 
19 #include <QString>
20 #include <QVector>
21 #include <QDomDocument>
22 
23 #include "qgis.h"
24 
25 #include <geos_c.h>
26 #include <climits>
27 
28 #if defined(GEOS_VERSION_MAJOR) && (GEOS_VERSION_MAJOR<3)
29 #define GEOSGeometry struct GEOSGeom_t
30 #define GEOSCoordSequence struct GEOSCoordSeq_t
31 #endif
32 
33 #include "qgsabstractgeometryv2.h"
34 #include "qgspoint.h"
35 #include "qgscoordinatetransform.h"
36 #include "qgsfeature.h"
37 #include <limits>
38 #include <QSet>
39 
40 class QgsGeometryEngine;
41 class QgsVectorLayer;
42 class QgsMapToPixel;
43 class QPainter;
45 
48 
51 
54 
57 
60 
61 class QgsRectangle;
62 
63 class QgsConstWkbPtr;
64 
65 struct QgsGeometryPrivate;
66 
76 class CORE_EXPORT QgsGeometry
77 {
78  public:
80  QgsGeometry();
81 
83  QgsGeometry( const QgsGeometry & );
84 
88  QgsGeometry & operator=( QgsGeometry const & rhs );
89 
94  explicit QgsGeometry( QgsAbstractGeometryV2* geom );
95 
97  ~QgsGeometry();
98 
103  QgsAbstractGeometryV2* geometry() const;
104 
109  void setGeometry( QgsAbstractGeometryV2* geometry );
110 
116  bool isEmpty() const;
117 
119  static QgsGeometry* fromWkt( const QString& wkt );
121  static QgsGeometry* fromPoint( const QgsPoint& point );
123  static QgsGeometry* fromMultiPoint( const QgsMultiPoint& multipoint );
125  static QgsGeometry* fromPolyline( const QgsPolyline& polyline );
127  static QgsGeometry* fromMultiPolyline( const QgsMultiPolyline& multiline );
129  static QgsGeometry* fromPolygon( const QgsPolygon& polygon );
131  static QgsGeometry* fromMultiPolygon( const QgsMultiPolygon& multipoly );
133  static QgsGeometry* fromRect( const QgsRectangle& rect );
134 
140  void fromGeos( GEOSGeometry* geos );
141 
146  void fromWkb( unsigned char *wkb, int length );
147 
153  const unsigned char* asWkb() const;
154 
159  int wkbSize() const;
160 
166  const GEOSGeometry* asGeos( double precision = 0 ) const;
167 
171  QGis::WkbType wkbType() const;
172 
176  QGis::GeometryType type() const;
177 
179  bool isMultipart() const;
180 
184  bool isGeosEqual( const QgsGeometry& ) const;
185 
189  bool isGeosValid() const;
190 
194  bool isGeosEmpty() const;
195 
199  double area() const;
200 
204  double length() const;
205 
212  double distance( const QgsGeometry& geom ) const;
213 
218  QgsPoint closestVertex( const QgsPoint& point, int& atVertex, int& beforeVertex, int& afterVertex, double& sqrDist ) const;
219 
232  void adjacentVertices( int atVertex, int& beforeVertex, int& afterVertex ) const;
233 
245  bool insertVertex( double x, double y, int beforeVertex );
246 
253  bool moveVertex( double x, double y, int atVertex );
254 
261  bool moveVertex( const QgsPointV2& p, int atVertex );
262 
273  bool deleteVertex( int atVertex );
274 
280  QgsPoint vertexAt( int atVertex ) const;
281 
287  double sqrDistToVertexAt( QgsPoint& point, int atVertex ) const;
288 
293  QgsGeometry nearestPoint( const QgsGeometry& other ) const;
294 
299  QgsGeometry shortestLine( const QgsGeometry& other ) const;
300 
307  double closestVertexWithContext( const QgsPoint& point, int& atVertex ) const;
308 
319  double closestSegmentWithContext( const QgsPoint& point, QgsPoint& minDistPoint, int& afterVertex, double* leftOf = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
320 
324  int addRing( const QList<QgsPoint>& ring );
325 
329  int addRing( QgsCurveV2* ring );
330 
337  int addPart( const QList<QgsPoint> &points, QGis::GeometryType geomType = QGis::UnknownGeometry );
338 
345  int addPart( const QList<QgsPointV2> &points, QGis::GeometryType geomType = QGis::UnknownGeometry );
346 
353  int addPart( QgsAbstractGeometryV2* part, QGis::GeometryType geomType = QGis::UnknownGeometry );
354 
361  int addPart( GEOSGeometry *newPart );
362 
368  int addPart( const QgsGeometry *newPart );
369 
372  int translate( double dx, double dy );
373 
376  int transform( const QgsCoordinateTransform& ct );
377 
381  int transform( const QTransform& ct );
382 
388  int rotate( double rotation, const QgsPoint& center );
389 
396  int splitGeometry( const QList<QgsPoint>& splitLine,
397  QList<QgsGeometry*>&newGeometries,
398  bool topological,
399  QList<QgsPoint> &topologyTestPoints );
400 
404  int reshapeGeometry( const QList<QgsPoint>& reshapeWithLine );
405 
409  int makeDifference( const QgsGeometry* other );
410 
412  QgsRectangle boundingBox() const;
413 
415  bool intersects( const QgsRectangle& r ) const;
416 
418  bool intersects( const QgsGeometry* geometry ) const;
419 
421  bool contains( const QgsPoint* p ) const;
422 
425  bool contains( const QgsGeometry* geometry ) const;
426 
429  bool disjoint( const QgsGeometry* geometry ) const;
430 
433  bool equals( const QgsGeometry* geometry ) const;
434 
437  bool touches( const QgsGeometry* geometry ) const;
438 
441  bool overlaps( const QgsGeometry* geometry ) const;
442 
445  bool within( const QgsGeometry* geometry ) const;
446 
449  bool crosses( const QgsGeometry* geometry ) const;
450 
453  QgsGeometry* buffer( double distance, int segments ) const;
454 
464  QgsGeometry* buffer( double distance, int segments, int endCapStyle, int joinStyle, double mitreLimit ) const;
465 
471  QgsGeometry* offsetCurve( double distance, int segments, int joinStyle, double mitreLimit ) const;
472 
474  QgsGeometry* simplify( double tolerance ) const;
475 
479  QgsGeometry* centroid() const;
480 
482  QgsGeometry* pointOnSurface() const;
483 
485  QgsGeometry* convexHull() const;
486 
491  QgsGeometry* interpolate( double distance ) const;
492 
494  QgsGeometry* intersection( const QgsGeometry* geometry ) const;
495 
499  QgsGeometry* combine( const QgsGeometry* geometry ) const;
500 
502  QgsGeometry* difference( const QgsGeometry* geometry ) const;
503 
505  QgsGeometry* symDifference( const QgsGeometry* geometry ) const;
506 
508  QgsGeometry extrude( double x, double y );
509 
514  QString exportToWkt( int precision = 17 ) const;
515 
522  QString exportToGeoJSON( int precision = 17 ) const;
523 
530  QgsGeometry* convertToType( QGis::GeometryType destType, bool destMultipart = false ) const;
531 
532  /* Accessor functions for getting geometry data */
533 
536  QgsPoint asPoint() const;
537 
540  QgsPolyline asPolyline() const;
541 
544  QgsPolygon asPolygon() const;
545 
548  QgsMultiPoint asMultiPoint() const;
549 
552  QgsMultiPolyline asMultiPolyline() const;
553 
556  QgsMultiPolygon asMultiPolygon() const;
557 
560  QList<QgsGeometry*> asGeometryCollection() const;
561 
566  QPointF asQPointF() const;
567 
573  QPolygonF asQPolygonF() const;
574 
579  bool deleteRing( int ringNum, int partNum = 0 );
580 
584  bool deletePart( int partNum );
585 
594  bool convertToMultiType();
595 
605  bool convertToSingleType();
606 
615  int avoidIntersections( const QMap<QgsVectorLayer*, QSet<QgsFeatureId> >& ignoreFeatures = ( QMap<QgsVectorLayer*, QSet<QgsFeatureId> >() ) );
616 
617  class Error
618  {
619  QString message;
620  QgsPoint location;
621  bool hasLocation;
622  public:
623  Error() : message( "none" ), hasLocation( false ) {}
624  explicit Error( const QString& m ) : message( m ), hasLocation( false ) {}
625  Error( const QString& m, const QgsPoint& p ) : message( m ), location( p ), hasLocation( true ) {}
626 
627  QString what() { return message; }
628  QgsPoint where() { return location; }
629  bool hasWhere() { return hasLocation; }
630  };
631 
636  void validateGeometry( QList<Error> &errors );
637 
642  static QgsGeometry *unaryUnion( const QList<QgsGeometry*>& geometryList );
643 
648  void convertToStraightSegment();
649 
655  bool requiresConversionToStraightSegments() const;
656 
661  void mapToPixel( const QgsMapToPixel& mtp );
662 
663  // not implemented for 2.10
664  /* Clips the geometry using the specified rectangle
665  * @param rect clip rectangle
666  * @note added in QGIS 2.10
667  */
668  // void clip( const QgsRectangle& rect );
669 
674  void draw( QPainter& p ) const;
675 
683  bool vertexIdFromVertexNr( int nr, QgsVertexId& id ) const;
684 
691  int vertexNrFromVertexId( QgsVertexId i ) const;
692 
697  static GEOSContextHandle_t getGEOSHandler();
698 
703  static QgsGeometry* fromQPointF( QPointF point );
704 
711  static QgsGeometry* fromQPolygonF( const QPolygonF& polygon );
712 
718  static QgsPolyline createPolylineFromQPolygonF( const QPolygonF &polygon );
719 
725  static QgsPolygon createPolygonFromQPolygonF( const QPolygonF &polygon );
726 
735  static bool compare( const QgsPolyline& p1, const QgsPolyline& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
736 
745  static bool compare( const QgsPolygon& p1, const QgsPolygon& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
746 
756  static bool compare( const QgsMultiPolygon& p1, const QgsMultiPolygon& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
757 
767  QgsGeometry* smooth( const unsigned int iterations = 1, const double offset = 0.25 ) const;
768 
770  QgsPolygon smoothPolygon( const QgsPolygon &polygon, const unsigned int iterations = 1, const double offset = 0.25 ) const;
772  QgsPolyline smoothLine( const QgsPolyline &polyline, const unsigned int iterations = 1, const double offset = 0.25 ) const;
773 
776  static QgsGeometryEngine* createGeometryEngine( const QgsAbstractGeometryV2* geometry );
777 
782  static void convertPointList( const QList<QgsPoint>& input, QList<QgsPointV2>& output );
783 
788  static void convertPointList( const QList<QgsPointV2>& input, QList<QgsPoint>& output );
789 
790  private:
791 
792  QgsGeometryPrivate* d; //implicitely shared data pointer
793 
794  void detach( bool cloneGeom = true ); //make sure mGeometry only referenced from this instance
795  void removeWkbGeos();
796 
797  static void convertToPolyline( const QList<QgsPointV2>& input, QgsPolyline& output );
798  static void convertPolygon( const QgsPolygonV2& input, QgsPolygon& output );
799 
801  QgsGeometry* convertToPoint( bool destMultipart ) const;
803  QgsGeometry* convertToLine( bool destMultipart ) const;
805  QgsGeometry* convertToPolygon( bool destMultipart ) const;
806 }; // class QgsGeometry
807 
808 Q_DECLARE_METATYPE( QgsGeometry )
809 
810 
811 CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsGeometry& geometry );
813 CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsGeometry& geometry );
814 
815 #endif
A rectangle specified with double values.
Definition: qgsrectangle.h:35
GeometryType
Definition: qgis.h:111
QgsPoint where()
Definition: qgsgeometry.h:628
Error(const QString &m)
Definition: qgsgeometry.h:624
QVector< QgsPoint > QgsPolyline
Polyline is represented as a vector of points.
Definition: qgsgeometry.h:44
Abstract base class for all geometries.
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:76
WkbType
Used for symbology operations.
Definition: qgis.h:57
CORE_EXPORT QDataStream & operator<<(QDataStream &out, const QgsGeometry &geometry)
Writes the geometry to stream out.
Perform transforms between map coordinates and device coordinates.
Definition: qgsmaptopixel.h:34
Polygon geometry type.
Definition: qgspolygonv2.h:29
Utility class for identifying a unique vertex within a geometry.
const double DEFAULT_SEGMENT_EPSILON
Default snapping tolerance for segments.
Definition: qgis.h:382
Point geometry type, with support for z-dimension and m-values.
Definition: qgspointv2.h:34
QVector< QgsPolygon > QgsMultiPolygon
A collection of QgsPolygons that share a common collection of attributes.
Definition: qgsgeometry.h:59
QVector< QgsPoint > QgsMultiPoint
A collection of QgsPoints that share a common collection of attributes.
Definition: qgsgeometry.h:53
QVector< QgsPolyline > QgsPolygon
Polygon: first item of the list is outer ring, inner rings (if any) start from second item...
Definition: qgsgeometry.h:50
A class to represent a point.
Definition: qgspoint.h:65
CORE_EXPORT QDataStream & operator>>(QDataStream &in, QgsGeometry &geometry)
Reads a geometry from stream in into geometry.
QVector< QgsPolyline > QgsMultiPolyline
A collection of QgsPolylines that share a common collection of attributes.
Definition: qgsgeometry.h:56
Class for doing transforms between two map coordinate systems.
Contains geometry relation and modification algorithms.
double ANALYSIS_EXPORT leftOf(Point3D *thepoint, Point3D *p1, Point3D *p2)
Returns whether &#39;thepoint&#39; is left or right of the line from &#39;p1&#39; to &#39;p2&#39;.
Abstract base class for curved geometry type.
Definition: qgscurvev2.h:32
Represents a vector layer which manages a vector based data sets.
Error(const QString &m, const QgsPoint &p)
Definition: qgsgeometry.h:625