Make asGridified and newSameType (helper function)

qgis · Oct 27, 2017 · 3f5b11b · 3f5b11b
1 parent 99b1c74
commit 3f5b11b
Show file tree

Hide file tree

Showing 49 changed files with 576 additions and 14 deletions.
diff --git a/python/core/geometry/qgsabstractgeometry.sip b/python/core/geometry/qgsabstractgeometry.sip
@@ -71,6 +71,16 @@ class QgsAbstractGeometry
     virtual ~QgsAbstractGeometry();
     QgsAbstractGeometry( const QgsAbstractGeometry &geom );
 
+    virtual QgsAbstractGeometry *createEmptyWithSameType() const = 0 /Factory/;
+%Docstring
+ Makes a new geometry with the same class and same WKB and transfers ownership.
+ To create it, the geometry is default constructedand then the WKB is changed.
+ :return: the new empty geometry. Callee takes ownership.
+.. seealso:: clone
+.. versionadded:: 3.0
+ :rtype: QgsAbstractGeometry
+%End
+
     virtual QgsAbstractGeometry *clone() const = 0 /Factory/;
 %Docstring
  Clones the geometry by performing a deep copy
@@ -402,6 +412,32 @@ Returns the centroid of the geometry
  :rtype: QgsAbstractGeometry
 %End
 
+    virtual QgsAbstractGeometry *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0, double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const = 0 /Factory/;
+%Docstring
+ Makes a new geometry with all the points or vertices snapped to the closest point of the grid.
+ It transfers ownership to the callee.
+ If it couldn't make the gridified geometry it returns None.
+ It may generate an invalid geometry (in some corner cases).
+ It can also be thought as rounding the edges and it may be useful for removing errors.
+ If the geometry is curved, it will be segmentized before gridifying it.
+ Example:
+ \code
+ geometry->snappedToGrid(1, 1);
+ \endcode
+ In this case we use a 2D grid of 1x1 to gridify.
+ In this case, it can be thought like rounding the x and y of all the points/vertices to full units (remove all decimals).
+ \param hSpacing Horizontal spacing of the grid (x axis). 0 to disable.
+ \param vSpacing Vertical spacing of the grid (y axis). 0 to disable.
+ \param dSpacing Depth spacing of the grid (z axis). 0 (default) to disable.
+ \param mSpacing Custom dimension spacing of the grid (m axis). 0 (default) to disable.
+ \param tolerance In case of segmentation, the tolerance to use (passed to segmentize as is).
+ \param toleranceType In case of segmentation, the toleranceType to use (passed to segmentize as is).
+ :return: the segmentized geometry or None if it wasn't possible to make. Caller takes ownership.
+.. seealso:: segmentize
+.. versionadded:: 3.0
+ :rtype: QgsAbstractGeometry
+%End
+
     virtual double vertexAngle( QgsVertexId vertex ) const = 0;
 %Docstring
  Returns approximate angle at a vertex. This is usually the average angle between adjacent

diff --git a/python/core/geometry/qgscircularstring.sip b/python/core/geometry/qgscircularstring.sip
@@ -29,6 +29,7 @@ class QgsCircularString: QgsCurve
 
     virtual QString geometryType() const;
     virtual int dimension() const;
+    virtual QgsCircularString *createEmptyWithSameType() const /Factory/;
     virtual QgsCircularString *clone() const /Factory/;
     virtual void clear();
 

diff --git a/python/core/geometry/qgscompoundcurve.sip b/python/core/geometry/qgscompoundcurve.sip
@@ -29,6 +29,7 @@ class QgsCompoundCurve: QgsCurve
 
     virtual QString geometryType() const;
     virtual int dimension() const;
+    virtual QgsCompoundCurve *createEmptyWithSameType() const /Factory/;
     virtual QgsCompoundCurve *clone() const /Factory/;
     virtual void clear();
 

diff --git a/python/core/geometry/qgscurve.sip b/python/core/geometry/qgscurve.sip
@@ -126,6 +126,8 @@ class QgsCurve: QgsAbstractGeometry
 
     virtual QgsAbstractGeometry *boundary() const /Factory/;
 
+    virtual QgsCurve *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0,
+                                     double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
 
     virtual QgsCurve *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
 

diff --git a/python/core/geometry/qgscurvepolygon.sip b/python/core/geometry/qgscurvepolygon.sip
@@ -35,7 +35,7 @@ class QgsCurvePolygon: QgsSurface
     virtual QString geometryType() const;
 
     virtual int dimension() const;
