21 #include <QApplication>
25 #include <QGraphicsItem>
26 #include <QGraphicsScene>
27 #include <QGraphicsView>
30 #include <QPaintEvent>
33 #include <QTextStream>
34 #include <QResizeEvent>
37 #include <QStringList>
38 #include <QWheelEvent>
42 #include <QVariantAnimation>
43 #include <QPropertyAnimation>
128 : QGraphicsView( parent )
130 , mExpressionContextScope( tr(
"Map Canvas" ) )
132 mScene =
new QGraphicsScene();
134 setHorizontalScrollBarPolicy( Qt::ScrollBarAlwaysOff );
135 setVerticalScrollBarPolicy( Qt::ScrollBarAlwaysOff );
136 setMouseTracking(
true );
137 setFocusPolicy( Qt::StrongFocus );
139 mResizeTimer =
new QTimer(
this );
140 mResizeTimer->setSingleShot(
true );
143 mRefreshTimer =
new QTimer(
this );
144 mRefreshTimer->setSingleShot(
true );
145 connect( mRefreshTimer, &QTimer::timeout,
this, &QgsMapCanvas::refreshMap );
148 mMap =
new QgsMapCanvasMap(
this );
189 setDestinationCrs( crs );
202 double segmentationTolerance = settings.
value( QStringLiteral(
"qgis/segmentationTolerance" ),
"0.01745" ).toDouble();
207 mWheelZoomFactor = settings.
value( QStringLiteral(
"qgis/zoom_factor" ), 2 ).toDouble();
209 QSize s = viewport()->size();
212 setSceneRect( 0, 0, s.width(), s.height() );
213 mScene->setSceneRect( QRectF( 0, 0, s.width(), s.height() ) );
217 connect( &mMapUpdateTimer, &QTimer::timeout,
this, &QgsMapCanvas::mapUpdateTimeout );
218 mMapUpdateTimer.setInterval( 250 );
223 grabGesture( Qt::PinchGesture );
224 grabGesture( Qt::TapAndHoldGesture );
225 viewport()->setAttribute( Qt::WA_AcceptTouchEvents );
229 viewport()->setGraphicsEffect( mPreviewEffect );
233 connect( &mAutoRefreshTimer, &QTimer::timeout,
this, &QgsMapCanvas::autoRefreshTriggered );
237 setInteractive(
false );
255 mLastNonZoomMapTool =
nullptr;
262 qDeleteAll( mScene->items() );
264 mScene->deleteLater();
282 QList< QgsMapRendererQImageJob * >::const_iterator previewJob = mPreviewJobs.constBegin();
283 for ( ; previewJob != mPreviewJobs.constEnd(); ++previewJob )
299 factor = std::clamp( factor, magnifierMin, magnifierMax );
333 if ( index >= 0 && index <
layers.size() )
356 if ( mCurrentLayer ==
layer )
359 mCurrentLayer =
layer;
370 return nullptr != mJob;
383 if ( !mTheme.isEmpty() )
386 setLayersPrivate(
layers );
389 void QgsMapCanvas::setLayersPrivate(
const QList<QgsMapLayer *> &layers )
391 QList<QgsMapLayer *> oldLayers = mSettings.
layers();
394 if (
layers == oldLayers )
397 const auto constOldLayers = oldLayers;
410 const auto constLayers =
layers;
426 updateAutoRefreshTimer();
454 QgsDebugMsg( QStringLiteral(
"Transform error caught: %1" ).arg( e.
what() ) );
462 mBlockItemPositionUpdates++;
464 mBlockItemPositionUpdates--;
471 QgsDebugMsgLevel( QStringLiteral(
"refreshing after destination CRS changed" ), 2 );
482 mController = controller;
500 if ( !allowOutdatedResults && mLabelingResultsOutdated )
503 return mLabelingResults.get();
508 if ( !allowOutdatedResults && mRenderedItemResultsOutdated )
511 return mRenderedItemResults.get();
534 mPreviousRenderedItemResults.reset();
539 return nullptr != mCache;
547 if ( mPreviousRenderedItemResults )
548 mPreviousRenderedItemResults.reset();
549 if ( mRenderedItemResults )
550 mRenderedItemResults.reset();
555 mUseParallelRendering = enabled;
560 return mUseParallelRendering;
565 mMapUpdateTimer.setInterval( timeMilliseconds );
570 return mMapUpdateTimer.interval();
576 return mCurrentLayer;
596 expressionContext << generator->createExpressionContextScope();
600 return expressionContext;
607 QgsDebugMsgLevel( QStringLiteral(
"CANVAS refresh - invalid settings -> nothing to do" ), 2 );
611 if ( !mRenderFlag || mFrozen )
617 if ( mRefreshScheduled )
619 QgsDebugMsgLevel( QStringLiteral(
"CANVAS refresh already scheduled" ), 2 );
623 mRefreshScheduled =
true;
628 mRefreshTimer->start( 1 );
630 mLabelingResultsOutdated =
true;
631 mRenderedItemResultsOutdated =
true;
634 void QgsMapCanvas::refreshMap()
636 Q_ASSERT( mRefreshScheduled );
646 if ( !mTheme.isEmpty() )
659 QList<QgsMapLayer *> allLayers = renderSettings.
layers();
665 mJobCanceled =
false;
666 if ( mUseParallelRendering )
683 mRefreshScheduled =
false;
685 mMapUpdateTimer.start();
690 void QgsMapCanvas::mapThemeChanged(
const QString &theme )
692 if (
theme == mTheme )
697 setLayersPrivate(
QgsProject::instance()->mapThemeCollection()->mapThemeVisibleLayers( mTheme ) );
710 void QgsMapCanvas::mapThemeRenamed(
const QString &theme,
const QString &newTheme )
712 if ( mTheme.isEmpty() ||
theme != mTheme )
721 void QgsMapCanvas::rendererJobFinished()
723 QgsDebugMsgLevel( QStringLiteral(
"CANVAS finish! %1" ).arg( !mJobCanceled ), 2 );
725 mMapUpdateTimer.stop();
728 const auto constErrors = mJob->
errors();
744 mLabelingResultsOutdated =
false;
748 if ( mRenderedItemResults )
752 if ( mPreviousRenderedItemResults )
758 if ( mCache && !mPreviousRenderedItemResults )
759 mPreviousRenderedItemResults = std::make_unique< QgsRenderedItemResults >( mJob->
mapSettings().
extent() );
761 if ( mRenderedItemResults && mPreviousRenderedItemResults )
766 mPreviousRenderedItemResults->transferResults( mRenderedItemResults.get() );
768 if ( mPreviousRenderedItemResults )
774 mRenderedItemResultsOutdated =
false;
784 QString logMsg = tr(
"Canvas refresh: %1 ms" ).arg( mJob->
renderingTime() );
788 if ( mDrawRenderingStats )
790 int w = img.width(), h = img.height();
791 QFont fnt = p.font();
794 int lh = p.fontMetrics().height() * 2;
795 QRect r( 0, h - lh, w, lh );
796 p.setPen( Qt::NoPen );
797 p.setBrush( QColor( 0, 0, 0, 110 ) );
799 p.setPen( Qt::white );
800 QString msg = QStringLiteral(
"%1 :: %2 ms" ).arg( mUseParallelRendering ? QStringLiteral(
"PARALLEL" ) : QStringLiteral(
"SEQUENTIAL" ) ).arg( mJob->
renderingTime() );
801 p.drawText( r, msg, QTextOption( Qt::AlignCenter ) );
806 mMap->setContent( img, imageRect( img, mSettings ) );
808 mLastLayerRenderTime.clear();
810 for (
auto it = times.constBegin(); it != times.constEnd(); ++it )
812 mLastLayerRenderTime.insert( it.key()->id(), it.value() );
814 if ( mUsePreviewJobs && !mRefreshAfterJob )
819 mRefreshAfterJob =
false;
829 if ( mRefreshAfterJob )
831 mRefreshAfterJob =
false;
832 clearTemporalCache();
833 clearElevationCache();
838 void QgsMapCanvas::previewJobFinished()
846 mPreviewJobs.removeAll( job );
848 int number = job->property(
"number" ).toInt();
851 startPreviewJob( number + 1 );
868 QgsLogger::warning( QStringLiteral(
"The renderer map has a wrong device pixel ratio" ) );
872 QgsRectangle rect( topLeft.
x(), topLeft.
y(), topLeft.
x() + img.width()*res, topLeft.
y() - img.height()*res );
878 return mUsePreviewJobs;
883 mUsePreviewJobs = enabled;
888 mDropHandlers = handlers;
891 void QgsMapCanvas::clearTemporalCache()
909 void QgsMapCanvas::clearElevationCache()
929 const QgsPointXY mapPoint =
event->originalMapPoint();
933 QMenu *copyCoordinateMenu =
new QMenu( tr(
"Copy Coordinate" ), &menu );
941 const QgsPointXY transformedPoint = ct.transform( mapPoint );
944 int displayPrecision = 0;
952 displayPrecision = 0;
954 displayPrecision = 1;
956 displayPrecision = 2;
958 displayPrecision = 3;
960 displayPrecision = 4;
962 displayPrecision = 5;
964 displayPrecision = 6;
966 displayPrecision = 7;
968 displayPrecision = 8;
970 displayPrecision = 9;
977 QAction *copyCoordinateAction =
new QAction( QStringLiteral(
"%3 (%1, %2)" ).arg(
978 QString::number( transformedPoint.
x(),
'f', displayPrecision ),
979 QString::number( transformedPoint.
y(),
'f', displayPrecision ),
980 identifier ), &menu );
982 connect( copyCoordinateAction, &QAction::triggered,
this, [displayPrecision, transformedPoint]
984 QClipboard *clipboard = QApplication::clipboard();
986 const QString coordinates = QString::number( transformedPoint.
x(),
'f', displayPrecision ) +
',' + QString::number( transformedPoint.
y(),
'f', displayPrecision );
989 if ( clipboard->supportsSelection() )
991 clipboard->setText( coordinates, QClipboard::Selection );
993 clipboard->setText( coordinates, QClipboard::Clipboard );
996 copyCoordinateMenu->addAction( copyCoordinateAction );
1009 const QString customCrsString = settings.
value( QStringLiteral(
"qgis/custom_coordinate_crs" ) ).toString();
1010 if ( !customCrsString.isEmpty() )
1018 copyCoordinateMenu->addSeparator();
1019 QAction *setCustomCrsAction =
new QAction( tr(
"Set Custom CRS…" ), &menu );
1020 connect( setCustomCrsAction, &QAction::triggered,
this, [ = ]
1024 if ( selector.exec() )
1029 copyCoordinateMenu->addAction( setCustomCrsAction );
1031 menu.addMenu( copyCoordinateMenu );
1039 menu.exec(
event->globalPos() );
1042 void QgsMapCanvas::updateDevicePixelFromScreen()
1048 if ( window()->windowHandle() )
1050 mSettings.
setOutputDpi( window()->windowHandle()->screen()->physicalDotsPerInch() );
1051 mSettings.
setDpiTarget( window()->windowHandle()->screen()->physicalDotsPerInch() );
1057 mSettings.
setOutputDpi( window()->windowHandle()->screen()->logicalDotsPerInch() );
1058 mSettings.
setDpiTarget( window()->windowHandle()->screen()->logicalDotsPerInch() );
1068 mSettings.
setIsTemporal( dateTimeRange.begin().isValid() || dateTimeRange.end().isValid() );
1075 clearTemporalCache();
1077 autoRefreshTriggered();
1087 mInteractionBlockers.append( blocker );
1092 mInteractionBlockers.removeAll( blocker );
1099 if ( block->blockCanvasInteraction( interaction ) )
1105 void QgsMapCanvas::mapUpdateTimeout()
1110 mMap->setContent( img, imageRect( img, mSettings ) );
1119 mJobCanceled =
true;
1140 image = theQPixmap->toImage();
1141 painter.begin( &image );
1151 image = mMap->contentImage().copy();
1152 painter.begin( &image );
1156 QStyleOptionGraphicsItem option;
1157 option.initFrom(
this );
1158 QGraphicsItem *item =
nullptr;
1159 QListIterator<QGraphicsItem *> i( items() );
1161 while ( i.hasPrevious() )
1163 item = i.previous();
1172 QPointF itemScenePos = item->scenePos();
1173 painter.translate( itemScenePos.x(), itemScenePos.y() );
1175 item->paint( &painter, &option );
1179 image.save( fileName, format.toLocal8Bit().data() );
1181 QFileInfo myInfo = QFileInfo( fileName );
1184 QString outputSuffix = myInfo.suffix();
1185 QString myWorldFileName = myInfo.absolutePath() +
'/' + myInfo.completeBaseName() +
'.'
1186 + outputSuffix.at( 0 ) + outputSuffix.at( myInfo.suffix().size() - 1 ) +
'w';
1187 QFile myWorldFile( myWorldFileName );
1188 if ( !myWorldFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
1192 QTextStream myStream( &myWorldFile );
1228 if ( ( r == current ) && magnified )
1241 QgsDebugMsgLevel( QStringLiteral(
"Empty extent - keeping old scale with new center!" ), 2 );
1249 if ( mScaleLocked && magnified )
1251 ScaleRestorer restorer(
this );
1268 for (
int i = mLastExtent.size() - 1; i > mLastExtentIndex; i-- )
1270 mLastExtent.removeAt( i );
1273 if ( !mLastExtent.isEmpty() && mLastExtent.last() !=
extent() )
1275 mLastExtent.append(
extent() );
1279 if ( mLastExtent.size() > 100 )
1281 mLastExtent.removeAt( 0 );
1285 mLastExtentIndex = mLastExtent.size() - 1;
1334 return mCursorPoint;
1389 if ( mLastExtentIndex > 0 )
1392 mSettings.
setExtent( mLastExtent[mLastExtentIndex] );
1405 if ( mLastExtentIndex < mLastExtent.size() - 1 )
1408 mSettings.
setExtent( mLastExtent[mLastExtentIndex] );
1420 mLastExtent.clear();
1421 mLastExtent.append(
extent() ) ;
1422 mLastExtentIndex = mLastExtent.size() - 1;
1440 double closestSquaredDistance = pow( extentRect.
width(), 2.0 ) + pow( extentRect.
height(), 2.0 );
1441 bool pointFound =
false;
1445 double sqrDist = point.
sqrDist( centerLayerCoordinates );
1446 if ( sqrDist > closestSquaredDistance || sqrDist < 4 * std::numeric_limits<double>::epsilon() )
1449 closestPoint = point;
1450 closestSquaredDistance = sqrDist;
1456 rect.scale( scaleFactor, &
center );
1469 layer = qobject_cast<QgsVectorLayer *>( mCurrentLayer );
1479 emit
messageEmitted( tr(
"Cannot zoom to selected feature(s)" ), tr(
"No extent could be determined." ), Qgis::MessageLevel::Warning );
1489 rect = optimalExtentForPointLayer(
layer, rect.
center() );
1508 rect =
layer->boundingBoxOfSelected();
1516 rect = optimalExtentForPointLayer(
layer, rect.
center() );
1521 if ( selectionExtent.
isNull() )
1523 emit
messageEmitted( tr(
"Cannot zoom to selected feature(s)" ), tr(
"No extent could be determined." ), Qgis::MessageLevel::Warning );
1532 return mSettings.
zRange();
1547 clearElevationCache();
1549 autoRefreshTriggered();
1585 if ( boundingBoxOfFeatureIds( ids,
layer, bbox, errorMsg ) )
1589 bbox = optimalExtentForPointLayer(
layer, bbox.
center() );
1595 emit
messageEmitted( tr(
"Zoom to feature id failed" ), errorMsg, Qgis::MessageLevel::Warning );
1609 if ( boundingBoxOfFeatureIds( ids,
layer, bbox, errorMsg ) )
1617 emit
messageEmitted( tr(
"Pan to feature id failed" ), errorMsg, Qgis::MessageLevel::Warning );
1626 int featureCount = 0;
1634 errorMsg = tr(
"Feature does not have a geometry" );
1638 errorMsg = tr(
"Feature geometry is empty" );
1640 if ( !errorMsg.isEmpty() )
1649 if ( featureCount != ids.count() )
1651 errorMsg = tr(
"Feature not found" );
1663 layer = qobject_cast<QgsVectorLayer *>( mCurrentLayer );
1672 emit
messageEmitted( tr(
"Cannot pan to selected feature(s)" ), tr(
"No extent could be determined." ), Qgis::MessageLevel::Warning );
1695 rect =
layer->boundingBoxOfSelected();
1703 rect = optimalExtentForPointLayer(
layer, rect.
center() );
1708 if ( selectionExtent.
isNull() )
1710 emit
messageEmitted( tr(
"Cannot pan to selected feature(s)" ), tr(
"No extent could be determined." ), Qgis::MessageLevel::Warning );
1719 const QColor &color1,
const QColor &color2,
1720 int flashes,
int duration )
1727 QList< QgsGeometry > geoms;
1743 if ( geometries.isEmpty() )
1761 QColor startColor = color1;
1762 if ( !startColor.isValid() )
1772 startColor.setAlpha( 255 );
1774 QColor endColor = color2;
1775 if ( !endColor.isValid() )
1777 endColor = startColor;
1778 endColor.setAlpha( 0 );
1782 QVariantAnimation *animation =
new QVariantAnimation(
this );
1783 connect( animation, &QVariantAnimation::finished,
this, [animation, rb]
1785 animation->deleteLater();
1788 connect( animation, &QPropertyAnimation::valueChanged,
this, [rb, geomType](
const QVariant & value )
1790 QColor
c = value.value<QColor>();
1799 c.setAlpha(
c.alpha() );
1805 animation->setDuration( duration * flashes );
1806 animation->setStartValue( endColor );
1807 double midStep = 0.2 / flashes;
1808 for (
int i = 0; i < flashes; ++i )
1810 double start =
static_cast< double >( i ) / flashes;
1811 animation->setKeyValueAt( start + midStep, startColor );
1812 double end =
static_cast< double >( i + 1 ) / flashes;
1814 animation->setKeyValueAt( end, endColor );
1816 animation->setEndValue( endColor );
1839 if ( !e->isAccepted() )
1844 double dx = std::fabs( currentExtent.
width() / 4 );
1845 double dy = std::fabs( currentExtent.
height() / 4 );
1877 if ( ! e->isAutoRepeat() )
1885 case Qt::Key_PageUp:
1890 case Qt::Key_PageDown:
1897 mUseParallelRendering = !mUseParallelRendering;
1902 mDrawRenderingStats = !mDrawRenderingStats;
1930 mTemporaryCursorOverride.reset();
1944 QgsDebugMsgLevel(
"Ignoring key release: " + QString::number( e->key() ), 2 );
1963 void QgsMapCanvas::beginZoomRect( QPoint pos )
1965 mZoomRect.setRect( 0, 0, 0, 0 );
1967 mZoomDragging =
true;
1969 QColor color( Qt::blue );
1970 color.setAlpha( 63 );
1971 mZoomRubberBand->setColor( color );
1972 mZoomRect.setTopLeft( pos );
1975 void QgsMapCanvas::endZoomRect( QPoint pos )
1977 mZoomDragging =
false;
1978 mZoomRubberBand.reset(
nullptr );
1979 mTemporaryCursorOverride.reset();
1982 mZoomRect.setRight( pos.x() );
1983 mZoomRect.setBottom( pos.y() );
1986 mZoomRect = mZoomRect.normalized();
1988 if ( mZoomRect.width() < 5 && mZoomRect.height() < 5 )
1995 const QSize &zoomRectSize = mZoomRect.size();
1996 const QSize &canvasSize = mSettings.
outputSize();
1997 double sfx =
static_cast< double >( zoomRectSize.width() ) / canvasSize.width();
1998 double sfy =
static_cast< double >( zoomRectSize.height() ) / canvasSize.height();
1999 double sf = std::max( sfx, sfy );
2010 if ( e->button() == Qt::MiddleButton &&
2011 e->modifiers() & Qt::ShiftModifier )
2013 beginZoomRect( e->pos() );
2017 else if ( e->button() == Qt::MiddleButton )
2032 && e->modifiers() & Qt::ShiftModifier )
2034 beginZoomRect( e->pos() );
2040 showContextMenu( me.get() );
2063 if ( mZoomDragging &&
2064 e->button() == Qt::MiddleButton )
2066 endZoomRect( e->pos() );
2070 else if ( e->button() == Qt::MiddleButton )
2075 mTemporaryCursorOverride.reset();
2079 else if ( e->button() == Qt::BackButton )
2084 else if ( e->button() == Qt::ForwardButton )
2091 if ( mZoomDragging && e->button() == Qt::LeftButton )
2093 endZoomRect( e->pos() );
2103 QgsDebugMsgLevel( QStringLiteral(
"Right click in map tool zoom or pan, last tool is %1." ).arg(
2104 mLastNonZoomMapTool ? QStringLiteral(
"not null" ) : QStringLiteral(
"null" ) ), 2 );
2106 QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( mCurrentLayer );
2109 if ( mLastNonZoomMapTool
2114 mLastNonZoomMapTool =
nullptr;
2134 QGraphicsView::resizeEvent( e );
2135 mResizeTimer->start( 500 );
2137 double oldScale = mSettings.
scale();
2138 QSize lastSize = viewport()->size();
2141 mScene->setSceneRect( QRectF( 0, 0, lastSize.width(), lastSize.height() ) );
2147 double scaleFactor = oldScale / mSettings.
scale();
2165 QGraphicsView::paintEvent( e );
2170 if ( mBlockItemPositionUpdates )
2173 const QList<QGraphicsItem *> items = mScene->items();
2174 for ( QGraphicsItem *gi : items )
2191 QgsDebugMsgLevel(
"Wheel event delta " + QString::number( e->angleDelta().y() ), 2 );
2196 if ( e->isAccepted() )
2200 if ( e->angleDelta().y() == 0 )
2209 zoomFactor = 1.0 + ( zoomFactor - 1.0 ) / 120.0 * std::fabs( e->angleDelta().y() );
2211 if ( e->modifiers() & Qt::ControlModifier )
2214 zoomFactor = 1.0 + ( zoomFactor - 1.0 ) / 20.0;
2217 double signedWheelFactor = e->angleDelta().y() > 0 ? 1 / zoomFactor : zoomFactor;
2221 #if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
2226 QgsPointXY newCenter( mousePos.
x() + ( ( oldCenter.
x() - mousePos.
x() ) * signedWheelFactor ),
2227 mousePos.
y() + ( ( oldCenter.
y() - mousePos.
y() ) * signedWheelFactor ) );
2235 mWheelZoomFactor = factor;
2264 ScaleRestorer restorer(
this );
2278 if ( mScaleLocked != isLocked )
2280 mScaleLocked = isLocked;
2293 else if ( mZoomDragging )
2295 mZoomRect.setBottomRight( e->pos() );
2296 mZoomRubberBand->setToCanvasRectangle( mZoomRect );
2297 mZoomRubberBand->show();
2310 if ( !panOperationInProgress() )
2327 disconnect( mMapTool, &QObject::destroyed,
this, &QgsMapCanvas::mapToolDestroyed );
2337 mLastNonZoomMapTool = mMapTool;
2341 mLastNonZoomMapTool =
nullptr;
2351 connect( mMapTool, &QObject::destroyed,
this, &QgsMapCanvas::mapToolDestroyed );
2359 if ( mMapTool && mMapTool == tool )
2361 disconnect( mMapTool, &QObject::destroyed,
this, &QgsMapCanvas::mapToolDestroyed );
2366 setCursor( Qt::ArrowCursor );
2369 if ( mLastNonZoomMapTool && mLastNonZoomMapTool == tool )
2371 mLastNonZoomMapTool =
nullptr;
2389 QBrush bgBrush( color );
2390 setBackgroundBrush( bgBrush );
2393 palette.setColor( backgroundRole(), color );
2394 setPalette( palette );
2398 mScene->setBackgroundBrush( bgBrush );
2407 return mScene->backgroundBrush().color();
2419 bool hasSelectedFeatures =
false;
2426 hasSelectedFeatures =
true;
2431 if ( hasSelectedFeatures )
2498 if ( mTheme ==
theme )
2512 setLayersPrivate(
QgsProject::instance()->mapThemeCollection()->mapThemeVisibleLayers( mTheme ) );
2530 void QgsMapCanvas::connectNotify(
const char *signal )
2533 QgsDebugMsg(
"QgsMapCanvas connected to " + QString( signal ) );
2537 void QgsMapCanvas::layerRepaintRequested(
bool deferred )
2543 void QgsMapCanvas::autoRefreshTriggered()
2549 mRefreshAfterJob =
true;
2556 void QgsMapCanvas::updateAutoRefreshTimer()
2560 int minAutoRefreshInterval = -1;
2565 minAutoRefreshInterval = minAutoRefreshInterval > 0 ? std::min(
layer->
autoRefreshInterval(), minAutoRefreshInterval ) :
layer->autoRefreshInterval();
2568 if ( minAutoRefreshInterval > 0 )
2570 mAutoRefreshTimer.setInterval( minAutoRefreshInterval );
2571 mAutoRefreshTimer.start();
2575 mAutoRefreshTimer.stop();
2579 void QgsMapCanvas::projectThemesChanged()
2581 if ( mTheme.isEmpty() )
2612 double dx = end.
x() - start.
x();
2613 double dy = end.
y() - start.
y();
2615 c.set(
c.x() - dx,
c.y() - dy );
2653 setSceneRect( -pnt.x(), -pnt.y(), viewport()->size().width(), viewport()->size().height() );
2661 bool allHandled =
true;
2664 bool handled =
false;
2667 if ( handler && handler->customUriProviderKey() == uri.providerKey )
2669 if ( handler->handleCustomUriCanvasDrop( uri,
this ) )
2693 updateDevicePixelFromScreen();
2695 if ( window()->windowHandle() )
2697 connect( window()->windowHandle(), &QWindow::screenChanged,
this, [ = ]( QScreen * )
2699 disconnect( mScreenDpiChangedConnection );
2700 mScreenDpiChangedConnection = connect( window()->windowHandle()->screen(), &QScreen::physicalDotsPerInchChanged,
this, &QgsMapCanvas::updateDevicePixelFromScreen );
2701 updateDevicePixelFromScreen();
2704 mScreenDpiChangedConnection = connect( window()->windowHandle()->screen(), &QScreen::physicalDotsPerInchChanged,
this, &QgsMapCanvas::updateDevicePixelFromScreen );
2715 if ( !mPreviewEffect )
2720 mPreviewEffect->setEnabled( previewEnabled );
2725 if ( !mPreviewEffect )
2730 return mPreviewEffect->isEnabled();
2735 if ( !mPreviewEffect )
2740 mPreviewEffect->
setMode( mode );
2745 if ( !mPreviewEffect )
2750 return mPreviewEffect->
mode();
2755 if ( !mSnappingUtils )
2761 return mSnappingUtils;
2766 mSnappingUtils = utils;
2773 QDomNodeList nodes = doc.elementsByTagName( QStringLiteral(
"mapcanvas" ) );
2774 if ( nodes.count() )
2776 QDomNode node = nodes.item( 0 );
2779 if ( nodes.count() > 1 )
2781 for (
int i = 0; i < nodes.size(); ++i )
2783 QDomElement elementNode = nodes.at( i ).toElement();
2785 if ( elementNode.hasAttribute( QStringLiteral(
"name" ) ) && elementNode.attribute( QStringLiteral(
"name" ) ) == objectName() )
2787 node = nodes.at( i );
2795 if ( objectName() != QLatin1String(
"theMapCanvas" ) )
2806 QDomElement elem = node.toElement();
2807 if ( elem.hasAttribute( QStringLiteral(
"theme" ) ) )
2809 if (
QgsProject::instance()->mapThemeCollection()->hasMapTheme( elem.attribute( QStringLiteral(
"theme" ) ) ) )
2811 setTheme( elem.attribute( QStringLiteral(
"theme" ) ) );
2814 setAnnotationsVisible( elem.attribute( QStringLiteral(
"annotationsVisible" ), QStringLiteral(
"1" ) ).toInt() );
2817 const QDomNodeList scopeElements = elem.elementsByTagName( QStringLiteral(
"expressionContextScope" ) );
2818 if ( scopeElements.size() > 0 )
2820 const QDomElement scopeElement = scopeElements.at( 0 ).toElement();
2826 QgsDebugMsg( QStringLiteral(
"Couldn't read mapcanvas information from project" ) );
2839 QDomNodeList nl = doc.elementsByTagName( QStringLiteral(
"qgis" ) );
2842 QgsDebugMsg( QStringLiteral(
"Unable to find qgis element in project file" ) );
2845 QDomNode qgisNode = nl.item( 0 );
2847 QDomElement mapcanvasNode = doc.createElement( QStringLiteral(
"mapcanvas" ) );
2848 mapcanvasNode.setAttribute( QStringLiteral(
"name" ), objectName() );
2849 if ( !mTheme.isEmpty() )
2850 mapcanvasNode.setAttribute( QStringLiteral(
"theme" ), mTheme );
2851 mapcanvasNode.setAttribute( QStringLiteral(
"annotationsVisible" ), mAnnotationsVisible );
2852 qgisNode.appendChild( mapcanvasNode );
2854 mSettings.
writeXml( mapcanvasNode, doc );
2857 QDomElement scopeElement = doc.createElement( QStringLiteral(
"expressionContextScope" ) );
2859 tmpScope.
removeVariable( QStringLiteral(
"atlas_featurenumber" ) );
2865 mapcanvasNode.appendChild( scopeElement );
2872 if ( mScaleLocked && !ignoreScaleLock )
2874 ScaleRestorer restorer(
this );
2909 bool allHandled =
true;
2912 bool handled =
false;
2915 if ( handler->canHandleCustomUriCanvasDrop( uri,
this ) )
2941 return QGraphicsView::viewportEvent(
event );
2944 void QgsMapCanvas::mapToolDestroyed()
2952 if ( !QTouchDevice::devices().empty() )
2954 if ( e->type() == QEvent::Gesture )
2956 if ( QTapAndHoldGesture *tapAndHoldGesture = qobject_cast< QTapAndHoldGesture * >(
static_cast<QGestureEvent *
>( e )->gesture( Qt::TapAndHoldGesture ) ) )
2958 QPointF pos = tapAndHoldGesture->position();
2959 pos = mapFromGlobal( QPoint( pos.x(), pos.y() ) );
2967 return mMapTool->
gestureEvent(
static_cast<QGestureEvent *
>( e ) );
2973 return QGraphicsView::event( e );
2999 while ( mRefreshScheduled || mJob )
3001 QgsApplication::processEvents();
3017 QList<QgsMapCanvasAnnotationItem *> annotationItemList;
3018 const QList<QGraphicsItem *> items = mScene->items();
3019 for ( QGraphicsItem *gi : items )
3024 annotationItemList.push_back( aItem );
3028 return annotationItemList;
3033 mAnnotationsVisible = show;
3037 item->setVisible( show );
3051 void QgsMapCanvas::startPreviewJobs()
3060 schedulePreviewJob( 0 );
3063 void QgsMapCanvas::startPreviewJob(
int number )
3076 double dx = ( i - 1 ) * mapRect.
width();
3077 double dy = ( 1 - j ) * mapRect.
height();
3090 const QList<QgsMapLayer *>
layers = jobSettings.
layers();
3091 QList< QgsMapLayer * > previewLayers;
3100 QgsDebugMsgLevel( QStringLiteral(
"Layer %1 not rendered because it does not match the renderInPreview criterion %2" ).arg(
layer->
id() ).arg( mLastLayerRenderTime.value(
layer->
id() ) ), 3 );
3104 previewLayers <<
layer;
3109 job->setProperty(
"number", number );
3110 mPreviewJobs.append( job );
3115 void QgsMapCanvas::stopPreviewJobs()
3117 mPreviewTimer.stop();
3118 const auto previewJobs = mPreviewJobs;
3119 for (
auto previewJob : previewJobs )
3125 previewJob->cancelWithoutBlocking();
3128 mPreviewJobs.clear();
3131 void QgsMapCanvas::schedulePreviewJob(
int number )
3133 mPreviewTimer.setSingleShot(
true );
3134 mPreviewTimer.setInterval( PREVIEW_JOB_DELAY_MS );
3135 disconnect( mPreviewTimerConnection );
3136 mPreviewTimerConnection = connect( &mPreviewTimer, &QTimer::timeout,
this, [ = ]()
3138 startPreviewJob( number );
3140 mPreviewTimer.start();
3143 bool QgsMapCanvas::panOperationInProgress()
3148 if (
QgsMapToolPan *panTool = qobject_cast< QgsMapToolPan *>( mMapTool ) )
3150 if ( panTool->isDragging() )
3157 int QgsMapCanvas::nextZoomLevel(
const QList<double> &resolutions,
bool zoomIn )
const
3159 int resolutionLevel = -1;
3162 for (
int i = 0, n = resolutions.size(); i < n; ++i )
3164 if (
qgsDoubleNear( resolutions[i], currentResolution, 0.0001 ) )
3166 resolutionLevel =
zoomIn ? ( i - 1 ) : ( i + 1 );
3169 else if ( currentResolution <= resolutions[i] )
3171 resolutionLevel =
zoomIn ? ( i - 1 ) : i;
3175 return ( resolutionLevel < 0 || resolutionLevel >= resolutions.size() ) ? -1 : resolutionLevel;
3180 if ( !mZoomResolutions.isEmpty() )
3182 int zoomLevel = nextZoomLevel( mZoomResolutions,
true );
3183 if ( zoomLevel != -1 )
3188 return 1 / mWheelZoomFactor;
3193 if ( !mZoomResolutions.isEmpty() )
3195 int zoomLevel = nextZoomLevel( mZoomResolutions,
false );
3196 if ( zoomLevel != -1 )
3201 return mWheelZoomFactor;
@ DrawEditingInfo
Enable drawing of vertex markers for layers in editing mode.
@ RenderPreviewJob
Render is a 'canvas preview' render, and shortcuts should be taken to ensure fast rendering.
@ RenderMapTile
Draw map such that there are no problems between adjacent tiles.
@ UseRenderingOptimization
Enable vector simplification and other rendering optimizations.
@ RenderPartialOutput
Whether to make extra effort to update map image with partially rendered layers (better for interacti...
@ Antialiasing
Enable anti-aliasing for map rendering.
@ DrawLabeling
Enable drawing of labels on top of the map.
SegmentationToleranceType
Segmentation tolerance as maximum angle or maximum difference between approximation and circle.
@ MaximumAngle
Maximum angle between generating radii (lines from arc center to output vertices)
virtual bool isEmpty() const
Returns true if the geometry is empty.
static QCursor getThemeCursor(Cursor cursor)
Helper to get a theme cursor.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
static QgsImageCache * imageCache()
Returns the application's image cache, used for caching resampled versions of raster images.
static QgsSvgCache * svgCache()
Returns the application's SVG cache, used for caching SVG images and handling parameter replacement w...
static QgsCoordinateReferenceSystemRegistry * coordinateReferenceSystemRegistry()
Returns the application's coordinate reference system (CRS) registry, which handles known CRS definit...
void userCrsChanged(const QString &id)
Emitted whenever an existing user CRS definition is changed.
This class represents a coordinate reference system (CRS).
@ ShortString
A heavily abbreviated string, for use when a compact representation is required.
void updateDefinition()
Updates the definition and parameters of the coordinate reference system to their latest values.
QString userFriendlyIdentifier(IdentifierType type=MediumString) const
Returns a user friendly identifier for the CRS.
@ WKT_PREFERRED
Preferred format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019,...
Q_GADGET QgsUnitTypes::DistanceUnit mapUnits
Custom exception class for Coordinate Reference System related exceptions.
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS.
Abstract base class for spatial data provider implementations.
virtual bool renderInPreview(const QgsDataProvider::PreviewContext &context)
Returns whether the layer must be rendered in preview jobs.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
double bearing(const QgsPointXY &p1, const QgsPointXY &p2) const SIP_THROW(QgsCsException)
Computes the bearing (in radians) between two points.
double measureLine(const QVector< QgsPointXY > &points) const
Measures the length of a line with multiple segments.
void setSourceCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets source spatial reference system crs.
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
QgsUnitTypes::DistanceUnit lengthUnits() const
Returns the units of distance for length calculations made by this object.
QgsRange which stores a range of double values.
Abstract interface for generating an expression context scope.
Single scope for storing variables and functions for use within a QgsExpressionContext.
void readXml(const QDomElement &element, const QgsReadWriteContext &context)
Reads scope variables from an XML element.
bool writeXml(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
Writes scope variables to an XML element.
bool removeVariable(const QString &name)
Removes a variable from the context scope, if found.
void setVariable(const QString &name, const QVariant &value, bool isStatic=false)
Convenience method for setting a variable in the context scope by name name and value.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * atlasScope(const QgsLayoutAtlas *atlas)
Creates a new scope which contains variables and functions relating to a QgsLayoutAtlas.
static QgsExpressionContextScope * mapSettingsScope(const QgsMapSettings &mapSettings)
Creates a new scope which contains variables and functions relating to a QgsMapSettings object.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setLimit(long long limit)
Set the maximum number of features to request.
QgsFeatureRequest & setNoAttributes()
Set that no attributes will be fetched.
QgsFeatureRequest & setFilterRect(const QgsRectangle &rectangle)
Sets the rectangle from which features will be taken.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
bool hasGeometry() const
Returns true if the feature has an associated geometry.
A geometry is the spatial representation of a feature.
const QgsAbstractGeometry * constGet() const SIP_HOLDGIL
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
QgsPointXY asPoint() const
Returns the contents of the geometry as a 2-dimensional point.
static QgsGeometry fromPointXY(const QgsPointXY &point) SIP_HOLDGIL
Creates a new geometry from a QgsPointXY object.
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
void remoteImageFetched(const QString &url)
Emitted when the cache has finished retrieving an image file from a remote url.
Stores global configuration for labeling engine.
Class that stores computed placement from labeling engine.
static void warning(const QString &msg)
Goes to qWarning.
An interactive map canvas item which displays a QgsAnnotation.
An interface for objects which block interactions with a QgsMapCanvas.
Interaction
Available interactions to block.
An abstract class for items that can be placed on the map canvas.
virtual void updatePosition()
called on changed extent or resize event to update position of the item
Snapping utils instance that is connected to a canvas and updates the configuration (map settings + c...
Deprecated to be deleted, stuff from here should be moved elsewhere.
QPoint mouseLastXY
Last seen point of the mouse.
bool panSelectorDown
Flag to indicate the pan selector key is held down by user.
CanvasProperties()=default
Constructor for CanvasProperties.
QPoint rubberStartPoint
Beginning point of a rubber band.
bool mouseButtonDown
Flag to indicate status of mouse button.
Map canvas is a class for displaying all GIS data types on a canvas.
void setCurrentLayer(QgsMapLayer *layer)
void setCustomDropHandlers(const QVector< QPointer< QgsCustomDropHandler >> &handlers)
Sets a list of custom drop handlers to use when drop events occur on the canvas.
void messageEmitted(const QString &title, const QString &message, Qgis::MessageLevel=Qgis::MessageLevel::Info)
emit a message (usually to be displayed in a message bar)
void contextMenuAboutToShow(QMenu *menu, QgsMapMouseEvent *event)
Emitted before the map canvas context menu will be shown.
void zoomToProjectExtent()
Zoom to the full extent the project associated with this canvas.
QgsUnitTypes::DistanceUnit mapUnits() const
Convenience function for returning the current canvas map units.
void freeze(bool frozen=true)
Freeze/thaw the map canvas.
void enableAntiAliasing(bool flag)
used to determine if anti-aliasing is enabled or not
void setSnappingUtils(QgsSnappingUtils *utils)
Assign an instance of snapping utils to the map canvas.
bool isCachingEnabled() const
Check whether images of rendered layers are curerently being cached.
void zoomToFullExtent()
Zoom to the full extent of all layers currently visible in the canvas.
void setLayers(const QList< QgsMapLayer * > &layers)
Sets the list of layers that should be shown in the canvas.
void setProject(QgsProject *project)
Sets the project linked to this canvas.
const QgsRenderedItemResults * renderedItemResults(bool allowOutdatedResults=true) const
Gets access to the rendered item results (may be nullptr), which includes the results of rendering an...
QColor selectionColor() const
Returns color for selected features.
bool event(QEvent *e) override
void setCachingEnabled(bool enabled)
Set whether to cache images of rendered layers.
void mouseReleaseEvent(QMouseEvent *e) override
QgsDoubleRange zRange() const
Returns the range of z-values which will be visible in the map.
void setExtent(const QgsRectangle &r, bool magnified=false)
Sets the extent of the map canvas to the specified rectangle.
void setRenderFlag(bool flag)
Sets whether a user has disabled canvas renders via the GUI.
QList< QgsMapCanvasAnnotationItem * > annotationItems() const
Returns a list of all annotation items in the canvas.
void updateCanvasItemPositions()
called on resize or changed extent to notify canvas items to change their rectangle
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
void extentsChanged()
Emitted when the extents of the map change.
QgsExpressionContextScope * defaultExpressionContextScope() const
Creates a new scope which contains default variables and functions relating to the map canvas.
void xyCoordinates(const QgsPointXY &p)
Emits current mouse position.
void stopRendering()
stop rendering (if there is any right now)
void magnificationChanged(double)
Emitted when the scale of the map changes.
void setLabelingEngineSettings(const QgsLabelingEngineSettings &settings)
Sets global labeling engine settings in the internal map settings.
QgsPointXY center() const
Gets map center, in geographical coordinates.
void showEvent(QShowEvent *event) override
int layerCount() const
Returns number of layers on the map.
bool antiAliasingEnabled() const
true if antialiasing is enabled
void setPreviewMode(QgsPreviewEffect::PreviewMode mode)
Sets a preview mode for the map canvas.
void layerStateChange()
This slot is connected to the visibility change of one or more layers.
QgsPreviewEffect::PreviewMode previewMode() const
Returns the current preview mode for the map canvas.
void zoomScale(double scale, bool ignoreScaleLock=false)
Zooms the canvas to a specific scale.
void zoomWithCenter(int x, int y, bool zoomIn)
Zooms in/out with a given center.
QPoint mouseLastXY()
returns last position of mouse cursor
void clearCache()
Make sure to remove any rendered images from cache (does nothing if cache is not enabled)
void renderComplete(QPainter *)
Emitted when the canvas has rendered.
void tapAndHoldGestureOccurred(const QgsPointXY &mapPoint, QTapAndHoldGesture *gesture)
Emitted whenever a tap and hold gesture occurs at the specified map point.
void zoomNextStatusChanged(bool)
Emitted when zoom next status changed.
const QgsDateTimeRange & temporalRange() const
Returns map canvas datetime range.
void setCanvasColor(const QColor &_newVal)
Write property of QColor bgColor.
QList< QgsMapLayer * > layers() const
Returns the list of layers shown within the map canvas.
void zoomByFactor(double scaleFactor, const QgsPointXY *center=nullptr, bool ignoreScaleLock=false)
Zoom with the factor supplied.
const QgsTemporalController * temporalController() const
Gets access to the temporal controller that will be used to update the canvas temporal range.
void flashGeometries(const QList< QgsGeometry > &geometries, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem(), const QColor &startColor=QColor(255, 0, 0, 255), const QColor &endColor=QColor(255, 0, 0, 0), int flashes=3, int duration=500)
Causes a set of geometries to flash within the canvas.
void setMapUpdateInterval(int timeMilliseconds)
Set how often map preview should be updated while it is being rendered (in milliseconds)
void rotationChanged(double)
Emitted when the rotation of the map changes.
void selectionChanged(QgsVectorLayer *layer)
Emitted when selection in any layer gets changed.
void dragEnterEvent(QDragEnterEvent *e) override
bool isDrawing()
Find out whether rendering is in progress.
void zRangeChanged()
Emitted when the map canvas z (elevation) range changes.
void keyPressEvent(QKeyEvent *e) override
void setZRange(const QgsDoubleRange &range)
Sets the range of z-values which will be visible in the map.
void clearExtentHistory()
Clears the list of extents and sets current extent as first item.
void zoomToPreviousExtent()
Zoom to the previous extent (view)
void enableMapTileRendering(bool flag)
sets map tile rendering flag
void panAction(QMouseEvent *event)
Called when mouse is moving and pan is activated.
void setLayerStyleOverrides(const QMap< QString, QString > &overrides)
Sets the stored overrides of styles for rendering layers.
const QgsLabelingEngineSettings & labelingEngineSettings() const
Returns global labeling engine settings from the internal map settings.
void mapToolSet(QgsMapTool *newTool, QgsMapTool *oldTool)
Emit map tool changed with the old tool.
void canvasColorChanged()
Emitted when canvas background color changes.
double zoomInFactor() const
Returns the zoom in factor.
void panToSelected(QgsVectorLayer *layer=nullptr)
Pan to the selected features of current (vector) layer keeping same extent.
void saveAsImage(const QString &fileName, QPixmap *QPixmap=nullptr, const QString &="PNG")
Save the contents of the map canvas to disk as an image.
void setSegmentationToleranceType(QgsAbstractGeometry::SegmentationToleranceType type)
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation...
void setTemporalRange(const QgsDateTimeRange &range)
Set datetime range for the map canvas.
void moveCanvasContents(bool reset=false)
called when panning is in action, reset indicates end of panning
void zoomOut()
Zoom out with fixed factor.
void currentLayerChanged(QgsMapLayer *layer)
Emitted when the current layer is changed.
void setTemporalController(QgsTemporalController *controller)
Sets the temporal controller for this canvas.
void renderErrorOccurred(const QString &error, QgsMapLayer *layer)
Emitted whenever an error is encountered during a map render operation.
void waitWhileRendering()
Blocks until the rendering job has finished.
void mapRefreshCanceled()
Emitted when the pending map refresh has been canceled.
double magnificationFactor() const
Returns the magnification factor.
void writeProject(QDomDocument &)
called to write map canvas settings to project
void mousePressEvent(QMouseEvent *e) override
void updateScale()
Emits signal scaleChanged to update scale in main window.
void setMagnificationFactor(double factor, const QgsPointXY *center=nullptr)
Sets the factor of magnification to apply to the map canvas.
void refreshAllLayers()
Reload all layers (including refreshing layer properties from their data sources),...
void unsetMapTool(QgsMapTool *mapTool)
Unset the current map tool or last non zoom tool.
void panActionEnd(QPoint releasePoint)
Ends pan action and redraws the canvas.
void resizeEvent(QResizeEvent *e) override
double zoomOutFactor() const
Returns the zoom in factor.
void renderStarting()
Emitted when the canvas is about to be rendered.
void setMapSettingsFlags(Qgis::MapSettingsFlags flags)
Resets the flags for the canvas' map settings.
std::unique_ptr< CanvasProperties > mCanvasProperties
Handle pattern for implementation object.
void keyReleased(QKeyEvent *e)
Emit key release event.
void setWheelFactor(double factor)
Sets wheel zoom factor (should be greater than 1)
void setAnnotationsVisible(bool visible)
Sets whether annotations are visible in the canvas.
void layerStyleOverridesChanged()
Emitted when the configuration of overridden layer styles changes.
QgsMapCanvas(QWidget *parent=nullptr)
Constructor.
void panActionStart(QPoint releasePoint)
Starts a pan action.
void setPreviewJobsEnabled(bool enabled)
Sets whether canvas map preview jobs (low priority render jobs which render portions of the view just...
bool setReferencedExtent(const QgsReferencedRectangle &extent) SIP_THROW(QgsCsException)
Sets the canvas to the specified extent.
QgsRectangle fullExtent() const
Returns the combined extent for all layers on the map canvas.
void redrawAllLayers()
Clears all cached images and redraws all layers.
void keyReleaseEvent(QKeyEvent *e) override
bool isFrozen() const
Returns true if canvas is frozen.
void panToFeatureIds(QgsVectorLayer *layer, const QgsFeatureIds &ids, bool alwaysRecenter=true)
Centers canvas extent to feature ids.
void scaleChanged(double)
Emitted when the scale of the map changes.
void scaleLockChanged(bool locked)
Emitted when the scale locked state of the map changes.
const QgsLabelingResults * labelingResults(bool allowOutdatedResults=true) const
Gets access to the labeling results (may be nullptr).
void mouseMoveEvent(QMouseEvent *e) override
QgsRectangle projectExtent() const
Returns the associated project's full extent, in the canvas' CRS.
void setCenter(const QgsPointXY ¢er)
Set the center of the map canvas, in geographical coordinates.
void setParallelRenderingEnabled(bool enabled)
Set whether the layers are rendered in parallel or sequentially.
void setDestinationCrs(const QgsCoordinateReferenceSystem &crs)
Sets destination coordinate reference system.
void flashFeatureIds(QgsVectorLayer *layer, const QgsFeatureIds &ids, const QColor &startColor=QColor(255, 0, 0, 255), const QColor &endColor=QColor(255, 0, 0, 0), int flashes=3, int duration=500)
Causes a set of features with matching ids from a vector layer to flash within the canvas.
void installInteractionBlocker(QgsMapCanvasInteractionBlocker *blocker)
Installs an interaction blocker onto the canvas, which may prevent certain map canvas interactions fr...
bool isParallelRenderingEnabled() const
Check whether the layers are rendered in parallel or sequentially.
void panDistanceBearingChanged(double distance, QgsUnitTypes::DistanceUnit unit, double bearing)
Emitted whenever the distance or bearing of an in-progress panning operation is changed.
double scale() const
Returns the last reported scale of the canvas.
QgsSnappingUtils * snappingUtils() const
Returns snapping utility class that is associated with map canvas.
double rotation() const
Gets the current map canvas rotation in clockwise degrees.
void temporalRangeChanged()
Emitted when the map canvas temporal range changes.
void paintEvent(QPaintEvent *e) override
void setSegmentationTolerance(double tolerance)
Sets the segmentation tolerance applied when rendering curved geometries.
void themeChanged(const QString &theme)
Emitted when the canvas has been assigned a different map theme.
void destinationCrsChanged()
Emitted when map CRS has changed.
void transformContextChanged()
Emitted when the canvas transform context is changed.
QgsMapTool * mapTool()
Returns the currently active tool.
void keyPressed(QKeyEvent *e)
Emit key press event.
void setMapTool(QgsMapTool *mapTool, bool clean=false)
Sets the map tool currently being used on the canvas.
QColor canvasColor() const
Read property of QColor bgColor.
void mapCanvasRefreshed()
Emitted when canvas finished a refresh request.
int mapUpdateInterval() const
Find out how often map preview should be updated while it is being rendered (in milliseconds)
void zoomLastStatusChanged(bool)
Emitted when zoom last status changed.
void setSelectionColor(const QColor &color)
Set color of selected vector features.
double mapUnitsPerPixel() const
Returns the mapUnitsPerPixel (map units per pixel) for the canvas.
void mouseDoubleClickEvent(QMouseEvent *e) override
void selectionChangedSlot()
Receives signal about selection change, and pass it on with layer info.
bool viewportEvent(QEvent *event) override
void zoomToNextExtent()
Zoom to the next extent (view)
void layersChanged()
Emitted when a new set of layers has been received.
void zoomToFeatureIds(QgsVectorLayer *layer, const QgsFeatureIds &ids)
Set canvas extent to the bounding box of a set of features.
void zoomIn()
Zoom in with fixed factor.
QgsMapLayer * layer(int index)
Returns the map layer at position index in the layer stack.
void cancelJobs()
Cancel any rendering job, in a blocking way.
bool allowInteraction(QgsMapCanvasInteractionBlocker::Interaction interaction) const
Returns true if the specified interaction is currently permitted on the canvas.
void wheelEvent(QWheelEvent *e) override
bool previewModeEnabled() const
Returns whether a preview mode is enabled for the map canvas.
const QgsMapToPixel * getCoordinateTransform()
Gets the current coordinate transform.
void dropEvent(QDropEvent *event) override
void setPreviewModeEnabled(bool previewEnabled)
Enables a preview mode for the map canvas.
QgsProject * project()
Returns the project linked to this canvas.
void setScaleLocked(bool isLocked)
Lock the scale, so zooming can be performed using magnication.
void setRotation(double degrees)
Set the rotation of the map canvas in clockwise degrees.
void zoomToSelected(QgsVectorLayer *layer=nullptr)
Zoom to the extent of the selected features of provided (vector) layer.
void removeInteractionBlocker(QgsMapCanvasInteractionBlocker *blocker)
Removes an interaction blocker from the canvas.
void readProject(const QDomDocument &)
called to read map canvas settings from project
void setTheme(const QString &theme)
Sets a map theme to show in the canvas.
void zoomToFeatureExtent(QgsRectangle &rect)
Zooms to feature extent.
QMap< QString, QString > layerStyleOverrides() const
Returns the stored overrides of styles for layers.
const QgsMapSettings & mapSettings() const
Gets access to properties used for map rendering.
QgsRectangle extent() const
Returns the current zoom extent of the map canvas.
void refresh()
Repaints the canvas map.
QgsMapLayer * currentLayer()
returns current layer (set by legend widget)
virtual QgsMapLayerElevationProperties::Flags flags() const
Returns flags associated to the elevation properties.
@ FlagDontInvalidateCachedRendersWhenRangeChanges
Any cached rendering will not be invalidated when z range context is modified.
virtual bool hasElevation() const
Returns true if the layer has an elevation or z component.
static QgsRectangle combinedExtent(const QList< QgsMapLayer * > &layers, const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &transformContext)
Returns the combined extent of a list of layers.
Base class for all map layer types.
virtual bool isSpatial() const
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated w...
void autoRefreshIntervalChanged(int interval)
Emitted when the auto refresh interval changes.
QgsCoordinateReferenceSystem crs
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
bool hasAutoRefreshEnabled() const
Returns true if auto refresh is enabled for the layer.
void repaintRequested(bool deferredUpdate=false)
By emitting this signal the layer tells that either appearance or content have been changed and any v...
virtual QgsMapLayerElevationProperties * elevationProperties()
Returns the layer's elevation properties.
virtual Q_INVOKABLE QgsDataProvider * dataProvider()
Returns the layer's data provider, it may be nullptr.
virtual Q_INVOKABLE void reload()
Synchronises with changes in the datasource.
virtual QgsMapLayerTemporalProperties * temporalProperties()
Returns the layer's temporal properties.
A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas.
This class is responsible for keeping cache of rendered images resulting from a map rendering job.
void clear()
Invalidates the cache contents, clearing all cached images.
void invalidateCacheForLayer(QgsMapLayer *layer)
Invalidates cached images which relate to the specified map layer.
Job implementation that renders everything sequentially using a custom painter.
void waitForFinished() override
Block until the job has finished.
virtual void waitForFinished()=0
Block until the job has finished.
void setCache(QgsMapRendererCache *cache)
Assign a cache to be used for reading and storing rendered images of individual layers.
virtual QgsLabelingResults * takeLabelingResults()=0
Gets pointer to internal labeling engine (in order to get access to the results).
QHash< QgsMapLayer *, int > perLayerRenderingTime() const
Returns the render time (in ms) per layer.
virtual bool usedCachedLabels() const =0
Returns true if the render job was able to use a cached labeling solution.
Errors errors() const
List of errors that happened during the rendering job - available when the rendering has been finishe...
static const QgsSettingsEntryBool settingsLogCanvasRefreshEvent
Settings entry log canvas refresh event.
const QgsMapSettings & mapSettings() const
Returns map settings with which this job was started.
void finished()
emitted when asynchronous rendering is finished (or canceled).
void start()
Start the rendering job and immediately return.
int renderingTime() const
Returns the total time it took to finish the job (in milliseconds).
QStringList layersRedrawnFromCache() const
Returns a list of the layer IDs for all layers which were redrawn from cached images.
virtual bool isActive() const =0
Tell whether the rendering job is currently running in background.
void setLayerRenderingTimeHints(const QHash< QString, int > &hints)
Sets approximate render times (in ms) for map layers.
QgsRenderedItemResults * takeRenderedItemResults()
Takes the rendered item results from the map render job and returns them.
virtual void cancelWithoutBlocking()=0
Triggers cancellation of the rendering job without blocking.
Job implementation that renders all layers in parallel.
Intermediate base class adding functionality that allows client to query the rendered image.
virtual QImage renderedImage()=0
Gets a preview/resulting image.
Job implementation that renders everything sequentially in one thread.
static QString worldFileContent(const QgsMapSettings &mapSettings)
Creates the content of a world file.
The QgsMapSettings class contains configuration for rendering of the map.
void writeXml(QDomNode &node, QDomDocument &doc)
QgsPointXY layerToMapCoordinates(const QgsMapLayer *layer, QgsPointXY point) const
transform point coordinates from layer's CRS to output CRS
void setSelectionColor(const QColor &color)
Sets the color that is used for drawing of selected vector features.
void setLayers(const QList< QgsMapLayer * > &layers)
Sets the list of layers to render in the map.
double scale() const
Returns the calculated map scale.
void setFlags(Qgis::MapSettingsFlags flags)
Sets combination of flags that will be used for rendering.
QgsRectangle layerExtentToOutputExtent(const QgsMapLayer *layer, QgsRectangle extent) const
transform bounding box from layer's CRS to output CRS
QgsDoubleRange zRange() const
Returns the range of z-values which will be visible in the map.
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
void setDpiTarget(double dpi)
Sets the target dpi (dots per inch) to be taken into consideration when rendering.
QStringList layerIds() const
Returns the list of layer IDs which will be rendered in the map.
double magnificationFactor() const
Returns the magnification factor.
void setDevicePixelRatio(float dpr)
Sets the device pixel ratio.
void setZRange(const QgsDoubleRange &range)
Sets the range of z-values which will be visible in the map.
QColor backgroundColor() const
Returns the background color of the map.
void setOutputDpi(double dpi)
Sets the dpi (dots per inch) used for conversion between real world units (e.g.
double mapUnitsPerPixel() const
Returns the distance in geographical coordinates that equals to one pixel in the map.
float devicePixelRatio() const
Returns the device pixel ratio.
QSize outputSize() const
Returns the size of the resulting map image, in pixels.
QgsRectangle extent() const
Returns geographical coordinates of the rectangle that should be rendered.
void setSegmentationTolerance(double tolerance)
Sets the segmentation tolerance applied when rendering curved geometries.
void setLayerStyleOverrides(const QMap< QString, QString > &overrides)
Sets the map of map layer style overrides (key: layer ID, value: style name) where a different style ...
void setExtent(const QgsRectangle &rect, bool magnified=true)
Sets the coordinates of the rectangle which should be rendered.
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context.
QgsUnitTypes::DistanceUnit mapUnits() const
Returns the units of the map's geographical coordinates - used for scale calculation.
const QgsMapToPixel & mapToPixel() const
QColor selectionColor() const
Returns the color that is used for drawing of selected vector features.
QgsRectangle visibleExtent() const
Returns the actual extent derived from requested extent that takes output image size into account.
void setLabelingEngineSettings(const QgsLabelingEngineSettings &settings)
Sets the global configuration of the labeling engine.
QgsRectangle fullExtent() const
returns current extent of layer set
void setTransformContext(const QgsCoordinateTransformContext &context)
Sets the coordinate transform context, which stores various information regarding which datum transfo...
void setRotation(double rotation)
Sets the rotation of the resulting map image, in degrees clockwise.
QList< QgsMapLayer * > layers() const
Returns the list of layers which will be rendered in the map.
void setPathResolver(const QgsPathResolver &resolver)
Sets the path resolver for conversion between relative and absolute paths during rendering operations...
const QgsLabelingEngineSettings & labelingEngineSettings() const
Returns the global configuration of the labeling engine.
bool testFlag(Qgis::MapSettingsFlag flag) const
Check whether a particular flag is enabled.
QMap< QString, QString > layerStyleOverrides() const
Returns the map of map layer style overrides (key: layer ID, value: style name) where a different sty...
double rotation() const
Returns the rotation of the resulting map image, in degrees clockwise.
bool hasValidSettings() const
Check whether the map settings are valid and can be used for rendering.
void setOutputSize(QSize size)
Sets the size of the resulting map image, in pixels.
QgsPointXY mapToLayerCoordinates(const QgsMapLayer *layer, QgsPointXY point) const
transform point coordinates from output CRS to layer's CRS
void setBackgroundColor(const QColor &color)
Sets the background color of the map.
void setSegmentationToleranceType(QgsAbstractGeometry::SegmentationToleranceType type)
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation...
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system for the map render.
void setFlag(Qgis::MapSettingsFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
void setDestinationCrs(const QgsCoordinateReferenceSystem &crs)
Sets the destination crs (coordinate reference system) for the map render.
void readXml(QDomNode &node)
void setMagnificationFactor(double factor, const QgsPointXY *center=nullptr)
Set the magnification factor.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context, which stores various information regarding which datum tran...
void mapThemesChanged()
Emitted when map themes within the collection are changed.
void mapThemeRenamed(const QString &name, const QString &newName)
Emitted when a map theme within the collection is renamed.
bool hasMapTheme(const QString &name) const
Returns whether a map theme with a matching name exists.
void mapThemeChanged(const QString &theme)
Emitted when a map theme changes definition.
Perform transforms between map coordinates and device coordinates.
double mapUnitsPerPixel() const
Returns the current map units per pixel.
QgsPointXY toMapCoordinates(int x, int y) const
Transforms device coordinates to map (world) coordinates.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
static bool isUriList(const QMimeData *data)
QList< QgsMimeDataUtils::Uri > UriList
static UriList decodeUriList(const QMimeData *data)
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.
A graphics effect which can be applied to a widget to simulate various printing and color blindness m...
void setMode(PreviewMode mode)
Sets the mode for the preview effect, which controls how the effect modifies a widgets appearance.
PreviewMode mode() const
Returns the mode used for the preview effect.
QgsReferencedRectangle defaultViewExtent() const
Returns the default view extent, which should be used as the initial map extent when this project is ...
QgsReferencedRectangle fullExtent() const
Returns the full extent of the project, which represents the maximal limits of the project.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
static QgsProject * instance()
Returns the QgsProject singleton instance.
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
void ellipsoidChanged(const QString &ellipsoid)
Emitted when the project ellipsoid is changed.
QgsMapThemeCollection * mapThemeCollection
void projectColorsChanged()
Emitted whenever the project's color scheme has been changed.
QgsCoordinateTransformContext transformContext
void readProject(const QDomDocument &)
Emitted when a project is being read.
void writeProject(QDomDocument &)
Emitted when the project is being written.
const QgsProjectViewSettings * viewSettings() const
Returns the project's view settings, which contains settings and properties relating to how a QgsProj...
void transformContextChanged()
Emitted when the project transformContext() is changed.
A generic dialog to prompt the user for a Coordinate Reference System.
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
void scale(double scaleFactor, const QgsPointXY *c=nullptr)
Scale the rectangle around its center point.
double yMaximum() const SIP_HOLDGIL
Returns the y maximum value (top side of rectangle).
double xMaximum() const SIP_HOLDGIL
Returns the x maximum value (right side of rectangle).
double xMinimum() const SIP_HOLDGIL
Returns the x minimum value (left side of rectangle).
double yMinimum() const SIP_HOLDGIL
Returns the y minimum value (bottom side of rectangle).
void setYMinimum(double y) SIP_HOLDGIL
Set the minimum y value.
bool isNull() const
Test if the rectangle is null (all coordinates zero or after call to setMinimal()).
void setXMaximum(double x) SIP_HOLDGIL
Set the maximum x value.
void setXMinimum(double x) SIP_HOLDGIL
Set the minimum x value.
double height() const SIP_HOLDGIL
Returns the height of the rectangle.
void setYMaximum(double y) SIP_HOLDGIL
Set the maximum y value.
void setMinimal() SIP_HOLDGIL
Set a rectangle so that min corner is at max and max corner is at min.
double width() const SIP_HOLDGIL
Returns the width of the rectangle.
void combineExtentWith(const QgsRectangle &rect)
Expands the rectangle so that it covers both the original rectangle and the given rectangle.
bool isEmpty() const
Returns true if the rectangle is empty.
QgsPointXY center() const SIP_HOLDGIL
Returns the center point of the rectangle.
A QgsRectangle with associated coordinate reference system.
Stores collated details of rendered items during a map rendering operation.
void transferResults(QgsRenderedItemResults *other, const QStringList &layerIds)
Transfers all results from an other QgsRenderedItemResults object where the items have layer IDs matc...
A class for drawing transient features (e.g.
void setWidth(int width)
Sets the width of the line.
void setSecondaryStrokeColor(const QColor &color)
Sets a secondary stroke color for the rubberband which will be drawn under the main stroke color.
@ ICON_CIRCLE
A circle is used to highlight points (○)
void setStrokeColor(const QColor &color)
Sets the stroke color for the rubberband.
QColor secondaryStrokeColor
void setIcon(IconType icon)
Sets the icon type to highlight point geometries.
void updatePosition() override
called on changed extent or resize event to update position of the item
void addGeometry(const QgsGeometry &geometry, QgsMapLayer *layer, bool doUpdate=true)
Adds the geometry of an existing feature to a rubberband This is useful for multi feature highlightin...
void setFillColor(const QColor &color)
Sets the fill color for the rubberband.
Scoped object for saving and restoring a QPainter object's state.
Scoped object for logging of the runtime for a single operation or group of operations.
static const QgsSettingsEntryBool settingsRespectScreenDPI
Settings entry respect screen dpi.
This class is a composition of two QSettings instances:
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
void setValue(const QString &key, const QVariant &value, QgsSettings::Section section=QgsSettings::NoSection)
Sets the value of setting key to value.
T enumValue(const QString &key, const T &defaultValue, const Section section=NoSection)
Returns the setting value for a setting based on an enum.
This class has all the configuration of snapping and can return answers to snapping queries.
void remoteSvgFetched(const QString &url)
Emitted when the cache has finished retrieving an SVG file from a remote url.
A controller base class for temporal objects, contains a signal for notifying updates of the objects ...
void updateTemporalRange(const QgsDateTimeRange &range)
Signals that a temporal range has changed and needs to be updated in all connected objects.
bool isActive() const
Returns true if the temporal property is active.
virtual QgsTemporalProperty::Flags flags() const
Returns flags associated to the temporal property.
@ FlagDontInvalidateCachedRendersWhenRangeChanges
Any cached rendering will not be invalidated when temporal range context is modified.
const QgsDateTimeRange & temporalRange() const
Returns the datetime range for the object.
void setIsTemporal(bool enabled)
Sets whether the temporal range is enabled (i.e.
void setTemporalRange(const QgsDateTimeRange &range)
Sets the temporal range for the object.
Temporarily sets a cursor override for the QApplication for the lifetime of the object.
void release()
Releases the cursor override early (i.e.
DistanceUnit
Units of distance.
@ DistanceDegrees
Degrees, for planar geographic CRS distance measurements.
Represents a vector layer which manages a vector based data sets.
int selectedFeatureCount() const
Returns the number of features that are selected in this layer.
bool isEditable() const FINAL
Returns true if the provider is in editing mode.
void selectionChanged(const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect)
Emitted when selection was changed.
A class to represent a vector.
static GeometryType geometryType(Type type) SIP_HOLDGIL
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a Polyg...
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
constexpr double CANVAS_MAGNIFICATION_MIN
Minimum magnification level allowed in map canvases.
constexpr double CANVAS_MAGNIFICATION_MAX
Maximum magnification level allowed in map canvases.
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
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
QSet< QgsFeatureId > QgsFeatureIds
#define QgsDebugMsgLevel(str, level)
const QgsCoordinateReferenceSystem & crs
Stores settings related to the context in which a preview job runs.
double maxRenderingTimeMs
Default maximum allowable render time, in ms.
double lastRenderingTimeMs
Previous rendering time for the layer, in ms.