Skip to content

Commit e060800

Browse files
author
timlinux
committed
API tidy ups for qgssnapper
git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@9542 c8812cc2-4d05-0410-92ff-de0c093fc19c
1 parent 3649a3f commit e060800

13 files changed

+62
-62
lines changed

‎python/core/qgssnapper.sip

+10-10
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,23 @@ class QgsSnapper
3838

3939
public:
4040
/**Snap to vertex, to segment or both*/
41-
enum SNAP_TO
41+
enum SnappingType
4242
{
43-
SNAP_TO_VERTEX,
44-
SNAP_TO_SEGMENT,
43+
SnapToVertex,
44+
SnapToSegment,
4545
//snap to vertex and also to segment if no vertex is within the search tolerance
46-
SNAP_TO_VERTEX_AND_SEGMENT
46+
SnapToVertexAndSegment
4747
};
4848

49-
enum SNAP_MODE
49+
enum SnappingMode
5050
{
5151
/**Only one snapping result is retured*/
52-
ONE_RESULT,
52+
SnapWithOneResult,
5353
/**Several snapping results which have the same position are returned. This is usefull for topological
5454
editing*/
55-
SEVERAL_RESULTS_SAME_POSITION,
55+
SnapWithResultsForSamePosition,
5656
/**All results within the given layer tolerances are returned*/
57-
ALL_RESULTS_WITHIN_GIVEN_TOLERANCES
57+
SnapWithResultsWithinTolerances
5858
};
5959

6060
QgsSnapper(QgsMapRenderer* mapRender);
@@ -68,7 +68,7 @@ public:
6868
//setters
6969
void setLayersToSnap(const QList<QgsVectorLayer*>& layerList);
7070
void setTolerances(const QList<double>& toleranceList);
71-
// TODO wrap void setSnapToList(const QList<QgsSnapper::SNAP_TO>& snapToList);
72-
void setSnapMode(QgsSnapper::SNAP_MODE snapMode);
71+
// TODO wrap void setSnapToList(const QList<QgsSnapper::SnappingType>& snapToList);
72+
void setSnapMode(QgsSnapper::SnappingMode snapMode);
7373

7474
};

‎python/core/qgsvectorlayer.sip

+1-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ public:
288288
@return 0 in case of success
289289
*/
290290
int snapWithContext(const QgsPoint& startPoint, double snappingTolerance, QMultiMap<double, QgsSnappingResult>& snappingResults /Out/,
291-
QgsSnapper::SNAP_TO snap_to);
291+
QgsSnapper::SnappingType snap_to);
292292

