Skip to content

Commit

Permalink
Allow QgsMapToolCapture subclasses to create tools which are associated
Browse files Browse the repository at this point in the history 
with a specific map layer, instead of always following the current
canvas layer
  • Loading branch information
@nyalldawson
nyalldawson committed Sep 8, 2021
1 parent f2776d9 commit e7ce050
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 15 deletions.
10 changes: 10 additions & 0 deletions python/gui/auto_generated/qgsmaptoolcapture.sip.in
View file
Expand Up @@ -301,6 +301,16 @@ Set the points on which to work
void closePolygon();
%Docstring
Close an open polygon
%End

virtual QgsMapLayer *layer() const;
%Docstring
Returns the map layer associated with the geometry being captured.

The base class implementation always returns the current map canvas layer, but
subclasses can override this if they need to be associated with a specific layer.

.. versionadded:: 3.22
%End

protected slots:
Expand Down
35 changes: 20 additions & 15 deletions src/gui/qgsmaptoolcapture.cpp
View file
Expand Up @@ -287,7 +287,7 @@ bool QgsMapToolCapture::tracingAddVertex( const QgsPointXY &point )
if ( QgsSettingsRegistryCore::settingsDigitizingConvertToCurve.value() )
{
// If the tool and the layer support curves
QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( mCanvas->currentLayer() );
QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer() );
if ( vlayer && capabilities().testFlag( QgsMapToolCapture::Capability::SupportsCurves ) && vlayer->dataProvider()->capabilities().testFlag( QgsVectorDataProvider::Capability::CircularGeometries ) )
{
const QgsGeometry linear = QgsGeometry( mCaptureCurve.segmentize() );
Expand All @@ -308,7 +308,7 @@ bool QgsMapToolCapture::tracingAddVertex( const QgsPointXY &point )

// adjust last captured point
const QgsPoint lastPt = mCaptureCurve.endPoint();
mCaptureLastPoint = toMapCoordinates( mCanvas->currentLayer(), lastPt );
mCaptureLastPoint = toMapCoordinates( layer(), lastPt );

return true;
}
Expand Down Expand Up @@ -346,7 +346,7 @@ void QgsMapToolCapture::resetRubberBand()
return;
QgsLineString *lineString = mCaptureCurve.curveToLine();
mRubberBand->reset( mCaptureMode == CapturePolygon ? QgsWkbTypes::PolygonGeometry : QgsWkbTypes::LineGeometry );
mRubberBand->addGeometry( QgsGeometry( lineString ), mCanvas->currentLayer() );
mRubberBand->addGeometry( QgsGeometry( lineString ), layer() );
}

QgsRubberBand *QgsMapToolCapture::takeRubberBand()
Expand Down Expand Up @@ -389,7 +389,7 @@ void QgsMapToolCapture::cadCanvasMoveEvent( QgsMapMouseEvent *e )
if ( !mCaptureCurve.isEmpty() )
{
const QgsPoint prevPoint = mCaptureCurve.curveAt( mCaptureCurve.nCurves() - 1 )->endPoint();
if ( QgsPointXY( toCanvasCoordinates( toMapCoordinates( mCanvas->currentLayer(), prevPoint ) ) ).distance( toCanvasCoordinates( point ) ) < mStreamingToleranceInPixels )
if ( QgsPointXY( toCanvasCoordinates( toMapCoordinates( layer(), prevPoint ) ) ).distance( toCanvasCoordinates( point ) ) < mStreamingToleranceInPixels )
return;
}

Expand Down Expand Up @@ -450,7 +450,7 @@ void QgsMapToolCapture::cadCanvasMoveEvent( QgsMapMouseEvent *e )

