QGIS API Documentation  2.99.0-Master (e077efd)
qgssnapper.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgssnapper.h
3  ------------
4  begin : June 7, 2007
5  copyright : (C) 2007 by Marco Hugentobler
6  email : marco dot hugentobler at karto dot baug dot ethz dot ch
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSSNAPPER_H
19 #define QGSSNAPPER_H
20 
21 #include "qgspoint.h"
22 #include "qgstolerance.h"
23 #include "qgsfeature.h"
24 
25 #include <QList>
26 #include <QMultiMap>
27 
28 class QgsMapSettings;
29 class QgsVectorLayer;
30 class QPoint;
31 
35 // ### QGIS 3: remove from API
36 struct CORE_EXPORT QgsSnappingResult
37 {
40 
46 
52 
60 };
61 
62 
63 
66 // ### QGIS 3: remove from API
67 class CORE_EXPORT QgsSnapper
68 {
69  public:
72  {
75  //snap to vertex and also to segment if no vertex is within the search tolerance
76  SnapToVertexAndSegment
77  };
78 
80  {
83 
88  SnapWithResultsWithinTolerances
89  };
90 
91  struct SnapLayer
92  {
96  double mTolerance;
101  };
102 
103  explicit QgsSnapper( const QgsMapSettings& mapSettings );
104 
111  int snapMapPoint( const QgsPoint &mapCoordPoint, QList<QgsSnappingResult> &snappingResult, const QList<QgsPoint> &excludePoints = QList<QgsPoint>() );
112 
113  //setters
114  void setSnapLayers( const QList<QgsSnapper::SnapLayer>& snapLayers );
115  void setSnapMode( QgsSnapper::SnappingMode snapMode );
116 
117  private:
118 
120  void cleanResultList( QMultiMap<double, QgsSnappingResult>& list, const QList<QgsPoint>& excludeList ) const;
121 
125  const QgsMapSettings& mMapSettings;
127  QgsSnapper::SnappingMode mSnapMode;
129  QList<QgsSnapper::SnapLayer> mSnapLayers;
130 };
131 
132 #endif
double mTolerance
The snapping tolerances for the layers, always in source coordinate systems of the layer...
Definition: qgssnapper.h:96
UnitType
Type of unit of tolerance value from settings.
Definition: qgstolerance.h:35
QgsTolerance::UnitType mUnitType
What unit is used for tolerance.
Definition: qgssnapper.h:100
QgsSnapper::SnappingType mSnapTo
What snapping type to use (snap to segment or to vertex)
Definition: qgssnapper.h:98
The QgsMapSettings class contains configuration for rendering of the map.
SnappingType
Snap to vertex, to segment or both.
Definition: qgssnapper.h:71
Represents the result of a snapping operation.
Definition: qgssnapper.h:36
A class that allows advanced snapping operations on a set of vector layers.
Definition: qgssnapper.h:67
int afterVertexNr
The index of the vertex after snappedVertex or -1 if no such vertex.
Definition: qgssnapper.h:55
Several snapping results which have the same position are returned.
Definition: qgssnapper.h:86
QgsFeatureId snappedAtGeometry
Index of the snapped geometry.
Definition: qgssnapper.h:57
A class to represent a point.
Definition: qgspoint.h:111
QgsPoint beforeVertex
The layer coordinates of the vertex before snappedVertex.
Definition: qgssnapper.h:45
QgsPoint afterVertex
The layer coordinates of the vertex after snappedVertex.
Definition: qgssnapper.h:51
int snappedVertexNr
The vertex index of snappedVertex or -1 if no such vertex number (e.g.
Definition: qgssnapper.h:43
Only one snapping result is returned.
Definition: qgssnapper.h:82
QgsPoint snappedVertex
The coordinates of the snapping result.
Definition: qgssnapper.h:39
QgsVectorLayer * mLayer
The layer to which snapping is applied.
Definition: qgssnapper.h:94
qint64 QgsFeatureId
Definition: qgsfeature.h:32
Represents a vector layer which manages a vector based data sets.
const QgsVectorLayer * layer
Layer where the snap occurred.
Definition: qgssnapper.h:59
int beforeVertexNr
The index of the vertex before snappedVertex or -1 if no such vertex.
Definition: qgssnapper.h:49