QGIS API Documentation  2.17.0-Master (8784312)
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 QgsMapRenderer;
29 class QgsMapSettings;
30 class QgsVectorLayer;
31 class QPoint;
32 
36 struct CORE_EXPORT QgsSnappingResult
37 {
57 };
58 
59 
60 
63 class CORE_EXPORT QgsSnapper
64 {
65  public:
68  {
71  //snap to vertex and also to segment if no vertex is within the search tolerance
72  SnapToVertexAndSegment
73  };
74 
76  {
83  SnapWithResultsWithinTolerances
84  };
85 
86  struct SnapLayer
87  {
91  double mTolerance;
96  };
97 
99  Q_DECL_DEPRECATED QgsSnapper( QgsMapRenderer *mapRender );
100 
101  explicit QgsSnapper( const QgsMapSettings& mapSettings );
102 
110  Q_DECL_DEPRECATED int snapPoint( QPoint startPoint, QList<QgsSnappingResult> &snappingResult, const QList<QgsPoint> &excludePoints = QList<QgsPoint>() );
111 
118  int snapMapPoint( const QgsPoint &mapCoordPoint, QList<QgsSnappingResult> &snappingResult, const QList<QgsPoint> &excludePoints = QList<QgsPoint>() );
119 
120  //setters
121  void setSnapLayers( const QList<QgsSnapper::SnapLayer>& snapLayers );
122  void setSnapMode( QgsSnapper::SnappingMode snapMode );
123 
124  private:
125 
127  void cleanResultList( QMultiMap<double, QgsSnappingResult>& list, const QList<QgsPoint>& excludeList ) const;
128 
132  const QgsMapSettings& mMapSettings;
134  QgsSnapper::SnappingMode mSnapMode;
136  QList<QgsSnapper::SnapLayer> mSnapLayers;
137 };
138 
139 #endif
double mTolerance
The snapping tolerances for the layers, always in source coordinate systems of the layer...
Definition: qgssnapper.h:91
UnitType
Type of unit of tolerance value from settings.
Definition: qgstolerance.h:33
A non GUI class for rendering a map layer set onto a QPainter.
QgsTolerance::UnitType mUnitType
What unit is used for tolerance.
Definition: qgssnapper.h:95
QgsSnapper::SnappingType mSnapTo
What snapping type to use (snap to segment or to vertex)
Definition: qgssnapper.h:93
The QgsMapSettings class contains configuration for rendering of the map.
SnappingType
Snap to vertex, to segment or both.
Definition: qgssnapper.h:67
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:63
int afterVertexNr
The index of the vertex after snappedVertex or -1 if no such vertex.
Definition: qgssnapper.h:52
Several snapping results which have the same position are returned.
Definition: qgssnapper.h:81
QgsFeatureId snappedAtGeometry
Index of the snapped geometry.
Definition: qgssnapper.h:54
A class to represent a point.
Definition: qgspoint.h:117
QgsPoint beforeVertex
The layer coordinates of the vertex before snappedVertex.
Definition: qgssnapper.h:44
QgsPoint afterVertex
The layer coordinates of the vertex after snappedVertex.
Definition: qgssnapper.h:49
int snappedVertexNr
The vertex index of snappedVertex or -1 if no such vertex number (e.g.
Definition: qgssnapper.h:42
Only one snapping result is returned.
Definition: qgssnapper.h:78
QgsPoint snappedVertex
The coordinates of the snapping result.
Definition: qgssnapper.h:39
QgsVectorLayer * mLayer
The layer to which snapping is applied.
Definition: qgssnapper.h:89
qint64 QgsFeatureId
Definition: qgsfeature.h:31
Represents a vector layer which manages a vector based data sets.
const QgsVectorLayer * layer
Layer where the snap occurred.
Definition: qgssnapper.h:56
int beforeVertexNr
The index of the vertex before snappedVertex or -1 if no such vertex.
Definition: qgssnapper.h:47