int QgsMapToolCapture::nextPoint( const QgsPoint &mapPoint, QgsPoint &layerPoint )
{
if ( QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( mCanvas->currentLayer() ) )
if ( QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer() ) )
{
try
{
Expand All @@ -469,7 +469,7 @@ int QgsMapToolCapture::nextPoint( const QgsPoint &mapPoint, QgsPoint &layerPoint
}
else
{
layerPoint = QgsPoint( toLayerCoordinates( mCanvas->currentLayer(), mapPoint ) );
layerPoint = QgsPoint( toLayerCoordinates( layer(), mapPoint ) );
}

return 0;
Expand All @@ -483,7 +483,7 @@ int QgsMapToolCapture::nextPoint( QPoint p, QgsPoint &layerPoint, QgsPoint &mapP

int QgsMapToolCapture::fetchLayerPoint( const QgsPointLocator::Match &match, QgsPoint &layerPoint )
{
QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( mCanvas->currentLayer() );
QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer() );
QgsVectorLayer *sourceLayer = match.layer();
if ( match.isValid() && ( match.hasVertex() || match.hasLineEndpoint() || ( QgsProject::instance()->topologicalEditing() && ( match.hasEdge() || match.hasMiddleSegment() ) ) ) && sourceLayer &&
( sourceLayer->crs() == vlayer->crs() ) )
Expand Down Expand Up @@ -559,7 +559,7 @@ int QgsMapToolCapture::addVertex( const QgsPointXY &point, const QgsPointLocator

int res = 0;
QgsPoint layerPoint;
if ( mCanvas->currentLayer() && mCanvas->currentLayer()->type() == QgsMapLayerType::VectorLayer )
if ( layer() && layer()->type() == QgsMapLayerType::VectorLayer )
{
res = fetchLayerPoint( match, layerPoint );
if ( res != 0 )
Expand All @@ -575,7 +575,7 @@ int QgsMapToolCapture::addVertex( const QgsPointXY &point, const QgsPointLocator
{
layerPoint = QgsPoint( point );
}
const QgsPoint mapPoint = toMapCoordinates( canvas()->currentLayer(), layerPoint );
const QgsPoint mapPoint = toMapCoordinates( layer(), layerPoint );

if ( mCaptureMode == CapturePoint )
{
Expand Down Expand Up @@ -685,7 +685,7 @@ int QgsMapToolCapture::addCurve( QgsCurve *c )
}

//transform back to layer CRS in case map CRS and layer CRS are different
const QgsCoordinateTransform ct = mCanvas->mapSettings().layerTransform( mCanvas->currentLayer() );
const QgsCoordinateTransform ct = mCanvas->mapSettings().layerTransform( layer() );
if ( ct.isValid() )
{
c->transform( ct, QgsCoordinateTransform::ReverseTransform );
Expand Down Expand Up @@ -787,7 +787,7 @@ void QgsMapToolCapture::undo( bool isAutoRepeat )
if ( mCaptureCurve.numPoints() > 0 )
{
const QgsPoint lastPt = mCaptureCurve.endPoint();
mCaptureLastPoint = toMapCoordinates( mCanvas->currentLayer(), lastPt );
mCaptureLastPoint = toMapCoordinates( layer(), lastPt );
mTempRubberBand->addPoint( lastCapturedMapPoint() );
mTempRubberBand->movePoint( lastPoint );
}
Expand Down Expand Up @@ -865,6 +865,11 @@ void QgsMapToolCapture::closePolygon()
updateExtraSnapLayer();
}

QgsMapLayer *QgsMapToolCapture::layer() const
{
return canvas()->currentLayer();
}

void QgsMapToolCapture::validateGeometry()
{
if ( QgsSettingsRegistryCore::settingsDigitizingValidateGeometries.value() == 0 )
Expand Down Expand Up @@ -920,7 +925,7 @@ void QgsMapToolCapture::validateGeometry()
void QgsMapToolCapture::addError( const QgsGeometry::Error &e )
{
mGeomErrors << e;
QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( mCanvas->currentLayer() );
QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer() );
if ( !vlayer )
return;

Expand Down Expand Up @@ -986,7 +991,7 @@ QgsPoint QgsMapToolCapture::mapPoint( const QgsPointXY &point ) const
QgsPoint newPoint( QgsWkbTypes::Point, point.x(), point.y() );

// get current layer
QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( mCanvas->currentLayer() );
QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer() );
if ( !vlayer )
{
return newPoint;
Expand Down Expand Up @@ -1057,10 +1062,10 @@ void QgsMapToolCapture::updateExtraSnapLayer()
if ( !mExtraSnapLayer )
return;

if ( canvas()->snappingUtils()->config().selfSnapping() && mCanvas->currentLayer() && mCaptureCurve.numPoints() >= 2 )
if ( canvas()->snappingUtils()->config().selfSnapping() && layer() && mCaptureCurve.numPoints() >= 2 )
{
// the current layer may have changed
mExtraSnapLayer->setCrs( mCanvas->currentLayer()->crs() );
mExtraSnapLayer->setCrs( layer()->crs() );
QgsGeometry geom = QgsGeometry( mCaptureCurve.clone() );
// we close the curve to allow snapping on last segment
if ( mCaptureMode == CapturePolygon && mCaptureCurve.numPoints() >= 3 )
Expand Down
10 changes: 10 additions & 0 deletions src/gui/qgsmaptoolcapture.h
View file
Expand Up @@ -390,6 +390,16 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing
*/
void closePolygon();

/**
* Returns the map layer associated with the geometry being captured.
*
* The base class implementation always returns the current map canvas layer, but
* subclasses can override this if they need to be associated with a specific layer.
*
* \since QGIS 3.22
*/
virtual QgsMapLayer *layer() const;

protected slots:

/**
Expand Down

0 comments on commit e7ce050

Please sign in to comment.