293293
/** Draws the layer using coordinate transformation
294294
* @return FALSE if an error occurred during drawing

‎src/app/qgsmaptooladdvertex.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ void QgsMapToolAddVertex::canvasPressEvent( QMouseEvent * e )
5151
mRubberBand = 0;
5252

5353
//snap to segments of the current layer
54-
if ( mSnapper.snapToCurrentLayer( e->pos(), mRecentSnappingResults, QgsSnapper::SNAP_TO_SEGMENT ) != 0 )
54+
if ( mSnapper.snapToCurrentLayer( e->pos(), mRecentSnappingResults, QgsSnapper::SnapToSegment ) != 0 )
5555
{
5656
//error
5757
}

‎src/app/qgsmaptooldeletevertex.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ void QgsMapToolDeleteVertex::canvasPressEvent( QMouseEvent * e )
4343

4444
mRecentSnappingResults.clear();
4545
//do snap -> new recent snapping results
46-
if ( mSnapper.snapToCurrentLayer( e->pos(), mRecentSnappingResults, QgsSnapper::SNAP_TO_VERTEX ) != 0 )
46+
if ( mSnapper.snapToCurrentLayer( e->pos(), mRecentSnappingResults, QgsSnapper::SnapToVertex ) != 0 )
4747
{
4848
//error
4949
}

‎src/app/qgsmaptoolmovevertex.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ void QgsMapToolMoveVertex::canvasPressEvent( QMouseEvent * e )
7979
mRubberBandMovingPoints.clear();
8080

8181
//do snap -> new recent snapping results
82-
if ( mSnapper.snapToCurrentLayer( e->pos(), mRecentSnappingResults, QgsSnapper::SNAP_TO_VERTEX ) != 0 )
82+
if ( mSnapper.snapToCurrentLayer( e->pos(), mRecentSnappingResults, QgsSnapper::SnapToVertex ) != 0 )
8383
{
8484
//error
8585
}

‎src/core/qgssnapper.cpp

+5-5
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ int QgsSnapper::snapPoint( const QPoint& startPoint, QList<QgsSnappingResult>& s
5151

5252
QList<QgsVectorLayer*>::iterator layerIt = mLayersToSnap.begin();
5353
QList<double>::const_iterator toleranceIt = mSnappingTolerances.constBegin();
54-
QList<QgsSnapper::SNAP_TO>::const_iterator snapToIt = mSnapToList.constBegin();
54+
QList<QgsSnapper::SnappingType>::const_iterator snapToIt = mSnapToList.constBegin();
5555

5656
QMultiMap<double, QgsSnappingResult> snappingResultList;//all snapping results
5757
QMultiMap<double, QgsSnappingResult> currentResultList; //snapping results of examined layer
@@ -95,12 +95,12 @@ int QgsSnapper::snapPoint( const QPoint& startPoint, QList<QgsSnappingResult>& s
9595
return 0;
9696
}
9797

98-
if ( mSnapMode == QgsSnapper::ONE_RESULT )
98+
if ( mSnapMode == QgsSnapper::SnapWithOneResult )
9999
{
100100
//return only closest result
101101
snappingResult.push_back( evalIt.value() );
102102
}
103-
else if ( mSnapMode == QgsSnapper::SEVERAL_RESULTS_SAME_POSITION )
103+
else if ( mSnapMode == QgsSnapper::SnapWithResultsForSamePosition )
104104
{
105105
//take all snapping Results within a certain tolerance because rounding differences may occur
106106
double tolerance = 0.000001;
@@ -138,12 +138,12 @@ void QgsSnapper::setTolerances( const QList<double>& toleranceList )
138138
mSnappingTolerances = toleranceList;
139139
}
140140

141-
void QgsSnapper::setSnapToList( const QList<QgsSnapper::SNAP_TO>& snapToList )
141+
void QgsSnapper::setSnapToList( const QList<QgsSnapper::SnappingType>& snapToList )
142142
{
143143
mSnapToList = snapToList;
144144
}
145145

146-
void QgsSnapper::setSnapMode( QgsSnapper::SNAP_MODE snapMode )
146+
void QgsSnapper::setSnapMode( QgsSnapper::SnappingMode snapMode )
147147
{
148148
mSnapMode = snapMode;
149149
}

‎src/core/qgssnapper.h

+12-12
Original file line numberDiff line numberDiff line change
@@ -59,23 +59,23 @@ class CORE_EXPORT QgsSnapper
5959
{
6060
public:
6161
/**Snap to vertex, to segment or both*/
62-
enum SNAP_TO
62+
enum SnappingType
6363
{
64-
SNAP_TO_VERTEX,
65-
SNAP_TO_SEGMENT,
64+
SnapToVertex,
65+
SnapToSegment,
6666
//snap to vertex and also to segment if no vertex is within the search tolerance
67-
SNAP_TO_VERTEX_AND_SEGMENT
67+
SnapToVertexAndSegment
6868
};
6969

70-
enum SNAP_MODE
70+
enum SnappingMode
7171
{
7272
/**Only one snapping result is retured*/
73-
ONE_RESULT,
73+
SnapWithOneResult,
7474
/**Several snapping results which have the same position are returned. This is usefull for topological
7575
editing*/
76-
SEVERAL_RESULTS_SAME_POSITION,
76+
SnapWithResultsForSamePosition,
7777
/**All results within the given layer tolerances are returned*/
78-
ALL_RESULTS_WITHIN_GIVEN_TOLERANCES
78+
SnapWithResultsWithinTolerances
7979
};
8080

8181
QgsSnapper( QgsMapRenderer* mapRender );
@@ -90,8 +90,8 @@ class CORE_EXPORT QgsSnapper
9090
//setters
9191
void setLayersToSnap( const QList<QgsVectorLayer*>& layerList );
9292
void setTolerances( const QList<double>& toleranceList );
93-
void setSnapToList( const QList<QgsSnapper::SNAP_TO>& snapToList );
94-
void setSnapMode( QgsSnapper::SNAP_MODE snapMode );
93+
void setSnapToList( const QList<QgsSnapper::SnappingType>& snapToList );
94+
void setSnapMode( QgsSnapper::SnappingMode snapMode );
9595

