QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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 
62 class CORE_EXPORT QgsSnapper
63 {
64  public:
67  {
70  //snap to vertex and also to segment if no vertex is within the search tolerance
71  SnapToVertexAndSegment
72  };
73 
75  {
82  SnapWithResultsWithinTolerances
83  };
84 
85  struct SnapLayer
86  {
90  double mTolerance;
95  };
96 
98  Q_DECL_DEPRECATED QgsSnapper( QgsMapRenderer* mapRender );
99 
100  explicit QgsSnapper( const QgsMapSettings& mapSettings );
101 
102  ~QgsSnapper();
109  int snapPoint( const QPoint& startPoint, QList<QgsSnappingResult>& snappingResult, const QList<QgsPoint>& excludePoints = QList<QgsPoint>() );
110 
111  //setters
112  void setSnapLayers( const QList<QgsSnapper::SnapLayer>& snapLayers );
113  void setSnapMode( QgsSnapper::SnappingMode snapMode );
114 
115  private:
116 
118  void cleanResultList( QMultiMap<double, QgsSnappingResult>& list, const QList<QgsPoint>& excludeList ) const;
119 
122  const QgsMapSettings& mMapSettings;
124  QgsSnapper::SnappingMode mSnapMode;
126  QList<QgsSnapper::SnapLayer> mSnapLayers;
127 };
128 
129 #endif
double mTolerance
The snapping tolerances for the layers, always in source coordinate systems of the layer...
Definition: qgssnapper.h:90
Definition: qgssnapper.h:85
Definition: qgssnapper.h:69
A non GUI class for rendering a map layer set onto a QPainter.
Definition: qgsmaprenderer.h:133
QgsTolerance::UnitType mUnitType
What unit is used for tolerance.
Definition: qgssnapper.h:94
QgsSnapper::SnappingType mSnapTo
What snapping type to use (snap to segment or to vertex)
Definition: qgssnapper.h:92
The QgsMapSettings class contains configuration for rendering of the map.
Definition: qgsmapsettings.h:52
SnappingType
Snap to vertex, to segment or both.
Definition: qgssnapper.h:66
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:62
SnappingMode
Definition: qgssnapper.h:74
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:80
QgsFeatureId snappedAtGeometry
Index of the snapped geometry.
Definition: qgssnapper.h:54
A class to represent a point geometry.
Definition: qgspoint.h:63
Definition: qgssnapper.h:68
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:77
QgsPoint snappedVertex
The coordinates of the snapping result.
Definition: qgssnapper.h:39
QgsVectorLayer * mLayer
The layer to which snapping is applied.
Definition: qgssnapper.h:88
qint64 QgsFeatureId
Definition: qgsfeature.h:30
UnitType
Type of unit of tolerance value from settings.
Definition: qgstolerance.h:33
Represents a vector layer which manages a vector based data sets.
Definition: qgsvectorlayer.h:470
const QgsVectorLayer * layer
Layer where the snap occured.
Definition: qgssnapper.h:56
int beforeVertexNr
The index of the vertex before snappedVertex or -1 if no such vertex.
Definition: qgssnapper.h:47