Improvements to QgsAbstractGeometry::snappedToGrid

- Fix loss of coordinates when not rounding a particular dimension - Don't segmentize curved geometries - Add extra unit tests - Make createEmptyWithSameType() protected and skip from Python bindings. This method relies on low-level manipulation of the returned geometry which we do not want to expose as public/fixed API
qgis · Oct 27, 2017 · c67e398 · c67e398
1 parent 3f5b11b
commit c67e398
Show file tree

Hide file tree

Showing 48 changed files with 470 additions and 301 deletions.
diff --git a/python/core/geometry/qgsabstractgeometry.sip b/python/core/geometry/qgsabstractgeometry.sip
@@ -71,16 +71,6 @@ 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
@@ -412,14 +402,14 @@ 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/;
+    virtual QgsAbstractGeometry *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) 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.
+ Ownership is transferred to the caller.
+
+ If the gridified geometry could not be calculated a None will be returned.
  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);
@@ -430,10 +420,6 @@ Returns the centroid of the geometry
  \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
@@ -528,6 +514,7 @@ Returns the centroid of the geometry
 
   protected:
 
+
     virtual bool hasChildGeometries() const;
 %Docstring
  Returns whether the geometry has any child geometries (false for point / curve, true otherwise)

diff --git a/python/core/geometry/qgscircularstring.sip b/python/core/geometry/qgscircularstring.sip
@@ -25,17 +25,24 @@ class QgsCircularString: QgsCurve
     QgsCircularString();
 
     virtual bool operator==( const QgsCurve &other ) const;
+
     virtual bool operator!=( const QgsCurve &other ) const;
 
+
     virtual QString geometryType() const;
+
     virtual int dimension() const;
-    virtual QgsCircularString *createEmptyWithSameType() const /Factory/;
+
     virtual QgsCircularString *clone() const /Factory/;
+
     virtual void clear();
 
+
     virtual bool fromWkb( QgsConstWkbPtr &wkb );
+
     virtual bool fromWkt( const QString &wkt );
 
+
     virtual QByteArray asWkb() const;
 
     virtual QString asWkt( int precision = 17 ) const;
@@ -67,10 +74,14 @@ class QgsCircularString: QgsCurve
 %End
 
     virtual double length() const;
+
     virtual QgsPoint startPoint() const;
+
     virtual QgsPoint endPoint() const;
 
+
     virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
+
 %Docstring
  Returns a new line string geometry corresponding to a segmentized approximation
  of the curve.
@@ -82,6 +93,9 @@ class QgsCircularString: QgsCurve
  :rtype: QgsLineString
 %End
 
+    virtual QgsCircularString *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const /Factory/;
+
+
     virtual void draw( QPainter &p ) const;
 
      virtual void transform( const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d = QgsCoordinateTransform::ForwardTransform,
@@ -90,17 +104,15 @@ class QgsCircularString: QgsCurve
 
     virtual void addToPainterPath( QPainterPath &path ) const;
 
-
     virtual void drawAsPolygon( QPainter &p ) const;
 
-
     virtual bool insertVertex( QgsVertexId position, const QgsPoint &vertex );
+
     virtual bool moveVertex( QgsVertexId position, const QgsPoint &newPos );
+
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/,
-                                   QgsVertexId &vertexAfter /Out/,
-                                   bool *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
+    virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, bool *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
 
     virtual bool pointAt( int node, QgsPoint &point, QgsVertexId::VertexType &type ) const;
 
@@ -120,21 +132,28 @@ class QgsCircularString: QgsCurve
 
     virtual QgsCircularString *reversed() const  /Factory/;
 
+
     virtual bool addZValue( double zValue = 0 );
+
     virtual bool addMValue( double mValue = 0 );
 
+
     virtual bool dropZValue();
+
     virtual bool dropMValue();
 
+
     virtual double xAt( int index ) const;
 
     virtual double yAt( int index ) const;
 
 
   protected:
+    virtual QgsCircularString *createEmptyWithSameType() const /Factory/;
 
     virtual QgsRectangle calculateBoundingBox() const;
 
+
 };
 
 

diff --git a/python/core/geometry/qgscompoundcurve.sip b/python/core/geometry/qgscompoundcurve.sip
@@ -25,17 +25,24 @@ class QgsCompoundCurve: QgsCurve
     ~QgsCompoundCurve();
 
     virtual bool operator==( const QgsCurve &other ) const;
+
     virtual bool operator!=( const QgsCurve &other ) const;
 
+
     virtual QString geometryType() const;
+
     virtual int dimension() const;
-    virtual QgsCompoundCurve *createEmptyWithSameType() const /Factory/;
+
     virtual QgsCompoundCurve *clone() const /Factory/;
+
     virtual void clear();
 
+
     virtual bool fromWkb( QgsConstWkbPtr &wkb );
+
     virtual bool fromWkt( const QString &wkt );
 
+
     virtual QByteArray asWkb() const;
 
     virtual QString asWkt( int precision = 17 ) const;
@@ -48,14 +55,20 @@ class QgsCompoundCurve: QgsCurve
 
 
     virtual double length() const;
