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 );
145  void fromWkb( unsigned char * wkb, int length );
146 
152  const unsigned char* asWkb() const;
153 
158  int wkbSize() const;
159 
165  const GEOSGeometry* asGeos( double precision = 0 ) const;
166 
170  QGis::WkbType wkbType() const;
171 
175  QGis::GeometryType type() const;
176 
178  bool isMultipart() const;
179 
183  bool isGeosEqual( const QgsGeometry& ) const;
184 
188  bool isGeosValid() const;
189 
193  bool isGeosEmpty() const;
194 
198  double area() const;
199 
203  double length() const;
204 
211  double distance( const QgsGeometry& geom ) const;
212 
217  QgsPoint closestVertex( const QgsPoint& point, int& atVertex, int& beforeVertex, int& afterVertex, double& sqrDist ) const;
218 
231  void adjacentVertices( int atVertex, int& beforeVertex, int& afterVertex ) const;
232 
244  bool insertVertex( double x, double y, int beforeVertex );
245 
252  bool moveVertex( double x, double y, int atVertex );
253 
260  bool moveVertex( const QgsPointV2& p, int atVertex );
261 
272  bool deleteVertex( int atVertex );
273 
279  QgsPoint vertexAt( int atVertex ) const;
280 
286  double sqrDistToVertexAt( QgsPoint& point, int atVertex ) const;
287 
292  QgsGeometry nearestPoint( const QgsGeometry& other ) const;
293 
298  QgsGeometry shortestLine( const QgsGeometry& other ) const;
299 
306  double closestVertexWithContext( const QgsPoint& point, int& atVertex ) const;
307 
318  double closestSegmentWithContext( const QgsPoint& point, QgsPoint& minDistPoint, int& afterVertex, double* leftOf = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
319 
323  int addRing( const QList<QgsPoint>& ring );
324 
328  int addRing( QgsCurveV2* ring );
329 
336  int addPart( const QList<QgsPoint> &points, QGis::GeometryType geomType = QGis::UnknownGeometry );
337 
344  int addPart( QgsAbstractGeometryV2* part, QGis::GeometryType geomType = QGis::UnknownGeometry );
345 
352  int addPart( GEOSGeometry *newPart );
353 
359  int addPart( const QgsGeometry *newPart );
360 
363  int translate( double dx, double dy );
364 
367  int transform( const QgsCoordinateTransform& ct );
368 
372  int transform( const QTransform& ct );
373 
379  int rotate( double rotation, const QgsPoint& center );
380 
387  int splitGeometry( const QList<QgsPoint>& splitLine,
388  QList<QgsGeometry*>&newGeometries,
389  bool topological,
390  QList<QgsPoint> &topologyTestPoints );
391 
395  int reshapeGeometry( const QList<QgsPoint>& reshapeWithLine );
396 
400  int makeDifference( const QgsGeometry* other );
401 
403  QgsRectangle boundingBox() const;
404 
406  bool intersects( const QgsRectangle& r ) const;
407 
409  bool intersects( const QgsGeometry* geometry ) const;
410 
412  bool contains( const QgsPoint* p ) const;
413 
416  bool contains( const QgsGeometry* geometry ) const;
417 
420  bool disjoint( const QgsGeometry* geometry ) const;
421 
424  bool equals( const QgsGeometry* geometry ) const;
425 
428  bool touches( const QgsGeometry* geometry ) const;
429 
432  bool overlaps( const QgsGeometry* geometry ) const;
433 
436  bool within( const QgsGeometry* geometry ) const;
437 
440  bool crosses( const QgsGeometry* geometry ) const;
441 
444  QgsGeometry* buffer( double distance, int segments ) const;
445 
455  QgsGeometry* buffer( double distance, int segments, int endCapStyle, int joinStyle, double mitreLimit ) const;
456 
462  QgsGeometry* offsetCurve( double distance, int segments, int joinStyle, double mitreLimit ) const;
463 
465  QgsGeometry* simplify( double tolerance ) const;
466 
470  QgsGeometry* centroid() const;
471 
473  QgsGeometry* pointOnSurface() const;
474 
476  QgsGeometry* convexHull() const;
477 
482  QgsGeometry* interpolate( double distance ) const;
483 
485  QgsGeometry* intersection( const QgsGeometry* geometry ) const;
486 
490  QgsGeometry* combine( const QgsGeometry* geometry ) const;
491 
493  QgsGeometry* difference( const QgsGeometry* geometry ) const;
494 
496  QgsGeometry* symDifference( const QgsGeometry* geometry ) const;
497 
499  QgsGeometry extrude( double x, double y );
500 
505  QString exportToWkt( int precision = 17 ) const;
506 
513  QString exportToGeoJSON( int precision = 17 ) const;
514 
521  QgsGeometry* convertToType( QGis::GeometryType destType, bool destMultipart = false ) const;
522 
523  /* Accessor functions for getting geometry data */
524 
527  QgsPoint asPoint() const;
528 
531  QgsPolyline asPolyline() const;
532 
535  QgsPolygon asPolygon() const;
536 
539  QgsMultiPoint asMultiPoint() const;
540 
543  QgsMultiPolyline asMultiPolyline() const;
544 
547  QgsMultiPolygon asMultiPolygon() const;
548 
551  QList<QgsGeometry*> asGeometryCollection() const;
552 
557  QPointF asQPointF() const;
558 
564  QPolygonF asQPolygonF() const;
565 
570  bool deleteRing( int ringNum, int partNum = 0 );
571 
575  bool deletePart( int partNum );
576 
585  bool convertToMultiType();
586 
596  bool convertToSingleType();
597 
606  int avoidIntersections( const QMap<QgsVectorLayer*, QSet<QgsFeatureId> >& ignoreFeatures = ( QMap<QgsVectorLayer*, QSet<QgsFeatureId> >() ) );
607 
608  class Error
609  {
610  QString message;
611  QgsPoint location;
612  bool hasLocation;
613  public:
614  Error() : message( "none" ), hasLocation( false ) {}
615  explicit Error( const QString& m ) : message( m ), hasLocation( false ) {}
616  Error( const QString& m, const QgsPoint& p ) : message( m ), location( p ), hasLocation( true ) {}
617 
618  QString what() { return message; }
619  QgsPoint where() { return location; }
620  bool hasWhere() { return hasLocation; }
621  };
622 
627  void validateGeometry( QList<Error> &errors );
628 
633  static QgsGeometry *unaryUnion( const QList<QgsGeometry*>& geometryList );
634 
639  void convertToStraightSegment();
640 
646  bool requiresConversionToStraightSegments() const;
647 
652  void mapToPixel( const QgsMapToPixel& mtp );
653 
654  // not implemented for 2.10
655  /* Clips the geometry using the specified rectangle
656  * @param rect clip rectangle
657  * @note added in QGIS 2.10
658  */
659  // void clip( const QgsRectangle& rect );
660 
665  void draw( QPainter& p ) const;
666 
674  bool vertexIdFromVertexNr( int nr, QgsVertexId& id ) const;
675 
682  int vertexNrFromVertexId( QgsVertexId i ) const;
683 
688  static GEOSContextHandle_t getGEOSHandler();
689 
694  static QgsGeometry* fromQPointF( QPointF point );
695 
702  static QgsGeometry* fromQPolygonF( const QPolygonF& polygon );
703 
709  static QgsPolyline createPolylineFromQPolygonF( const QPolygonF &polygon );
710 
716  static QgsPolygon createPolygonFromQPolygonF( const QPolygonF &polygon );
717 
726  static bool compare( const QgsPolyline& p1, const QgsPolyline& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
727 
736  static bool compare( const QgsPolygon& p1, const QgsPolygon& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
737 
747  static bool compare( const QgsMultiPolygon& p1, const QgsMultiPolygon& p2, double epsilon = 4 * std::numeric_limits<double>::epsilon() );
748 
758  QgsGeometry* smooth( const unsigned int iterations = 1, const double offset = 0.25 ) const;
759 
761  QgsPolygon smoothPolygon( const QgsPolygon &polygon, const unsigned int iterations = 1, const double offset = 0.25 ) const;
763  QgsPolyline smoothLine( const QgsPolyline &polyline, const unsigned int iterations = 1, const double offset = 0.25 ) const;
764 
767  static QgsGeometryEngine* createGeometryEngine( const QgsAbstractGeometryV2* geometry );
768 
773  static void convertPointList( const QList<QgsPoint>& input, QList<QgsPointV2>& output );
774 
779  static void convertPointList( const QList<QgsPointV2>& input, QList<QgsPoint>& output );
780 
781  private:
782 
783  QgsGeometryPrivate* d; //implicitely shared data pointer
784 
785  void detach( bool cloneGeom = true ); //make sure mGeometry only referenced from this instance
786  void removeWkbGeos();
787 
788  static void convertToPolyline( const QList<QgsPointV2>& input, QgsPolyline& output );
789  static void convertPolygon( const QgsPolygonV2& input, QgsPolygon& output );
790 
792  QgsGeometry* convertToPoint( bool destMultipart ) const;
794  QgsGeometry* convertToLine( bool destMultipart ) const;
796  QgsGeometry* convertToPolygon( bool destMultipart ) const;
797 }; // class QgsGeometry
798 
799 Q_DECLARE_METATYPE( QgsGeometry )
800 
801 
802 CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsGeometry& geometry );
804 CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsGeometry& geometry );
805 
806 #endif
A rectangle specified with double values.
Definition: qgsrectangle.h:35
GeometryType
Definition: qgis.h:111
QgsPoint where()
Definition: qgsgeometry.h:619
Error(const QString &m)
Definition: qgsgeometry.h:615
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:616