26 , mEnableSnappingForInvisibleFeature( enableSnappingForInvisibleFeature )
41 if ( !mLocators.contains( vl ) )
45 mLocators.insert( vl, vlpl );
47 return mLocators.value( vl );
52 qDeleteAll( mLocators );
55 qDeleteAll( mTemporaryLocators );
56 mTemporaryLocators.clear();
65 QgsRectangle aoi( pointMap.
x() - tolerance, pointMap.
y() - tolerance,
66 pointMap.
x() + tolerance, pointMap.
y() + tolerance );
70 if ( loc->
isIndexing() || isIndexPrepared( loc, aoi ) )
73 return temporaryLocatorForLayer( vl, pointMap, tolerance );
78 if ( mTemporaryLocators.contains( vl ) )
79 delete mTemporaryLocators.take( vl );
81 QgsRectangle rect( pointMap.
x() - tolerance, pointMap.
y() - tolerance,
82 pointMap.
x() + tolerance, pointMap.
y() + tolerance );
87 mTemporaryLocators.insert( vl, vlpl );
88 return mTemporaryLocators.value( vl );
106 if ( segments.isEmpty() )
109 QSet<QgsPointXY> endpoints;
112 QVector<QgsGeometry> geoms;
113 const auto constSegments = segments;
119 m.edgePoints( pl[0], pl[1] );
121 endpoints << pl[0] << pl[1];
128 QList<QgsPointXY> newPoints;
134 if ( !endpoints.contains( p ) )
143 const auto constPl = pl;
146 if ( !endpoints.contains( p ) )
152 if ( newPoints.isEmpty() )
157 double minSqrDist = 1e20;
158 const auto constNewPoints = newPoints;
161 double sqrDist = pt.
sqrDist( p.x(), p.y() );
162 if ( sqrDist < minSqrDist )
164 minSqrDist = sqrDist;
175 if ( !candidateMatch.
isValid() || candidateMatch.
distance() > maxDistance )
194 bestMatch = candidateMatch;
206 bestMatch = candidateMatch;
213 _replaceIfBetter( bestMatch, loc->
nearestVertex( pointMap, tolerance, filter, relaxed ), tolerance );
217 _replaceIfBetter( bestMatch, loc->
nearestEdge( pointMap, tolerance, filter, relaxed ), tolerance );
224 _replaceIfBetter( bestMatch, loc->
nearestArea( pointMap, tolerance, filter, relaxed ), tolerance );
228 _replaceIfBetter( bestMatch, loc->
nearestCentroid( pointMap, tolerance, filter ), tolerance );
237 static QgsPointLocator::Types _snappingTypeToPointLocatorType( QgsSnappingConfig::SnappingTypeFlag type )
239 return QgsPointLocator::Types(
static_cast<int>( type ) );
249 return QgsRectangle( point.
x() - tolerance, point.
y() - tolerance,
250 point.
x() + tolerance, point.
y() + tolerance );
267 QgsPointLocator::Types type = _snappingTypeToPointLocatorType( mSnappingConfig.
typeFlag() );
269 prepareIndex( QList<LayerAndAreaOfInterest>() << qMakePair( mCurrentLayer,
_areaOfInterest( pointMap, tolerance ) ), relaxed );
272 QgsPointLocator *loc = locatorForLayerUsingStrategy( mCurrentLayer, pointMap, tolerance );
278 _updateBestMatch( bestMatch, pointMap, loc, type, tolerance, filter, relaxed );
282 QgsPointLocator *locEdges = locatorForLayerUsingStrategy( mCurrentLayer, pointMap, tolerance );
285 edges = locEdges->
edgesInRect( pointMap, tolerance );
290 QgsPointLocator *loc = locatorForLayerUsingStrategy( vl, pointMap, tolerance );
291 _updateBestMatch( bestMatch, pointMap, loc, type, tolerance, filter,
false );
298 _replaceIfBetter( bestMatch, _findClosestSegmentIntersection( pointMap, edges ), tolerance );
305 QList<LayerAndAreaOfInterest>
layers;
306 QList<LayerConfig> filteredConfigs;
314 for (
const LayerConfig &layerConfig : qgis::as_const( mLayers ) )
329 filteredConfigs << layerConfig;
332 prepareIndex(
layers, relaxed );
336 double maxTolerance = 0;
339 for (
const LayerConfig &layerConfig : qgis::as_const( filteredConfigs ) )
342 if (
QgsPointLocator *loc = locatorForLayerUsingStrategy( layerConfig.layer, pointMap, tolerance ) )
344 _updateBestMatch( bestMatch, pointMap, loc, layerConfig.type, tolerance, filter, relaxed );
351 maxTolerance = std::max( maxTolerance, tolerance );
359 QgsPointLocator *loc = locatorForLayerUsingStrategy( vl, pointMap, maxTolerance );
360 _updateBestMatch( bestMatch, pointMap, loc, maxTypes, maxTolerance, filter,
false );
362 edges << loc->
edgesInRect( pointMap, maxTolerance );
366 _replaceIfBetter( bestMatch, _findClosestSegmentIntersection( pointMap, edges ), maxTolerance );
374 QgsPointLocator::Types type = _snappingTypeToPointLocatorType( mSnappingConfig.
typeFlag() );
377 QList<LayerAndAreaOfInterest>
layers;
378 const auto constLayers = mMapSettings.
layers();
380 if (
QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer ) )
381 layers << qMakePair( vl, aoi );
382 prepareIndex(
layers, relaxed );
387 for (
const LayerAndAreaOfInterest &entry : qgis::as_const(
layers ) )
390 if (
QgsPointLocator *loc = locatorForLayerUsingStrategy( vl, pointMap, tolerance ) )
392 _updateBestMatch( bestMatch, pointMap, loc, type, tolerance, filter, relaxed );
401 QgsPointLocator *loc = locatorForLayerUsingStrategy( vl, pointMap, tolerance );
402 _updateBestMatch( bestMatch, pointMap, loc, type, tolerance, filter,
false );
408 _replaceIfBetter( bestMatch, _findClosestSegmentIntersection( pointMap, edges ), tolerance );
416 void QgsSnappingUtils::onInitFinished(
bool ok )
424 mHybridMaxAreaPerLayer[loc->
layer()->
id()] /= 4;
428 void QgsSnappingUtils::prepareIndex(
const QList<LayerAndAreaOfInterest> &layers,
bool relaxed )
431 QList<LayerAndAreaOfInterest> layersToIndex;
432 const auto constLayers =
layers;
433 for (
const LayerAndAreaOfInterest &entry : constLayers )
442 if ( !loc->
isIndexing() && !isIndexPrepared( loc, entry.second ) )
443 layersToIndex << entry;
445 if ( !layersToIndex.isEmpty() )
457 for (
const LayerAndAreaOfInterest &entry : layersToIndex )
468 if ( !mEnableSnappingForInvisibleFeature )
478 loc->
init( -1, relaxed );
483 if ( !mHybridMaxAreaPerLayer.contains( vl->
id() ) )
486 if ( totalFeatureCount < mHybridPerLayerFeatureLimit )
489 mHybridMaxAreaPerLayer[vl->
id()] = -1;
496 double totalArea = layerExtent.
width() * layerExtent.
height();
497 mHybridMaxAreaPerLayer[vl->
id()] = totalArea * mHybridPerLayerFeatureLimit / totalFeatureCount / 4;
501 double indexReasonableArea = mHybridMaxAreaPerLayer[vl->
id()];
502 if ( indexReasonableArea == -1 )
505 loc->
init( -1, relaxed );
511 double halfSide = std::sqrt( indexReasonableArea ) / 2;
513 c.x() + halfSide,
c.y() + halfSide );
517 loc->
init( mHybridPerLayerFeatureLimit, relaxed );
522 loc->
init( relaxed );
530 QgsDebugMsg( QStringLiteral(
"Prepare index total: %1 ms" ).arg( t.elapsed() ) );
537 return mSnappingConfig;
542 mEnableSnappingForInvisibleFeature = enable;
547 if ( mSnappingConfig ==
config )
566 if ( !mCurrentLayer )
572 QgsPointLocator *loc = locatorForLayerUsingStrategy( mCurrentLayer, pointMap, tolerance );
577 _updateBestMatch( bestMatch, pointMap, loc, type, tolerance, filter,
false );
585 mMapSettings = settings;
587 if ( newDestCRS != oldDestCRS )
593 mCurrentLayer = layer;
598 QString msg = QStringLiteral(
"--- SNAPPING UTILS DUMP ---\n" );
602 msg += QLatin1String(
"invalid map settings!" );
606 QList<LayerConfig>
layers;
612 msg += QLatin1String(
"no current layer!" );
620 const auto constLayers = mMapSettings.
layers();
623 if (
QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( layer ) )
632 const auto constLayers =
layers;
635 msg += QString(
"layer : %1\n"
636 "config: %2 tolerance %3 %4\n" )
637 .arg( layer.layer->name() )
638 .arg( layer.type ).arg( layer.tolerance ).arg( layer.unit );
644 QString extentStr, cachedGeoms, limit( QStringLiteral(
"no max area" ) );
647 extentStr = QStringLiteral(
" extent %1" ).arg( r->toString() );
650 extentStr = QStringLiteral(
"full extent" );
654 cachedGeoms = QStringLiteral(
"not initialized" );
657 if ( mHybridMaxAreaPerLayer.contains( layer.layer->id() ) )
659 double maxArea = mStrategy ==
IndexHybrid ? mHybridMaxAreaPerLayer[layer.layer->id()] : -1;
661 limit = QStringLiteral(
"max area %1" ).arg( maxArea );
664 limit = QStringLiteral(
"not evaluated" );
666 msg += QStringLiteral(
"index : YES | %1 | %2 | %3\n" ).arg( cachedGeoms, extentStr, limit );
669 msg += QLatin1String(
"index : ???\n" );
672 msg += QLatin1String(
"index : NO\n" );
673 msg += QLatin1String(
"-\n" );
684 void QgsSnappingUtils::onIndividualLayerSettingsChanged(
const QHash<QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings> &layerSettings )
688 QHash<QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings>::const_iterator i;
690 for ( i = layerSettings.constBegin(); i != layerSettings.constEnd(); ++i )
694 mLayers.append( LayerConfig( i.key(), _snappingTypeToPointLocatorType(
static_cast<QgsSnappingConfig::SnappingTypeFlag
>( i->typeFlag() ) ), i->tolerance(), i->units() ) );
This class represents a coordinate reference system (CRS).
QString authid() const
Returns the authority identifier for the CRS.
A geometry is the spatial representation of a feature.
QgsWkbTypes::Type wkbType() const SIP_HOLDGIL
Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
static QgsGeometry unaryUnion(const QVector< QgsGeometry > &geometries)
Compute the unary union on a list of geometries.
static QgsGeometry fromPolylineXY(const QgsPolylineXY &polyline)
Creates a new LineString geometry from a list of QgsPointXY points.
QgsPolylineXY asPolyline() const
Returns the contents of the geometry as a polyline.
QgsMultiPolylineXY asMultiPolyline() const
Returns the contents of the geometry as a multi-linestring.
Base class for all map layer types.
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
The QgsMapSettings class contains configuration for rendering of the map.
double scale() const
Returns the calculated map scale.
QgsRectangle layerExtentToOutputExtent(const QgsMapLayer *layer, QgsRectangle extent) const
transform bounding box from layer's CRS to output CRS
const QgsMapToPixel & mapToPixel() const
QgsRectangle visibleExtent() const
Returns the actual extent derived from requested extent that takes takes output image size into accou...
QList< QgsMapLayer * > layers() const
Returns the list of layers which will be rendered in the map.
bool hasValidSettings() const
Check whether the map settings are valid and can be used for rendering.
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system for the map render.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context, which stores various information regarding which datum tran...
QgsPointXY toMapCoordinates(int x, int y) const
Transform device coordinates to map (world) coordinates.
The class defines interface for querying point location:
const QgsRectangle * extent() const
Gets extent of the area point locator covers - if nullptr then it caches the whole layer.
Match nearestEdge(const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter=nullptr, bool relaxed=false)
Find nearest edge to the specified point - up to distance specified by tolerance Optional filter may ...
void setRenderContext(const QgsRenderContext *context)
Configure render context - if not nullptr, it will use to index only visible feature.
int cachedGeometryCount() const
Returns how many geometries are cached in the index.
void setExtent(const QgsRectangle *extent)
Configure extent - if not nullptr, it will index only that area.
bool init(int maxFeaturesToIndex=-1, bool relaxed=false)
Prepare the index for queries.
class QList< QgsPointLocator::Match > MatchList
Match nearestVertex(const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter=nullptr, bool relaxed=false)
Find nearest vertex to the specified point - up to distance specified by tolerance Optional filter ma...
QgsVectorLayer * layer() const
Gets associated layer.
bool isIndexing() const
Returns true if the point locator is currently indexing the data.
MatchList edgesInRect(const QgsRectangle &rect, QgsPointLocator::MatchFilter *filter=nullptr, bool relaxed=false)
Find edges within a specified rectangle Optional filter may discard unwanted matches.
bool hasIndex() const
Indicate whether the data have been already indexed.
Match nearestMiddleOfSegment(const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter=nullptr, bool relaxed=false)
Find nearest middle of segment to the specified point - up to distance specified by tolerance Optiona...
void waitForIndexingFinished()
If the point locator has been initialized relaxedly and is currently indexing, this methods waits for...
Match nearestCentroid(const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter=nullptr, bool relaxed=false)
Find nearest centroid to the specified point - up to distance specified by tolerance Optional filter ...
void initFinished(bool ok)
Emitted whenever index has been built and initialization is finished.
Match nearestArea(const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter=nullptr, bool relaxed=false)
Find nearest area to the specified point - up to distance specified by tolerance Optional filter may ...
Type
The type of a snap result or the filter type for a snap request.
@ Area
Snapped to an area.
@ MiddleOfSegment
Snapped to the middle of a segment.
@ Vertex
Snapped to a vertex. Can be a vertex of the geometry or an intersection.
@ Centroid
Snapped to a centroid.
@ Edge
Snapped to an edge.
A class to represent a 2D point.
double sqrDist(double x, double y) const SIP_HOLDGIL
Returns the squared distance between this point a specified x, y coordinate.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
A rectangle specified with double values.
bool contains(const QgsRectangle &rect) const
Returns true when rectangle contains other rectangle.
bool intersects(const QgsRectangle &rect) const
Returns true when rectangle intersects with other rectangle.
double height() const SIP_HOLDGIL
Returns the height of the rectangle.
double width() const SIP_HOLDGIL
Returns the width of the rectangle.
Contains information about the context of a rendering operation.
static QgsRenderContext fromMapSettings(const QgsMapSettings &mapSettings)
create initialized QgsRenderContext instance from given QgsMapSettings
This is a container of advanced configuration (per layer) of the snapping of the project.
double maximumScale() const
Returns max scale on which snapping is limited.
double minimumScale() const
Returns minimum scale on which snapping is limited.
This is a container for configuration of the snapping of the project.
@ ActiveLayer
On the active layer.
@ AdvancedConfiguration
On a per layer configuration basis.
@ AllLayers
On all vector layers.
QgsTolerance::UnitType units() const
Returns the type of units.
bool intersectionSnapping() const
Returns if the snapping on intersection is enabled.
@ PerLayer
Scale dependency using min max range per layer.
@ Disabled
No scale dependency.
@ Global
Scale dependency using global min max range.
double minimumScale() const
Returns the min scale (i.e.
double tolerance() const
Returns the tolerance.
double maximumScale() const
Returns the max scale (i.e.
SnappingMode mode() const
Returns the mode (all layers, active layer, per layer settings)
QgsSnappingConfig::SnappingTypeFlag typeFlag() const
Returns the flags type (vertices | segments | area | centroid | middle)
QHash< QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings > individualLayerSettings() const
Returns individual snapping settings for all layers.
ScaleDependencyMode scaleDependencyMode() const
Returns the scale dependency mode.
void setEnabled(bool enabled)
enables the snapping
bool enabled() const
Returns if snapping is enabled.
QgsPointLocator::Match snapToCurrentLayer(QPoint point, QgsPointLocator::Types type, QgsPointLocator::MatchFilter *filter=nullptr)
Snap to current layer.
void setMapSettings(const QgsMapSettings &settings)
Assign current map settings to the utils - used for conversion between screen coords to map coords.
void toggleEnabled()
Toggles the state of snapping.
@ IndexAlwaysFull
For all layers build index of full extent. Uses more memory, but queries are faster.
@ IndexHybrid
For "big" layers using IndexNeverFull, for the rest IndexAlwaysFull. Compromise between speed and mem...
@ IndexExtent
For all layer build index of extent given in map settings.
@ IndexNeverFull
For all layers only create temporary indexes of small extent. Low memory usage, slower queries.
QList< QgsSnappingUtils::LayerConfig > layers() const
Query layers used for snapping.
QgsPointLocator * locatorForLayer(QgsVectorLayer *vl)
Gets a point locator for the given layer.
virtual void prepareIndexProgress(int index)
Called when finished indexing a layer with snapToMap. When index == count the indexing is complete.
QString dump()
Gets extra information about the instance.
void configChanged(const QgsSnappingConfig &snappingConfig)
Emitted when the snapping settings object changes.
~QgsSnappingUtils() override
void clearAllLocators()
Deletes all existing locators (e.g. when destination CRS has changed and we need to reindex)
void setCurrentLayer(QgsVectorLayer *layer)
Sets current layer so that if mode is SnapCurrentLayer we know which layer to use.
QgsPointLocator::Match snapToMap(QPoint point, QgsPointLocator::MatchFilter *filter=nullptr, bool relaxed=false)
Snap to map according to the current configuration.
QgsSnappingUtils(QObject *parent=nullptr, bool enableSnappingForInvisibleFeature=true)
Constructor for QgsSnappingUtils.
void setConfig(const QgsSnappingConfig &snappingConfig)
The snapping configuration controls the behavior of this object.
void setEnableSnappingForInvisibleFeature(bool enable)
Set if invisible features must be snapped or not.
virtual void prepareIndexStarting(int count)
Called when starting to index with snapToMap - can be overridden and e.g. progress dialog can be prov...
static double vertexSearchRadius(const QgsMapSettings &mapSettings)
Static function to get vertex tolerance value.
static double toleranceInProjectUnits(double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, QgsTolerance::UnitType units)
Static function to translate tolerance value into map units.
Represents a vector layer which manages a vector based data sets.
Q_INVOKABLE QgsWkbTypes::GeometryType geometryType() const
Returns point, line or polygon.
QgsRectangle extent() const FINAL
Returns the extent of the layer.
long featureCount(const QString &legendKey) const
Number of features rendered with specified legend key.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
QVector< QgsPointXY > QgsPolylineXY
Polyline as represented as a vector of two-dimensional points.
QgsRectangle _areaOfInterest(const QgsPointXY &point, double tolerance)
Interface that allows rejection of some matches in intersection queries (e.g.
double distance() const
for vertex / edge match units depending on what class returns it (geom.cache: layer units,...
QgsPointLocator::Type type() const
Configures how a certain layer should be handled in a snapping operation.