-
+    virtual QgsCurvePolygon *createEmptyWithSameType() const /Factory/;
     virtual QgsCurvePolygon *clone() const /Factory/;
 
     virtual void clear();
@@ -64,7 +64,8 @@ class QgsCurvePolygon: QgsSurface
     virtual QgsPolygonV2 *surfaceToPolygon() const /Factory/;
 
     virtual QgsAbstractGeometry *boundary() const /Factory/;
-
+    virtual QgsCurvePolygon *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0,
+                                            double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
 
     int numInteriorRings() const;
 %Docstring

diff --git a/python/core/geometry/qgsgeometrycollection.sip b/python/core/geometry/qgsgeometrycollection.sip
@@ -26,6 +26,7 @@ class QgsGeometryCollection: QgsAbstractGeometry
     QgsGeometryCollection( const QgsGeometryCollection &c );
     virtual ~QgsGeometryCollection();
 
+    virtual QgsGeometryCollection *createEmptyWithSameType() const /Factory/;
     virtual QgsGeometryCollection *clone() const /Factory/;
 
 
@@ -50,7 +51,8 @@ class QgsGeometryCollection: QgsAbstractGeometry
     virtual QString geometryType() const;
 
     virtual void clear();
-
+    virtual QgsGeometryCollection *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0,
+        double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
     virtual QgsAbstractGeometry *boundary() const /Factory/;
 
     virtual void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex /Out/, QgsVertexId &nextVertex /Out/ ) const;

diff --git a/python/core/geometry/qgslinestring.sip b/python/core/geometry/qgslinestring.sip
@@ -170,13 +170,15 @@ Closes the line string by appending the first point to the end of the line, if i
     virtual QString geometryType() const;
 
     virtual int dimension() const;
-
+    virtual QgsLineString *createEmptyWithSameType() const /Factory/;
     virtual QgsLineString *clone() const /Factory/;
 
     virtual void clear();
 
     virtual bool isEmpty() const;
 
+    virtual QgsLineString *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0,
+                                          double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
 
     virtual bool fromWkb( QgsConstWkbPtr &wkb );
 

diff --git a/python/core/geometry/qgsmulticurve.sip b/python/core/geometry/qgsmulticurve.sip
@@ -21,7 +21,7 @@ class QgsMultiCurve: QgsGeometryCollection
   public:
     QgsMultiCurve();
     virtual QString geometryType() const;
-
+    virtual QgsMultiCurve *createEmptyWithSameType() const /Factory/;
     virtual QgsMultiCurve *clone() const /Factory/;
 
     virtual void clear();

diff --git a/python/core/geometry/qgsmultilinestring.sip b/python/core/geometry/qgsmultilinestring.sip
@@ -22,7 +22,7 @@ class QgsMultiLineString: QgsMultiCurve
     QgsMultiLineString();
 
     virtual QString geometryType() const;
-
+    virtual QgsMultiLineString *createEmptyWithSameType() const /Factory/;
     virtual QgsMultiLineString *clone() const /Factory/;
 
     virtual void clear();

diff --git a/python/core/geometry/qgsmultipoint.sip b/python/core/geometry/qgsmultipoint.sip
@@ -22,7 +22,7 @@ class QgsMultiPointV2: QgsGeometryCollection
     QgsMultiPointV2();
 
     virtual QString geometryType() const;
-
+    virtual QgsMultiPointV2 *createEmptyWithSameType() const /Factory/;
     virtual QgsMultiPointV2 *clone() const /Factory/;
 
     virtual QgsMultiPointV2 *toCurveType() const /Factory/;

diff --git a/python/core/geometry/qgsmultipolygon.sip b/python/core/geometry/qgsmultipolygon.sip
@@ -21,7 +21,7 @@ class QgsMultiPolygonV2: QgsMultiSurface
   public:
     QgsMultiPolygonV2();
     virtual QString geometryType() const;
-
+    virtual QgsMultiPolygonV2 *createEmptyWithSameType() const /Factory/;
     virtual void clear();
 
     virtual QgsMultiPolygonV2 *clone() const /Factory/;

diff --git a/python/core/geometry/qgsmultisurface.sip b/python/core/geometry/qgsmultisurface.sip
@@ -21,9 +21,8 @@ class QgsMultiSurface: QgsGeometryCollection
   public:
     QgsMultiSurface();
     virtual QString geometryType() const;
