MapFetcher queuing refactoring
[situare] / src / map / mapengine.cpp
1 /*
2    Situare - A location system for Facebook
3    Copyright (C) 2010  Ixonos Plc. Authors:
4
5        Sami Rämö - sami.ramo@ixonos.com
6        Jussi Laitinen - jussi.laitinen@ixonos.com
7        Pekka Nissinen - pekka.nissinen@ixonos.com
8
9    Situare is free software; you can redistribute it and/or
10    modify it under the terms of the GNU General Public License
11    version 2 as published by the Free Software Foundation.
12
13    Situare is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with Situare; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
21    USA.
22 */
23
24 #include <QDebug>
25 #include <QString>
26 #include <QStringList>
27 #include <QUrl>
28 #include <QHash>
29 #include <QHashIterator>
30 #include <QRect>
31
32 #include "mapengine.h"
33 #include "maptile.h"
34
35 MapEngine::MapEngine(QObject *parent)
36     : QObject(parent)
37     , m_centerTile(QPoint(UNDEFINED, UNDEFINED))
38     , m_viewSize(QSize(DEFAULT_SCREEN_WIDTH, DEFAULT_SCREEN_HEIGHT))
39     , m_zoomedIn(false)
40     , m_zoomLevel(DEFAULT_ZOOM_LEVEL)
41 {
42     m_mapScene = new MapScene(this);
43
44     m_mapFetcher = new MapFetcher(new QNetworkAccessManager(this), this);
45     connect(this, SIGNAL(fetchImage(QUrl)), m_mapFetcher, SLOT(enqueueFetchMapImage(QUrl)));
46     connect(m_mapFetcher, SIGNAL(mapImageReceived(QUrl,QPixmap)), this,
47             SLOT(mapImageReceived(QUrl, QPixmap)));
48
49     m_mapZoomPanel = new MapZoomPanel(NULL, MAP_ZOOM_PANEL_POSITION_X, MAP_ZOOM_PANEL_POSITION_Y);
50     m_mapScene->addItem(m_mapZoomPanel);
51     connect(m_mapZoomPanel, SIGNAL(zoomInPressed()), this, SLOT(zoomIn()));
52     connect(m_mapZoomPanel, SIGNAL(zoomOutPressed()), this, SLOT(zoomOut()));
53 }
54
55 void MapEngine::init()
56 {
57     emit zoomLevelChanged(m_zoomLevel);
58     setViewLocation(QPointF(DEFAULT_LONGITUDE, DEFAULT_LATITUDE));
59 }
60
61 void MapEngine::setViewLocation(QPointF latLonCoordinate)
62 {
63     qDebug() << __PRETTY_FUNCTION__;
64     setLocation(convertLatLonToSceneCoordinate(latLonCoordinate));
65 }
66
67 QUrl MapEngine::buildURL(int zoomLevel, QPoint tileNumbers)
68 {
69     QString url = QString("http://tile.openstreetmap.org/mapnik/%1/%2/%3.png")
70                   .arg(zoomLevel).arg(tileNumbers.x()).arg(tileNumbers.y());
71
72     return QUrl(url);
73 }
74
75 void MapEngine::parseURL(const QUrl &url, int &zoom, int &x, int &y)
76 {
77     QString path = url.path();
78     QStringList pathParts = path.split("/", QString::SkipEmptyParts);
79
80     int size = pathParts.size();
81
82     if (size >= 3) {
83         zoom = (pathParts.at(size-3)).toInt();
84         x = (pathParts.at(size-2)).toInt();
85         QString yString = pathParts.at(size-1);
86         yString.chop(4);
87         y = yString.toInt();
88     }
89 }
90
91 void MapEngine::mapImageReceived(const QUrl &url, const QPixmap &pixmap)
92 {
93     qDebug() << __PRETTY_FUNCTION__;
94
95     int zoom = UNDEFINED;
96     int x = UNDEFINED;
97     int y = UNDEFINED;
98
99     parseURL(url, zoom, x, y);
100     QString hashKey = tilePath(zoom, x, y);
101     if (!m_mapScene->isTileInScene(hashKey)) {
102
103         MapTile *mapTile = new MapTile();
104         mapTile->setZoomLevel(zoom, m_zoomLevel);
105         mapTile->setTileNumber(QPoint(x, y));
106         mapTile->setPixmap(pixmap);
107
108         m_mapScene->addTile(mapTile, hashKey);
109
110         m_mapScene->debugItemsCount();
111
112         m_mapScene->enqueueRemoveStackedTiles(mapTile);
113    }
114 }
115
116 QGraphicsScene* MapEngine::scene()
117 {
118     return dynamic_cast<QGraphicsScene *>(m_mapScene);
119 }
120
121 int MapEngine::tileMaxValue(int zoomLevel)
122 {
123     return (1 << zoomLevel) - 1;
124 }
125
126 QRect MapEngine::calculateTileGrid(QPoint sceneCoordinate)
127 {
128     QPoint tileCoordinate = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
129     int gridWidth = (m_viewSize.width()/TILE_SIZE_X + 1) + (GRID_PADDING*2);
130     int gridHeight = (m_viewSize.height()/TILE_SIZE_Y + 1) + (GRID_PADDING*2);
131     int topLeftX = tileCoordinate.x() - (gridWidth/2);
132     int topLeftY = tileCoordinate.y() - (gridHeight/2);
133
134     m_mapFetcher->setDownloadQueueSize(gridWidth * gridHeight);
135
136     return QRect(topLeftX, topLeftY, gridWidth, gridHeight);
137 }
138
139 void MapEngine::alignImmovableItems(QPoint viewTopLeft)
140 {
141     m_mapZoomPanel->setPos(viewTopLeft);
142
143     qDebug() << __PRETTY_FUNCTION__ << "viewTopLeft:" << viewTopLeft;
144 }
145
146 void MapEngine::setLocation(QPoint sceneCoordinate)
147 {
148     qDebug() << __PRETTY_FUNCTION__;
149
150     m_sceneCoordinate = sceneCoordinate;
151     emit locationChanged(m_sceneCoordinate);
152
153     if (isCenterTileChanged(sceneCoordinate)) {
154         getTiles(sceneCoordinate);
155         m_mapScene->removeOutOfViewTiles();
156     }
157 }
158
159 bool MapEngine::isCenterTileChanged(QPoint sceneCoordinate)
160 {
161     QPoint centerTile = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
162     QPoint temp = m_centerTile;
163     m_centerTile = centerTile;
164
165     return (centerTile != temp);
166 }
167
168 void MapEngine::getTiles(QPoint sceneCoordinate)
169 {
170     qDebug() << __PRETTY_FUNCTION__;
171
172     m_viewTilesGrid = calculateTileGrid(sceneCoordinate);
173     updateViewTilesSceneRect();
174
175     int topLeftX = m_viewTilesGrid.topLeft().x();
176     int topLeftY = m_viewTilesGrid.topLeft().y();
177     int bottomRightX = m_viewTilesGrid.bottomRight().x();
178     int bottomRightY = m_viewTilesGrid.bottomRight().y();
179
180     int tileMaxVal = tileMaxValue(m_zoomLevel);
181
182     for (int x = topLeftX; x <= bottomRightX; ++x) {
183         for (int y = topLeftY; y <= bottomRightY; ++y) {
184
185             int tileX = x;
186             int tileY = y;
187
188             if (tileX < 0)
189                 tileX += tileMaxVal;
190             else if (tileX > tileMaxVal)
191                 tileX -= tileMaxVal;
192
193             if (tileY < 0)
194                 tileY += tileMaxVal;
195             else if (tileY > tileMaxVal)
196                 tileY -= tileMaxVal;
197
198             QUrl url = buildURL(m_zoomLevel, QPoint(tileX, tileY));
199
200             if (!m_mapScene->isTileInScene(tilePath(m_zoomLevel, tileX, tileY)))
201                 emit fetchImage(url);
202         }
203     }
204 }
205
206 void MapEngine::updateViewTilesSceneRect()
207 {
208     QPoint topLeft = convertTileNumberToSceneCoordinate(m_zoomLevel, m_viewTilesGrid.topLeft());
209     QPoint bottomRight = convertTileNumberToSceneCoordinate(m_zoomLevel,
210                                                             m_viewTilesGrid.bottomRight()
211                                                              + QPoint(1, 1)) - QPoint(1, 1);
212
213     m_mapScene->viewRectUpdated(QRect(topLeft, bottomRight));
214 }
215
216 void MapEngine::viewResized(const QSize &size)
217 {
218     m_viewSize = size;
219     getTiles(m_sceneCoordinate);
220     m_mapScene->removeOutOfViewTiles();
221 }
222
223 void MapEngine::viewZoomFinished()
224 {
225     qDebug() << __PRETTY_FUNCTION__;
226
227     if (m_zoomedIn) {
228         m_zoomedIn = false;
229         m_mapScene->removeOutOfViewTiles();
230     }
231 }
232
233 void MapEngine::zoomIn()
234 {
235     qDebug() << __PRETTY_FUNCTION__;
236
237     if (m_zoomLevel < MAX_MAP_ZOOM_LEVEL) {
238         m_zoomLevel++;
239         m_zoomedIn = true;
240         emit zoomLevelChanged(m_zoomLevel);
241
242         m_mapScene->setTilesDrawingLevels(m_zoomLevel);
243
244         getTiles(m_sceneCoordinate);
245     }
246 }
247
248 void MapEngine::zoomOut()
249 {
250     qDebug() << __PRETTY_FUNCTION__;
251
252     if (m_zoomLevel > MIN_VIEW_ZOOM_LEVEL) {
253         m_zoomLevel--;
254         emit zoomLevelChanged(m_zoomLevel);
255
256         m_mapScene->setTilesDrawingLevels(m_zoomLevel);
257
258         getTiles(m_sceneCoordinate);
259     }
260 }
261
262 QString MapEngine::tilePath(int zoomLevel, int x, int y)
263 {
264     QString tilePathString(QString::number(zoomLevel) + "/");
265     tilePathString.append(QString::number(x) + "/");
266     tilePathString.append(QString::number(y));
267
268     return tilePathString;
269 }
270
271 QPoint MapEngine::convertSceneCoordinateToTileNumber(int zoomLevel, QPoint sceneCoordinate)
272 {
273     int pow = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
274     int x = static_cast<int>(sceneCoordinate.x() / (TILE_SIZE_X*pow));
275     int y = static_cast<int>(sceneCoordinate.y() / (TILE_SIZE_Y*pow));
276
277     return QPoint(x, y);
278 }
279
280 QPoint MapEngine::convertTileNumberToSceneCoordinate(int zoomLevel, QPoint tileNumber)
281 {
282     int pow = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
283     int x = tileNumber.x() * TILE_SIZE_X * pow;
284     int y = tileNumber.y() * TILE_SIZE_Y * pow;
285
286     return QPoint(x, y);
287 }
288
289 QPoint MapEngine::convertLatLonToSceneCoordinate(QPointF latLonCoordinate)
290 {
291     qDebug() << __PRETTY_FUNCTION__;
292
293     qreal longitude = latLonCoordinate.x();
294     qreal latitude = latLonCoordinate.y();
295
296     if ((longitude > MAX_LONGITUDE) || (longitude < MIN_LONGITUDE))
297         return QPoint(UNDEFINED, UNDEFINED);
298     if ((latitude > MAX_LATITUDE) || (latitude < MIN_LATITUDE))
299         return QPoint(UNDEFINED, UNDEFINED);
300
301     qreal z = static_cast<qreal>(1 << MAX_MAP_ZOOM_LEVEL);
302
303     qreal x = static_cast<qreal>((longitude + 180.0) / 360.0);
304     qreal y = static_cast<qreal>((1.0 - log(tan(latitude * M_PI / 180.0) + 1.0
305                                 / cos(latitude * M_PI / 180.0)) / M_PI) / 2.0);
306
307     return QPointF(x*z*TILE_SIZE_X, y*z*TILE_SIZE_Y).toPoint();
308 }