QGIS API Documentation  2.15.0-Master (af20121)
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 
249  void adjacentVertices( int atVertex, int& beforeVertex, int& afterVertex ) const;
250 
262  bool insertVertex( double x, double y, int beforeVertex );
263 
270  bool moveVertex( double x, double y, int atVertex );
271 
278  bool moveVertex( const QgsPointV2& p, int atVertex );
279 
290  bool deleteVertex( int atVertex );
291 
297  QgsPoint vertexAt( int atVertex ) const;
298 
304  double sqrDistToVertexAt( QgsPoint& point, int atVertex ) const;
305 
310  QgsGeometry nearestPoint( const QgsGeometry& other ) const;
311 
316  QgsGeometry shortestLine( const QgsGeometry& other ) const;
317 
324  double closestVertexWithContext( const QgsPoint& point, int& atVertex ) const;
325 
336  double closestSegmentWithContext( const QgsPoint& point, QgsPoint& minDistPoint, int& afterVertex, double* leftOf = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
337 
341  // TODO QGIS 3.0 returns an enum instead of a magic constant
342  int addRing( const QList<QgsPoint>& ring );
343 
347  // TODO QGIS 3.0 returns an enum instead of a magic constant
348  int addRing( QgsCurveV2* ring );
349 
356  // TODO QGIS 3.0 returns an enum instead of a magic constant
357  int addPart( const QList<QgsPoint> &points, QGis::GeometryType geomType = QGis::UnknownGeometry );
358 
365  // TODO QGIS 3.0 returns an enum instead of a magic constant
366  int addPart( const QgsPointSequenceV2 &points, QGis::GeometryType geomType = QGis::UnknownGeometry );
367 
374  // TODO QGIS 3.0 returns an enum instead of a magic constant
375  int addPart( QgsAbstractGeometryV2* part, QGis::GeometryType geomType = QGis::UnknownGeometry );
376 
383  // TODO QGIS 3.0 returns an enum instead of a magic constant
384  int addPart( GEOSGeometry *newPart );
385 
391  // TODO QGIS 3.0 returns an enum instead of a magic constant
392  int addPart( const QgsGeometry *newPart );
393 
396  int translate( double dx, double dy );
397 
400  int transform( const QgsCoordinateTransform& ct );
401 
405  int transform( const QTransform& ct );
406 
412  int rotate( double rotation, const QgsPoint& center );
413 
420  // TODO QGIS 3.0 returns an enum instead of a magic constant
421  int splitGeometry( const QList<QgsPoint>& splitLine,
422  QList<QgsGeometry*>&newGeometries,
423  bool topological,
424  QList<QgsPoint> &topologyTestPoints );
425 
430  int reshapeGeometry( const QList<QgsPoint>& reshapeWithLine );
431 
436  int makeDifference( const QgsGeometry* other );
437 
439  QgsRectangle boundingBox() const;
440 
442  bool intersects( const QgsRectangle& r ) const;
443 
445  bool intersects( const QgsGeometry* geometry ) const;
446 
448  bool contains( const QgsPoint* p ) const;
449 
452  bool contains( const QgsGeometry* geometry ) const;
453 
456  bool disjoint( const QgsGeometry* geometry ) const;
457 
460  bool equals( const QgsGeometry* geometry ) const;
461 
464  bool touches( const QgsGeometry* geometry ) const;
465 
468  bool overlaps( const QgsGeometry* geometry ) const;
469 
472  bool within( const QgsGeometry* geometry ) const;
473 
476  bool crosses( const QgsGeometry* geometry ) const;
477 
480  QgsGeometry* buffer( double distance, int segments ) const;
481 
491  QgsGeometry* buffer( double distance, int segments, int endCapStyle, int joinStyle, double mitreLimit ) const;
492 
498  QgsGeometry* offsetCurve( double distance, int segments, int joinStyle, double mitreLimit ) const;
499 
501  QgsGeometry* simplify( double tolerance ) const;
502 
507  QgsGeometry* centroid() const;
508 
510  QgsGeometry* pointOnSurface() const;
511 
513  QgsGeometry* convexHull() const;
514 
519  QgsGeometry* interpolate( double distance ) const;
520 
522  QgsGeometry* intersection( const QgsGeometry* geometry ) const;
523 
528  QgsGeometry* combine( const QgsGeometry* geometry ) const;
529 
531  QgsGeometry* difference( const QgsGeometry* geometry ) const;
532 
534  QgsGeometry* symDifference( const QgsGeometry* geometry ) const;
535 
537  QgsGeometry extrude( double x, double y );
538 
543  QString exportToWkt( int precision = 17 ) const;
544 
551  QString exportToGeoJSON( int precision = 17 ) const;
552 
559  QgsGeometry* convertToType( QGis::GeometryType destType, bool destMultipart = false ) const;
560 
561  /* Accessor functions for getting geometry data */
562 
566  QgsPoint asPoint() const;
567 
571  QgsPolyline asPolyline() const;
572 
576  QgsPolygon asPolygon() const;
577 
580  QgsMultiPoint asMultiPoint() const;
581 
584  QgsMultiPolyline asMultiPolyline() const;
585 
588  QgsMultiPolygon asMultiPolygon() const;
589 
592  QList<QgsGeometry*> asGeometryCollection() const;
593 
598  QPointF asQPointF() const;
599 
605  QPolygonF asQPolygonF() const;
606 
611  bool deleteRing( int ringNum, int partNum = 0 );
612 
616  bool deletePart( int partNum );
617 
626  bool convertToMultiType();
627 
637  bool convertToSingleType();
638 
647  int avoidIntersections( const QMap<QgsVectorLayer*, QSet<QgsFeatureId> >& ignoreFeatures = ( QMap<QgsVectorLayer*, QSet<QgsFeatureId> >() ) );
648 
649  class Error
650  {
651  QString message;
652  QgsPoint location;
653  bool hasLocation;
654  public:
655  Error() : message( "none" ), hasLocation( false ) {}
656  explicit Error( const QString& m ) : message( m ), hasLocation( false ) {}
657  Error( const QString& m, const QgsPoint& p ) : message( m ), location( p ), hasLocation( true ) {}
658 
659  QString what() { return message; }
660  QgsPoint where() { return location; }
661  bool hasWhere() { return hasLocation; }
662  };
663 
668  void validateGeometry( QList<Error> &errors );
669 
674  static QgsGeometry *unaryUnion( const QList<QgsGeometry*>& geometryList );
675 
680  void convertToStraightSegment();
681 
687  bool requiresConversionToStraightSegments() const;
688 
693  void mapToPixel( const QgsMapToPixel& mtp );
694 
695  // not implemented for 2.10
696  /* Clips the geometry using the specified rectangle
697  * @param rect clip rectangle
698  * @note added in QGIS 2.10
699  */
700  // void clip( const QgsRectangle& rect );
701 
706  void draw( QPainter& p ) const;
707 
715  bool vertexIdFromVertexNr( int nr, QgsVertexId& id ) const;
716 
723  int vertexNrFromVertexId( QgsVertexId i ) const;
724 
729  static GEOSContextHandle_t getGEOSHandler();
730 
735  static QgsGeometry* fromQPointF( QPointF point );
736 
743  static QgsGeometry* fromQPolygonF( const QPolygonF& polygon );
744 
750  static QgsPolyline createPolylineFromQPolygonF( const QPolygonF &polygon );
751 
757  static QgsPolygon createPolygonFromQPolygonF( const QPolygonF &polygon );
758 
767  static bool compare( const QgsPolyline& p1, const QgsPolyline& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
768 
777  static bool compare( const QgsPolygon& p1, const QgsPolygon& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
778 
788  static bool compare( const QgsMultiPolygon& p1, const QgsMultiPolygon& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
789 
799  QgsGeometry* smooth( const unsigned int iterations = 1, const double offset = 0.25 ) const;
800 
802  QgsPolygon smoothPolygon( const QgsPolygon &polygon, const unsigned int iterations = 1, const double offset = 0.25 ) const;
804  QgsPolyline smoothLine( const QgsPolyline &polyline, const unsigned int iterations = 1, const double offset = 0.25 ) const;
805 
808  static QgsGeometryEngine* createGeometryEngine( const QgsAbstractGeometryV2* geometry );
809 
814  static void convertPointList( const QList<QgsPoint> &input, QgsPointSequenceV2 &output );
815 
820  static void convertPointList( const QgsPointSequenceV2 &input, QList<QgsPoint> &output );
821 
823  operator QVariant() const
824  {
825  return QVariant::fromValue( *this );
826  }
827 
828  private:
829 
830  QgsGeometryPrivate* d; //implicitely shared data pointer
831 
832  void detach( bool cloneGeom = true ); //make sure mGeometry only referenced from this instance
833  void removeWkbGeos();
834 
835  static void convertToPolyline( const QgsPointSequenceV2 &input, QgsPolyline& output );
836  static void convertPolygon( const QgsPolygonV2& input, QgsPolygon& output );
837 
839  QgsGeometry* convertToPoint( bool destMultipart ) const;
841  QgsGeometry* convertToLine( bool destMultipart ) const;
843  QgsGeometry* convertToPolygon( bool destMultipart ) const;
844 }; // class QgsGeometry
845 
846 Q_DECLARE_METATYPE( QgsGeometry )
847 
848 
849 CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsGeometry& geometry );
851 CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsGeometry& geometry );
852 
853 #endif
A rectangle specified with double values.
Definition: qgsrectangle.h:35
GeometryType
Definition: qgis.h:115
QgsPoint where()
Definition: qgsgeometry.h:660
Error(const QString &m)
Definition: qgsgeometry.h:656
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
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:479
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:657