Minor fixes and doxymentation for QgsSnappingUtils

m-kuhn · m-kuhn · commit dab157f70fb8 · 2016-06-21T11:46:18.000+02:00
diff --git a/python/core/qgspointlocator.sip b/python/core/qgspointlocator.sip
@@ -29,11 +29,11 @@ class QgsPointLocator : QObject
 
     enum Type
     {
-      Invalid,
-      Vertex,
-      Edge,
-      Area,
-      All
+      Invalid = 0, //!< Invalid
+      Vertex  = 1, //!< Snapped to a vertex. Can be a vertex of the geometry or an intersection.
+      Edge    = 2, //!< Snapped to an edge
+      Area    = 4, //!< Snapped to an area
+      All     = 7  //!< Combination of vertex, edge and area
     };
 
     typedef QFlags<QgsPointLocator::Type> Types;
diff --git a/python/core/qgssnappingutils.sip b/python/core/qgssnappingutils.sip
@@ -69,7 +69,7 @@ class QgsSnappingUtils : QObject
      */
     struct LayerConfig
     {
-      LayerConfig( QgsVectorLayer* l, const QgsPointLocator::Types& t, double tol, QgsTolerance::UnitType u );
+      LayerConfig( QgsVectorLayer* l, QgsPointLocator::Types t, double tol, QgsTolerance::UnitType u );
 
       bool operator==( const QgsSnappingUtils::LayerConfig& other ) const;
       bool operator!=( const QgsSnappingUtils::LayerConfig& other ) const;
diff --git a/src/core/qgspointlocator.h b/src/core/qgspointlocator.h
@@ -77,10 +77,10 @@ class CORE_EXPORT QgsPointLocator : public QObject
      */
     enum Type
     {
-      Invalid = 0,   //!< Invalid
-      Vertex = 1,    //!< Snapped to a vertex. Can be a vertex of the geometry or an intersection.
-      Edge = 2,      //!< Snapped to an edge
-      Area = 4,      //!< Snapped to an area
+      Invalid = 0, //!< Invalid
+      Vertex  = 1, //!< Snapped to a vertex. Can be a vertex of the geometry or an intersection.
+      Edge    = 2, //!< Snapped to an edge
+      Area    = 4, //!< Snapped to an area
       All = Vertex | Edge | Area //!< Combination of vertex, edge and area
     };
 
diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h
@@ -90,7 +90,7 @@ class CORE_EXPORT QgsProject : public QObject
 
     /** Sets the project's title.
      * @param title new title
-     *  @note added in 2.4
+     * @note added in 2.4
      * @see title()
      */
     void setTitle( const QString& title );
diff --git a/src/core/qgssnappingutils.h b/src/core/qgssnappingutils.h
@@ -65,6 +65,7 @@ class CORE_EXPORT QgsSnappingUtils : public QObject
 
     /** Set current layer so that if mode is SnapCurrentLayer we know which layer to use */
     void setCurrentLayer( QgsVectorLayer* layer );
+    /** The current layer used if mode is SnapCurrentLayer */
     QgsVectorLayer* currentLayer() const { return mCurrentLayer; }
 
 
@@ -105,7 +106,25 @@ class CORE_EXPORT QgsSnappingUtils : public QObject
      */
     struct LayerConfig
     {
-      LayerConfig( QgsVectorLayer* l, const QgsPointLocator::Types& t, double tol, QgsTolerance::UnitType u )
+      /**
+       * Create a new configuration for a snapping layer.
+
+        ```py
+        snapper = QgsMapCanvasSnappingUtils(mapCanvas)
+
+        snapping_layer1 = QgsSnappingUtils.LayerConfig(layer1, QgsPointLocator.Vertex, 10, QgsTolerance.Pixels)
+        snapping_layer2 = QgsSnappingUtils.LayerConfig(layer2, QgsPointLocator.Vertex and QgsPointLocator.Edge, 10, QgsTolerance.Pixels)
+
+        snapper.setLayers([snapping_layer1, snapping_layer2])
+        snapper.setSnapToMapMode(QgsSnappingUtils.SnapAdvanced)
+        ```
+
+       * @param l   The vector layer for which this configuration is
+       * @param t   Which parts of the geometry should be snappable
+       * @param tol The tolerance radius in which the snapping will trigger
+       * @param u   The unit in which the tolerance is specified
+       */
+      LayerConfig( QgsVectorLayer* l, QgsPointLocator::Types t, double tol, QgsTolerance::UnitType u )
           : layer( l )
           , type( t )
           , tolerance( tol )

-Original file line number
+Diff line change
     enum Type
+    {
 -      Invalid,
 -      Vertex,
 -      Edge,
 -      Area,
 -      All
 +      Invalid = 0, //!< Invalid
 +      Vertex  = 1, //!< Snapped to a vertex. Can be a vertex of the geometry or an intersection.
 +      Edge    = 2, //!< Snapped to an edge
 +      Area    = 4, //!< Snapped to an area
 +      All     = 7  //!< Combination of vertex, edge and areaCollapse commentComment on line R36
3nids commented on Jun 21, 2016 
3nids
on Jun 21, 2016
Member
I thought SIP files should not contain the enum values, am I wrong?
m-kuhn replied on Jun 21, 2016 
m-kuhn
on Jun 21, 2016
MemberAuthor
No, you are right
Code has comments. Press enter to view.
     };
     typedef QFlags<QgsPointLocator::Type> Types;
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ class QgsSnappingUtils : QObject`
`69`	`69`	`*/`
`70`	`70`	`struct LayerConfig`
`71`	`71`	`{`
`72`		`- LayerConfig( QgsVectorLayer* l, const QgsPointLocator::Types& t, double tol, QgsTolerance::UnitType u );`
	`72`	`+ LayerConfig( QgsVectorLayer* l, QgsPointLocator::Types t, double tol, QgsTolerance::UnitType u );`
`73`	`73`
`74`	`74`	`bool operator==( const QgsSnappingUtils::LayerConfig& other ) const;`
`75`	`75`	`bool operator!=( const QgsSnappingUtils::LayerConfig& other ) const;`