34#include <QDomDocument>
35#include <QGraphicsView>
41#include <QGestureEvent>
97 if ( qobject_cast<QgsMapCanvas *>( sipCpp ) !=
nullptr )
98 sipType = sipType_QgsMapCanvas;
105 Q_PROPERTY( QString theme READ theme WRITE setTheme NOTIFY themeChanged )
106 Q_PROPERTY(
bool previewJobsEnabled READ previewJobsEnabled WRITE setPreviewJobsEnabled )
125 void addOverlayWidget( QWidget *widget
SIP_TRANSFER, Qt::Edge edge );
130 double magnificationFactor() const;
142 void setLayers( const QList<
QgsMapLayer *> &layers );
150 void setFlags(
Qgis::MapCanvasFlags flags );
158 Qgis::MapCanvasFlags flags() const;
199 void setMapSettingsFlags(
Qgis::MapSettingsFlags flags );
228 void setCachingEnabled(
bool enabled );
237 bool isCachingEnabled() const;
268 void waitWhileRendering();
273 void setParallelRenderingEnabled(
bool enabled );
278 bool isParallelRenderingEnabled() const;
283 void setMapUpdateInterval(
int timeMilliseconds );
288 int mapUpdateInterval() const;
294 double scale() const;
297 double mapUnitsPerPixel() const;
334 void setExtent( const
QgsRectangle &r,
bool magnified = false );
349 double rotation() const;
354 void setRotation(
double degrees );
371 void zoomToFullExtent();
381 void zoomToProjectExtent();
384 void zoomToPreviousExtent();
387 void zoomToNextExtent();
390 void clearExtentHistory();
409 void panToSelected(
QgsMapLayer *layer =
nullptr );
416 void panToSelected( const QList<
QgsMapLayer *> &layers );
430 const QColor &startColor = QColor( 255, 0, 0, 255 ), const QColor &endColor = QColor( 255, 0, 0, 0 ),
431 int flashes = 3,
int duration = 500 );
445 const QColor &startColor = QColor( 255, 0, 0, 255 ), const QColor &endColor = QColor( 255, 0, 0, 0 ),
446 int flashes = 3,
int duration = 500 );
449 void setMapTool(
QgsMapTool *mapTool,
bool clean = false );
479 void setCanvasColor( const QColor &_newVal );
481 QColor canvasColor() const;
486 void setSelectionColor( const QColor &color );
491 QColor selectionColor() const;
514 int layerCount() const;
524 QList<
QgsMapLayer *> layers(
bool expandGroupLayers = false ) const;
533 template <
typename T>
534 QVector<T>
layers()
const {
return mapSettings().layers<T>();}
546 void freeze(
bool frozen =
true );
555 bool isFrozen()
const;
577 QMap<QString, QString> layerStyleOverrides()
const;
589 void setLayerStyleOverrides(
const QMap<QString, QString> &overrides );
608 void setTheme(
const QString &theme );
614 QString
theme()
const {
return mTheme; }
626 void setWheelFactor(
double factor );
635 void zoomScale(
double scale,
bool ignoreScaleLock =
false );
644 void zoomByFactor(
double scaleFactor,
const QgsPointXY *center =
nullptr,
bool ignoreScaleLock =
false );
647 void zoomWithCenter(
int x,
int y,
bool zoomIn );
662 void enableAntiAliasing(
bool flag );
665 bool antiAliasingEnabled()
const;
668 void enableMapTileRendering(
bool flag );
673 void panActionEnd( QPoint releasePoint );
682 void panActionStart( QPoint releasePoint );
686 void panAction( QMouseEvent *event );
689 QPoint mouseLastXY();
696 void setPreviewModeEnabled(
bool previewEnabled );
704 bool previewModeEnabled()
const;
785 void setSegmentationTolerance(
double tolerance );
802 bool annotationsVisible()
const {
return mAnnotationsVisible; }
808 void setAnnotationsVisible(
bool visible );
827 bool previewJobsEnabled()
const;
836 void setPreviewJobsEnabled(
bool enabled );
843 void setCustomDropHandlers(
const QVector<QPointer<QgsCustomDropHandler >> &handlers )
SIP_SKIP;
916 void refreshAllLayers();
926 void redrawAllLayers();
929 void selectionChangedSlot();
932 void saveAsImage(
const QString &fileName, QPixmap *QPixmap =
nullptr,
const QString & =
"PNG" );
935 void layerStateChange();
944 void setRenderFlag(
bool flag );
949 void stopRendering();
952 void readProject(
const QDomDocument & );
955 void writeProject( QDomDocument & );
964 void setMagnificationFactor(
double factor,
const QgsPointXY *center =
nullptr );
970 void setScaleLocked(
bool isLocked );
982 void zoomToSelected(
QgsMapLayer *layer =
nullptr );
989 void zoomToSelected(
const QList<QgsMapLayer *> &layers );
1001 double zoomInFactor()
const;
1006 double zoomOutFactor()
const;
1037 void mapToolDestroyed();
1040 void rendererJobFinished();
1043 void previewJobFinished();
1045 void mapUpdateTimeout();
1049 void mapThemeChanged(
const QString &theme );
1051 void mapThemeRenamed(
const QString &theme,
const QString &newTheme );
1053 void updateDevicePixelFromScreen();
1055 void onElevationShadingRendererChanged();
1233 bool event( QEvent *e )
override;
1234 void keyPressEvent( QKeyEvent *e )
override;
1235 void keyReleaseEvent( QKeyEvent *e )
override;
1236 void mouseDoubleClickEvent( QMouseEvent *e )
override;
1237 void mouseMoveEvent( QMouseEvent *e )
override;
1238 void mousePressEvent( QMouseEvent *e )
override;
1239 void mouseReleaseEvent( QMouseEvent *e )
override;
1240 void wheelEvent( QWheelEvent *e )
override;
1241 void resizeEvent( QResizeEvent *e )
override;
1242 void paintEvent( QPaintEvent *e )
override;
1243 void dragEnterEvent( QDragEnterEvent *e )
override;
1244 bool viewportEvent( QEvent *event )
override;
1247 void moveCanvasContents(
bool reset =
false );
1249 void dropEvent( QDropEvent *event )
override;
1251 void showEvent( QShowEvent *event )
override;
1258 void emitExtentsChanged();
1272 void connectNotify(
const char *signal )
override;
1277 void updateCanvasItemPositions();
1281 void layerRepaintRequested(
bool deferred );
1283 void autoRefreshTriggered();
1285 void updateAutoRefreshTimer();
1287 void projectThemesChanged();
1289 void startPreviewJob(
int number );
1291 void temporalControllerModeChanged();
1302 mLockedScale = mCanvas->mapSettings().scale();
1307 QgsRectangle newExtent = mCanvas->mapSettings().extent();
1308 newExtent.
scale( mLockedScale / mCanvas->mapSettings().scale() );
1309 mCanvas->mSettings.setExtent( newExtent );
1314 double mLockedScale;
1317 enum class CacheInvalidationType
1331 QgsMapCanvasMap *mMap =
nullptr;
1342 bool mFrozen =
false;
1345 bool mRefreshScheduled =
false;
1348 bool mRefreshAfterJob =
false;
1351 bool mRenderFlag =
true;
1353 QFlags<CacheInvalidationType> mCacheInvalidations;
1356 QPointer< QgsMapLayer > mCurrentLayer;
1359 QGraphicsScene *mScene =
nullptr;
1368 QList <QgsRectangle> mLastExtent;
1369 int mLastExtentIndex = -1;
1372 double mWheelZoomFactor = 2.0;
1375 QTimer mMapUpdateTimer;
1381 bool mJobCanceled =
false;
1384 std::unique_ptr< QgsLabelingResults > mLabelingResults;
1387 bool mLabelingResultsOutdated =
false;
1393 std::unique_ptr< QgsRenderedItemResults > mRenderedItemResults;
1399 std::unique_ptr< QgsRenderedItemResults > mPreviousRenderedItemResults;
1406 bool mRenderedItemResultsOutdated =
false;
1409 bool mUseParallelRendering =
false;
1412 bool mDrawRenderingStats =
false;
1417 QTimer *mResizeTimer =
nullptr;
1418 QTimer *mRefreshTimer =
nullptr;
1426 QList< QgsMapRendererQImageJob * > mPreviewJobs;
1429 bool mScaleLocked =
false;
1437 bool mZoomDragging =
false;
1440 std::unique_ptr< QgsRubberBand > mZoomRubberBand;
1442 QCursor mZoomCursor;
1444 QTimer mAutoRefreshTimer;
1446 QTimer mPreviewTimer;
1447 QMetaObject::Connection mPreviewTimerConnection;
1453 bool mAnnotationsVisible =
true;
1455 bool mUsePreviewJobs =
false;
1457 QHash< QString, int > mLastLayerRenderTime;
1459 QVector<QPointer<QgsCustomDropHandler >> mDropHandlers;
1462 QList<double> mZoomResolutions;
1464 QList< QgsMapCanvasInteractionBlocker * > mInteractionBlockers;
1466 int mBlockItemPositionUpdates = 0;
1467 int mBlockExtentChangedSignal = 0;
1468 int mBlockScaleChangedSignal = 0;
1470 std::unique_ptr< QgsTemporaryCursorOverride > mTemporaryCursorOverride;
1479 QMap <QString, QDateTime> mRendererErrors;
1482 QPointer< QgsAbstract2DMapController > mMapController;
1493 void updateMapSize();
1499 void beginZoomRect( QPoint pos );
1505 void endZoomRect( QPoint pos );
1508 void stopZoomRect();
1534 void setLayersPrivate(
const QList<QgsMapLayer *> &layers );
1536 void startPreviewJobs();
1537 void stopPreviewJobs();
1538 void schedulePreviewJob(
int number );
1543 bool panOperationInProgress();
1545 int nextZoomLevel(
const QList<double> &resolutions,
bool zoomIn =
true )
const;
1551 void clearTemporalCache();
1556 void clearElevationCache();
1566 friend class TestQgsMapCanvas;
The Qgis class provides global constants for use throughout the application.
DistanceUnit
Units of distance.
MessageLevel
Level for messages This will be used both for message log and message bar in application.
@ Info
Information message.
QFlags< MapCanvasFlag > MapCanvasFlags
Flags controlling behavior of map canvases.
Abstract base class for all 2D map controllers.
Abstract base class for all geometries.
This class represents a coordinate reference system (CRS).
Custom exception class for Coordinate Reference System related exceptions.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
QgsRange which stores a range of double values.
Abstract interface for generating an expression context.
Single scope for storing variables and functions for use within a QgsExpressionContext.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
A geometry is the spatial representation of a feature.
A class for highlight features on the map.
Stores global configuration for labeling engine.
Class that stores computed placement from labeling engine.
An interactive map canvas item which displays a QgsAnnotation.
An interface for objects which block interactions with a QgsMapCanvas.
Interaction
Available interactions to block.
Deprecated to be deleted, stuff from here should be moved elsewhere.
Map canvas is a class for displaying all GIS data types on a canvas.
void contextMenuAboutToShow(QMenu *menu, QgsMapMouseEvent *event)
Emitted before the map canvas context menu will be shown.
void selectionChanged(QgsMapLayer *layer)
Emitted when selection in any layer gets changed.
void extentsChanged()
Emitted when the extents of the map change.
void xyCoordinates(const QgsPointXY &p)
Emits current mouse position.
QgsExpressionContextScope & expressionContextScope()
Returns a reference to the expression context scope for the map canvas.
void setZoomResolutions(const QList< double > &resolutions)
Set a list of resolutions (map units per pixel) to which to "snap to" when zooming the map.
QString theme() const
Returns the map's theme shown in the canvas, if set.
QVector< T > layers() const
Returns a list of registered map layers with a specified layer type.
void tapAndHoldGestureOccurred(const QgsPointXY &mapPoint, QTapAndHoldGesture *gesture)
Emitted whenever a tap and hold gesture occurs at the specified map point.
const QList< double > & zoomResolutions() const
void panDistanceBearingChanged(double distance, Qgis::DistanceUnit unit, double bearing)
Emitted whenever the distance or bearing of an in-progress panning operation is changed.
bool scaleLocked() const
Returns whether the scale is locked, so zooming can be performed using magnication.
void zRangeChanged()
Emitted when the map canvas z (elevation) range changes.
void scaleChanged(double scale)
Emitted when the scale of the map changes.
void mapToolSet(QgsMapTool *newTool, QgsMapTool *oldTool)
Emit map tool changed with the old tool.
void canvasColorChanged()
Emitted when canvas background color changes.
void magnificationChanged(double magnification)
Emitted when the scale of the map changes.
void currentLayerChanged(QgsMapLayer *layer)
Emitted when the current layer is changed.
void renderErrorOccurred(const QString &error, QgsMapLayer *layer)
Emitted whenever an error is encountered during a map render operation.
void mapRefreshCanceled()
Emitted when the pending map refresh has been canceled.
void renderStarting()
Emitted when the canvas is about to be rendered.
std::unique_ptr< CanvasProperties > mCanvasProperties
Handle pattern for implementation object.
void keyReleased(QKeyEvent *e)
Emit key release event.
const QgsExpressionContextScope & expressionContextScope() const
Returns a const reference to the expression context scope for the map canvas.
void layerStyleOverridesChanged()
Emitted when the configuration of overridden layer styles changes.
void zoomNextStatusChanged(bool available)
Emitted when zoom next status changed.
void rotationChanged(double rotation)
Emitted when the rotation of the map changes.
void messageEmitted(const QString &title, const QString &message, Qgis::MessageLevel level=Qgis::MessageLevel::Info)
emit a message (usually to be displayed in a message bar)
void scaleLockChanged(bool locked)
Emitted when the scale locked state of the map changes.
bool renderFlag() const
Returns true if canvas render is disabled as a result of user disabling renders via the GUI.
void temporalRangeChanged()
Emitted when the map canvas temporal range changes.
void zoomLastStatusChanged(bool available)
Emitted when zoom last status changed.
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.
void keyPressed(QKeyEvent *e)
Emit key press event.
void mapCanvasRefreshed()
Emitted when canvas finished a refresh request.
void layersChanged()
Emitted when a new set of layers has been received.
void renderComplete(QPainter *painter)
Emitted when the canvas has rendered.
void setExpressionContextScope(const QgsExpressionContextScope &scope)
Sets an expression context scope for the map canvas.
Base class for all map layer types.
A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas.
A widget that displays an overview map.
This class is responsible for keeping cache of rendered images resulting from a map rendering job.
QList< QgsMapRendererJob::Error > Errors
Intermediate base class adding functionality that allows client to query the rendered image.
The QgsMapSettings class contains configuration for rendering of the map.
Perform transforms between map coordinates and device coordinates.
A class to represent a 2D point.
A graphics effect which can be applied to a widget to simulate various printing and color blindness m...
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
A rectangle specified with double values.
void scale(double scaleFactor, const QgsPointXY *c=nullptr)
Scale the rectangle around its center point.
A QgsRectangle with associated coordinate reference system.
Stores collated details of rendered items during a map rendering operation.
A class for drawing transient features (e.g.
A utility class for dynamic handling of changes to screen properties.
This class has all the configuration of snapping and can return answers to snapping queries.
A controller base class for temporal objects, contains a signal for notifying updates of the objects ...
Temporarily sets a cursor override for the QApplication for the lifetime of the object.
Represents a vector layer which manages a vector based data sets.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
#define SIP_KEEPREFERENCE
#define SIP_THROW(name,...)
QSet< QgsFeatureId > QgsFeatureIds
const QgsCoordinateReferenceSystem & crs