/
qgsmapcanvas.cpp
2841 lines (2394 loc) · 78.6 KB
/
qgsmapcanvas.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
qgsmapcanvas.cpp - description
------------------ -
begin : Sun Jun 30 2002
copyright : (C) 2002 by Gary E.Sherman
email : sherman at mrcc.com
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include <cmath>
#include <QtGlobal>
#include <QApplication>
#include <QCursor>
#include <QDir>
#include <QFile>
#include <QGraphicsItem>
#include <QGraphicsScene>
#include <QGraphicsView>
#include <QKeyEvent>
#include <QPainter>
#include <QPaintEvent>
#include <QPixmap>
#include <QRect>
#include <QTextStream>
#include <QResizeEvent>
#include <QScreen>
#include <QString>
#include <QStringList>
#include <QWheelEvent>
#include <QWindow>
#include <QMenu>
#include <QClipboard>
#include "qgis.h"
#include "qgssettings.h"
#include "qgsmapcanvasannotationitem.h"
#include "qgsapplication.h"
#include "qgsexception.h"
#include "qgsdatumtransformdialog.h"
#include "qgsfeatureiterator.h"
#include "qgslogger.h"
#include "qgsmapcanvas.h"
#include "qgsmapcanvasmap.h"
#include "qgsmapcanvassnappingutils.h"
#include "qgsmaplayer.h"
#include "qgsmapmouseevent.h"
#include "qgsmaptoolpan.h"
#include "qgsmaptoolzoom.h"
#include "qgsmaptopixel.h"
#include "qgsmapoverviewcanvas.h"
#include "qgsmaprenderercache.h"
#include "qgsmaprenderercustompainterjob.h"
#include "qgsmaprendererparalleljob.h"
#include "qgsmaprenderersequentialjob.h"
#include "qgsmapsettingsutils.h"
#include "qgsmessagelog.h"
#include "qgsmessageviewer.h"
#include "qgspallabeling.h"
#include "qgsproject.h"
#include "qgsrubberband.h"
#include "qgsvectorlayer.h"
#include "qgsmapthemecollection.h"
#include "qgscoordinatetransformcontext.h"
#include "qgssvgcache.h"
#include "qgsimagecache.h"
#include "qgsexpressioncontextutils.h"
#include "qgsmimedatautils.h"
#include "qgscustomdrophandler.h"
#include "qgsreferencedgeometry.h"
#include "qgsprojectviewsettings.h"
#include "qgsmaplayertemporalproperties.h"
#include "qgsrasterlayertemporalproperties.h"
#include "qgsvectorlayertemporalproperties.h"
#include "qgstemporalcontroller.h"
#include "qgsruntimeprofiler.h"
#include "qgsprojectionselectiondialog.h"
#include "qgsannotationlayer.h"
/**
* \ingroup gui
* Deprecated to be deleted, stuff from here should be moved elsewhere.
* \note not available in Python bindings
*/
//TODO QGIS 4.0 - remove
class QgsMapCanvas::CanvasProperties
{
public:
/**
* Constructor for CanvasProperties.
*/
CanvasProperties() = default;
//!Flag to indicate status of mouse button
bool mouseButtonDown{ false };
//! Last seen point of the mouse
QPoint mouseLastXY;
//! Beginning point of a rubber band
QPoint rubberStartPoint;
//! Flag to indicate the pan selector key is held down by user
bool panSelectorDown{ false };
};
QgsMapCanvas::QgsMapCanvas( QWidget *parent )
: QGraphicsView( parent )
, mCanvasProperties( new CanvasProperties )
, mMenu( new QMenu( this ) )
, mExpressionContextScope( tr( "Map Canvas" ) )
{
mScene = new QGraphicsScene();
setScene( mScene );
setHorizontalScrollBarPolicy( Qt::ScrollBarAlwaysOff );
setVerticalScrollBarPolicy( Qt::ScrollBarAlwaysOff );
setMouseTracking( true );
setFocusPolicy( Qt::StrongFocus );
mResizeTimer = new QTimer( this );
mResizeTimer->setSingleShot( true );
connect( mResizeTimer, &QTimer::timeout, this, &QgsMapCanvas::refresh );
mRefreshTimer = new QTimer( this );
mRefreshTimer->setSingleShot( true );
connect( mRefreshTimer, &QTimer::timeout, this, &QgsMapCanvas::refreshMap );
// create map canvas item which will show the map
mMap = new QgsMapCanvasMap( this );
// project handling
connect( QgsProject::instance(), &QgsProject::readProject,
this, &QgsMapCanvas::readProject );
connect( QgsProject::instance(), &QgsProject::writeProject,
this, &QgsMapCanvas::writeProject );
connect( QgsProject::instance()->mapThemeCollection(), &QgsMapThemeCollection::mapThemeChanged, this, &QgsMapCanvas::mapThemeChanged );
connect( QgsProject::instance()->mapThemeCollection(), &QgsMapThemeCollection::mapThemeRenamed, this, &QgsMapCanvas::mapThemeRenamed );
connect( QgsProject::instance()->mapThemeCollection(), &QgsMapThemeCollection::mapThemesChanged, this, &QgsMapCanvas::projectThemesChanged );
{
QgsScopedRuntimeProfile profile( "Map settings initialization" );
mSettings.setFlag( QgsMapSettings::DrawEditingInfo );
mSettings.setFlag( QgsMapSettings::UseRenderingOptimization );
mSettings.setFlag( QgsMapSettings::RenderPartialOutput );
mSettings.setEllipsoid( QgsProject::instance()->ellipsoid() );
connect( QgsProject::instance(), &QgsProject::ellipsoidChanged,
this, [ = ]
{
mSettings.setEllipsoid( QgsProject::instance()->ellipsoid() );
refresh();
} );
mSettings.setTransformContext( QgsProject::instance()->transformContext() );
connect( QgsProject::instance(), &QgsProject::transformContextChanged,
this, [ = ]
{
mSettings.setTransformContext( QgsProject::instance()->transformContext() );
emit transformContextChanged();
refresh();
} );
}
// refresh canvas when a remote svg/image has finished downloading
connect( QgsApplication::svgCache(), &QgsSvgCache::remoteSvgFetched, this, &QgsMapCanvas::redrawAllLayers );
connect( QgsApplication::imageCache(), &QgsImageCache::remoteImageFetched, this, &QgsMapCanvas::redrawAllLayers );
// refresh canvas when project color scheme is changed -- if layers use project colors, they need to be redrawn
connect( QgsProject::instance(), &QgsProject::projectColorsChanged, this, &QgsMapCanvas::redrawAllLayers );
//segmentation parameters
QgsSettings settings;
double segmentationTolerance = settings.value( QStringLiteral( "qgis/segmentationTolerance" ), "0.01745" ).toDouble();
QgsAbstractGeometry::SegmentationToleranceType toleranceType = settings.enumValue( QStringLiteral( "qgis/segmentationToleranceType" ), QgsAbstractGeometry::MaximumAngle );
mSettings.setSegmentationTolerance( segmentationTolerance );
mSettings.setSegmentationToleranceType( toleranceType );
mWheelZoomFactor = settings.value( QStringLiteral( "qgis/zoom_factor" ), 2 ).toDouble();
QSize s = viewport()->size();
mSettings.setOutputSize( s );
mSettings.setDevicePixelRatio( devicePixelRatio() );
setSceneRect( 0, 0, s.width(), s.height() );
mScene->setSceneRect( QRectF( 0, 0, s.width(), s.height() ) );
moveCanvasContents( true );
// keep device pixel ratio up to date on screen or resolution change
if ( window()->windowHandle() )
{
connect( window()->windowHandle(), &QWindow::screenChanged, this, [ = ]( QScreen * ) {mSettings.setDevicePixelRatio( devicePixelRatio() );} );
connect( window()->windowHandle()->screen(), &QScreen::physicalDotsPerInchChanged, this, [ = ]( qreal ) {mSettings.setDevicePixelRatio( devicePixelRatio() );} );
}
connect( &mMapUpdateTimer, &QTimer::timeout, this, &QgsMapCanvas::mapUpdateTimeout );
mMapUpdateTimer.setInterval( 250 );
#ifdef Q_OS_WIN
// Enable touch event on Windows.
// Qt on Windows needs to be told it can take touch events or else it ignores them.
grabGesture( Qt::PinchGesture );
grabGesture( Qt::TapAndHoldGesture );
viewport()->setAttribute( Qt::WA_AcceptTouchEvents );
#endif
mPreviewEffect = new QgsPreviewEffect( this );
viewport()->setGraphicsEffect( mPreviewEffect );
mZoomCursor = QgsApplication::getThemeCursor( QgsApplication::Cursor::ZoomIn );
connect( &mAutoRefreshTimer, &QTimer::timeout, this, &QgsMapCanvas::autoRefreshTriggered );
connect( this, &QgsMapCanvas::extentsChanged, this, &QgsMapCanvas::updateCanvasItemPositions );
setInteractive( false );
// make sure we have the same default in QgsMapSettings and the scene's background brush
// (by default map settings has white bg color, scene background brush is black)
setCanvasColor( mSettings.backgroundColor() );
setTemporalRange( mSettings.temporalRange() );
refresh();
}
QgsMapCanvas::~QgsMapCanvas()
{
if ( mMapTool )
{
mMapTool->deactivate();
mMapTool = nullptr;
}
mLastNonZoomMapTool = nullptr;
// rendering job may still end up writing into canvas map item
// so kill it before deleting canvas items
if ( mJob )
{
whileBlocking( mJob )->cancel();
delete mJob;
}
QList< QgsMapRendererQImageJob * >::const_iterator previewJob = mPreviewJobs.constBegin();
for ( ; previewJob != mPreviewJobs.constEnd(); ++previewJob )
{
if ( *previewJob )
{
whileBlocking( *previewJob )->cancel();
delete *previewJob;
}
}
// delete canvas items prior to deleting the canvas
// because they might try to update canvas when it's
// already being destructed, ends with segfault
qDeleteAll( mScene->items() );
mScene->deleteLater(); // crashes in python tests on windows
delete mCache;
delete mLabelingResults;
}
void QgsMapCanvas::setMagnificationFactor( double factor, const QgsPointXY *center )
{
// do not go higher or lower than min max magnification ratio
double magnifierMin = QgsGuiUtils::CANVAS_MAGNIFICATION_MIN;
double magnifierMax = QgsGuiUtils::CANVAS_MAGNIFICATION_MAX;
factor = qBound( magnifierMin, factor, magnifierMax );
// the magnifier widget is in integer percent
if ( !qgsDoubleNear( factor, mSettings.magnificationFactor(), 0.01 ) )
{
mSettings.setMagnificationFactor( factor, center );
refresh();
emit magnificationChanged( factor );
}
}
double QgsMapCanvas::magnificationFactor() const
{
return mSettings.magnificationFactor();
}
void QgsMapCanvas::enableAntiAliasing( bool flag )
{
mSettings.setFlag( QgsMapSettings::Antialiasing, flag );
} // anti aliasing
void QgsMapCanvas::enableMapTileRendering( bool flag )
{
mSettings.setFlag( QgsMapSettings::RenderMapTile, flag );
}
QgsMapLayer *QgsMapCanvas::layer( int index )
{
QList<QgsMapLayer *> layers = mapSettings().layers();
if ( index >= 0 && index < layers.size() )
return layers[index];
else
return nullptr;
}
void QgsMapCanvas::setCurrentLayer( QgsMapLayer *layer )
{
if ( mCurrentLayer == layer )
return;
mCurrentLayer = layer;
emit currentLayerChanged( layer );
}
double QgsMapCanvas::scale() const
{
return mapSettings().scale();
}
bool QgsMapCanvas::isDrawing()
{
return nullptr != mJob;
} // isDrawing
// return the current coordinate transform based on the extents and
// device size
const QgsMapToPixel *QgsMapCanvas::getCoordinateTransform()
{
return &mapSettings().mapToPixel();
}
void QgsMapCanvas::setLayers( const QList<QgsMapLayer *> &layers )
{
// following a theme => request denied!
if ( !mTheme.isEmpty() )
return;
setLayersPrivate( layers );
}
void QgsMapCanvas::setLayersPrivate( const QList<QgsMapLayer *> &layers )
{
QList<QgsMapLayer *> oldLayers = mSettings.layers();
// update only if needed
if ( layers == oldLayers )
return;
const auto constOldLayers = oldLayers;
for ( QgsMapLayer *layer : constOldLayers )
{
disconnect( layer, &QgsMapLayer::repaintRequested, this, &QgsMapCanvas::layerRepaintRequested );
disconnect( layer, &QgsMapLayer::autoRefreshIntervalChanged, this, &QgsMapCanvas::updateAutoRefreshTimer );
if ( QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer ) )
{
disconnect( vlayer, &QgsVectorLayer::selectionChanged, this, &QgsMapCanvas::selectionChangedSlot );
}
}
mSettings.setLayers( layers );
const auto constLayers = layers;
for ( QgsMapLayer *layer : constLayers )
{
if ( !layer )
continue;
connect( layer, &QgsMapLayer::repaintRequested, this, &QgsMapCanvas::layerRepaintRequested );
connect( layer, &QgsMapLayer::autoRefreshIntervalChanged, this, &QgsMapCanvas::updateAutoRefreshTimer );
if ( QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer ) )
{
connect( vlayer, &QgsVectorLayer::selectionChanged, this, &QgsMapCanvas::selectionChangedSlot );
}
}
QgsDebugMsgLevel( QStringLiteral( "Layers have changed, refreshing" ), 2 );
emit layersChanged();
updateAutoRefreshTimer();
refresh();
}
const QgsMapSettings &QgsMapCanvas::mapSettings() const
{
return mSettings;
}
void QgsMapCanvas::setDestinationCrs( const QgsCoordinateReferenceSystem &crs )
{
if ( mSettings.destinationCrs() == crs )
return;
// try to reproject current extent to the new one
QgsRectangle rect;
if ( !mSettings.visibleExtent().isEmpty() )
{
QgsCoordinateTransform transform( mSettings.destinationCrs(), crs, QgsProject::instance() );
transform.setBallparkTransformsAreAppropriate( true );
try
{
rect = transform.transformBoundingBox( mSettings.visibleExtent() );
}
catch ( QgsCsException &e )
{
Q_UNUSED( e )
QgsDebugMsg( QStringLiteral( "Transform error caught: %1" ).arg( e.what() ) );
}
}
if ( !rect.isEmpty() )
{
setExtent( rect );
}
mSettings.setDestinationCrs( crs );
updateScale();
QgsDebugMsgLevel( QStringLiteral( "refreshing after destination CRS changed" ), 2 );
refresh();
emit destinationCrsChanged();
}
void QgsMapCanvas::setTemporalController( QgsTemporalController *controller )
{
if ( mController )
disconnect( mController, &QgsTemporalController::updateTemporalRange, this, &QgsMapCanvas::setTemporalRange );
mController = controller;
connect( mController, &QgsTemporalController::updateTemporalRange, this, &QgsMapCanvas::setTemporalRange );
}
const QgsTemporalController *QgsMapCanvas::temporalController() const
{
return mController;
}
void QgsMapCanvas::setMapSettingsFlags( QgsMapSettings::Flags flags )
{
mSettings.setFlags( flags );
clearCache();
refresh();
}
const QgsLabelingResults *QgsMapCanvas::labelingResults() const
{
return mLabelingResults;
}
void QgsMapCanvas::setCachingEnabled( bool enabled )
{
if ( enabled == isCachingEnabled() )
return;
if ( mJob && mJob->isActive() )
{
// wait for the current rendering to finish, before touching the cache
mJob->waitForFinished();
}
if ( enabled )
{
mCache = new QgsMapRendererCache;
}
else
{
delete mCache;
mCache = nullptr;
}
}
bool QgsMapCanvas::isCachingEnabled() const
{
return nullptr != mCache;
}
void QgsMapCanvas::clearCache()
{
if ( mCache )
mCache->clear();
}
void QgsMapCanvas::setParallelRenderingEnabled( bool enabled )
{
mUseParallelRendering = enabled;
}
bool QgsMapCanvas::isParallelRenderingEnabled() const
{
return mUseParallelRendering;
}
void QgsMapCanvas::setMapUpdateInterval( int timeMilliseconds )
{
mMapUpdateTimer.setInterval( timeMilliseconds );
}
int QgsMapCanvas::mapUpdateInterval() const
{
return mMapUpdateTimer.interval();
}
QgsMapLayer *QgsMapCanvas::currentLayer()
{
return mCurrentLayer;
}
QgsExpressionContextScope *QgsMapCanvas::defaultExpressionContextScope()
{
QgsExpressionContextScope *s = new QgsExpressionContextScope( QObject::tr( "Map Canvas" ) );
s->setVariable( QStringLiteral( "canvas_cursor_point" ), QgsGeometry::fromPointXY( cursorPoint() ), true );
return s;
}
void QgsMapCanvas::refresh()
{
if ( !mSettings.hasValidSettings() )
{
QgsDebugMsgLevel( QStringLiteral( "CANVAS refresh - invalid settings -> nothing to do" ), 2 );
return;
}
if ( !mRenderFlag || mFrozen )
{
QgsDebugMsgLevel( QStringLiteral( "CANVAS render flag off" ), 2 );
return;
}
if ( mRefreshScheduled )
{
QgsDebugMsgLevel( QStringLiteral( "CANVAS refresh already scheduled" ), 2 );
return;
}
mRefreshScheduled = true;
QgsDebugMsgLevel( QStringLiteral( "CANVAS refresh scheduling" ), 2 );
// schedule a refresh
mRefreshTimer->start( 1 );
}
void QgsMapCanvas::refreshMap()
{
Q_ASSERT( mRefreshScheduled );
QgsDebugMsgLevel( QStringLiteral( "CANVAS refresh!" ), 3 );
stopRendering(); // if any...
stopPreviewJobs();
//build the expression context
QgsExpressionContext expressionContext;
expressionContext << QgsExpressionContextUtils::globalScope()
<< QgsExpressionContextUtils::projectScope( QgsProject::instance() )
<< QgsExpressionContextUtils::atlasScope( nullptr )
<< QgsExpressionContextUtils::mapSettingsScope( mSettings );
if ( QgsExpressionContextScopeGenerator *generator = dynamic_cast< QgsExpressionContextScopeGenerator * >( mController ) )
{
expressionContext << generator->createExpressionContextScope();
}
expressionContext << defaultExpressionContextScope()
<< new QgsExpressionContextScope( mExpressionContextScope );
mSettings.setExpressionContext( expressionContext );
mSettings.setPathResolver( QgsProject::instance()->pathResolver() );
if ( !mTheme.isEmpty() )
{
// IMPORTANT: we MUST set the layer style overrides here! (At the time of writing this
// comment) retrieving layer styles from the theme collection gives an XML snapshot of the
// current state of the style. If we had stored the style overrides earlier (such as in
// mapThemeChanged slot) then this xml could be out of date...
// TODO: if in future QgsMapThemeCollection::mapThemeStyleOverrides is changed to
// just return the style name, we can instead set the overrides in mapThemeChanged and not here
mSettings.setLayerStyleOverrides( QgsProject::instance()->mapThemeCollection()->mapThemeStyleOverrides( mTheme ) );
}
// render main annotation layer above all other layers
QgsMapSettings renderSettings = mSettings;
QList<QgsMapLayer *> allLayers = renderSettings.layers();
allLayers.insert( 0, QgsProject::instance()->mainAnnotationLayer() );
renderSettings.setLayers( allLayers );
// create the renderer job
Q_ASSERT( !mJob );
mJobCanceled = false;
if ( mUseParallelRendering )
mJob = new QgsMapRendererParallelJob( renderSettings );
else
mJob = new QgsMapRendererSequentialJob( renderSettings );
connect( mJob, &QgsMapRendererJob::finished, this, &QgsMapCanvas::rendererJobFinished );
mJob->setCache( mCache );
mJob->start();
// from now on we can accept refresh requests again
// this must be reset only after the job has been started, because
// some providers (yes, it's you WCS and AMS!) during preparation
// do network requests and start an internal event loop, which may
// end up calling refresh() and would schedule another refresh,
// deleting the one we have just started.
mRefreshScheduled = false;
mMapUpdateTimer.start();
emit renderStarting();
}
void QgsMapCanvas::mapThemeChanged( const QString &theme )
{
if ( theme == mTheme )
{
// set the canvas layers to match the new layers contained in the map theme
// NOTE: we do this when the theme layers change and not when we are refreshing the map
// as setLayers() sets up necessary connections to handle changes to the layers
setLayersPrivate( QgsProject::instance()->mapThemeCollection()->mapThemeVisibleLayers( mTheme ) );
// IMPORTANT: we don't set the layer style overrides here! (At the time of writing this
// comment) retrieving layer styles from the theme collection gives an XML snapshot of the
// current state of the style. If changes were made to the style then this xml
// snapshot goes out of sync...
// TODO: if in future QgsMapThemeCollection::mapThemeStyleOverrides is changed to
// just return the style name, we can instead set the overrides here and not in refreshMap()
clearCache();
refresh();
}
}
void QgsMapCanvas::mapThemeRenamed( const QString &theme, const QString &newTheme )
{
if ( mTheme.isEmpty() || theme != mTheme )
{
return;
}
setTheme( newTheme );
refresh();
}
void QgsMapCanvas::rendererJobFinished()
{
QgsDebugMsgLevel( QStringLiteral( "CANVAS finish! %1" ).arg( !mJobCanceled ), 2 );
mMapUpdateTimer.stop();
// TODO: would be better to show the errors in message bar
const auto constErrors = mJob->errors();
for ( const QgsMapRendererJob::Error &error : constErrors )
{
QgsMapLayer *layer = QgsProject::instance()->mapLayer( error.layerID );
emit renderErrorOccurred( error.message, layer );
QgsMessageLog::logMessage( error.layerID + " :: " + error.message, tr( "Rendering" ) );
}
if ( !mJobCanceled )
{
// take labeling results before emitting renderComplete, so labeling map tools
// connected to signal work with correct results
if ( !mJob->usedCachedLabels() )
{
delete mLabelingResults;
mLabelingResults = mJob->takeLabelingResults();
}
QImage img = mJob->renderedImage();
// emit renderComplete to get our decorations drawn
QPainter p( &img );
emit renderComplete( &p );
QgsSettings settings;
if ( settings.value( QStringLiteral( "Map/logCanvasRefreshEvent" ), false ).toBool() )
{
QString logMsg = tr( "Canvas refresh: %1 ms" ).arg( mJob->renderingTime() );
QgsMessageLog::logMessage( logMsg, tr( "Rendering" ) );
}
if ( mDrawRenderingStats )
{
int w = img.width(), h = img.height();
QFont fnt = p.font();
fnt.setBold( true );
p.setFont( fnt );
int lh = p.fontMetrics().height() * 2;
QRect r( 0, h - lh, w, lh );
p.setPen( Qt::NoPen );
p.setBrush( QColor( 0, 0, 0, 110 ) );
p.drawRect( r );
p.setPen( Qt::white );
QString msg = QStringLiteral( "%1 :: %2 ms" ).arg( mUseParallelRendering ? QStringLiteral( "PARALLEL" ) : QStringLiteral( "SEQUENTIAL" ) ).arg( mJob->renderingTime() );
p.drawText( r, msg, QTextOption( Qt::AlignCenter ) );
}
p.end();
mMap->setContent( img, imageRect( img, mSettings ) );
mLastLayerRenderTime.clear();
const auto times = mJob->perLayerRenderingTime();
for ( auto it = times.constBegin(); it != times.constEnd(); ++it )
{
mLastLayerRenderTime.insert( it.key()->id(), it.value() );
}
if ( mUsePreviewJobs && !mRefreshAfterJob )
startPreviewJobs();
}
else
{
mRefreshAfterJob = false;
}
// now we are in a slot called from mJob - do not delete it immediately
// so the class is still valid when the execution returns to the class
mJob->deleteLater();
mJob = nullptr;
emit mapCanvasRefreshed();
if ( mRefreshAfterJob )
{
mRefreshAfterJob = false;
clearTemporalCache();
refresh();
}
}
void QgsMapCanvas::previewJobFinished()
{
QgsMapRendererQImageJob *job = qobject_cast<QgsMapRendererQImageJob *>( sender() );
Q_ASSERT( job );
if ( mMap )
{
mMap->addPreviewImage( job->renderedImage(), job->mapSettings().extent() );
mPreviewJobs.removeAll( job );
int number = job->property( "number" ).toInt();
if ( number < 8 )
{
startPreviewJob( number + 1 );
}
delete job;
}
}
QgsRectangle QgsMapCanvas::imageRect( const QImage &img, const QgsMapSettings &mapSettings )
{
// This is a hack to pass QgsMapCanvasItem::setRect what it
// expects (encoding of position and size of the item)
const QgsMapToPixel &m2p = mapSettings.mapToPixel();
QgsPointXY topLeft = m2p.toMapCoordinates( 0, 0 );
#ifdef QGISDEBUG
// do not assert this, since it might lead to crashes when changing screen while rendering
if ( img.devicePixelRatio() != mapSettings.devicePixelRatio() )
{
QgsLogger::warning( QStringLiteral( "The renderer map has a wrong device pixel ratio" ) );
}
#endif
double res = m2p.mapUnitsPerPixel() / img.devicePixelRatioF();
QgsRectangle rect( topLeft.x(), topLeft.y(), topLeft.x() + img.width()*res, topLeft.y() - img.height()*res );
return rect;
}
bool QgsMapCanvas::previewJobsEnabled() const
{
return mUsePreviewJobs;
}
void QgsMapCanvas::setPreviewJobsEnabled( bool enabled )
{
mUsePreviewJobs = enabled;
}
void QgsMapCanvas::setCustomDropHandlers( const QVector<QPointer<QgsCustomDropHandler> > &handlers )
{
mDropHandlers = handlers;
}
void QgsMapCanvas::clearTemporalCache()
{
if ( mCache )
{
const QList<QgsMapLayer *> layerList = mapSettings().layers();
for ( QgsMapLayer *layer : layerList )
{
if ( layer->temporalProperties() && layer->temporalProperties()->isActive() )
{
if ( layer->temporalProperties()->flags() & QgsTemporalProperty::FlagDontInvalidateCachedRendersWhenRangeChanges )
continue;
mCache->invalidateCacheForLayer( layer );
}
}
}
}
void QgsMapCanvas::showContextMenu( QgsMapMouseEvent *event )
{
const QgsPointXY mapPoint = event->originalMapPoint();
mMenu->clear();
QMenu *copyCoordinateMenu = new QMenu( tr( "Copy Coordinate" ), mMenu );
copyCoordinateMenu->setIcon( QgsApplication::getThemeIcon( QStringLiteral( "/mActionEditCopy.svg" ) ) );
auto addCoordinateFormat = [ = ]( const QString identifier, const QgsCoordinateReferenceSystem & crs )
{
QgsCoordinateTransform ct( mSettings.destinationCrs(), crs, mSettings.transformContext() );
try
{
const QgsPointXY transformedPoint = ct.transform( mapPoint );
// calculate precision based on visible map extent -- if user is zoomed in, we get better precision!
int displayPrecision = 0;
try
{
QgsRectangle extentReproj = ct.transformBoundingBox( extent() );
const double mapUnitsPerPixel = ( extentReproj.width() / width() + extentReproj.height() / height() ) * 0.5;
if ( mapUnitsPerPixel > 10 )
displayPrecision = 0;
else if ( mapUnitsPerPixel > 1 )
displayPrecision = 1;
else if ( mapUnitsPerPixel > 0.1 )
displayPrecision = 2;
else if ( mapUnitsPerPixel > 0.01 )
displayPrecision = 3;
else if ( mapUnitsPerPixel > 0.001 )
displayPrecision = 4;
else if ( mapUnitsPerPixel > 0.0001 )
displayPrecision = 5;
else if ( mapUnitsPerPixel > 0.00001 )
displayPrecision = 6;
else if ( mapUnitsPerPixel > 0.000001 )
displayPrecision = 7;
else if ( mapUnitsPerPixel > 0.0000001 )
displayPrecision = 8;
else
displayPrecision = 9;
}
catch ( QgsCsException & )
{
displayPrecision = crs.mapUnits() == QgsUnitTypes::DistanceDegrees ? 5 : 3;
}
QAction *copyCoordinateAction = new QAction( QStringLiteral( "%3 (%1, %2)" ).arg(
QString::number( transformedPoint.x(), 'f', displayPrecision ),
QString::number( transformedPoint.y(), 'f', displayPrecision ),
identifier ), mMenu );
connect( copyCoordinateAction, &QAction::triggered, this, [displayPrecision, transformedPoint]
{
QClipboard *clipboard = QApplication::clipboard();
const QString coordinates = QString::number( transformedPoint.x(), 'f', displayPrecision ) + ',' + QString::number( transformedPoint.y(), 'f', displayPrecision );
//if we are on x11 system put text into selection ready for middle button pasting
if ( clipboard->supportsSelection() )
{
clipboard->setText( coordinates, QClipboard::Selection );
}
clipboard->setText( coordinates, QClipboard::Clipboard );
} );
copyCoordinateMenu->addAction( copyCoordinateAction );
}
catch ( QgsCsException & )
{
}
};
addCoordinateFormat( tr( "Map CRS — %1" ).arg( mSettings.destinationCrs().userFriendlyIdentifier( QgsCoordinateReferenceSystem::ShortString ) ), mSettings.destinationCrs() );
if ( mSettings.destinationCrs() != QgsCoordinateReferenceSystem( QStringLiteral( "EPSG:4326" ) ) )
addCoordinateFormat( tr( "WGS84" ), QgsCoordinateReferenceSystem( QStringLiteral( "EPSG:4326" ) ) );
QgsSettings settings;
const QString customCrsString = settings.value( QStringLiteral( "qgis/custom_coordinate_crs" ) ).toString();
if ( !customCrsString.isEmpty() )
{
QgsCoordinateReferenceSystem customCrs( customCrsString );
if ( customCrs != mSettings.destinationCrs() && customCrs != QgsCoordinateReferenceSystem( QStringLiteral( "EPSG:4326" ) ) )
{
addCoordinateFormat( customCrs.userFriendlyIdentifier( QgsCoordinateReferenceSystem::ShortString ), customCrs );
}
}
copyCoordinateMenu->addSeparator();
QAction *setCustomCrsAction = new QAction( tr( "Set Custom CRS…" ), mMenu );
connect( setCustomCrsAction, &QAction::triggered, this, [ = ]
{
QgsProjectionSelectionDialog selector( this );
selector.setCrs( QgsCoordinateReferenceSystem( customCrsString ) );
if ( selector.exec() )
{
QgsSettings().setValue( QStringLiteral( "qgis/custom_coordinate_crs" ), selector.crs().authid().isEmpty() ? selector.crs().toWkt( QgsCoordinateReferenceSystem::WKT_PREFERRED ) : selector.crs().authid() );
}
} );
copyCoordinateMenu->addAction( setCustomCrsAction );
mMenu->addMenu( copyCoordinateMenu );
if ( mMapTool )
mMapTool->populateContextMenu( mMenu );
emit contextMenuAboutToShow( mMenu, event );
mMenu->exec( event->globalPos() );
}
void QgsMapCanvas::setTemporalRange( const QgsDateTimeRange &dateTimeRange )
{
if ( temporalRange() == dateTimeRange )
return;
mSettings.setTemporalRange( dateTimeRange );
mSettings.setIsTemporal( dateTimeRange.begin().isValid() || dateTimeRange.end().isValid() );
emit temporalRangeChanged();
// we need to discard any previously cached images which have temporal properties enabled, so that these will be updated when
// the canvas is redrawn
if ( !mJob )
clearTemporalCache();
autoRefreshTriggered();
}
const QgsDateTimeRange &QgsMapCanvas::temporalRange() const
{
return mSettings.temporalRange();
}
void QgsMapCanvas::installInteractionBlocker( QgsMapCanvasInteractionBlocker *blocker )
{
mInteractionBlockers.append( blocker );
}
void QgsMapCanvas::removeInteractionBlocker( QgsMapCanvasInteractionBlocker *blocker )
{
mInteractionBlockers.removeAll( blocker );
}
bool QgsMapCanvas::allowInteraction( QgsMapCanvasInteractionBlocker::Interaction interaction ) const
{
for ( const QgsMapCanvasInteractionBlocker *block : mInteractionBlockers )
{
if ( block->blockCanvasInteraction( interaction ) )
return false;
}
return true;
}
void QgsMapCanvas::mapUpdateTimeout()
{
if ( mJob )
{
const QImage &img = mJob->renderedImage();
mMap->setContent( img, imageRect( img, mSettings ) );
}
}
void QgsMapCanvas::stopRendering()
{
if ( mJob )
{
QgsDebugMsgLevel( QStringLiteral( "CANVAS stop rendering!" ), 2 );
mJobCanceled = true;
disconnect( mJob, &QgsMapRendererJob::finished, this, &QgsMapCanvas::rendererJobFinished );
connect( mJob, &QgsMapRendererQImageJob::finished, mJob, &QgsMapRendererQImageJob::deleteLater );
mJob->cancelWithoutBlocking();
mJob = nullptr;
}
stopPreviewJobs();
}
//the format defaults to "PNG" if not specified
void QgsMapCanvas::saveAsImage( const QString &fileName, QPixmap *theQPixmap, const QString &format )
{
QPainter painter;
QImage image;
//
//check if the optional QPaintDevice was supplied
//
if ( theQPixmap )
{
image = theQPixmap->toImage();
painter.begin( &image );