+
     virtual QgsPoint startPoint() const;
+
     virtual QgsPoint endPoint() const;
+
     virtual void points( QgsPointSequence &pts /Out/ ) const;
+
     virtual int numPoints() const;
+
     virtual bool isEmpty() const;
 
 
     virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const /Factory/;
+
 %Docstring
  Returns a new line string geometry corresponding to a segmentized approximation
  of the curve.
@@ -64,6 +77,9 @@ class QgsCompoundCurve: QgsCurve
  :rtype: QgsLineString
 %End
 
+    virtual QgsCompoundCurve *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const /Factory/;
+
+
     int nCurves() const;
 %Docstring
  Returns the number of curves in the geometry.
@@ -102,18 +118,16 @@ class QgsCompoundCurve: QgsCurve
 
     virtual void drawAsPolygon( QPainter &p ) const;
 
-
     virtual bool insertVertex( QgsVertexId position, const QgsPoint &vertex );
+
     virtual bool moveVertex( QgsVertexId position, const QgsPoint &newPos );
+
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/,
-                                   QgsVertexId &vertexAfter /Out/, bool *leftOf /Out/ = 0,
-                                   double epsilon = 4 * DBL_EPSILON ) const;
+    virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, bool *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
 
     virtual bool pointAt( int node, QgsPoint &point, QgsVertexId::VertexType &type ) const;
 
-
     virtual void sumUpArea( double &sum /Out/ ) const;
 
 
@@ -136,12 +150,17 @@ Appends first point if not already closed.
 
     virtual QgsCompoundCurve *reversed() const /Factory/;
 
+
     virtual bool addZValue( double zValue = 0 );
+
     virtual bool addMValue( double mValue = 0 );
 
+
     virtual bool dropZValue();
+
     virtual bool dropMValue();
 
+
     virtual double xAt( int index ) const;
 
     virtual double yAt( int index ) const;
@@ -151,6 +170,9 @@ Appends first point if not already closed.
 
     virtual QgsRectangle calculateBoundingBox() const;
 
+    virtual QgsCompoundCurve *createEmptyWithSameType() const /Factory/;
+
+
 };
 
 

diff --git a/python/core/geometry/qgscurve.sip b/python/core/geometry/qgscurve.sip
@@ -126,8 +126,6 @@ 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/;
 
@@ -186,6 +184,7 @@ class QgsCurve: QgsAbstractGeometry
     virtual int childCount() const;
     virtual QgsPoint childPoint( int index ) const;
 
+
 };
 
 /************************************************************************

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,8 +64,9 @@ 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/;
+
+    virtual QgsCurvePolygon *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const /Factory/;
+
 
     int numInteriorRings() const;
 %Docstring
@@ -197,9 +198,13 @@ Adds an interior ring to the geometry (takes ownership)
     virtual QgsCurvePolygon *toCurveType() const /Factory/;
 
   protected:
+    virtual QgsCurvePolygon *createEmptyWithSameType() const /Factory/;
+
     virtual int childCount() const;
+
     virtual QgsAbstractGeometry *childGeometry( int index ) const;
 
+
   protected:
 
 

diff --git a/python/core/geometry/qgsgeometrycollection.sip b/python/core/geometry/qgsgeometrycollection.sip
@@ -26,7 +26,6 @@ class QgsGeometryCollection: QgsAbstractGeometry
     QgsGeometryCollection( const QgsGeometryCollection &c );
     virtual ~QgsGeometryCollection();
 
-    virtual QgsGeometryCollection *createEmptyWithSameType() const /Factory/;
     virtual QgsGeometryCollection *clone() const /Factory/;
 
 
@@ -51,8 +50,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 QgsGeometryCollection *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const /Factory/;
     virtual QgsAbstractGeometry *boundary() const /Factory/;
 
     virtual void adjacentVertices( QgsVertexId vertex, QgsVertexId &previousVertex /Out/, QgsVertexId &nextVertex /Out/ ) const;
@@ -175,9 +174,13 @@ Adds a geometry and takes ownership. Returns true in case of success.
 
 
   protected:
+    virtual QgsGeometryCollection *createEmptyWithSameType() const /Factory/;
+
     virtual int childCount() const;
+
     virtual QgsAbstractGeometry *childGeometry( int index ) const;
 
+
   protected:
 
     virtual bool wktOmitChildType() const;

diff --git a/python/core/geometry/qgslinestring.sip b/python/core/geometry/qgslinestring.sip
@@ -170,15 +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 QgsLineString *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const /Factory/;
+
 
     virtual bool fromWkb( QgsConstWkbPtr &wkb );
 
@@ -270,6 +270,7 @@ Closes the line string by appending the first point to the end of the line, if i
 
 
   protected:
+    virtual QgsLineString *createEmptyWithSameType() const /Factory/;
 
     virtual QgsRectangle calculateBoundingBox() const;
 

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();
@@ -52,6 +52,11 @@ class QgsMultiCurve: QgsGeometryCollection
 
 
 
+  protected:
+
+    virtual QgsMultiCurve *createEmptyWithSameType() const /Factory/;
+
+
 };