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>
129 : QGraphicsView( parent )
131 , mExpressionContextScope( tr(
"Map Canvas" ) )
133 mScene =
new QGraphicsScene();
135 setLayout( mLayout );
138 setHorizontalScrollBarPolicy( Qt::ScrollBarAlwaysOff );
139 setVerticalScrollBarPolicy( Qt::ScrollBarAlwaysOff );
140 setMouseTracking(
true );
141 setFocusPolicy( Qt::StrongFocus );
146 mResizeTimer =
new QTimer(
this );
147 mResizeTimer->setSingleShot(
true );
150 mRefreshTimer =
new QTimer(
this );
151 mRefreshTimer->setSingleShot(
true );
152 connect( mRefreshTimer, &QTimer::timeout,
this, &QgsMapCanvas::refreshMap );
155 mMap =
new QgsMapCanvasMap(
this );
196 setDestinationCrs( crs );
209 double segmentationTolerance = settings.
value( QStringLiteral(
"qgis/segmentationTolerance" ),
"0.01745" ).toDouble();
214 mWheelZoomFactor = settings.
value( QStringLiteral(
"qgis/zoom_factor" ), 2 ).toDouble();
216 QSize s = viewport()->size();
221 setSceneRect( 0, 0, s.width(), s.height() );
222 mScene->setSceneRect( QRectF( 0, 0, s.width(), s.height() ) );
226 connect( &mMapUpdateTimer, &QTimer::timeout,
this, &QgsMapCanvas::mapUpdateTimeout );
227 mMapUpdateTimer.setInterval( 250 );
232 grabGesture( Qt::PinchGesture );
233 grabGesture( Qt::TapAndHoldGesture );
234 viewport()->setAttribute( Qt::WA_AcceptTouchEvents );
238 viewport()->setGraphicsEffect( mPreviewEffect );
242 connect( &mAutoRefreshTimer, &QTimer::timeout,
this, &QgsMapCanvas::autoRefreshTriggered );
246 setInteractive(
false );
262 disconnect( mMapTool, &QObject::destroyed,
this, &QgsMapCanvas::mapToolDestroyed );
270 const QList< QgsMapTool * > tools = findChildren< QgsMapTool *>();
273 tool->mCanvas =
nullptr;
281 qDeleteAll( mScene->items() );
283 mScene->deleteLater();
304 for (
auto previewJob = mPreviewJobs.constBegin(); previewJob != mPreviewJobs.constEnd(); ++previewJob )
312 mPreviewJobs.clear();
320 factor = std::clamp( factor, magnifierMin, magnifierMax );
355 if ( index >= 0 && index <
layers.size() )
378 if ( mCurrentLayer ==
layer )
381 mCurrentLayer =
layer;
392 return nullptr != mJob;
405 if ( !mTheme.isEmpty() )
408 setLayersPrivate(
layers );
411 void QgsMapCanvas::setLayersPrivate(
const QList<QgsMapLayer *> &layers )
413 QList<QgsMapLayer *> oldLayers = mSettings.
layers();
416 if (
layers == oldLayers )
419 const auto constOldLayers = oldLayers;
454 const auto constLayers =
layers;
493 updateAutoRefreshTimer();
534 mBlockExtentChangedSignal++;
535 mBlockScaleChangedSignal++;
541 mBlockItemPositionUpdates++;
543 mBlockItemPositionUpdates--;
546 mBlockExtentChangedSignal--;
547 mBlockScaleChangedSignal--;
555 QgsDebugMsgLevel( QStringLiteral(
"refreshing after destination CRS changed" ), 2 );
575 mController = controller;
581 void QgsMapCanvas::temporalControllerModeChanged()
585 switch ( temporalNavigationObject->navigationMode() )
589 mSettings.
setFrameRate( temporalNavigationObject->framesPerSecond() );
590 mSettings.
setCurrentFrame( temporalNavigationObject->currentFrameNumber() );
618 if ( !allowOutdatedResults && mLabelingResultsOutdated )
621 return mLabelingResults.get();
626 if ( !allowOutdatedResults && mRenderedItemResultsOutdated )
629 return mRenderedItemResults.get();
652 mPreviousRenderedItemResults.reset();
657 return nullptr != mCache;
665 if ( mPreviousRenderedItemResults )
666 mPreviousRenderedItemResults.reset();
667 if ( mRenderedItemResults )
668 mRenderedItemResults.reset();
678 mUseParallelRendering = enabled;
683 return mUseParallelRendering;
688 mMapUpdateTimer.setInterval( timeMilliseconds );
693 return mMapUpdateTimer.interval();
699 return mCurrentLayer;
719 expressionContext << generator->createExpressionContextScope();
723 return expressionContext;
730 QgsDebugMsgLevel( QStringLiteral(
"CANVAS refresh - invalid settings -> nothing to do" ), 2 );
734 if ( !mRenderFlag || mFrozen )
740 if ( mRefreshScheduled )
742 QgsDebugMsgLevel( QStringLiteral(
"CANVAS refresh already scheduled" ), 2 );
746 mRefreshScheduled =
true;
751 mRefreshTimer->start( 1 );
753 mLabelingResultsOutdated =
true;
754 mRenderedItemResultsOutdated =
true;
757 void QgsMapCanvas::refreshMap()
759 Q_ASSERT( mRefreshScheduled );
771 switch ( temporalNavigationObject->navigationMode() )
775 mSettings.
setFrameRate( temporalNavigationObject->framesPerSecond() );
776 mSettings.
setCurrentFrame( temporalNavigationObject->currentFrameNumber() );
787 if ( !mTheme.isEmpty() )
800 QList<QgsMapLayer *> allLayers = renderSettings.
layers();
809 mJobCanceled =
false;
810 if ( mUseParallelRendering )
827 mRefreshScheduled =
false;
829 mMapUpdateTimer.start();
834 void QgsMapCanvas::mapThemeChanged(
const QString &theme )
836 if (
theme == mTheme )
841 setLayersPrivate(
QgsProject::instance()->mapThemeCollection()->mapThemeVisibleLayers( mTheme ) );
854 void QgsMapCanvas::mapThemeRenamed(
const QString &theme,
const QString &newTheme )
856 if ( mTheme.isEmpty() ||
theme != mTheme )
865 void QgsMapCanvas::rendererJobFinished()
867 QgsDebugMsgLevel( QStringLiteral(
"CANVAS finish! %1" ).arg( !mJobCanceled ), 2 );
869 mMapUpdateTimer.stop();
871 notifyRendererErrors( mJob->
errors() );
881 mLabelingResultsOutdated =
false;
885 if ( mRenderedItemResults )
889 if ( mPreviousRenderedItemResults )
895 if ( mCache && !mPreviousRenderedItemResults )
896 mPreviousRenderedItemResults = std::make_unique< QgsRenderedItemResults >( mJob->
mapSettings().
extent() );
898 if ( mRenderedItemResults && mPreviousRenderedItemResults )
903 mPreviousRenderedItemResults->transferResults( mRenderedItemResults.get() );
905 if ( mPreviousRenderedItemResults )
911 mRenderedItemResultsOutdated =
false;
921 QString logMsg = tr(
"Canvas refresh: %1 ms" ).arg( mJob->
renderingTime() );
925 if ( mDrawRenderingStats )
927 int w = img.width(), h = img.height();
928 QFont fnt = p.font();
931 int lh = p.fontMetrics().height() * 2;
932 QRect r( 0, h - lh, w, lh );
933 p.setPen( Qt::NoPen );
934 p.setBrush( QColor( 0, 0, 0, 110 ) );
936 p.setPen( Qt::white );
937 QString msg = QStringLiteral(
"%1 :: %2 ms" ).arg( mUseParallelRendering ? QStringLiteral(
"PARALLEL" ) : QStringLiteral(
"SEQUENTIAL" ) ).arg( mJob->
renderingTime() );
938 p.drawText( r, msg, QTextOption( Qt::AlignCenter ) );
943 mMap->setContent( img, imageRect( img, mSettings ) );
945 mLastLayerRenderTime.clear();
947 for (
auto it = times.constBegin(); it != times.constEnd(); ++it )
949 mLastLayerRenderTime.insert( it.key()->id(), it.value() );
951 if ( mUsePreviewJobs && !mRefreshAfterJob )
956 mRefreshAfterJob =
false;
966 if ( mRefreshAfterJob )
968 mRefreshAfterJob =
false;
969 clearTemporalCache();
970 clearElevationCache();
975 void QgsMapCanvas::previewJobFinished()
983 mPreviewJobs.removeAll( job );
985 int number = job->property(
"number" ).toInt();
988 startPreviewJob( number + 1 );
1005 QgsLogger::warning( QStringLiteral(
"The renderer map has a wrong device pixel ratio" ) );
1009 QgsRectangle rect( topLeft.
x(), topLeft.
y(), topLeft.
x() + img.width()*res, topLeft.
y() - img.height()*res );
1015 return mUsePreviewJobs;
1020 mUsePreviewJobs = enabled;
1025 mDropHandlers = handlers;
1028 void QgsMapCanvas::clearTemporalCache()
1032 bool invalidateLabels =
false;
1036 bool alreadyInvalidatedThisLayer =
false;
1044 alreadyInvalidatedThisLayer =
true;
1054 if ( vl->labelsEnabled() || vl->diagramsEnabled() )
1055 invalidateLabels =
true;
1061 if ( !alreadyInvalidatedThisLayer )
1066 const QList<QgsMapLayer *> childLayerList = gl->childLayers();
1069 if ( childLayer->temporalProperties() && childLayer->temporalProperties()->isActive() )
1081 if ( invalidateLabels )
1089 void QgsMapCanvas::clearElevationCache()
1093 bool invalidateLabels =
false;
1101 if ( vl->labelsEnabled() || vl->diagramsEnabled() )
1102 invalidateLabels =
true;
1112 const QList<QgsMapLayer *> childLayerList = gl->childLayers();
1115 if ( childLayer->elevationProperties() && childLayer->elevationProperties()->hasElevation() )
1127 if ( invalidateLabels )
1137 const QgsPointXY mapPoint =
event->originalMapPoint();
1141 QMenu *copyCoordinateMenu =
new QMenu( tr(
"Copy Coordinate" ), &menu );
1149 const QgsPointXY transformedPoint = ct.transform( mapPoint );
1152 int displayPrecision = 0;
1160 displayPrecision = 0;
1162 displayPrecision = 1;
1164 displayPrecision = 2;
1166 displayPrecision = 3;
1168 displayPrecision = 4;
1170 displayPrecision = 5;
1172 displayPrecision = 6;
1174 displayPrecision = 7;
1176 displayPrecision = 8;
1178 displayPrecision = 9;
1186 QString firstSuffix;
1187 QString secondSuffix;
1188 if ( axisList.size() >= 2 )
1194 QString firstNumber;
1195 QString secondNumber;
1198 firstNumber = QString::number( transformedPoint.
y(),
'f', displayPrecision );
1199 secondNumber = QString::number( transformedPoint.
x(),
'f', displayPrecision );
1203 firstNumber = QString::number( transformedPoint.
x(),
'f', displayPrecision );
1204 secondNumber = QString::number( transformedPoint.
y(),
'f', displayPrecision );
1207 QAction *copyCoordinateAction =
new QAction( QStringLiteral(
"%5 (%1%2, %3%4)" ).arg(
1208 firstNumber, firstSuffix, secondNumber, secondSuffix, identifier ), &menu );
1210 connect( copyCoordinateAction, &QAction::triggered,
this, [firstNumber, secondNumber, transformedPoint]
1212 QClipboard *clipboard = QApplication::clipboard();
1214 const QString coordinates = firstNumber +
',' + secondNumber;
1217 if ( clipboard->supportsSelection() )
1219 clipboard->setText( coordinates, QClipboard::Selection );
1221 clipboard->setText( coordinates, QClipboard::Clipboard );
1224 copyCoordinateMenu->addAction( copyCoordinateAction );
1238 const QString customCrsString = settings.
value( QStringLiteral(
"qgis/custom_coordinate_crs" ) ).toString();
1239 if ( !customCrsString.isEmpty() )
1247 copyCoordinateMenu->addSeparator();
1248 QAction *setCustomCrsAction =
new QAction( tr(
"Set Custom CRS…" ), &menu );
1249 connect( setCustomCrsAction, &QAction::triggered,
this, [ = ]
1253 if ( selector.exec() )
1258 copyCoordinateMenu->addAction( setCustomCrsAction );
1260 menu.addMenu( copyCoordinateMenu );
1268 if ( !menu.isEmpty() )
1269 menu.exec(
event->globalPos() );
1274 const QDateTime currentTime = QDateTime::currentDateTime();
1279 const QString errorKey = error.layerID +
':' + error.message;
1280 if ( mRendererErrors.contains( errorKey ) )
1282 const QDateTime sameErrorTime = mRendererErrors.value( errorKey );
1284 if ( sameErrorTime.secsTo( currentTime ) < 60 )
1288 mRendererErrors[errorKey] = currentTime;
1295 void QgsMapCanvas::updateDevicePixelFromScreen()
1301 if ( window()->windowHandle() )
1303 mSettings.
setOutputDpi( window()->windowHandle()->screen()->physicalDotsPerInch() );
1304 mSettings.
setDpiTarget( window()->windowHandle()->screen()->physicalDotsPerInch() );
1310 mSettings.
setOutputDpi( window()->windowHandle()->screen()->logicalDotsPerInch() );
1311 mSettings.
setDpiTarget( window()->windowHandle()->screen()->logicalDotsPerInch() );
1316 void QgsMapCanvas::onElevationShadingRendererChanged()
1322 if ( mCache && wasDeactivated )
1340 clearTemporalCache();
1342 autoRefreshTriggered();
1352 mInteractionBlockers.append( blocker );
1357 mInteractionBlockers.removeAll( blocker );
1364 if ( block->blockCanvasInteraction( interaction ) )
1372 if ( mMapController )
1374 delete mMapController;
1375 mMapController =
nullptr;
1381 mMapController = controller;
1382 mMapController->setParent(
this );
1386 connect( mMapController, &QgsAbstract2DMapController::zoomMap,
this, [ = ](
double factor ) {
zoomByFactor( factor ); } );
1390 void QgsMapCanvas::mapUpdateTimeout()
1395 mMap->setContent( img, imageRect( img, mSettings ) );
1404 mJobCanceled =
true;
1425 image = theQPixmap->toImage();
1426 painter.begin( &image );
1436 image = mMap->contentImage().copy();
1437 painter.begin( &image );
1441 QStyleOptionGraphicsItem option;
1442 option.initFrom(
this );
1443 QGraphicsItem *item =
nullptr;
1444 QListIterator<QGraphicsItem *> i( items() );
1446 while ( i.hasPrevious() )
1448 item = i.previous();
1457 QPointF itemScenePos = item->scenePos();
1458 painter.translate( itemScenePos.x(), itemScenePos.y() );
1460 item->paint( &painter, &option );
1464 image.save( fileName, format.toLocal8Bit().data() );
1466 QFileInfo myInfo = QFileInfo( fileName );
1469 QString outputSuffix = myInfo.suffix();
1470 QString myWorldFileName = myInfo.absolutePath() +
'/' + myInfo.completeBaseName() +
'.'
1471 + outputSuffix.at( 0 ) + outputSuffix.at( myInfo.suffix().size() - 1 ) +
'w';
1472 QFile myWorldFile( myWorldFileName );
1473 if ( !myWorldFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
1477 QTextStream myStream( &myWorldFile );
1513 if ( ( r == current ) && magnified )
1526 QgsDebugMsgLevel( QStringLiteral(
"Empty extent - keeping old scale with new center!" ), 2 );
1535 if ( mScaleLocked && magnified )
1537 ScaleRestorer restorer(
this );
1554 for (
int i = mLastExtent.size() - 1; i > mLastExtentIndex; i-- )
1556 mLastExtent.removeAt( i );
1559 if ( !mLastExtent.isEmpty() && mLastExtent.last() != mSettings.
extent() )
1561 mLastExtent.append( mSettings.
extent() );
1565 if ( mLastExtent.size() > 100 )
1567 mLastExtent.removeAt( 0 );
1571 mLastExtentIndex = mLastExtent.size() - 1;
1620 return mCursorPoint;
1642 if ( !mBlockScaleChangedSignal )
1675 if ( mLastExtentIndex > 0 )
1678 mSettings.
setExtent( mLastExtent[mLastExtentIndex] );
1691 if ( mLastExtentIndex < mLastExtent.size() - 1 )
1694 mSettings.
setExtent( mLastExtent[mLastExtentIndex] );
1706 mLastExtent.clear();
1707 mLastExtent.append( mSettings.
extent() ) ;
1708 mLastExtentIndex = mLastExtent.size() - 1;
1726 double closestSquaredDistance = pow( extentRect.
width(), 2.0 ) + pow( extentRect.
height(), 2.0 );
1727 bool pointFound =
false;
1731 double sqrDist = point.
sqrDist( centerLayerCoordinates );
1732 if ( sqrDist > closestSquaredDistance || sqrDist < 4 * std::numeric_limits<double>::epsilon() )
1735 closestPoint = point;
1736 closestSquaredDistance = sqrDist;
1742 rect.scale( scaleFactor, &
center );
1755 layer = mCurrentLayer;
1775 emit
messageEmitted( tr(
"Cannot zoom to selected feature(s)" ), tr(
"No extent could be determined." ), Qgis::MessageLevel::Warning );
1785 rect = optimalExtentForPointLayer( vlayer, rect.
center() );
1797 for (
const QgsFeature &feature : selectedFeatures )
1799 if ( !feature.hasGeometry() )
1808 emit
messageEmitted( tr(
"Cannot zoom to selected feature(s)" ), tr(
"No extent could be determined." ), Qgis::MessageLevel::Warning );
1838 if ( !mapLayer || !mapLayer->isSpatial() )
1841 switch ( mapLayer->type() )
1847 if (
layer->selectedFeatureCount() == 0 )
1850 rect =
layer->boundingBoxOfSelected();
1858 rect = optimalExtentForPointLayer(
layer, rect.
center() );
1872 for (
const QgsFeature &feature : selectedFeatures )
1874 if ( !feature.hasGeometry() )
1896 if ( selectionExtent.
isNull() )
1898 emit
messageEmitted( tr(
"Cannot zoom to selected feature(s)" ), tr(
"No extent could be determined." ), Qgis::MessageLevel::Warning );
1907 return mSettings.
zRange();
1922 clearElevationCache();
1924 autoRefreshTriggered();
1960 if ( boundingBoxOfFeatureIds( ids,
layer, bbox, errorMsg ) )
1964 bbox = optimalExtentForPointLayer(
layer, bbox.
center() );
1970 emit
messageEmitted( tr(
"Zoom to feature id failed" ), errorMsg, Qgis::MessageLevel::Warning );
1984 if ( boundingBoxOfFeatureIds( ids,
layer, bbox, errorMsg ) )
1992 emit
messageEmitted( tr(
"Pan to feature id failed" ), errorMsg, Qgis::MessageLevel::Warning );
2001 int featureCount = 0;
2009 errorMsg = tr(
"Feature does not have a geometry" );
2013 errorMsg = tr(
"Feature geometry is empty" );
2015 if ( !errorMsg.isEmpty() )
2024 if ( featureCount != ids.count() )
2026 errorMsg = tr(
"Feature not found" );
2038 layer = mCurrentLayer;
2062 for (
const QgsFeature &feature : selectedFeatures )
2064 if ( !feature.hasGeometry() )
2084 emit
messageEmitted( tr(
"Cannot pan to selected feature(s)" ), tr(
"No extent could be determined." ), Qgis::MessageLevel::Warning );
2100 if ( !mapLayer || !mapLayer->isSpatial() )
2104 switch ( mapLayer->type() )
2109 if (
layer->selectedFeatureCount() == 0 )
2112 rect =
layer->boundingBoxOfSelected();
2120 rect = optimalExtentForPointLayer(
layer, rect.
center() );
2131 for (
const QgsFeature &feature : selectedFeatures )
2133 if ( !feature.hasGeometry() )
2156 if ( selectionExtent.
isNull() )
2158 emit
messageEmitted( tr(
"Cannot pan to selected feature(s)" ), tr(
"No extent could be determined." ), Qgis::MessageLevel::Warning );
2167 const QColor &color1,
const QColor &color2,
2168 int flashes,
int duration )
2175 QList< QgsGeometry > geoms;
2191 if ( geometries.isEmpty() )
2209 QColor startColor = color1;
2210 if ( !startColor.isValid() )
2220 startColor.setAlpha( 255 );
2222 QColor endColor = color2;
2223 if ( !endColor.isValid() )
2225 endColor = startColor;
2226 endColor.setAlpha( 0 );
2230 QVariantAnimation *animation =
new QVariantAnimation(
this );
2231 connect( animation, &QVariantAnimation::finished,
this, [animation, rb]
2233 animation->deleteLater();
2236 connect( animation, &QPropertyAnimation::valueChanged,
this, [rb, geomType](
const QVariant & value )
2238 QColor
c = value.value<QColor>();
2247 c.setAlpha(
c.alpha() );
2253 animation->setDuration( duration * flashes );
2254 animation->setStartValue( endColor );
2255 double midStep = 0.2 / flashes;
2256 for (
int i = 0; i < flashes; ++i )
2258 double start =
static_cast< double >( i ) / flashes;
2259 animation->setKeyValueAt( start + midStep, startColor );
2260 double end =
static_cast< double >( i + 1 ) / flashes;
2262 animation->setKeyValueAt( end, endColor );
2264 animation->setEndValue( endColor );
2287 if ( !e->isAccepted() )
2292 double dx = std::fabs( currentExtent.
width() / 4 );
2293 double dy = std::fabs( currentExtent.
height() / 4 );
2325 if ( ! e->isAutoRepeat() )
2333 case Qt::Key_PageUp:
2338 case Qt::Key_PageDown:
2345 mUseParallelRendering = !mUseParallelRendering;
2350 mDrawRenderingStats = !mDrawRenderingStats;
2378 mTemporaryCursorOverride.reset();
2392 QgsDebugMsgLevel(
"Ignoring key release: " + QString::number( e->key() ), 2 );
2411 void QgsMapCanvas::beginZoomRect( QPoint pos )
2413 mZoomRect.setRect( 0, 0, 0, 0 );
2415 mZoomDragging =
true;
2417 QColor color( Qt::blue );
2418 color.setAlpha( 63 );
2419 mZoomRubberBand->setColor( color );
2420 mZoomRect.setTopLeft( pos );
2423 void QgsMapCanvas::stopZoomRect()
2425 if ( mZoomDragging )
2427 mZoomDragging =
false;
2428 mZoomRubberBand.reset(
nullptr );
2429 mTemporaryCursorOverride.reset();
2433 void QgsMapCanvas::endZoomRect( QPoint pos )
2438 mZoomRect.setRight( pos.x() );
2439 mZoomRect.setBottom( pos.y() );
2442 mZoomRect = mZoomRect.normalized();
2444 if ( mZoomRect.width() < 5 && mZoomRect.height() < 5 )
2451 const QSize &zoomRectSize = mZoomRect.size();
2452 const QSize &canvasSize = mSettings.
outputSize();
2453 double sfx =
static_cast< double >( zoomRectSize.width() ) / canvasSize.width();
2454 double sfy =
static_cast< double >( zoomRectSize.height() ) / canvasSize.height();
2455 double sf = std::max( sfx, sfy );
2463 void QgsMapCanvas::startPan()
2473 void QgsMapCanvas::stopPan()
2478 mTemporaryCursorOverride.reset();
2486 if ( e->button() == Qt::MiddleButton &&
2487 e->modifiers() & Qt::ShiftModifier )
2489 beginZoomRect( e->pos() );
2493 else if ( e->button() == Qt::MiddleButton )
2508 && e->modifiers() & Qt::ShiftModifier )
2510 beginZoomRect( e->pos() );
2516 showContextMenu( me.get() );
2539 if ( mZoomDragging &&
2540 e->button() == Qt::MiddleButton )
2542 endZoomRect( e->pos() );
2546 else if ( e->button() == Qt::MiddleButton )
2550 else if ( e->button() == Qt::BackButton )
2555 else if ( e->button() == Qt::ForwardButton )
2562 if ( mZoomDragging && e->button() == Qt::LeftButton )
2564 endZoomRect( e->pos() );
2586 QGraphicsView::resizeEvent( e );
2587 mResizeTimer->start( 500 );
2589 double oldScale = mSettings.
scale();
2590 QSize lastSize = viewport()->size();
2593 mScene->setSceneRect( QRectF( 0, 0, lastSize.width(), lastSize.height() ) );
2599 double scaleFactor = oldScale / mSettings.
scale();
2617 QGraphicsView::paintEvent( e );
2622 if ( mBlockItemPositionUpdates )
2625 const QList<QGraphicsItem *> items = mScene->items();
2626 for ( QGraphicsItem *gi : items )
2643 QgsDebugMsgLevel(
"Wheel event delta " + QString::number( e->angleDelta().y() ), 2 );
2648 if ( e->isAccepted() )
2652 if ( e->angleDelta().y() == 0 )
2659 bool reverseZoom = settings.
value( QStringLiteral(
"qgis/reverse_wheel_zoom" ),
false ).toBool();
2660 bool zoomIn = reverseZoom ? e->angleDelta().y() < 0 : e->angleDelta().y() > 0;
2664 zoomFactor = 1.0 + ( zoomFactor - 1.0 ) / 120.0 * std::fabs( e->angleDelta().y() );
2666 if ( e->modifiers() & Qt::ControlModifier )
2669 zoomFactor = 1.0 + ( zoomFactor - 1.0 ) / 20.0;
2672 double signedWheelFactor =
zoomIn ? 1 / zoomFactor : zoomFactor;
2677 QgsPointXY newCenter( mousePos.
x() + ( ( oldCenter.
x() - mousePos.
x() ) * signedWheelFactor ),
2678 mousePos.
y() + ( ( oldCenter.
y() - mousePos.
y() ) * signedWheelFactor ) );
2686 mWheelZoomFactor = std::max( factor, 1.01 );
2715 ScaleRestorer restorer(
this );
2726 if ( mScaleLocked != isLocked )
2728 mScaleLocked = isLocked;
2741 else if ( mZoomDragging )
2743 mZoomRect.setBottomRight( e->pos() );
2744 mZoomRubberBand->setToCanvasRectangle( mZoomRect );
2745 mZoomRubberBand->show();
2758 if ( !panOperationInProgress() )
2770 if ( tool == mMapTool )
2781 disconnect( mMapTool, &QObject::destroyed,
this, &QgsMapCanvas::mapToolDestroyed );
2792 connect( mMapTool, &QObject::destroyed,
this, &QgsMapCanvas::mapToolDestroyed );
2800 if ( mMapTool && mMapTool == tool )
2802 disconnect( mMapTool, &QObject::destroyed,
this, &QgsMapCanvas::mapToolDestroyed );
2807 setCursor( Qt::ArrowCursor );
2831 QBrush bgBrush( color );
2832 setBackgroundBrush( bgBrush );
2835 palette.setColor( backgroundRole(), color );
2836 setPalette( palette );
2840 mScene->setBackgroundBrush( bgBrush );
2849 return mScene->backgroundBrush().color();
2861 bool hasSelectedFeatures =
false;
2868 hasSelectedFeatures =
true;
2873 if ( hasSelectedFeatures )
2939 if ( mTheme ==
theme )
2953 setLayersPrivate(
QgsProject::instance()->mapThemeCollection()->mapThemeVisibleLayers( mTheme ) );
2971 void QgsMapCanvas::connectNotify(
const char *signal )
2978 void QgsMapCanvas::layerRepaintRequested(
bool deferred )
2984 void QgsMapCanvas::autoRefreshTriggered()
2990 mRefreshAfterJob =
true;
2997 void QgsMapCanvas::updateAutoRefreshTimer()
3001 int minAutoRefreshInterval = -1;
3005 int layerRefreshInterval = 0;
3016 if ( rendererRefreshRate > 0 )
3018 layerRefreshInterval = 1000 / rendererRefreshRate;
3023 if ( layerRefreshInterval == 0 )
3026 minAutoRefreshInterval = minAutoRefreshInterval > 0 ? std::min( layerRefreshInterval, minAutoRefreshInterval ) : layerRefreshInterval;
3029 if ( minAutoRefreshInterval > 0 )
3031 mAutoRefreshTimer.setInterval( minAutoRefreshInterval );
3032 mAutoRefreshTimer.start();
3036 mAutoRefreshTimer.stop();
3040 void QgsMapCanvas::projectThemesChanged()
3042 if ( mTheme.isEmpty() )
3073 double dx = end.
x() - start.
x();
3074 double dy = end.
y() - start.
y();
3076 c.set(
c.x() - dx,
c.y() - dy );
3114 setSceneRect( -pnt.x(), -pnt.y(), viewport()->size().width(), viewport()->size().height() );
3122 bool allHandled =
true;
3125 bool handled =
false;
3128 if ( handler && handler->customUriProviderKey() == uri.providerKey )
3130 if ( handler->handleCustomUriCanvasDrop( uri,
this ) )
3154 updateDevicePixelFromScreen();
3159 if ( !mBlockExtentChangedSignal )
3170 if ( !mPreviewEffect )
3175 mPreviewEffect->setEnabled( previewEnabled );
3180 if ( !mPreviewEffect )
3185 return mPreviewEffect->isEnabled();
3190 if ( !mPreviewEffect )
3195 mPreviewEffect->
setMode( mode );
3200 if ( !mPreviewEffect )
3205 return mPreviewEffect->
mode();
3210 if ( !mSnappingUtils )
3216 return mSnappingUtils;
3221 mSnappingUtils = utils;
3228 QDomNodeList nodes = doc.elementsByTagName( QStringLiteral(
"mapcanvas" ) );
3229 if ( nodes.count() )
3231 QDomNode node = nodes.item( 0 );
3234 if ( nodes.count() > 1 )
3236 for (
int i = 0; i < nodes.size(); ++i )
3238 QDomElement elementNode = nodes.at( i ).toElement();
3240 if ( elementNode.hasAttribute( QStringLiteral(
"name" ) ) && elementNode.attribute( QStringLiteral(
"name" ) ) == objectName() )
3242 node = nodes.at( i );
3250 if ( objectName() != QLatin1String(
"theMapCanvas" ) )
3261 QDomElement elem = node.toElement();
3262 if ( elem.hasAttribute( QStringLiteral(
"theme" ) ) )
3264 if (
QgsProject::instance()->mapThemeCollection()->hasMapTheme( elem.attribute( QStringLiteral(
"theme" ) ) ) )
3266 setTheme( elem.attribute( QStringLiteral(
"theme" ) ) );
3269 setAnnotationsVisible( elem.attribute( QStringLiteral(
"annotationsVisible" ), QStringLiteral(
"1" ) ).toInt() );
3272 const QDomNodeList scopeElements = elem.elementsByTagName( QStringLiteral(
"expressionContextScope" ) );
3273 if ( scopeElements.size() > 0 )
3275 const QDomElement scopeElement = scopeElements.at( 0 ).toElement();
3281 QgsDebugMsgLevel( QStringLiteral(
"Couldn't read mapcanvas information from project" ), 2 );
3296 QDomNodeList nl = doc.elementsByTagName( QStringLiteral(
"qgis" ) );
3299 QgsDebugError( QStringLiteral(
"Unable to find qgis element in project file" ) );
3302 QDomNode qgisNode = nl.item( 0 );
3304 QDomElement mapcanvasNode = doc.createElement( QStringLiteral(
"mapcanvas" ) );
3305 mapcanvasNode.setAttribute( QStringLiteral(
"name" ), objectName() );
3306 if ( !mTheme.isEmpty() )
3307 mapcanvasNode.setAttribute( QStringLiteral(
"theme" ), mTheme );
3308 mapcanvasNode.setAttribute( QStringLiteral(
"annotationsVisible" ), mAnnotationsVisible );
3309 qgisNode.appendChild( mapcanvasNode );
3311 mSettings.
writeXml( mapcanvasNode, doc );
3314 QDomElement scopeElement = doc.createElement( QStringLiteral(
"expressionContextScope" ) );
3316 tmpScope.
removeVariable( QStringLiteral(
"atlas_featurenumber" ) );
3322 mapcanvasNode.appendChild( scopeElement );
3329 if ( mScaleLocked && !ignoreScaleLock )
3331 ScaleRestorer restorer(
this );
3366 bool allHandled =
true;
3369 bool handled =
false;
3372 if ( handler->canHandleCustomUriCanvasDrop( uri,
this ) )
3398 return QGraphicsView::viewportEvent(
event );
3401 void QgsMapCanvas::mapToolDestroyed()
3409 if ( e->type() == QEvent::Gesture )
3411 if ( QTapAndHoldGesture *tapAndHoldGesture = qobject_cast< QTapAndHoldGesture * >(
static_cast<QGestureEvent *
>( e )->gesture( Qt::TapAndHoldGesture ) ) )
3413 QPointF pos = tapAndHoldGesture->position();
3414 pos = mapFromGlobal( QPoint( pos.x(), pos.y() ) );
3422 return mMapTool->
gestureEvent(
static_cast<QGestureEvent *
>( e ) );
3427 return QGraphicsView::event( e );
3453 while ( mRefreshScheduled || mJob )
3455 QgsApplication::processEvents();
3471 QList<QgsMapCanvasAnnotationItem *> annotationItemList;
3472 const QList<QGraphicsItem *> items = mScene->items();
3473 for ( QGraphicsItem *gi : items )
3478 annotationItemList.push_back( aItem );
3482 return annotationItemList;
3487 mAnnotationsVisible = show;
3491 item->setVisible( show );
3505 void QgsMapCanvas::startPreviewJobs()
3514 schedulePreviewJob( 0 );
3517 void QgsMapCanvas::startPreviewJob(
int number )
3530 double dx = ( i - 1 ) * mapRect.
width();
3531 double dy = ( 1 - j ) * mapRect.
height();
3546 const QList<QgsMapLayer *>
layers = jobSettings.
layers();
3547 QList< QgsMapLayer * > previewLayers;
3552 if (
layer->
customProperty( QStringLiteral(
"rendering/noPreviewJobs" ), false ).toBool() )
3554 QgsDebugMsgLevel( QStringLiteral(
"Layer %1 not rendered because it is explicitly blocked from preview jobs" ).arg(
layer->
id() ), 3 );
3561 QgsDebugMsgLevel( QStringLiteral(
"Layer %1 not rendered because it does not match the renderInPreview criterion %2" ).arg(
layer->
id() ).arg( mLastLayerRenderTime.value(
layer->
id() ) ), 3 );
3565 previewLayers <<
layer;
3570 job->setProperty(
"number", number );
3571 mPreviewJobs.append( job );
3576 void QgsMapCanvas::stopPreviewJobs()
3578 mPreviewTimer.stop();
3579 for (
auto previewJob = mPreviewJobs.constBegin(); previewJob != mPreviewJobs.constEnd(); ++previewJob )
3585 ( *previewJob )->cancelWithoutBlocking();
3588 mPreviewJobs.clear();
3591 void QgsMapCanvas::schedulePreviewJob(
int number )
3593 mPreviewTimer.setSingleShot(
true );
3594 mPreviewTimer.setInterval( PREVIEW_JOB_DELAY_MS );
3595 disconnect( mPreviewTimerConnection );
3596 mPreviewTimerConnection = connect( &mPreviewTimer, &QTimer::timeout,
this, [ = ]()
3598 startPreviewJob( number );
3600 mPreviewTimer.start();
3603 bool QgsMapCanvas::panOperationInProgress()
3608 if (
QgsMapToolPan *panTool = qobject_cast< QgsMapToolPan *>( mMapTool ) )
3610 if ( panTool->isDragging() )
3617 int QgsMapCanvas::nextZoomLevel(
const QList<double> &resolutions,
bool zoomIn )
const
3619 int resolutionLevel = -1;
3621 int nResolutions = resolutions.size();
3623 for (
int i = 0; i < nResolutions; ++i )
3625 if (
qgsDoubleNear( resolutions[i], currentResolution, 0.0001 ) )
3627 resolutionLevel =
zoomIn ? ( i - 1 ) : ( i + 1 );
3630 else if ( currentResolution <= resolutions[i] )
3632 resolutionLevel =
zoomIn ? ( i - 1 ) : i;
3635 resolutionLevel =
zoomIn ? i : i + 1;
3638 if ( resolutionLevel < 0 || resolutionLevel >= nResolutions )
3642 if (
zoomIn && resolutionLevel == nResolutions - 1 && resolutions[nResolutions - 1] < currentResolution / mWheelZoomFactor )
3647 if ( !
zoomIn && resolutionLevel == 0 && resolutions[0] > mWheelZoomFactor * currentResolution )
3652 return resolutionLevel;
3657 if ( !mZoomResolutions.isEmpty() )
3659 int zoomLevel = nextZoomLevel( mZoomResolutions,
true );
3660 if ( zoomLevel != -1 )
3665 return 1 / mWheelZoomFactor;
3670 if ( !mZoomResolutions.isEmpty() )
3672 int zoomLevel = nextZoomLevel( mZoomResolutions,
false );
3673 if ( zoomLevel != -1 )
3678 return mWheelZoomFactor;
QFlags< MapSettingsFlag > MapSettingsFlags
Map settings flags.
@ MediumString
A medium-length string, recommended for general purpose use.
DistanceUnit
Units of distance.
@ Degrees
Degrees, for planar geographic CRS distance measurements.
@ Animated
Temporal navigation relies on frames within a datetime range.
@ Movie
Movie mode – behaves like a video player, with a fixed frame duration and no temporal range (since QG...
@ FixedRange
Temporal navigation relies on a fixed datetime range.
@ Disabled
Temporal navigation is disabled.
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
@ YX
Northing/Easting (or Latitude/Longitude for geographic CRS)
@ View
Renderer used for displaying on screen.
@ Preferred
Preferred format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019,...
@ BallparkTransformsAreAppropriate
Indicates that approximate "ballpark" results are appropriate for this coordinate transform....
@ IgnoreImpossibleTransformations
Indicates that impossible transformations (such as those which attempt to transform between two diffe...
@ 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.
@ RecordProfile
Enable run-time profiling while rendering (since QGIS 3.34)
@ 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.
@ HighQualityImageTransforms
Enable high quality image transformations, which results in better appearance of scaled or rotated ra...
Abstract base class for all 2D map controllers.
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 QgsRuntimeProfiler * profiler()
Returns the application runtime profiler.
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.
static Qgis::CoordinateOrder defaultCoordinateOrderForCrs(const QgsCoordinateReferenceSystem &crs)
Returns the default coordinate order to use for the specified crs.
static QString axisDirectionToAbbreviatedString(Qgis::CrsAxisDirection axis)
Returns a translated abbreviation representing an axis direction.
This class represents a coordinate reference system (CRS).
Q_GADGET Qgis::DistanceUnit mapUnits
QString userFriendlyIdentifier(Qgis::CrsIdentifierType type=Qgis::CrsIdentifierType::MediumString) const
Returns a user friendly identifier for the CRS.
void updateDefinition()
Updates the definition and parameters of the coordinate reference system to their latest values.
QList< Qgis::CrsAxisDirection > axisOrdering() const
Returns an ordered list of the axis directions reflecting the native axis order for the CRS.
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
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.
Qgis::DistanceUnit lengthUnits() const
Returns the units of distance for length calculations made by this object.
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
QgsRange which stores a range of double values.
bool isActive() const
Returns whether this shading renderer is active.
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)
Fetch next feature and stores in f, returns true on success.
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
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)
Creates a new geometry from a QgsPointXY object.
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
A map layer which consists of a set of child layers, where all component layers are rendered as a sin...
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.
void panToSelected(QgsMapLayer *layer=nullptr)
Pan to the selected features of current ayer keeping same extent.
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 zoomToSelected(QgsMapLayer *layer=nullptr)
Zoom to the extent of the selected features of provided map layer.
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...
void setMapController(QgsAbstract2DMapController *controller)
Sets the input controller device to use for controlling the canvas.
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.
void selectionChanged(QgsMapLayer *layer)
Emitted when selection in any layer gets changed.
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.
void emitExtentsChanged()
Emits the extentsChanged signal when appropriate.
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.
void panDistanceBearingChanged(double distance, Qgis::DistanceUnit unit, double bearing)
Emitted whenever the distance or bearing of an in-progress panning operation is changed.
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.
bool setReferencedExtent(const QgsReferencedRectangle &extent)
Sets the canvas to the specified extent.
void dragEnterEvent(QDragEnterEvent *e) override
QgsMapRendererCache * cache()
Returns the map renderer cache, if caching is enabled.
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.
QList< QgsMapLayer * > layers(bool expandGroupLayers=false) const
Returns the list of layers shown within the map canvas.
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 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 addOverlayWidget(QWidget *widget, Qt::Edge edge)
Adds an overlay widget to the layout, which will be bound to the specified edge.
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...
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.
double scale() const
Returns the last reported scale of the canvas.
QgsSnappingUtils * snappingUtils() const
Returns snapping utility class that is associated with map canvas.
Qgis::DistanceUnit mapUnits() const
Convenience function for returning the current canvas map units.
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 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...
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
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.
Q_DECL_DEPRECATED bool hasAutoRefreshEnabled() const
Returns true if auto refresh is enabled for the layer.
void rendererChanged()
Signal emitted when renderer is changed.
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.
void clearCacheImage(const QString &cacheKey)
Removes an image from the cache with matching cacheKey.
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...
const QgsMapSettings & mapSettings() const
Returns map settings with which this job was started.
void finished()
emitted when asynchronous rendering is finished (or canceled).
static const QgsSettingsEntryBool * settingsLogCanvasRefreshEvent
Settings entry log canvas refresh event.
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.
QList< QgsMapRendererJob::Error > Errors
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 setElevationShadingRenderer(const QgsElevationShadingRenderer &renderer)
Sets the shading renderer used to render shading on the entire map.
Qgis::DistanceUnit mapUnits() const
Returns the units of the map's geographical coordinates - used for scale calculation.
void writeXml(QDomNode &node, QDomDocument &doc)
QgsPointXY layerToMapCoordinates(const QgsMapLayer *layer, QgsPointXY point) const
transform point coordinates from layer's CRS to output CRS
QList< QgsMapLayer * > layers(bool expandGroupLayers=false) const
Returns the list of layers which will be rendered in the map.
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 setFrameRate(double rate)
Sets the frame rate of the map (in frames per second), for maps which are part of an animation.
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.
double magnificationFactor() const
Returns the magnification factor.
QStringList layerIds(bool expandGroupLayers=false) const
Returns the list of layer IDs which will be rendered in the map.
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.
void setRendererUsage(Qgis::RendererUsage rendererUsage)
Sets the rendering usage.
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.
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.
void setCurrentFrame(long long frame)
Sets the current frame of the map, for maps which are part of an animation.
const QgsElevationShadingRenderer & elevationShadingRenderer() const
Returns the shading renderer used to render shading on the entire 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
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.
double defaultRotation() const
Returns the default map rotation (in clockwise degrees) for maps in the project.
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.
QgsElevationShadingRenderer elevationShadingRenderer() const
Returns the elevation shading renderer used for map shading.
void elevationShadingRendererChanged()
Emitted when the map shading renderer changes.
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 xMinimum() const
Returns the x minimum value (left side of rectangle).
void setYMinimum(double y)
Set the minimum y value.
double yMinimum() const
Returns the y minimum value (bottom side of rectangle).
void setXMinimum(double x)
Set the minimum x value.
double width() const
Returns the width of the rectangle.
double xMaximum() const
Returns the x maximum value (right side of rectangle).
bool isNull() const
Test if the rectangle is null (holding no spatial information).
double yMaximum() const
Returns the y maximum value (top side of rectangle).
void setYMaximum(double y)
Set the maximum y value.
QgsPointXY center() const
Returns the center point of the rectangle.
void setXMaximum(double x)
Set the maximum x value.
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 has no area.
double height() const
Returns the height of the rectangle.
void setNull()
Mark a rectangle as being null (holding no spatial information).
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.
void clear(const QString &group="startup")
clear Clear all profile data.
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.
A utility class for dynamic handling of changes to screen properties.
void screenDpiChanged(double dpi)
Emitted whenever the screen dpi associated with the widget is changed.
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.
static double rendererFrameRate(const QgsFeatureRenderer *renderer)
Calculates the frame rate (in frames per second) at which the given renderer must be redrawn.
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.
Implements a temporal controller based on a frame by frame navigation and animation.
void navigationModeChanged(Qgis::TemporalNavigationMode mode)
Emitted whenever the navigation mode changes.
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.
T begin() const
Returns the beginning of the range.
T end() const
Returns the upper bound of the range.
Temporarily sets a cursor override for the QApplication for the lifetime of the object.
void release()
Releases the cursor override early (i.e.
Represents a vector layer which manages a vector based data sets.
Q_INVOKABLE QgsRectangle boundingBoxOfSelected() const
Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,...
int selectedFeatureCount() const
Returns the number of features that are selected in this layer.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
void selectionChanged(const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect)
Emitted when selection was changed.
Implements a map layer that is dedicated to rendering of vector tiles.
QList< QgsFeature > selectedFeatures() const
Returns the list of features currently selected in the layer.
void selectionChanged()
Emitted whenever the selected features in the layer are changed.
int selectedFeatureCount() const
Returns the number of features that are selected in this layer.
A class to represent a vector.
static Qgis::GeometryType geometryType(Qgis::WkbType type)
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a Polyg...
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)
#define QgsDebugError(str)
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.