QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
qgsquickmapsettings.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsquickmapsettings.cpp
3 --------------------------------------
4 Date : 27.12.2014
5 Copyright : (C) 2014 by Matthias Kuhn
6 Email : matthias (at) opengis.ch
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16
17#include "qgis.h"
18#include "qgsquickmapsettings.h"
19
20#include "qgsmaplayer.h"
22#include "qgsmessagelog.h"
23#include "qgsproject.h"
25
27 : QObject( parent )
28{
29 // Connect signals for derived values
36}
37
39{
40 if ( project == mProject )
41 return;
42
43 // If we have already something connected, disconnect it!
44 if ( mProject )
45 {
46 mProject->disconnect( this );
47 }
48
49 mProject = project;
50
51 // Connect all signals
52 if ( mProject )
53 {
54 connect( mProject, &QgsProject::readProject, this, &QgsQuickMapSettings::onReadProject );
55 connect( mProject, &QgsProject::crsChanged, this, &QgsQuickMapSettings::onCrsChanged );
56 setDestinationCrs( mProject->crs() );
57 mMapSettings.setTransformContext( mProject->transformContext() );
58 mMapSettings.setPathResolver( mProject->pathResolver() );
59 }
60 else
61 {
63 }
64
65 emit projectChanged();
66}
67
69{
70 return mProject;
71}
72
74{
75 return mMapSettings.transformContext();
76}
77
79{
80 return mMapSettings.extent();
81}
82
84{
85 if ( mMapSettings.extent() == extent )
86 return;
87
88 mMapSettings.setExtent( extent );
89 emit extentChanged();
90}
91
93{
94 return QgsPoint( extent().center() );
95}
96
98{
99 QgsVector delta = QgsPointXY( center ) - mMapSettings.extent().center();
100
101 QgsRectangle e = mMapSettings.extent();
102 e.setXMinimum( e.xMinimum() + delta.x() );
103 e.setXMaximum( e.xMaximum() + delta.x() );
104 e.setYMinimum( e.yMinimum() + delta.y() );
105 e.setYMaximum( e.yMaximum() + delta.y() );
106
107 setExtent( e );
108}
109
111{
112 return mMapSettings.mapUnitsPerPixel();
113}
114
116{
117 Q_ASSERT( layer );
118
119 const QgsRectangle extent = mapSettings().layerToMapCoordinates( layer, layer->extent() );
120
121 if ( !extent.isEmpty() )
122 {
123 if ( shouldZoom )
124 setExtent( extent );
125 else
127 }
128}
129
131{
132 return mMapSettings.mapUnitsPerPixel() * devicePixelRatio();
133}
134
136{
137 return mMapSettings.visibleExtent();
138}
139
141{
142 QgsPointXY pt( point.x(), point.y() );
143 QgsPointXY pp = mMapSettings.mapToPixel().transform( pt );
144 pp.setX( pp.x() / devicePixelRatio() );
145 pp.setY( pp.y() / devicePixelRatio() );
146 return pp.toQPointF();
147}
148
150{
151 const QgsPointXY pp = mMapSettings.mapToPixel().toMapCoordinates( point.x() * devicePixelRatio(), point.y() * devicePixelRatio() );
152 return QgsPoint( pp );
153}
154
156{
157 mMapSettings.setTransformContext( ctx );
158}
159
161{
162 return mMapSettings;
163}
164
166{
167 return mMapSettings.outputSize();
168}
169
171{
172 outputSize.setWidth( outputSize.width() * devicePixelRatio() );
173 outputSize.setHeight( outputSize.height() * devicePixelRatio() );
174 if ( mMapSettings.outputSize() == outputSize )
175 return;
176
177 mMapSettings.setOutputSize( outputSize );
178 emit outputSizeChanged();
179}
180
182{
183 return mMapSettings.outputDpi();
184}
185
186void QgsQuickMapSettings::setOutputDpi( double outputDpi )
187{
189 if ( qgsDoubleNear( mMapSettings.outputDpi(), outputDpi ) )
190 return;
191
192 mMapSettings.setOutputDpi( outputDpi );
193 emit outputDpiChanged();
194}
195
197{
198 return mMapSettings.destinationCrs();
199}
200
202{
203 if ( mMapSettings.destinationCrs() == destinationCrs )
204 return;
205
206 mMapSettings.setDestinationCrs( destinationCrs );
208}
209
210QList<QgsMapLayer *> QgsQuickMapSettings::layers() const
211{
212 return mMapSettings.layers();
213}
214
215void QgsQuickMapSettings::setLayers( const QList<QgsMapLayer *> &layers )
216{
217 mMapSettings.setLayers( layers );
218 emit layersChanged();
219}
220
221void QgsQuickMapSettings::onCrsChanged()
222{
223 setDestinationCrs( mProject->crs() );
224}
225
226void QgsQuickMapSettings::onReadProject( const QDomDocument &doc )
227{
228 if ( mProject )
229 {
230 int red = mProject->readNumEntry( QStringLiteral( "Gui" ), QStringLiteral( "/CanvasColorRedPart" ), 255 );
231 int green = mProject->readNumEntry( QStringLiteral( "Gui" ), QStringLiteral( "/CanvasColorGreenPart" ), 255 );
232 int blue = mProject->readNumEntry( QStringLiteral( "Gui" ), QStringLiteral( "/CanvasColorBluePart" ), 255 );
233 mMapSettings.setBackgroundColor( QColor( red, green, blue ) );
234
235 const bool isTemporal = mProject->readNumEntry( QStringLiteral( "TemporalControllerWidget" ), QStringLiteral( "/NavigationMode" ), 0 ) != 0;
236 const QString startString = QgsProject::instance()->readEntry( QStringLiteral( "TemporalControllerWidget" ), QStringLiteral( "/StartDateTime" ) );
237 const QString endString = QgsProject::instance()->readEntry( QStringLiteral( "TemporalControllerWidget" ), QStringLiteral( "/EndDateTime" ) );
238 mMapSettings.setIsTemporal( isTemporal );
239 mMapSettings.setTemporalRange( QgsDateTimeRange( QDateTime::fromString( startString, Qt::ISODateWithMs ),
240 QDateTime::fromString( endString, Qt::ISODateWithMs ) ) );
241 }
242
243 QDomNodeList nodes = doc.elementsByTagName( "mapcanvas" );
244 bool foundTheMapCanvas = false;
245 for ( int i = 0; i < nodes.size(); i++ )
246 {
247 QDomNode node = nodes.item( 0 );
248 QDomElement element = node.toElement();
249
250 if ( element.hasAttribute( QStringLiteral( "name" ) ) && element.attribute( QStringLiteral( "name" ) ) == QLatin1String( "theMapCanvas" ) )
251 {
252 foundTheMapCanvas = true;
253 mMapSettings.readXml( node );
254
255 if ( !qgsDoubleNear( mMapSettings.rotation(), 0 ) )
256 QgsMessageLog::logMessage( tr( "Map Canvas rotation is not supported. Resetting from %1 to 0." ).arg( mMapSettings.rotation() ) );
257 }
258 }
259 if ( !foundTheMapCanvas )
260 {
261 mMapSettings.setDestinationCrs( mProject->crs() );
262 mMapSettings.setExtent( mProject->viewSettings()->fullExtent() );
263 }
264
265 mMapSettings.setRotation( 0 );
266
267 mMapSettings.setTransformContext( mProject->transformContext() );
268 mMapSettings.setPathResolver( mProject->pathResolver() );
269
270 emit extentChanged();
272 emit outputSizeChanged();
273 emit outputDpiChanged();
274 emit layersChanged();
276}
277
279{
280 return mMapSettings.rotation();
281}
282
283void QgsQuickMapSettings::setRotation( double rotation )
284{
285 if ( !qgsDoubleNear( rotation, 0 ) )
286 QgsMessageLog::logMessage( tr( "Map Canvas rotation is not supported. Resetting from %1 to 0." ).arg( rotation ) );
287}
288
290{
291 return mMapSettings.backgroundColor();
292}
293
295{
296 if ( mMapSettings.backgroundColor() == color )
297 return;
298
299 mMapSettings.setBackgroundColor( color );
301}
302
304{
305 return mDevicePixelRatio;
306}
307
308void QgsQuickMapSettings::setDevicePixelRatio( const qreal &devicePixelRatio )
309{
310 mDevicePixelRatio = devicePixelRatio;
312}
313
315{
316 return mMapSettings.isTemporal();
317}
318
320{
321 mMapSettings.setIsTemporal( temporal );
323}
324
326{
327 return mMapSettings.temporalRange().begin();
328}
329
330void QgsQuickMapSettings::setTemporalBegin( const QDateTime &begin )
331{
332 const QgsDateTimeRange range = mMapSettings.temporalRange();
333 mMapSettings.setTemporalRange( QgsDateTimeRange( begin, range.end() ) );
335}
336
338{
339 return mMapSettings.temporalRange().end();
340}
341
342void QgsQuickMapSettings::setTemporalEnd( const QDateTime &end )
343{
344 const QgsDateTimeRange range = mMapSettings.temporalRange();
345 mMapSettings.setTemporalRange( QgsDateTimeRange( range.begin(), end ) );
347}
This class represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Base class for all map layer types.
Definition: qgsmaplayer.h:73
virtual QgsRectangle extent() const
Returns the extent of the layer.
The QgsMapSettings class contains configuration for rendering of the map.
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 setLayers(const QList< QgsMapLayer * > &layers)
Sets the list of layers to render 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.
const QgsMapToPixel & mapToPixel() const
double mapUnitsPerPixel() const
Returns the distance in geographical coordinates that equals to one pixel in the map.
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 setExtent(const QgsRectangle &rect, bool magnified=true)
Sets the coordinates of the rectangle which should be rendered.
QgsRectangle visibleExtent() const
Returns the actual extent derived from requested extent that takes output image size into account.
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 setPathResolver(const QgsPathResolver &resolver)
Sets the path resolver for conversion between relative and absolute paths during rendering operations...
double outputDpi() const
Returns the DPI (dots per inch) used for conversion between real world units (e.g.
double rotation() const
Returns the rotation of the resulting map image, in degrees clockwise.
void setOutputSize(QSize size)
Sets the size of the resulting map image, in pixels.
void setBackgroundColor(const QColor &color)
Sets the background color of the map.
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system for the map render.
void setDestinationCrs(const QgsCoordinateReferenceSystem &crs)
Sets the destination crs (coordinate reference system) for the map render.
void readXml(QDomNode &node)
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context, which stores various information regarding which datum tran...
QgsPointXY toMapCoordinates(int x, int y) const
Transforms device coordinates to map (world) coordinates.
QgsPointXY transform(const QgsPointXY &p) const
Transforms a point p from map (world) coordinates to device coordinates.
Definition: qgsmaptopixel.h:90
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).
A class to represent a 2D point.
Definition: qgspointxy.h:59
void setX(double x) SIP_HOLDGIL
Sets the x value of the point.
Definition: qgspointxy.h:122
double y
Definition: qgspointxy.h:63
Q_GADGET double x
Definition: qgspointxy.h:62
void setY(double y) SIP_HOLDGIL
Sets the y value of the point.
Definition: qgspointxy.h:132
QPointF toQPointF() const
Converts a point to a QPointF.
Definition: qgspointxy.h:169
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:49
Q_GADGET double x
Definition: qgspoint.h:52
double y
Definition: qgspoint.h:53
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,...
Definition: qgsproject.h:104
int readNumEntry(const QString &scope, const QString &key, int def=0, bool *ok=nullptr) const
Reads an integer from the specified scope and key.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Definition: qgsproject.cpp:477
QgsPathResolver pathResolver() const
Returns path resolver object with considering whether the project uses absolute or relative paths and...
void crsChanged()
Emitted when the CRS of the project has changed.
QString readEntry(const QString &scope, const QString &key, const QString &def=QString(), bool *ok=nullptr) const
Reads a string from the specified scope and key.
QgsCoordinateTransformContext transformContext
Definition: qgsproject.h:110
void readProject(const QDomDocument &)
Emitted when a project is being read.
QgsCoordinateReferenceSystem crs
Definition: qgsproject.h:109
const QgsProjectViewSettings * viewSettings() const
Returns the project's view settings, which contains settings and properties relating to how a QgsProj...
double outputDpi
Output DPI used for conversion between real world units (e.g.
void setIsTemporal(bool temporal)
Returns true if a temporal filtering is enabled.
QgsQuickMapSettings(QObject *parent=nullptr)
Create new map settings.
void setOutputSize(QSize outputSize)
Sets the size of the resulting map image, in pixels.
void setRotation(double rotation)
The rotation of the resulting map image, in degrees clockwise.
void setTransformContext(const QgsCoordinateTransformContext &context)
Sets the coordinate transform context, which stores various information regarding which datum transfo...
void extentChanged()
Geographical coordinates of the rectangle that should be rendered.
double rotation
The rotation of the resulting map image, in degrees clockwise.
QgsRectangle extent
Geographical coordinates of the rectangle that should be rendered.
void outputSizeChanged()
The size of the resulting map image.
QDateTime temporalBegin
The temporal range's begin (i.e.
void projectChanged()
A project property should be used as a primary source of project all other components in the applicat...
Q_INVOKABLE QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context, which stores various information regarding which datum tran...
bool isTemporal
Returns true if a temporal filtering is enabled.
QgsRectangle visibleExtent
Returns the actual extent derived from requested extent that takes output image size into account.
void outputDpiChanged()
Output DPI used for conversion between real world units (e.g.
void layersChanged()
Set list of layers for map rendering.
void destinationCrsChanged()
CRS of destination coordinate reference system.
void visibleExtentChanged()
Returns the actual extent derived from requested extent that takes output image size into account.
void temporalStateChanged()
Emitted when the temporal state has changed.
void setExtent(const QgsRectangle &extent)
Sets the coordinates of the rectangle which should be rendered.
Q_INVOKABLE QgsPoint screenToCoordinate(const QPointF &point) const
Convert a screen coordinate to a map coordinate.
Q_INVOKABLE void setCenter(const QgsPoint &center)
Move current map extent to have center point defined by center.
void devicePixelRatioChanged()
Returns the ratio between physical pixels and device-independent pixels.
QColor backgroundColor
The background color used to render the map.
double mapUnitsPerPixel
Returns the distance in geographical coordinates that equals to one pixel in the map.
void setDevicePixelRatio(const qreal &devicePixelRatio)
Sets the ratio between physical pixels and device-independent pixels.
double mapUnitsPerPoint
Returns the distance in geographical coordinates that equals to one point unit in the map.
QgsMapSettings mapSettings() const
Clone map settings.
void setProject(QgsProject *project)
A project property should be used as a primary source of project all other components in the applicat...
void mapUnitsPerPixelChanged()
Returns the distance in geographical coordinates that equals to one pixel in the map.
void setOutputDpi(double outputDpi)
Sets the dpi (dots per inch) used for conversion between real world units (e.g.
qreal devicePixelRatio() const
Returns the ratio between physical pixels and device-independent pixels.
void setLayers(const QList< QgsMapLayer * > &layers)
Sets the list of layers to render in the map.
Q_INVOKABLE void setCenterToLayer(QgsMapLayer *layer, bool shouldZoom=true)
Move current map extent to have center point defined by layer. Optionally only pan to the layer if sh...
QgsCoordinateReferenceSystem destinationCrs
CRS of destination coordinate reference system.
QDateTime temporalEnd
The temporal range's end (i.e.
QList< QgsMapLayer * > layers
Set list of layers for map rendering.
void setDestinationCrs(const QgsCoordinateReferenceSystem &destinationCrs)
Sets the destination crs (coordinate reference system) for the map render.
QSize outputSize
The size of the resulting map image.
void backgroundColorChanged()
The background color used to render the map.
void setTemporalEnd(const QDateTime &end)
The temporal range's end (i.e.
void rotationChanged()
The rotation of the resulting map image, in degrees clockwise.
Q_INVOKABLE QPointF coordinateToScreen(const QgsPoint &point) const
Convert a map coordinate to screen pixel coordinates.
QgsPoint center
Geographical coordinate representing the center point of the current extent.
void setTemporalBegin(const QDateTime &begin)
The temporal range's begin (i.e.
QgsProject * project
A project property should be used as a primary source of project all other components in the applicat...
void setBackgroundColor(const QColor &color)
The background color used to render the map.
A rectangle specified with double values.
Definition: qgsrectangle.h:42
double yMaximum() const SIP_HOLDGIL
Returns the y maximum value (top side of rectangle).
Definition: qgsrectangle.h:193
double xMaximum() const SIP_HOLDGIL
Returns the x maximum value (right side of rectangle).
Definition: qgsrectangle.h:183
double xMinimum() const SIP_HOLDGIL
Returns the x minimum value (left side of rectangle).
Definition: qgsrectangle.h:188
double yMinimum() const SIP_HOLDGIL
Returns the y minimum value (bottom side of rectangle).
Definition: qgsrectangle.h:198
void setYMinimum(double y) SIP_HOLDGIL
Set the minimum y value.
Definition: qgsrectangle.h:161
void setXMaximum(double x) SIP_HOLDGIL
Set the maximum x value.
Definition: qgsrectangle.h:156
void setXMinimum(double x) SIP_HOLDGIL
Set the minimum x value.
Definition: qgsrectangle.h:151
void setYMaximum(double y) SIP_HOLDGIL
Set the maximum y value.
Definition: qgsrectangle.h:166
bool isEmpty() const
Returns true if the rectangle is empty.
Definition: qgsrectangle.h:469
QgsPointXY center() const SIP_HOLDGIL
Returns the center point of the rectangle.
Definition: qgsrectangle.h:251
const QgsDateTimeRange & temporalRange() const
Returns the datetime range for the object.
bool isTemporal() const
Returns true if the object's temporal range is enabled, and the object will be filtered when renderin...
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.
A class to represent a vector.
Definition: qgsvector.h:30
double y() const SIP_HOLDGIL
Returns the vector's y-component.
Definition: qgsvector.h:156
double x() const SIP_HOLDGIL
Returns the vector's x-component.
Definition: qgsvector.h:147
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition: qgis.h:2527