QGIS API Documentation 4.1.0-Master (5bf3c20f3c9)
Loading...
Searching...
No Matches
qgsalgorithmxyztiles.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmxyztiles.cpp
3 ---------------------
4 begin : August 2023
5 copyright : (C) 2023 by Alexander Bruy
6 email : alexander dot bruy at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
19
21#include "qgslayertree.h"
22#include "qgslayertreelayer.h"
23#include "qgsmaplayerutils.h"
24#include "qgsprovidermetadata.h"
25
26#include <QBuffer>
27#include <QString>
28
29using namespace Qt::StringLiterals;
30
32
33int tile2tms( const int y, const int zoom )
34{
35 double n = std::pow( 2, zoom );
36 return ( int ) std::floor( n - y - 1 );
37}
38
39int lon2tileX( const double lon, const int z )
40{
41 return ( int ) ( std::floor( ( lon + 180.0 ) / 360.0 * ( 1 << z ) ) );
42}
43
44int lat2tileY( const double lat, const int z )
45{
46 double latRad = lat * M_PI / 180.0;
47 return ( int ) ( std::floor( ( 1.0 - std::asinh( std::tan( latRad ) ) / M_PI ) / 2.0 * ( 1 << z ) ) );
48}
49
50double tileX2lon( const int x, const int z )
51{
52 return x / ( double ) ( 1 << z ) * 360.0 - 180;
53}
54
55double tileY2lat( const int y, const int z )
56{
57 double n = M_PI - 2.0 * M_PI * y / ( double ) ( 1 << z );
58 return 180.0 / M_PI * std::atan( 0.5 * ( std::exp( n ) - std::exp( -n ) ) );
59}
60
61void extent2TileXY( QgsRectangle extent, const int zoom, int &xMin, int &yMin, int &xMax, int &yMax )
62{
63 xMin = lon2tileX( extent.xMinimum(), zoom );
64 yMin = lat2tileY( extent.yMinimum(), zoom );
65 xMax = lon2tileX( extent.xMaximum(), zoom );
66 yMax = lat2tileY( extent.xMaximum(), zoom );
67}
68
69QList<MetaTile> getMetatiles( const QgsRectangle extent, const int zoom, const int tileSize )
70{
71 int minX = lon2tileX( extent.xMinimum(), zoom );
72 int minY = lat2tileY( extent.yMaximum(), zoom );
73 int maxX = lon2tileX( extent.xMaximum(), zoom );
74 int maxY = lat2tileY( extent.yMinimum(), zoom );
75 ;
76
77 int i = 0;
78 QMap<QString, MetaTile> tiles;
79 for ( int x = minX; x <= maxX; x++ )
80 {
81 int j = 0;
82 for ( int y = minY; y <= maxY; y++ )
83 {
84 QString key = u"%1:%2"_s.arg( ( int ) ( i / tileSize ) ).arg( ( int ) ( j / tileSize ) );
85 MetaTile tile = tiles.value( key, MetaTile() );
86 tile.addTile( i % tileSize, j % tileSize, Tile( x, y, zoom ) );
87 tiles.insert( key, tile );
88 j++;
89 }
90 i++;
91 }
92 return tiles.values();
93}
94
96
97QString QgsXyzTilesBaseAlgorithm::group() const
98{
99 return QObject::tr( "Raster tools" );
100}
101
102QString QgsXyzTilesBaseAlgorithm::groupId() const
103{
104 return u"rastertools"_s;
105}
106
107Qgis::ProcessingAlgorithmFlags QgsXyzTilesBaseAlgorithm::flags() const
108{
110}
111
112void QgsXyzTilesBaseAlgorithm::createCommonParameters()
113{
114 addParameter( new QgsProcessingParameterExtent( u"EXTENT"_s, QObject::tr( "Extent" ) ) );
115 addParameter( new QgsProcessingParameterNumber( u"ZOOM_MIN"_s, QObject::tr( "Minimum zoom" ), Qgis::ProcessingNumberParameterType::Integer, 12, false, 0, 25 ) );
116 addParameter( new QgsProcessingParameterNumber( u"ZOOM_MAX"_s, QObject::tr( "Maximum zoom" ), Qgis::ProcessingNumberParameterType::Integer, 12, false, 0, 25 ) );
117 addParameter( new QgsProcessingParameterNumber( u"DPI"_s, QObject::tr( "DPI" ), Qgis::ProcessingNumberParameterType::Integer, 96, false, 48, 600 ) );
118 addParameter( new QgsProcessingParameterColor( u"BACKGROUND_COLOR"_s, QObject::tr( "Background color" ), QColor( Qt::transparent ), true, true ) );
119 addParameter( new QgsProcessingParameterBoolean( u"ANTIALIAS"_s, QObject::tr( "Enable antialiasing" ), true ) );
120 addParameter( new QgsProcessingParameterEnum( u"TILE_FORMAT"_s, QObject::tr( "Tile format" ), QStringList() << u"PNG"_s << u"JPG"_s, false, 0 ) );
121 addParameter( new QgsProcessingParameterNumber( u"QUALITY"_s, QObject::tr( "Quality (JPG only)" ), Qgis::ProcessingNumberParameterType::Integer, 75, false, 1, 100 ) );
122 addParameter( new QgsProcessingParameterNumber( u"METATILESIZE"_s, QObject::tr( "Metatile size" ), Qgis::ProcessingNumberParameterType::Integer, 4, false, 1, 20 ) );
123}
124
125bool QgsXyzTilesBaseAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
126{
127 Q_UNUSED( feedback );
128
129 QgsProject *project = context.project();
130
131 const QList<QgsLayerTreeLayer *> projectLayers = project->layerTreeRoot()->findLayers();
132 QSet<QString> visibleLayers;
133 for ( const QgsLayerTreeLayer *layer : projectLayers )
134 {
135 if ( layer->isVisible() )
136 {
137 visibleLayers << layer->layer()->id();
138 }
139 }
140
141 QList<QgsMapLayer *> renderLayers = project->layerTreeRoot()->layerOrder();
142 for ( QgsMapLayer *layer : renderLayers )
143 {
144 if ( visibleLayers.contains( layer->id() ) )
145 {
146 QgsMapLayer *clonedLayer = layer->clone();
147 clonedLayer->moveToThread( nullptr );
148 mLayers << clonedLayer;
149 }
150 }
151
152 QgsRectangle extent = parameterAsExtent( parameters, u"EXTENT"_s, context );
153 QgsCoordinateReferenceSystem extentCrs = parameterAsExtentCrs( parameters, u"EXTENT"_s, context );
154 QgsCoordinateTransform ct( extentCrs, project->crs(), context.transformContext() );
155 try
156 {
157 mExtent = ct.transformBoundingBox( extent );
158 }
159 catch ( QgsCsException & )
160 {
161 feedback->reportError( QObject::tr( "Could not transform the extent into the project CRS" ), true );
162 return false;
163 }
164
165 mMinZoom = parameterAsInt( parameters, u"ZOOM_MIN"_s, context );
166 mMaxZoom = parameterAsInt( parameters, u"ZOOM_MAX"_s, context );
167 mDpi = parameterAsInt( parameters, u"DPI"_s, context );
168 mBackgroundColor = parameterAsColor( parameters, u"BACKGROUND_COLOR"_s, context );
169 mAntialias = parameterAsBool( parameters, u"ANTIALIAS"_s, context );
170 mTileFormat = parameterAsEnum( parameters, u"TILE_FORMAT"_s, context ) ? u"JPG"_s : u"PNG"_s;
171 mJpgQuality = mTileFormat == "JPG"_L1 ? parameterAsInt( parameters, u"QUALITY"_s, context ) : -1;
172 mMetaTileSize = parameterAsInt( parameters, u"METATILESIZE"_s, context );
173 mThreadsNumber = context.maximumThreads();
174 mTransformContext = context.transformContext();
175 mFeedback = feedback;
176
177 mWgs84Crs = QgsCoordinateReferenceSystem( "EPSG:4326" );
178 mMercatorCrs = QgsCoordinateReferenceSystem( "EPSG:3857" );
179 mSrc2Wgs = QgsCoordinateTransform( project->crs(), mWgs84Crs, context.transformContext() );
180 mWgs2Mercator = QgsCoordinateTransform( mWgs84Crs, mMercatorCrs, context.transformContext() );
181 try
182 {
183 mWgs84Extent = mSrc2Wgs.transformBoundingBox( mExtent );
184 }
185 catch ( QgsCsException & )
186 {
187 feedback->reportError( QObject::tr( "Could not transform the extent into WGS84" ), true );
188 return false;
189 }
190
191 if ( parameters.contains( u"TILE_WIDTH"_s ) )
192 {
193 mTileWidth = parameterAsInt( parameters, u"TILE_WIDTH"_s, context );
194 }
195
196 if ( parameters.contains( u"TILE_HEIGHT"_s ) )
197 {
198 mTileHeight = parameterAsInt( parameters, u"TILE_HEIGHT"_s, context );
199 }
200
201 if ( mTileFormat != "PNG"_L1 && mBackgroundColor.alpha() != 255 )
202 {
203 feedback->pushWarning( QObject::tr( "Background color setting ignored, the JPG format only supports fully opaque colors" ) );
204 }
205
206 mScaleMethod = project->scaleMethod();
207
208 return true;
209}
210
211void QgsXyzTilesBaseAlgorithm::checkLayersUsagePolicy( QgsProcessingFeedback *feedback )
212{
213 if ( mTotalTiles > MAXIMUM_OPENSTREETMAP_TILES_FETCH )
214 {
215 for ( QgsMapLayer *layer : std::as_const( mLayers ) )
216 {
218 {
219 // Prevent bulk downloading of tiles from openstreetmap.org as per OSMF tile usage policy
220 feedback->pushFormattedMessage(
221 QObject::tr( "Layer %1 will be skipped as the algorithm leads to bulk downloading behavior which is prohibited by the %2OpenStreetMap Foundation tile usage policy%3" )
222 .arg( layer->name(), u"<a href=\"https://operations.osmfoundation.org/policies/tiles/\">"_s, u"</a>"_s ),
223 QObject::tr( "Layer %1 will be skipped as the algorithm leads to bulk downloading behavior which is prohibited by the %2OpenStreetMap Foundation tile usage policy%3" )
224 .arg( layer->name(), QString(), QString() )
225 );
226 mLayers.removeAll( layer );
227 delete layer;
228 }
229 }
230 }
231}
232
233void QgsXyzTilesBaseAlgorithm::startJobs()
234{
235 while ( mRendererJobs.size() < mThreadsNumber && !mMetaTiles.empty() )
236 {
237 MetaTile metaTile = mMetaTiles.takeFirst();
238
239 QgsMapSettings settings;
240 try
241 {
242 settings.setExtent( mWgs2Mercator.transformBoundingBox( metaTile.extent() ) );
243 }
244 catch ( QgsCsException & )
245 {
246 continue;
247 }
248 settings.setOutputImageFormat( QImage::Format_ARGB32_Premultiplied );
249 settings.setTransformContext( mTransformContext );
250 settings.setDestinationCrs( mMercatorCrs );
251 settings.setLayers( mLayers );
252 settings.setOutputDpi( mDpi );
253 settings.setFlag( Qgis::MapSettingsFlag::Antialiasing, mAntialias );
254 settings.setScaleMethod( mScaleMethod );
255 if ( mTileFormat == "PNG"_L1 || mBackgroundColor.alpha() == 255 )
256 {
257 settings.setBackgroundColor( mBackgroundColor );
258 }
259 QSize size( mTileWidth * metaTile.rows, mTileHeight * metaTile.cols );
260 settings.setOutputSize( size );
261
262 QgsLabelingEngineSettings labelingSettings = settings.labelingEngineSettings();
263 labelingSettings.setFlag( Qgis::LabelingFlag::UsePartialCandidates, false );
264 settings.setLabelingEngineSettings( labelingSettings );
265
266 QgsExpressionContext exprContext = settings.expressionContext();
268 settings.setExpressionContext( exprContext );
269
271 mRendererJobs.insert( job, metaTile );
272 QObject::connect( job, &QgsMapRendererJob::finished, mFeedback, [this, job]() { processMetaTile( job ); } );
273 job->start();
274 }
275}
276
277// Native XYZ tiles (directory) algorithm
278
279QString QgsXyzTilesDirectoryAlgorithm::name() const
280{
281 return u"tilesxyzdirectory"_s;
282}
283
284QString QgsXyzTilesDirectoryAlgorithm::displayName() const
285{
286 return QObject::tr( "Generate XYZ tiles (Directory)" );
287}
288
289QStringList QgsXyzTilesDirectoryAlgorithm::tags() const
290{
291 return QObject::tr( "tiles,xyz,tms,directory" ).split( ',' );
292}
293
294QString QgsXyzTilesDirectoryAlgorithm::shortHelpString() const
295{
296 return QObject::tr( "Generates XYZ tiles of map canvas content and saves them as individual images in a directory." );
297}
298
299QgsXyzTilesDirectoryAlgorithm *QgsXyzTilesDirectoryAlgorithm::createInstance() const
300{
301 return new QgsXyzTilesDirectoryAlgorithm();
302}
303
304void QgsXyzTilesDirectoryAlgorithm::initAlgorithm( const QVariantMap & )
305{
306 createCommonParameters();
307 addParameter( new QgsProcessingParameterNumber( u"TILE_WIDTH"_s, QObject::tr( "Tile width" ), Qgis::ProcessingNumberParameterType::Integer, 256, false, 1, 4096 ) );
308 addParameter( new QgsProcessingParameterNumber( u"TILE_HEIGHT"_s, QObject::tr( "Tile height" ), Qgis::ProcessingNumberParameterType::Integer, 256, false, 1, 4096 ) );
309 addParameter( new QgsProcessingParameterBoolean( u"TMS_CONVENTION"_s, QObject::tr( "Use inverted tile Y axis (TMS convention)" ), false ) );
310
311 auto titleParam = std::make_unique<QgsProcessingParameterString>( u"HTML_TITLE"_s, QObject::tr( "Leaflet HTML output title" ), QVariant(), false, true );
312 titleParam->setFlags( titleParam->flags() | Qgis::ProcessingParameterFlag::Advanced );
313 addParameter( titleParam.release() );
314 auto attributionParam = std::make_unique<QgsProcessingParameterString>( u"HTML_ATTRIBUTION"_s, QObject::tr( "Leaflet HTML output attribution" ), QVariant(), false, true );
315 attributionParam->setFlags( attributionParam->flags() | Qgis::ProcessingParameterFlag::Advanced );
316 addParameter( attributionParam.release() );
317 auto osmParam = std::make_unique<QgsProcessingParameterBoolean>( u"HTML_OSM"_s, QObject::tr( "Include OpenStreetMap basemap in Leaflet HTML output" ), false );
318 osmParam->setFlags( osmParam->flags() | Qgis::ProcessingParameterFlag::Advanced );
319 addParameter( osmParam.release() );
320
321 addParameter( new QgsProcessingParameterFolderDestination( u"OUTPUT_DIRECTORY"_s, QObject::tr( "Output directory" ) ) );
322 addParameter( new QgsProcessingParameterFileDestination( u"OUTPUT_HTML"_s, QObject::tr( "Output html (Leaflet)" ), QObject::tr( "HTML files (*.html)" ), QVariant(), true ) );
323}
324
325QVariantMap QgsXyzTilesDirectoryAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
326{
327 const bool tms = parameterAsBoolean( parameters, u"TMS_CONVENTION"_s, context );
328 const QString title = parameterAsString( parameters, u"HTML_TITLE"_s, context );
329 const QString attribution = parameterAsString( parameters, u"HTML_ATTRIBUTION"_s, context );
330 const bool useOsm = parameterAsBoolean( parameters, u"HTML_OSM"_s, context );
331 QString outputDir = parameterAsString( parameters, u"OUTPUT_DIRECTORY"_s, context );
332 const QString outputHtml = parameterAsString( parameters, u"OUTPUT_HTML"_s, context );
333
334 mOutputDir = outputDir;
335 mTms = tms;
336
337 mTotalTiles = 0;
338 for ( int z = mMinZoom; z <= mMaxZoom; z++ )
339 {
340 if ( feedback->isCanceled() )
341 break;
342
343 mMetaTiles += getMetatiles( mWgs84Extent, z, mMetaTileSize );
344 feedback->pushWarning( QObject::tr( "%1 tiles will be created for zoom level %2" ).arg( mMetaTiles.size() - mTotalTiles ).arg( z ) );
345 mTotalTiles = mMetaTiles.size();
346 }
347 feedback->pushWarning( QObject::tr( "A total of %1 tiles will be created" ).arg( mTotalTiles ) );
348
349 checkLayersUsagePolicy( feedback );
350
351 for ( QgsMapLayer *layer : std::as_const( mLayers ) )
352 {
353 layer->moveToThread( QThread::currentThread() );
354 }
355
356 QEventLoop loop;
357 // cppcheck-suppress danglingLifetime
358 mEventLoop = &loop;
359 startJobs();
360 loop.exec();
361
362 qDeleteAll( mLayers );
363 mLayers.clear();
364
365 QVariantMap results;
366 results.insert( u"OUTPUT_DIRECTORY"_s, outputDir );
367
368 if ( !outputHtml.isEmpty() )
369 {
370 QString osm = QStringLiteral(
371 "var osm_layer = L.tileLayer('https://tile.openstreetmap.org/{z}/{x}/{y}.png',"
372 "{minZoom: %1, maxZoom: %2, attribution: '&copy; <a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a> contributors'}).addTo(map);"
373 )
374 .arg( mMinZoom )
375 .arg( mMaxZoom );
376
377 QString addOsm = useOsm ? osm : QString();
378 QString tmsConvention = tms ? u"true"_s : u"false"_s;
379 QString attr = attribution.isEmpty() ? u"Created by QGIS"_s : attribution;
380 QString tileSource = u"'file:///%1/{z}/{x}/{y}.%2'"_s.arg( outputDir.replace( "\\", "/" ).toHtmlEscaped() ).arg( mTileFormat.toLower() );
381
382 QString html = QStringLiteral(
383 "<!DOCTYPE html><html><head><title>%1</title><meta charset=\"utf-8\"/>"
384 "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">"
385 "<link rel=\"stylesheet\" href=\"https://unpkg.com/[email protected]/dist/leaflet.css\""
386 "integrity=\"sha384-sHL9NAb7lN7rfvG5lfHpm643Xkcjzp4jFvuavGOndn6pjVqS6ny56CAt3nsEVT4H\""
387 "crossorigin=\"\"/>"
388 "<script src=\"https://unpkg.com/[email protected]/dist/leaflet.js\""
389 "integrity=\"sha384-cxOPjt7s7Iz04uaHJceBmS+qpjv2JkIHNVcuOrM+YHwZOmJGBXI00mdUXEq65HTH\""
390 "crossorigin=\"\"></script>"
391 "<style type=\"text/css\">body {margin: 0;padding: 0;} html, body, #map{width: 100%;height: 100%;}</style></head>"
392 "<body><div id=\"map\"></div><script>"
393 "var map = L.map('map', {attributionControl: false}).setView([%2, %3], %4);"
394 "L.control.attribution({prefix: false}).addTo(map);"
395 "%5"
396 "var tilesource_layer = L.tileLayer(%6, {minZoom: %7, maxZoom: %8, tms: %9, attribution: '%10'}).addTo(map);"
397 "</script></body></html>"
398 )
399 .arg( title.isEmpty() ? u"Leaflet preview"_s : title )
400 .arg( mWgs84Extent.center().y() )
401 .arg( mWgs84Extent.center().x() )
402 .arg( ( mMaxZoom + mMinZoom ) / 2 )
403 .arg( addOsm )
404 .arg( tileSource )
405 .arg( mMinZoom )
406 .arg( mMaxZoom )
407 .arg( tmsConvention )
408 .arg( attr );
409
410 QFile htmlFile( outputHtml );
411 if ( !htmlFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
412 {
413 throw QgsProcessingException( QObject::tr( "Could not open html file %1" ).arg( outputHtml ) );
414 }
415 QTextStream fout( &htmlFile );
416 fout << html;
417
418 results.insert( u"OUTPUT_HTML"_s, outputHtml );
419 }
420
421 return results;
422}
423
424void QgsXyzTilesDirectoryAlgorithm::processMetaTile( QgsMapRendererSequentialJob *job )
425{
426 MetaTile metaTile = mRendererJobs.value( job );
427 QImage img = job->renderedImage();
428
429 QMap<QPair<int, int>, Tile>::const_iterator it = metaTile.tiles.constBegin();
430 while ( it != metaTile.tiles.constEnd() )
431 {
432 QPair<int, int> tm = it.key();
433 Tile tile = it.value();
434 QImage tileImage = img.copy( mTileWidth * tm.first, mTileHeight * tm.second, mTileWidth, mTileHeight );
435 QDir tileDir( u"%1/%2/%3"_s.arg( mOutputDir ).arg( tile.z ).arg( tile.x ) );
436 tileDir.mkpath( tileDir.absolutePath() );
437 int y = tile.y;
438 if ( mTms )
439 {
440 y = tile2tms( y, tile.z );
441 }
442 tileImage.save( u"%1/%2.%3"_s.arg( tileDir.absolutePath() ).arg( y ).arg( mTileFormat.toLower() ), mTileFormat.toStdString().c_str(), mJpgQuality );
443 ++it;
444 }
445
446 mRendererJobs.remove( job );
447 job->deleteLater();
448
449 mFeedback->setProgress( 100.0 * ( mProcessedTiles++ ) / mTotalTiles );
450
451 if ( mFeedback->isCanceled() )
452 {
453 while ( mRendererJobs.size() > 0 )
454 {
455 QgsMapRendererSequentialJob *j = mRendererJobs.firstKey();
456 j->cancel();
457 mRendererJobs.remove( j );
458 j->deleteLater();
459 }
460 mRendererJobs.clear();
461 if ( mEventLoop )
462 {
463 mEventLoop->exit();
464 }
465 return;
466 }
467
468 if ( mMetaTiles.size() > 0 )
469 {
470 startJobs();
471 }
472 else if ( mMetaTiles.size() == 0 && mRendererJobs.size() == 0 )
473 {
474 if ( mEventLoop )
475 {
476 mEventLoop->exit();
477 }
478 }
479}
480
481// Native XYZ tiles (MBTiles) algorithm
482
483QString QgsXyzTilesMbtilesAlgorithm::name() const
484{
485 return u"tilesxyzmbtiles"_s;
486}
487
488QString QgsXyzTilesMbtilesAlgorithm::displayName() const
489{
490 return QObject::tr( "Generate XYZ tiles (MBTiles)" );
491}
492
493QStringList QgsXyzTilesMbtilesAlgorithm::tags() const
494{
495 return QObject::tr( "tiles,xyz,tms,mbtiles" ).split( ',' );
496}
497
498QString QgsXyzTilesMbtilesAlgorithm::shortHelpString() const
499{
500 return QObject::tr( "Generates XYZ tiles of map canvas content and saves them as an MBTiles file." );
501}
502
503QgsXyzTilesMbtilesAlgorithm *QgsXyzTilesMbtilesAlgorithm::createInstance() const
504{
505 return new QgsXyzTilesMbtilesAlgorithm();
506}
507
508void QgsXyzTilesMbtilesAlgorithm::initAlgorithm( const QVariantMap & )
509{
510 createCommonParameters();
511 addParameter( new QgsProcessingParameterFileDestination( u"OUTPUT_FILE"_s, QObject::tr( "Output" ), QObject::tr( "MBTiles files (*.mbtiles *.MBTILES)" ) ) );
512}
513
514QVariantMap QgsXyzTilesMbtilesAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
515{
516 const QString outputFile = parameterAsString( parameters, u"OUTPUT_FILE"_s, context );
517
518 mMbtilesWriter = std::make_unique<QgsMbTiles>( outputFile );
519 if ( !mMbtilesWriter->create() )
520 {
521 throw QgsProcessingException( QObject::tr( "Failed to create MBTiles file %1" ).arg( outputFile ) );
522 }
523 mMbtilesWriter->setMetadataValue( "format", mTileFormat.toLower() );
524 mMbtilesWriter->setMetadataValue( "name", QFileInfo( outputFile ).baseName() );
525 mMbtilesWriter->setMetadataValue( "description", QFileInfo( outputFile ).baseName() );
526 mMbtilesWriter->setMetadataValue( "version", u"1.1"_s );
527 mMbtilesWriter->setMetadataValue( "type", u"overlay"_s );
528 mMbtilesWriter->setMetadataValue( "minzoom", QString::number( mMinZoom ) );
529 mMbtilesWriter->setMetadataValue( "maxzoom", QString::number( mMaxZoom ) );
530 QString boundsStr = QString( "%1,%2,%3,%4" ).arg( mWgs84Extent.xMinimum() ).arg( mWgs84Extent.yMinimum() ).arg( mWgs84Extent.xMaximum() ).arg( mWgs84Extent.yMaximum() );
531 mMbtilesWriter->setMetadataValue( "bounds", boundsStr );
532
533 mTotalTiles = 0;
534 for ( int z = mMinZoom; z <= mMaxZoom; z++ )
535 {
536 if ( feedback->isCanceled() )
537 break;
538
539 mMetaTiles += getMetatiles( mWgs84Extent, z, mMetaTileSize );
540 feedback->pushInfo( QObject::tr( "%1 tiles will be created for zoom level %2" ).arg( mMetaTiles.size() - mTotalTiles ).arg( z ) );
541 mTotalTiles = mMetaTiles.size();
542 }
543 feedback->pushInfo( QObject::tr( "A total of %1 tiles will be created" ).arg( mTotalTiles ) );
544
545 checkLayersUsagePolicy( feedback );
546
547 for ( QgsMapLayer *layer : std::as_const( mLayers ) )
548 {
549 layer->moveToThread( QThread::currentThread() );
550 }
551
552 QEventLoop loop;
553 // cppcheck-suppress danglingLifetime
554 mEventLoop = &loop;
555 startJobs();
556 loop.exec();
557
558 qDeleteAll( mLayers );
559 mLayers.clear();
560
561 QVariantMap results;
562 results.insert( u"OUTPUT_FILE"_s, outputFile );
563 return results;
564}
565
566void QgsXyzTilesMbtilesAlgorithm::processMetaTile( QgsMapRendererSequentialJob *job )
567{
568 MetaTile metaTile = mRendererJobs.value( job );
569 QImage img = job->renderedImage();
570
571 QMap<QPair<int, int>, Tile>::const_iterator it = metaTile.tiles.constBegin();
572 while ( it != metaTile.tiles.constEnd() )
573 {
574 QPair<int, int> tm = it.key();
575 Tile tile = it.value();
576 QImage tileImage = img.copy( mTileWidth * tm.first, mTileHeight * tm.second, mTileWidth, mTileHeight );
577 QByteArray ba;
578 QBuffer buffer( &ba );
579 buffer.open( QIODevice::WriteOnly );
580 tileImage.save( &buffer, mTileFormat.toStdString().c_str(), mJpgQuality );
581 mMbtilesWriter->setTileData( tile.z, tile.x, tile2tms( tile.y, tile.z ), ba );
582 ++it;
583 }
584
585 mRendererJobs.remove( job );
586 job->deleteLater();
587
588 mFeedback->setProgress( 100.0 * ( mProcessedTiles++ ) / mTotalTiles );
589
590 if ( mFeedback->isCanceled() )
591 {
592 while ( mRendererJobs.size() > 0 )
593 {
594 QgsMapRendererSequentialJob *j = mRendererJobs.firstKey();
595 j->cancel();
596 mRendererJobs.remove( j );
597 j->deleteLater();
598 }
599 mRendererJobs.clear();
600 if ( mEventLoop )
601 {
602 mEventLoop->exit();
603 }
604 return;
605 }
606
607 if ( mMetaTiles.size() > 0 )
608 {
609 startJobs();
610 }
611 else if ( mMetaTiles.size() == 0 && mRendererJobs.size() == 0 )
612 {
613 if ( mEventLoop )
614 {
615 mEventLoop->exit();
616 }
617 }
618}
619
@ UsePartialCandidates
Whether to use also label candidates that are partially outside of the map view.
Definition qgis.h:2944
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3724
@ RequiresProject
The algorithm requires that a valid QgsProject is available from the processing context in order to e...
Definition qgis.h:3711
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
Definition qgis.h:3880
@ Antialiasing
Enable anti-aliasing for map rendering.
Definition qgis.h:2812
Represents a coordinate reference system (CRS).
Handles coordinate transforms between two coordinate systems.
Custom exception class for Coordinate Reference System related exceptions.
static QgsExpressionContextScope * mapSettingsScope(const QgsMapSettings &mapSettings)
Creates a new scope which contains variables and functions relating to a QgsMapSettings object.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition qgsfeedback.h:56
Stores global configuration for labeling engine.
void setFlag(Qgis::LabelingFlag f, bool enabled=true)
Sets whether a particual flag is enabled.
QList< QgsLayerTreeLayer * > findLayers() const
Find all layer nodes.
Layer tree node points to a map layer.
QList< QgsMapLayer * > layerOrder() const
The order in which layers will be rendered on the canvas.
static bool isOpenStreetMapLayer(QgsMapLayer *layer)
Returns true if the layer is served by OpenStreetMap server.
Base class for all map layer types.
Definition qgsmaplayer.h:83
virtual QgsMapLayer * clone() const =0
Returns a new instance equivalent to this one except for the id which is still unique.
void finished()
emitted when asynchronous rendering is finished (or canceled).
void start()
Start the rendering job and immediately return.
Job implementation that renders everything sequentially in one thread.
QImage renderedImage() override
Gets a preview/resulting image.
void cancel() override
Stop the rendering job - does not return until the job has terminated.
Contains configuration for rendering maps.
const QgsLabelingEngineSettings & labelingEngineSettings() const
Returns the global configuration of the labeling engine.
void setLayers(const QList< QgsMapLayer * > &layers)
Sets the list of layers to render in the map.
void setScaleMethod(Qgis::ScaleCalculationMethod method)
Sets the method to use for scale calculations for the map.
void setOutputDpi(double dpi)
Sets the dpi (dots per inch) used for conversion between real world units (e.g.
void setOutputImageFormat(QImage::Format format)
sets format of internal QImage
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.
void setLabelingEngineSettings(const QgsLabelingEngineSettings &settings)
Sets the global configuration of the labeling engine.
void setTransformContext(const QgsCoordinateTransformContext &context)
Sets the coordinate transform context, which stores various information regarding which datum transfo...
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.
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.
const QgsExpressionContext & expressionContext() const
Gets the expression context.
virtual Qgis::ProcessingAlgorithmFlags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
Contains information about the context in which a processing algorithm is executed.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
QgsProject * project() const
Returns the project in which the algorithm is being executed.
int maximumThreads() const
Returns the (optional) number of threads to use when running algorithms.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
virtual void pushWarning(const QString &warning)
Pushes a warning informational message from the algorithm.
virtual void pushFormattedMessage(const QString &html, const QString &text)
Pushes a pre-formatted message from the algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
A boolean parameter for processing algorithms.
A color parameter for processing algorithms.
An enum based parameter for processing algorithms, allowing for selection from predefined values.
A rectangular map extent parameter for processing algorithms.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
A folder destination parameter, for specifying the destination path for a folder created by the algor...
A numeric parameter for processing algorithms.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:113
QgsLayerTree * layerTreeRoot() const
Returns pointer to the root (invisible) node of the project's layer tree.
QgsCoordinateReferenceSystem crs
Definition qgsproject.h:119
Qgis::ScaleCalculationMethod scaleMethod
Definition qgsproject.h:135
A rectangle specified with double values.
double xMinimum
double yMinimum
double xMaximum
double yMaximum
#define MAXIMUM_OPENSTREETMAP_TILES_FETCH