-
     virtual void clear();
-
+    virtual QgsMultiSurface *createEmptyWithSameType() const /Factory/;
     virtual QgsMultiSurface *clone() const /Factory/;
 
     virtual QgsMultiSurface *toCurveType() const /Factory/;

diff --git a/python/core/geometry/qgspoint.sip b/python/core/geometry/qgspoint.sip
@@ -335,9 +335,10 @@ class QgsPoint: QgsAbstractGeometry
     virtual QString geometryType() const;
 
     virtual int dimension() const;
-
+    virtual QgsPoint *createEmptyWithSameType() const /Factory/;
     virtual QgsPoint *clone() const /Factory/;
-
+    virtual QgsPoint *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0,
+                                     double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
     virtual void clear();
 
     virtual bool fromWkb( QgsConstWkbPtr &wkb );

diff --git a/python/core/geometry/qgspolygon.sip b/python/core/geometry/qgspolygon.sip
@@ -23,7 +23,7 @@ class QgsPolygonV2: QgsCurvePolygon
     QgsPolygonV2();
 
     virtual QString geometryType() const;
-
+    virtual QgsPolygonV2 *createEmptyWithSameType() const /Factory/;
     virtual QgsPolygonV2 *clone() const /Factory/;
 
     virtual void clear();

diff --git a/python/core/geometry/qgssurface.sip b/python/core/geometry/qgssurface.sip
@@ -25,6 +25,9 @@ class QgsSurface: QgsAbstractGeometry
  :rtype: QgsPolygonV2
 %End
 
+    virtual QgsSurface *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0,
+                                       double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
+
     virtual QgsRectangle boundingBox() const;
 %Docstring
  Returns the minimal bounding box for the geometry

diff --git a/python/core/geometry/qgstriangle.sip b/python/core/geometry/qgstriangle.sip
@@ -53,7 +53,7 @@ class QgsTriangle : QgsPolygonV2
 %End
 
     virtual QString geometryType() const;
-
+    virtual QgsTriangle *createEmptyWithSameType() const /Factory/;
     virtual QgsTriangle *clone() const /Factory/;
 
     virtual void clear();

diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
@@ -467,6 +467,7 @@ SET(QGIS_CORE_SRCS
   geometry/qgsrectangle.cpp
   geometry/qgsreferencedgeometry.cpp
   geometry/qgsregularpolygon.cpp
+  geometry/qgssurface.cpp
   geometry/qgstriangle.cpp
   geometry/qgswkbptr.cpp
   geometry/qgswkbtypes.cpp

diff --git a/src/core/geometry/qgsabstractgeometry.h b/src/core/geometry/qgsabstractgeometry.h
@@ -110,6 +110,14 @@ class CORE_EXPORT QgsAbstractGeometry
     QgsAbstractGeometry( const QgsAbstractGeometry &geom );
     QgsAbstractGeometry &operator=( const QgsAbstractGeometry &geom );
 
+    /** Makes a new geometry with the same class and same WKB and transfers ownership.
+     * To create it, the geometry is default constructedand then the WKB is changed.
+     * \returns the new empty geometry. Callee takes ownership.
+     * \see clone
+     * \since 3.0
+     */
+    virtual QgsAbstractGeometry *createEmptyWithSameType() const = 0 SIP_FACTORY;
+
     /**
      * Clones the geometry by performing a deep copy
      */
@@ -411,6 +419,30 @@ class CORE_EXPORT QgsAbstractGeometry
     */
     virtual QgsAbstractGeometry *toCurveType() const = 0 SIP_FACTORY;
 
+    /** Makes a new geometry with all the points or vertices snapped to the closest point of the grid.
+     * It transfers ownership to the callee.
+     * If it couldn't make the gridified geometry it returns nullptr.
+     * It may generate an invalid geometry (in some corner cases).
+     * It can also be thought as rounding the edges and it may be useful for removing errors.
+     * If the geometry is curved, it will be segmentized before gridifying it.
+     * Example:
+     * \code
+     * geometry->snappedToGrid(1, 1);
+     * \endcode
+     * In this case we use a 2D grid of 1x1 to gridify.
+     * In this case, it can be thought like rounding the x and y of all the points/vertices to full units (remove all decimals).
+     * \param hSpacing Horizontal spacing of the grid (x axis). 0 to disable.
+     * \param vSpacing Vertical spacing of the grid (y axis). 0 to disable.
+     * \param dSpacing Depth spacing of the grid (z axis). 0 (default) to disable.
+     * \param mSpacing Custom dimension spacing of the grid (m axis). 0 (default) to disable.
+     * \param tolerance In case of segmentation, the tolerance to use (passed to segmentize as is).
+     * \param toleranceType In case of segmentation, the toleranceType to use (passed to segmentize as is).
+     * \returns the segmentized geometry or nullptr if it wasn't possible to make. Caller takes ownership.
+     * \see segmentize
+     * \since 3.0
+     */
+    virtual QgsAbstractGeometry *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0, double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const = 0 SIP_FACTORY;
+
     /**
      * Returns approximate angle at a vertex. This is usually the average angle between adjacent
      * segments, and can be pictured as the orientation of a line following the curvature of the

diff --git a/src/core/geometry/qgscircularstring.cpp b/src/core/geometry/qgscircularstring.cpp
@@ -66,6 +66,13 @@ bool QgsCircularString::operator!=( const QgsCurve &other ) const
   return !operator==( other );
 }
 
+QgsCircularString *QgsCircularString::createEmptyWithSameType() const
+{
+  auto result = new QgsCircularString();
+  result->mWkbType = mWkbType;
+  return result;
+}
+
 QString QgsCircularString::geometryType() const
 {
   return QStringLiteral( "CircularString" );

diff --git a/src/core/geometry/qgscircularstring.h b/src/core/geometry/qgscircularstring.h
@@ -41,6 +41,7 @@ class CORE_EXPORT QgsCircularString: public QgsCurve
 
     virtual QString geometryType() const override;
     virtual int dimension() const override;
+    virtual QgsCircularString *createEmptyWithSameType() const override SIP_FACTORY;
     virtual QgsCircularString *clone() const override SIP_FACTORY;
     virtual void clear() override;
 

diff --git a/src/core/geometry/qgscompoundcurve.cpp b/src/core/geometry/qgscompoundcurve.cpp
@@ -61,6 +61,13 @@ bool QgsCompoundCurve::operator!=( const QgsCurve &other ) const
   return !operator==( other );
 }
 
+QgsCompoundCurve *QgsCompoundCurve::createEmptyWithSameType() const
+{
+  auto result = new QgsCompoundCurve();
+  result->mWkbType = mWkbType;
+  return result;
+}
+
 QString QgsCompoundCurve::geometryType() const
 {
   return QStringLiteral( "CompoundCurve" );

diff --git a/src/core/geometry/qgscompoundcurve.h b/src/core/geometry/qgscompoundcurve.h
@@ -41,6 +41,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve
 
     virtual QString geometryType() const override;
     virtual int dimension() const override;
+    virtual QgsCompoundCurve *createEmptyWithSameType() const override SIP_FACTORY;
     virtual QgsCompoundCurve *clone() const override SIP_FACTORY;
     virtual void clear() override;
 

diff --git a/src/core/geometry/qgscurve.cpp b/src/core/geometry/qgscurve.cpp
@@ -15,6 +15,8 @@
  *                                                                         *
  ***************************************************************************/
 
+#include <memory>
+
 #include "qgscurve.h"
 #include "qgslinestring.h"
 #include "qgspoint.h"
@@ -129,6 +131,13 @@ QgsAbstractGeometry *QgsCurve::boundary() const
   return multiPoint;
 }
 
+QgsCurve *QgsCurve::snappedToGrid( double hSpacing, double vSpacing, double dSpacing, double mSpacing,
+                                   double tolerance, SegmentationToleranceType toleranceType ) const
+{
+  std::unique_ptr<QgsLineString> line { curveToLine( tolerance, toleranceType ) };
+  return line->snappedToGrid( hSpacing, vSpacing, dSpacing, mSpacing );
+}
+
 QgsCurve *QgsCurve::segmentize( double tolerance, SegmentationToleranceType toleranceType ) const
 {
   return curveToLine( tolerance, toleranceType );

diff --git a/src/core/geometry/qgscurve.h b/src/core/geometry/qgscurve.h
@@ -123,6 +123,9 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry
 
     QgsAbstractGeometry *boundary() const override SIP_FACTORY;
 
+    virtual QgsCurve *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0,
+                                     double tolerance = M_PI / 180., SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY;
+
     /**
      * Returns a geometry without curves. Caller takes ownership
      * \param tolerance segmentation tolerance