QGIS API Documentation  2.17.0-Master (0497e4a)
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 
226  //TODO QGIS 3.0 - rename beforeVertex to previousVertex, afterVertex to nextVertex
227  QgsPoint closestVertex( const QgsPoint& point, int& atVertex, int& beforeVertex, int& afterVertex, double& sqrDist ) const;
228 
235  double distanceToVertex( int vertex ) const;
236 
244  double angleAtVertex( int vertex ) const;
245 
258  void adjacentVertices( int atVertex, int& beforeVertex, int& afterVertex ) const;
259 
271  bool insertVertex( double x, double y, int beforeVertex );
272 
279  bool moveVertex( double x, double y, int atVertex );
280 
287  bool moveVertex( const QgsPointV2& p, int atVertex );
288 
299  bool deleteVertex( int atVertex );
300 
306  QgsPoint vertexAt( int atVertex ) const;
307 
313  double sqrDistToVertexAt( QgsPoint& point, int atVertex ) const;
314 
319  QgsGeometry nearestPoint( const QgsGeometry& other ) const;
320 
325  QgsGeometry shortestLine( const QgsGeometry& other ) const;
326 
333  double closestVertexWithContext( const QgsPoint& point, int& atVertex ) const;
334 
345  double closestSegmentWithContext( const QgsPoint& point, QgsPoint& minDistPoint, int& afterVertex, double* leftOf = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
346 
350  // TODO QGIS 3.0 returns an enum instead of a magic constant
351  int addRing( const QList<QgsPoint>& ring );
352 
356  // TODO QGIS 3.0 returns an enum instead of a magic constant
357  int addRing( QgsCurveV2* ring );
358 
365  // TODO QGIS 3.0 returns an enum instead of a magic constant
366  int addPart( const QList<QgsPoint> &points, QGis::GeometryType geomType = QGis::UnknownGeometry );
367 
374  // TODO QGIS 3.0 returns an enum instead of a magic constant
375  int addPart( const QgsPointSequenceV2 &points, QGis::GeometryType geomType = QGis::UnknownGeometry );
376 
383  // TODO QGIS 3.0 returns an enum instead of a magic constant
384  int addPart( QgsAbstractGeometryV2* part, QGis::GeometryType geomType = QGis::UnknownGeometry );
385 
392  // TODO QGIS 3.0 returns an enum instead of a magic constant
393  int addPart( GEOSGeometry *newPart );
394 
400  // TODO QGIS 3.0 returns an enum instead of a magic constant
401  int addPart( const QgsGeometry *newPart );
402 
405  int translate( double dx, double dy );
406 
409  int transform( const QgsCoordinateTransform& ct );
410 
414  int transform( const QTransform& ct );
415 
421  int rotate( double rotation, const QgsPoint& center );
422 
429  // TODO QGIS 3.0 returns an enum instead of a magic constant
430  int splitGeometry( const QList<QgsPoint>& splitLine,
431  QList<QgsGeometry*>&newGeometries,
432  bool topological,
433  QList<QgsPoint> &topologyTestPoints );
434 
439  int reshapeGeometry( const QList<QgsPoint>& reshapeWithLine );
440 
445  int makeDifference( const QgsGeometry* other );
446 
448  QgsRectangle boundingBox() const;
449 
451  bool intersects( const QgsRectangle& r ) const;
452 
454  bool intersects( const QgsGeometry* geometry ) const;
455 
457  bool contains( const QgsPoint* p ) const;
458 
461  bool contains( const QgsGeometry* geometry ) const;
462 
465  bool disjoint( const QgsGeometry* geometry ) const;
466 
469  bool equals( const QgsGeometry* geometry ) const;
470 
473  bool touches( const QgsGeometry* geometry ) const;
474 
477  bool overlaps( const QgsGeometry* geometry ) const;
478 
481  bool within( const QgsGeometry* geometry ) const;
482 
485  bool crosses( const QgsGeometry* geometry ) const;
486 
489  QgsGeometry* buffer( double distance, int segments ) const;
490 
500  QgsGeometry* buffer( double distance, int segments, int endCapStyle, int joinStyle, double mitreLimit ) const;
501 
507  QgsGeometry* offsetCurve( double distance, int segments, int joinStyle, double mitreLimit ) const;
508 
510  QgsGeometry* simplify( double tolerance ) const;
511 
516  QgsGeometry* centroid() const;
517 
519  QgsGeometry* pointOnSurface() const;
520 
522  QgsGeometry* convexHull() const;
523 
529  QgsGeometry* interpolate( double distance ) const;
530 
541  double lineLocatePoint( const QgsGeometry& point ) const;
542 
551  double interpolateAngle( double distance ) const;
552 
554  QgsGeometry* intersection( const QgsGeometry* geometry ) const;
555 
560  QgsGeometry* combine( const QgsGeometry* geometry ) const;
561 
569  QgsGeometry mergeLines() const;
570 
572  QgsGeometry* difference( const QgsGeometry* geometry ) const;
573 
575  QgsGeometry* symDifference( const QgsGeometry* geometry ) const;
576 
578  QgsGeometry extrude( double x, double y );
579 
584  QString exportToWkt( int precision = 17 ) const;
585 
592  QString exportToGeoJSON( int precision = 17 ) const;
593 
600  QgsGeometry* convertToType( QGis::GeometryType destType, bool destMultipart = false ) const;
601 
602  /* Accessor functions for getting geometry data */
603 
607  QgsPoint asPoint() const;
608 
612  QgsPolyline asPolyline() const;
613 
617  QgsPolygon asPolygon() const;
618 
621  QgsMultiPoint asMultiPoint() const;
622 
625  QgsMultiPolyline asMultiPolyline() const;
626 
629  QgsMultiPolygon asMultiPolygon() const;
630 
633  QList<QgsGeometry*> asGeometryCollection() const;
634 
639  QPointF asQPointF() const;
640 
646  QPolygonF asQPolygonF() const;
647 
652  bool deleteRing( int ringNum, int partNum = 0 );
653 
657  bool deletePart( int partNum );
658 
667  bool convertToMultiType();
668 
678  bool convertToSingleType();
679 
688  int avoidIntersections( const QMap<QgsVectorLayer*, QSet<QgsFeatureId> >& ignoreFeatures = ( QMap<QgsVectorLayer*, QSet<QgsFeatureId> >() ) );
689 
692  class Error
693  {
694  QString message;
695  QgsPoint location;
696  bool hasLocation;
697  public:
698  Error() : message( "none" ), hasLocation( false ) {}
699  explicit Error( const QString& m ) : message( m ), hasLocation( false ) {}
700  Error( const QString& m, const QgsPoint& p ) : message( m ), location( p ), hasLocation( true ) {}
701 
702  QString what() { return message; }
703  QgsPoint where() { return location; }
704  bool hasWhere() { return hasLocation; }
705  };
706 
711  void validateGeometry( QList<Error> &errors );
712 
717  static QgsGeometry *unaryUnion( const QList<QgsGeometry*>& geometryList );
718 
723  void convertToStraightSegment();
724 
730  bool requiresConversionToStraightSegments() const;
731 
736  void mapToPixel( const QgsMapToPixel& mtp );
737 
738  // not implemented for 2.10
739  /* Clips the geometry using the specified rectangle
740  * @param rect clip rectangle
741  * @note added in QGIS 2.10
742  */
743  // void clip( const QgsRectangle& rect );
744 
749  void draw( QPainter& p ) const;
750 
758  bool vertexIdFromVertexNr( int nr, QgsVertexId& id ) const;
759 
766  int vertexNrFromVertexId( QgsVertexId i ) const;
767 
772  static GEOSContextHandle_t getGEOSHandler();
773 
778  static QgsGeometry* fromQPointF( QPointF point );
779 
786  static QgsGeometry* fromQPolygonF( const QPolygonF& polygon );
787 
793  static QgsPolyline createPolylineFromQPolygonF( const QPolygonF &polygon );
794 
800  static QgsPolygon createPolygonFromQPolygonF( const QPolygonF &polygon );
801 
810  static bool compare( const QgsPolyline& p1, const QgsPolyline& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
811 
820  static bool compare( const QgsPolygon& p1, const QgsPolygon& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
821 
831  static bool compare( const QgsMultiPolygon& p1, const QgsMultiPolygon& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
832 
842  QgsGeometry* smooth( const unsigned int iterations = 1, const double offset = 0.25 ) const;
843 
845  QgsPolygon smoothPolygon( const QgsPolygon &polygon, const unsigned int iterations = 1, const double offset = 0.25 ) const;
847  QgsPolyline smoothLine( const QgsPolyline &polyline, const unsigned int iterations = 1, const double offset = 0.25 ) const;
848 
851  static QgsGeometryEngine* createGeometryEngine( const QgsAbstractGeometryV2* geometry );
852 
857  static void convertPointList( const QList<QgsPoint> &input, QgsPointSequenceV2 &output );
858 
863  static void convertPointList( const QgsPointSequenceV2 &input, QList<QgsPoint> &output );
864 
866  operator QVariant() const
867  {
868  return QVariant::fromValue( *this );
869  }
870 
871  private:
872 
873  QgsGeometryPrivate* d; //implicitely shared data pointer
874 
875  void detach( bool cloneGeom = true ); //make sure mGeometry only referenced from this instance
876  void removeWkbGeos();
877 
878  static void convertToPolyline( const QgsPointSequenceV2 &input, QgsPolyline& output );
879  static void convertPolygon( const QgsPolygonV2& input, QgsPolygon& output );
880 
882  QgsGeometry* convertToPoint( bool destMultipart ) const;
884  QgsGeometry* convertToLine( bool destMultipart ) const;
886  QgsGeometry* convertToPolygon( bool destMultipart ) const;
887 }; // class QgsGeometry
888 
890 
891 
892 CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsGeometry& geometry );
894 CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsGeometry& geometry );
895 
896 #endif
A rectangle specified with double values.
Definition: qgsrectangle.h:35
GeometryType
Definition: qgis.h:115
QgsPoint where()
Definition: qgsgeometry.h:703
Error(const QString &m)
Definition: qgsgeometry.h:699
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:61
Q_DECLARE_METATYPE(QModelIndex)
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:490
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:117
CORE_EXPORT QDataStream & operator>>(QDataStream &in, QgsGeometry &geometry)
Reads a geometry from stream in into geometry.
QVariant fromValue(const T &value)
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:700