9696
private:
9797
/**Don't use the default constructor*/
@@ -104,14 +104,14 @@ class CORE_EXPORT QgsSnapper
104104
of the map and about the relationship between pixel space and map space*/
105105
QgsMapRenderer* mMapRenderer;
106106
/**Snap mode to apply*/
107-
QgsSnapper::SNAP_MODE mSnapMode;
107+
QgsSnapper::SnappingMode mSnapMode;
108108
/**The layers to which snapping is applied*/
109109
QList<QgsVectorLayer*> mLayersToSnap;
110110
/**The snapping tolerances for the layers. The order must correspond to the layer list.
111111
Note that the tolerances are always in source coordinate systems of the layers*/
112112
QList<double> mSnappingTolerances;
113113
/**List if snap to segment of to vertex. The order must correspond to the layer list*/
114-
QList<QgsSnapper::SNAP_TO> mSnapToList;
114+
QList<QgsSnapper::SnappingType> mSnapToList;
115115
};
116116

117117
#endif

‎src/core/qgsvectorlayer.cpp

+7-7
Original file line numberDiff line numberDiff line change
@@ -1928,7 +1928,7 @@ int QgsVectorLayer::addTopologicalPoints( const QgsPoint& p )
19281928
}
19291929

19301930

1931-
if ( snapWithContext( p, threshold, snapResults, QgsSnapper::SNAP_TO_SEGMENT ) != 0 )
1931+
if ( snapWithContext( p, threshold, snapResults, QgsSnapper::SnapToSegment ) != 0 )
19321932
{
19331933
return 2;
19341934
}
@@ -1939,7 +1939,7 @@ int QgsVectorLayer::addTopologicalPoints( const QgsPoint& p )
19391939
{
19401940
//test if p is already a vertex of this geometry. If yes, don't insert it
19411941
bool vertexAlreadyExists = false;
1942-
if ( snapWithContext( p, threshold, vertexSnapResults, QgsSnapper::SNAP_TO_VERTEX ) != 0 )
1942+
if ( snapWithContext( p, threshold, vertexSnapResults, QgsSnapper::SnapToVertex ) != 0 )
19431943
{
19441944
continue;
19451945
}
@@ -3107,7 +3107,7 @@ bool QgsVectorLayer::hasCompatibleSymbology( const QgsMapLayer& other ) const
31073107
bool QgsVectorLayer::snapPoint( QgsPoint& point, double tolerance )
31083108
{
31093109
QMultiMap<double, QgsSnappingResult> snapResults;
3110-
int result = snapWithContext( point, tolerance, snapResults, QgsSnapper::SNAP_TO_VERTEX );
3110+
int result = snapWithContext( point, tolerance, snapResults, QgsSnapper::SnapToVertex );
31113111

31123112
if ( result != 0 )
31133113
{
@@ -3128,7 +3128,7 @@ bool QgsVectorLayer::snapPoint( QgsPoint& point, double tolerance )
31283128

31293129
int QgsVectorLayer::snapWithContext( const QgsPoint& startPoint, double snappingTolerance,
31303130
QMultiMap<double, QgsSnappingResult>& snappingResults,
3131-
QgsSnapper::SNAP_TO snap_to )
3131+
QgsSnapper::SnappingType snap_to )
31323132
{
31333133
if ( snappingTolerance <= 0 || !mDataProvider )
31343134
{
@@ -3154,7 +3154,7 @@ int QgsVectorLayer::snapWithContext( const QgsPoint& startPoint, double snapping
31543154
}
31553155

31563156
void QgsVectorLayer::snapToGeometry( const QgsPoint& startPoint, int featureId, QgsGeometry* geom, double sqrSnappingTolerance,
3157-
QMultiMap<double, QgsSnappingResult>& snappingResults, QgsSnapper::SNAP_TO snap_to ) const
3157+
QMultiMap<double, QgsSnappingResult>& snappingResults, QgsSnapper::SnappingType snap_to ) const
31583158
{
31593159
if ( !geom )
31603160
{
@@ -3167,7 +3167,7 @@ void QgsVectorLayer::snapToGeometry( const QgsPoint& startPoint, int featureId,
31673167
QgsSnappingResult snappingResultVertex;
31683168
QgsSnappingResult snappingResultSegment;
31693169

3170-
if ( snap_to == QgsSnapper::SNAP_TO_VERTEX || snap_to == QgsSnapper::SNAP_TO_VERTEX_AND_SEGMENT )
3170+
if ( snap_to == QgsSnapper::SnapToVertex || snap_to == QgsSnapper::SnapToVertexAndSegment )
31713171
{
31723172
snappedPoint = geom->closestVertex( startPoint, atVertex, beforeVertex, afterVertex, sqrDistVertexSnap );
31733173
if ( sqrDistVertexSnap < sqrSnappingTolerance )
@@ -3190,7 +3190,7 @@ void QgsVectorLayer::snapToGeometry( const QgsPoint& startPoint, int featureId,
31903190
return;
31913191
}
31923192
}
3193-
if ( snap_to == QgsSnapper::SNAP_TO_SEGMENT || snap_to == QgsSnapper::SNAP_TO_VERTEX_AND_SEGMENT ) // snap to segment
3193+
if ( snap_to == QgsSnapper::SnapToSegment || snap_to == QgsSnapper::SnapToVertexAndSegment ) // snap to segment
31943194
{
31953195
if ( geometryType() != QGis::Point ) // cannot snap to segment for points/multipoints
31963196
{

‎src/core/qgsvectorlayer.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
347347
double snappingTolerance,
348348
QMultiMap < double,
349349
QgsSnappingResult > & snappingResults,
350-
QgsSnapper::SNAP_TO snap_to );
350+
QgsSnapper::SnappingType snap_to );
351351

352352
/** Draws the layer
353353
* @return FALSE if an error occurred during drawing
@@ -534,7 +534,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
534534
@param snap_to snap to vertex or to segment
535535
*/
536536
void snapToGeometry( const QgsPoint& startPoint, int featureId, QgsGeometry* geom, double sqrSnappingTolerance,
537-
QMultiMap<double, QgsSnappingResult>& snappingResults, QgsSnapper::SNAP_TO snap_to ) const;
537+
QMultiMap<double, QgsSnappingResult>& snappingResults, QgsSnapper::SnappingType snap_to ) const;
538538

539539
/**Little helper function that gives bounding box from a list of points.
540540
@return 0 in case of success*/

‎src/gui/qgsmapcanvassnapper.cpp

+13-13
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ void QgsMapCanvasSnapper::setMapCanvas( QgsMapCanvas* canvas )
5959
}
6060
}
6161

62-
int QgsMapCanvasSnapper::snapToCurrentLayer( const QPoint& p, QList<QgsSnappingResult>& results, QgsSnapper::SNAP_TO snap_to, double snappingTol, const QList<QgsPoint>& excludePoints )
62+
int QgsMapCanvasSnapper::snapToCurrentLayer( const QPoint& p, QList<QgsSnappingResult>& results, QgsSnapper::SnappingType snap_to, double snappingTol, const QList<QgsPoint>& excludePoints )
6363
{
6464
results.clear();
6565

@@ -70,11 +70,11 @@ int QgsMapCanvasSnapper::snapToCurrentLayer( const QPoint& p, QList<QgsSnappingR
7070
int topologicalEditing = QgsProject::instance()->readNumEntry( "Digitizing", "/TopologicalEditing", 0 );
7171
if ( topologicalEditing == 0 )
7272
{
73-
mSnapper->setSnapMode( QgsSnapper::ONE_RESULT );
73+
mSnapper->setSnapMode( QgsSnapper::SnapWithOneResult );
7474
}
7575
else
7676
{
77-
mSnapper->setSnapMode( QgsSnapper::SEVERAL_RESULTS_SAME_POSITION );
77+
mSnapper->setSnapMode( QgsSnapper::SnapWithResultsForSamePosition );
7878
}
7979

8080
//current vector layer
@@ -91,7 +91,7 @@ int QgsMapCanvasSnapper::snapToCurrentLayer( const QPoint& p, QList<QgsSnappingR
9191

9292
QList<QgsVectorLayer*> layerList;
9393
QList<double> toleranceList;
94-
QList<QgsSnapper::SNAP_TO> snapToList;
94+
QList<QgsSnapper::SnappingType> snapToList;
9595

9696
layerList.push_back( vlayer );
9797
snapToList.push_back( snap_to );
@@ -136,11 +136,11 @@ int QgsMapCanvasSnapper::snapToBackgroundLayers( const QPoint& p, QList<QgsSnapp
136136
int topologicalEditing = QgsProject::instance()->readNumEntry( "Digitizing", "/TopologicalEditing", 0 );
137137
if ( topologicalEditing == 0 )
138138
{
139-
mSnapper->setSnapMode( QgsSnapper::ONE_RESULT );
139+
mSnapper->setSnapMode( QgsSnapper::SnapWithOneResult );
140140
}
141141
else
142142
{
143-
mSnapper->setSnapMode( QgsSnapper::SEVERAL_RESULTS_SAME_POSITION );
143+
mSnapper->setSnapMode( QgsSnapper::SnapWithResultsForSamePosition );
144144
}
145145

146146
//read snapping settings from project
@@ -162,7 +162,7 @@ int QgsMapCanvasSnapper::snapToBackgroundLayers( const QPoint& p, QList<QgsSnapp
162162

163163
QList<QgsVectorLayer*> vectorLayerList;
164164
QList<double> toleranceDoubleList;
165-
QList<QgsSnapper::SNAP_TO> snapTo;
165+
QList<QgsSnapper::SnappingType> snapTo;
166166

167167
//Use snapping information from the project
168168
if ( snappingDefinedInProject )
@@ -200,15 +200,15 @@ int QgsMapCanvasSnapper::snapToBackgroundLayers( const QPoint& p, QList<QgsSnapp
200200
//segment or vertex
201201
if (( *snapIt ) == "to_vertex" )
202202
{
203-
snapTo.push_back( QgsSnapper::SNAP_TO_VERTEX );
203+
snapTo.push_back( QgsSnapper::SnapToVertex );
204204
}
205205
else if (( *snapIt ) == "to_segment" )
206206
{
207-
snapTo.push_back( QgsSnapper::SNAP_TO_SEGMENT );
207+
snapTo.push_back( QgsSnapper::SnapToSegment );
208208
}
209209
else //to vertex and segment
210210
{
211-
snapTo.push_back( QgsSnapper::SNAP_TO_VERTEX_AND_SEGMENT );
211+
snapTo.push_back( QgsSnapper::SnapToVertexAndSegment );
212212
}
213213

214214
}
@@ -234,15 +234,15 @@ int QgsMapCanvasSnapper::snapToBackgroundLayers( const QPoint& p, QList<QgsSnapp
234234
QString defaultSnapString = settings.value( "/qgis/digitizing/default_snap_mode", "to vertex" ).toString();
235235
if ( defaultSnapString == "to segment" )
236236
{
237-
snapTo.push_back( QgsSnapper::SNAP_TO_SEGMENT );
237+
snapTo.push_back( QgsSnapper::SnapToSegment );
238238
}
239239
else if ( defaultSnapString == "to vertex and segment" )
240240
{
241-
snapTo.push_back( QgsSnapper::SNAP_TO_VERTEX_AND_SEGMENT );
241+
snapTo.push_back( QgsSnapper::SnapToVertexAndSegment );
242242
}
243243
else
244244
{
245-
snapTo.push_back( QgsSnapper::SNAP_TO_VERTEX );
245+
snapTo.push_back( QgsSnapper::SnapToVertex );
246246
}
247247

248248
//default snapping tolerance

‎src/gui/qgsmapcanvassnapper.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,19 @@ class GUI_EXPORT QgsMapCanvasSnapper
4343
~QgsMapCanvasSnapper();
4444

4545
/**Does a snap to the current layer. Uses snap mode
46-
QgsSnapper::SEVERAL_RESULTS_SAME_POSITION if topological editing is enabled
47-
and QgsSnapper::ONE_RESULT_BY_SEGMENT if not. As this method is usually used to
46+
QgsSnapper::SnapWithResultsForSamePosition if topological editing is enabled
47+
and QgsSnapper::SnapWithOneResult_BY_SEGMENT if not. As this method is usually used to
4848
find vertices/segments for editing operations, it uses the search radius for vertex
4949
editing from the qgis options.
5050
@param p start point of the snap (in pixel coordinates)
5151
@param results list to which the results are appended
5252
@param snap_to snap to vertex or to segment
5353
@param snappingTol snapping tolerance. -1 means that the search radius for vertex edits is taken
5454
@param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position*/
55-
int snapToCurrentLayer( const QPoint& p, QList<QgsSnappingResult>& results, QgsSnapper::SNAP_TO snap_to, double snappingTol = -1, const QList<QgsPoint>& excludePoints = QList<QgsPoint>() );
55+
int snapToCurrentLayer( const QPoint& p, QList<QgsSnappingResult>& results, QgsSnapper::SnappingType snap_to, double snappingTol = -1, const QList<QgsPoint>& excludePoints = QList<QgsPoint>() );
5656
/**Snaps to the background layers. This method is usefull to align the features of the
5757
edited layers to those of other layers (as described in the project properties).
58-
Uses snap mode QgsSnapper::ONE_RESULT. Therefore, only the
58+
Uses snap mode QgsSnapper::SnapWithOneResult. Therefore, only the
5959
closest result is returned.
6060
@param p start point of the snap (in pixel coordinates)
6161
@param result snapped point

0 commit comments

Comments
 (0)