QGIS API Documentation  3.23.0-Master (eb871beae0)
qgssnapindicator.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgssnapindicator.cpp
3  --------------------------------------
4  Date : October 2017
5  Copyright : (C) 2017 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #include "qgssnapindicator.h"
17 
18 #include "qgsguiutils.h"
19 #include "qgsmapcanvas.h"
20 #include "qgssettingsregistrycore.h"
21 #include "qgsvectorlayer.h"
22 #include "qgsvertexmarker.h"
23 
24 #include <QToolTip>
25 
26 
28  : mCanvas( canvas )
29 {
30  // We need to make sure that the internal pointers are invalidated if the canvas is deleted before this
31  // indicator.
32  // The canvas is specified again as the "receiver", just to silence clazy (official clazy recommendation
33  // for false positives).
34  mCanvasDestroyedConnection = QObject::connect( canvas, &QgsMapCanvas::destroyed, canvas, [ = ]()
35  {
36  mCanvas = nullptr;
37  mSnappingMarker = nullptr;
38  } );
39 }
40 
42 {
43  if ( mSnappingMarker && mCanvas )
44  {
45  mCanvas->scene()->removeItem( mSnappingMarker );
46  delete mSnappingMarker;
47  }
48 
49  QObject::disconnect( mCanvasDestroyedConnection );
50 };
51 
53 {
54  mMatch = match;
55 
56  if ( !mMatch.isValid() )
57  {
58  if ( mSnappingMarker )
59  {
60  mCanvas->scene()->removeItem( mSnappingMarker );
61  delete mSnappingMarker; // need to delete since QGraphicsSene::removeItem transfers back ownership
62  }
63  mSnappingMarker = nullptr;
64  QToolTip::hideText();
65  }
66  else
67  {
68  if ( !mSnappingMarker )
69  {
70  mSnappingMarker = new QgsVertexMarker( mCanvas ); // ownership of the marker is transferred to QGraphicsScene
71  mSnappingMarker->setIconSize( QgsGuiUtils::scaleIconSize( 10 ) );
72  mSnappingMarker->setPenWidth( QgsGuiUtils::scaleIconSize( 3 ) );
73  }
74 
75  const QColor color = QgsSettingsRegistryCore::settingsDigitizingSnapColor.value();
76  mSnappingMarker->setColor( color );
77 
78  int iconType;
79  if ( match.hasLineEndpoint() )
80  {
81  iconType = QgsVertexMarker::ICON_INVERTED_TRIANGLE; // line endpoint snap
82  }
83  else if ( match.hasVertex() )
84  {
85  if ( match.layer() )
86  iconType = QgsVertexMarker::ICON_BOX; // vertex snap
87  else
88  iconType = QgsVertexMarker::ICON_X; // intersection snap
89  }
90  else if ( match.hasMiddleSegment() )
91  {
92  iconType = QgsVertexMarker::ICON_TRIANGLE; // middle snap
93  }
94  else if ( match.hasCentroid() )
95  {
96  iconType = QgsVertexMarker::ICON_CIRCLE; // centroid snap
97  }
98  else if ( match.hasArea() )
99  {
100  iconType = QgsVertexMarker::ICON_RHOMBUS; // area snap
101  }
102  else // must be segment snap
103  {
105  }
106 
107  mSnappingMarker->setIconType( iconType );
108 
109  mSnappingMarker->setCenter( match.point() );
110 
111  // tooltip
112  if ( QgsSettingsRegistryCore::settingsDigitizingSnapTooltip.value() )
113  {
114  const QPoint ptCanvas = mSnappingMarker->toCanvasCoordinates( match.point() ).toPoint();
115  const QPoint ptGlobal = mCanvas->mapToGlobal( ptCanvas );
116  const QRect rect( ptCanvas.x(), ptCanvas.y(), 1, 1 ); // area where is the tooltip valid
117  const QString layerName = match.layer() ? match.layer()->name() : QString();
118  QToolTip::showText( ptGlobal, layerName, mCanvas, rect );
119  }
120  }
121 }
122 
123 void QgsSnapIndicator::setVisible( bool visible )
124 {
125  if ( mSnappingMarker )
126  mSnappingMarker->setVisible( visible );
127 }
128 
130 {
131  if ( mSnappingMarker )
132  return mSnappingMarker->isVisible();
133 
134  return false;
135 }
QPointF toCanvasCoordinates(const QgsPointXY &point) const
transformation from map coordinates to screen coordinates
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:89
QString name
Definition: qgsmaplayer.h:76
QgsPointLocator::Match match() const
Returns currently displayed snapping match.
void setVisible(bool visible=true)
Sets whether the snapping indicator is visible.
void setMatch(const QgsPointLocator::Match &match)
Sets snapping match that should be displayed in map canvas. Invalid match hides the indicator.
QgsSnapIndicator(QgsMapCanvas *canvas)
Constructs an indicator for the given map canvas.
bool isVisible() const
Returns whether the snapping indicator is visible.
A class for marking vertices of features using e.g.
void setPenWidth(int width)
@ ICON_TRIANGLE
Added in QGIS 3.12.
@ ICON_DOUBLE_TRIANGLE
Added in QGIS 3.0.
@ ICON_INVERTED_TRIANGLE
Added in QGIS 3.20.
@ ICON_RHOMBUS
Added in QGIS 3.12.
void setIconSize(int iconSize)
void setCenter(const QgsPointXY &point)
Sets the center point of the marker, in map coordinates.
void setIconType(int iconType)
void setColor(const QColor &color)
Sets the stroke color for the marker.
int scaleIconSize(int standardSize)
Scales an icon size to compensate for display pixel density, making the icon size hi-dpi friendly,...
QgsVectorLayer * layer() const
The vector layer where the snap occurred.
bool hasCentroid() const
Returns true if the Match is a centroid.
QgsPointXY point() const
for vertex / edge match coords depending on what class returns it (geom.cache: layer coords,...
bool hasArea() const
Returns true if the Match is an area.
bool hasLineEndpoint() const
Returns true if the Match is a line endpoint (start or end vertex).
bool hasMiddleSegment() const
Returns true if the Match is the middle of a segment.
bool hasVertex() const
Returns true if the Match is a vertex.