Merge branch 'master' into settings_auto_update
[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        Ville Tiensuu - ville.tiensuu@ixonos.com
9
10    Situare is free software; you can redistribute it and/or
11    modify it under the terms of the GNU General Public License
12    version 2 as published by the Free Software Foundation.
13
14    Situare is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with Situare; if not, write to the Free Software
21    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
22    USA.
23 */
24
25 #include <QtAlgorithms>
26 #include <QDebug>
27 #include <QString>
28 #include <QStringList>
29 #include <QUrl>
30 #include <QHash>
31 #include <QHashIterator>
32 #include <QRect>
33
34 #include "common.h"
35 #include "frienditemshandler.h"
36 #include "gpslocationitem.h"
37 #include "mapcommon.h"
38 #include "mapfetcher.h"
39 #include "mapscene.h"
40 #include "maptile.h"
41 #include "ownlocationitem.h"
42
43 #include "mapengine.h"
44 #include "network/networkaccessmanager.h"
45
46 MapEngine::MapEngine(QObject *parent)
47     : QObject(parent),
48       m_autoCenteringEnabled(false),
49       m_zoomedIn(false),
50       m_zoomLevel(DEFAULT_ZOOM_LEVEL),
51       m_centerTile(QPoint(UNDEFINED, UNDEFINED)),
52       m_lastManualPosition(QPoint(0, 0)),
53       m_viewSize(QSize(DEFAULT_SCREEN_WIDTH, DEFAULT_SCREEN_HEIGHT))
54 {
55     qDebug() << __PRETTY_FUNCTION__;
56
57     m_mapScene = new MapScene(this);
58
59     m_mapFetcher = new MapFetcher(NetworkAccessManager::instance(), this);
60     connect(this, SIGNAL(fetchImage(int, int, int)),
61             m_mapFetcher, SLOT(enqueueFetchMapImage(int, int, int)));
62     connect(m_mapFetcher, SIGNAL(mapImageReceived(int, int, int, QPixmap)),
63             this, SLOT(mapImageReceived(int, int, int, QPixmap)));
64     connect(m_mapFetcher, SIGNAL(error(QString)),
65             this, SIGNAL(error(QString)));
66
67     m_ownLocation = new OwnLocationItem();
68     m_ownLocation->hide(); // hide until first location info is received
69     m_mapScene->addItem(m_ownLocation);
70
71     m_gpsLocationItem = new GPSLocationItem();
72     m_mapScene->addItem(m_gpsLocationItem);
73
74     m_friendItemsHandler = new FriendItemsHandler(m_mapScene, this);
75     connect(this, SIGNAL(zoomLevelChanged(int)),
76             m_friendItemsHandler, SLOT(refactorFriendItems(int)));
77
78     connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
79             m_friendItemsHandler, SLOT(friendListUpdated(QList<User*>&)));
80
81     connect(m_friendItemsHandler, SIGNAL(locationItemClicked(QList<QString>)),
82             this, SIGNAL(locationItemClicked(QList<QString>)));
83 }
84
85 MapEngine::~MapEngine()
86 {
87     qDebug() << __PRETTY_FUNCTION__;
88
89     QSettings settings(DIRECTORY_NAME, FILE_NAME);
90     settings.setValue(MAP_LAST_POSITION,
91                       convertSceneCoordinateToLatLon(m_zoomLevel, m_sceneCoordinate));
92     settings.setValue(MAP_LAST_ZOOMLEVEL, m_zoomLevel);
93 }
94
95 QRect MapEngine::calculateTileGrid(QPoint sceneCoordinate)
96 {
97     qDebug() << __PRETTY_FUNCTION__;
98
99     QPoint tileCoordinate = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
100     int gridWidth = (m_viewSize.width() / TILE_SIZE_X + 1) + (GRID_PADDING * 2);
101     int gridHeight = (m_viewSize.height() / TILE_SIZE_Y + 1) + (GRID_PADDING * 2);
102     int topLeftX = tileCoordinate.x() - (gridWidth / 2);
103     int topLeftY = tileCoordinate.y() - (gridHeight / 2);
104
105     m_mapFetcher->setDownloadQueueSize(gridWidth * gridHeight);
106
107     return QRect(topLeftX, topLeftY, gridWidth, gridHeight);
108 }
109
110 QPointF MapEngine::centerGeoCoordinate()
111 {
112     qDebug() << __PRETTY_FUNCTION__;
113
114     return convertSceneCoordinateToLatLon(m_zoomLevel, m_sceneCoordinate);
115 }
116
117 QPoint MapEngine::convertLatLonToSceneCoordinate(QPointF latLonCoordinate)
118 {
119     qDebug() << __PRETTY_FUNCTION__;
120
121     qreal longitude = latLonCoordinate.x();
122     qreal latitude = latLonCoordinate.y();
123
124     if ((longitude > MAX_LONGITUDE) || (longitude < MIN_LONGITUDE))
125         return QPoint(UNDEFINED, UNDEFINED);
126     if ((latitude > MAX_LATITUDE) || (latitude < MIN_LATITUDE))
127         return QPoint(UNDEFINED, UNDEFINED);
128
129     qreal z = static_cast<qreal>(1 << MAX_MAP_ZOOM_LEVEL);
130
131     qreal x = static_cast<qreal>((longitude + 180.0) / 360.0);
132     qreal y = static_cast<qreal>((1.0 - log(tan(latitude * M_PI / 180.0) + 1.0
133                                 / cos(latitude * M_PI / 180.0)) / M_PI) / 2.0);
134
135     return QPointF(x * z * TILE_SIZE_X, y * z * TILE_SIZE_Y).toPoint();
136 }
137
138 QPointF MapEngine::convertSceneCoordinateToLatLon(int zoomLevel, QPoint sceneCoordinate)
139 {
140     qDebug() << __PRETTY_FUNCTION__;
141
142     double tileFactor = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
143     double xFactor = (sceneCoordinate.x() / (TILE_SIZE_X*tileFactor));
144     double yFactor = (sceneCoordinate.y() / (TILE_SIZE_Y*tileFactor));
145
146     tileFactor = 1 << zoomLevel;
147     double longitude = xFactor / tileFactor * 360.0 - 180;
148
149     double n = M_PI - 2.0 * M_PI * yFactor / tileFactor;
150     double latitude = 180.0 / M_PI * atan(0.5 * (exp(n) - exp(-n)));
151
152     return QPointF(longitude, latitude);
153 }
154
155 QPoint MapEngine::convertSceneCoordinateToTileNumber(int zoomLevel, QPoint sceneCoordinate)
156 {
157     qDebug() << __PRETTY_FUNCTION__;
158
159     int pow = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
160     int x = static_cast<int>(sceneCoordinate.x() / (TILE_SIZE_X * pow));
161     int y = static_cast<int>(sceneCoordinate.y() / (TILE_SIZE_Y * pow));
162
163     return QPoint(x, y);
164 }
165
166 QPoint MapEngine::convertTileNumberToSceneCoordinate(int zoomLevel, QPoint tileNumber)
167 {
168     qDebug() << __PRETTY_FUNCTION__;
169
170     int pow = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
171     int x = tileNumber.x() * TILE_SIZE_X * pow;
172     int y = tileNumber.y() * TILE_SIZE_Y * pow;
173
174     return QPoint(x, y);
175 }
176
177 bool MapEngine::disableAutoCentering(QPoint sceneCoordinate)
178 {
179     if (isAutoCenteringEnabled()) {
180         int zoomFactor = (1 << (MAX_MAP_ZOOM_LEVEL - m_zoomLevel));
181
182         QPoint oldPixelValue = QPoint(m_lastManualPosition.x() / zoomFactor,
183                                       m_lastManualPosition.y() / zoomFactor);
184
185         QPoint newPixelValue = QPoint(sceneCoordinate.x() / zoomFactor,
186                                       sceneCoordinate.y() / zoomFactor);
187
188         if ((abs(oldPixelValue.x() - newPixelValue.x()) > AUTO_CENTERING_DISABLE_DISTANCE) ||
189             (abs(oldPixelValue.y() - newPixelValue.y()) > AUTO_CENTERING_DISABLE_DISTANCE))
190             return true;
191     }
192
193     return false;
194 }
195
196 void MapEngine::getTiles(QPoint sceneCoordinate)
197 {
198     qDebug() << __PRETTY_FUNCTION__;
199
200     m_viewTilesGrid = calculateTileGrid(sceneCoordinate);
201     updateViewTilesSceneRect();
202
203     int topLeftX = m_viewTilesGrid.topLeft().x();
204     int topLeftY = m_viewTilesGrid.topLeft().y();
205     int bottomRightX = m_viewTilesGrid.bottomRight().x();
206     int bottomRightY = m_viewTilesGrid.bottomRight().y();
207
208     int tileMaxVal = tileMaxValue(m_zoomLevel);
209
210     for (int x = topLeftX; x <= bottomRightX; ++x) {
211         for (int y = topLeftY; y <= bottomRightY; ++y) {
212
213             int tileX = x;
214             int tileY = y;
215
216             if (tileX < 0)
217                 tileX += tileMaxVal;
218             else if (tileX > tileMaxVal)
219                 tileX -= tileMaxVal;
220
221             if (tileY < 0)
222                 tileY += tileMaxVal;
223             else if (tileY > tileMaxVal)
224                 tileY -= tileMaxVal;
225
226             if (!m_mapScene->isTileInScene(tilePath(m_zoomLevel, tileX, tileY)))
227                 emit fetchImage(m_zoomLevel, tileX, tileY);
228         }
229     }
230 }
231
232 void MapEngine::gpsPositionUpdate(QPointF position, qreal accuracy)
233 {
234     qDebug() << __PRETTY_FUNCTION__;
235
236     m_gpsLocationItem->updatePosition(convertLatLonToSceneCoordinate(position), accuracy);
237
238     if (m_autoCenteringEnabled)
239         setViewLocation(position);
240 }
241
242 void MapEngine::init()
243 {
244     qDebug() << __PRETTY_FUNCTION__;
245
246     QPointF startLocation;
247     QSettings settings(DIRECTORY_NAME, FILE_NAME);
248
249     if (settings.value(MAP_LAST_POSITION, ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toString()
250         == ERROR_VALUE_NOT_FOUND_ON_SETTINGS || settings.value(MAP_LAST_ZOOMLEVEL,
251         ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toString() == ERROR_VALUE_NOT_FOUND_ON_SETTINGS) {
252
253         startLocation = QPointF(DEFAULT_LONGITUDE, DEFAULT_LATITUDE);
254         m_zoomLevel = DEFAULT_START_ZOOM_LEVEL;
255     } else {
256         m_zoomLevel = settings.value(MAP_LAST_ZOOMLEVEL, ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toInt();
257         startLocation = settings.value(MAP_LAST_POSITION,
258                                        ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toPointF();
259     }
260
261     emit zoomLevelChanged(m_zoomLevel);
262     setViewLocation(QPointF(startLocation.x(), startLocation.y()));
263 }
264
265 bool MapEngine::isAutoCenteringEnabled()
266 {
267     return m_autoCenteringEnabled;
268 }
269
270 bool MapEngine::isCenterTileChanged(QPoint sceneCoordinate)
271 {
272     qDebug() << __PRETTY_FUNCTION__;
273
274     QPoint centerTile = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
275     QPoint temp = m_centerTile;
276     m_centerTile = centerTile;
277
278     return (centerTile != temp);
279 }
280
281 void MapEngine::mapImageReceived(int zoomLevel, int x, int y, const QPixmap &image)
282 {
283     qDebug() << __PRETTY_FUNCTION__;
284
285     QString hashKey = tilePath(zoomLevel, x, y);
286     if (!m_mapScene->isTileInScene(hashKey)) {
287
288         MapTile *mapTile = new MapTile();
289         mapTile->setZoomLevel(zoomLevel, m_zoomLevel);
290         mapTile->setTileNumber(QPoint(x, y));
291         mapTile->setPixmap(image);
292
293         m_mapScene->addTile(mapTile, hashKey);
294
295         m_mapScene->enqueueRemoveStackedTiles(mapTile);
296    }
297 }
298
299 void MapEngine::receiveOwnLocation(User *user)
300 {
301     qDebug() << __PRETTY_FUNCTION__;
302
303     if(user) {
304         QPoint newPosition = convertLatLonToSceneCoordinate(user->coordinates());
305         if (m_ownLocation->pos().toPoint() != newPosition) {
306             m_ownLocation->setPos(newPosition);
307         }
308
309         if (!m_ownLocation->isVisible())
310             m_ownLocation->show();
311     }
312     else {
313         m_ownLocation->hide();
314     }
315 }
316
317 QGraphicsScene* MapEngine::scene()
318 {
319     qDebug() << __PRETTY_FUNCTION__;
320
321     return m_mapScene;
322 }
323
324 void MapEngine::setAutoCentering(bool enabled)
325 {
326     m_autoCenteringEnabled = enabled;
327 }
328
329 void MapEngine::setGPSEnabled(bool enabled)
330 {
331     m_gpsLocationItem->setEnabled(enabled);
332 }
333
334 void MapEngine::setLocation(QPoint sceneCoordinate)
335 {
336     qDebug() << __PRETTY_FUNCTION__;
337
338     if (disableAutoCentering(sceneCoordinate))
339         emit mapScrolledManually();
340
341     m_sceneCoordinate = sceneCoordinate;
342     emit locationChanged(m_sceneCoordinate);
343
344     if (isCenterTileChanged(sceneCoordinate)) {
345         getTiles(sceneCoordinate);
346         m_mapScene->removeOutOfViewTiles();
347     }
348 }
349
350 void MapEngine::setZoomLevel(int newZoomLevel)
351 {
352     qDebug() << __PRETTY_FUNCTION__;
353
354     m_zoomLevel = newZoomLevel;
355     emit zoomLevelChanged(m_zoomLevel);
356 }
357
358 void MapEngine::setViewLocation(QPointF latLonCoordinate)
359 {
360     qDebug() << __PRETTY_FUNCTION__;
361
362     QPoint sceneCoordinate = convertLatLonToSceneCoordinate(latLonCoordinate);
363
364     m_lastManualPosition = sceneCoordinate;
365
366     setLocation(sceneCoordinate);
367 }
368
369 int MapEngine::tileMaxValue(int zoomLevel)
370 {
371     qDebug() << __PRETTY_FUNCTION__;
372
373     return (1 << zoomLevel) - 1;
374 }
375
376 QString MapEngine::tilePath(int zoomLevel, int x, int y)
377 {
378     qDebug() << __PRETTY_FUNCTION__;
379
380     QString tilePathString(QString::number(zoomLevel) + "/");
381     tilePathString.append(QString::number(x) + "/");
382     tilePathString.append(QString::number(y));
383
384     return tilePathString;
385 }
386
387 void MapEngine::updateViewTilesSceneRect()
388 {
389     qDebug() << __PRETTY_FUNCTION__;
390
391     const QPoint ONE_TILE = QPoint(1, 1);
392     const QPoint ONE_PIXEL = QPoint(1, 1);
393
394     QPoint topLeft = convertTileNumberToSceneCoordinate(m_zoomLevel, m_viewTilesGrid.topLeft());
395     // one tile - one pixel is added because returned coordinates are pointing to upper left corner
396     // of the last tile.
397     QPoint bottomRight = convertTileNumberToSceneCoordinate(m_zoomLevel,
398                                                             m_viewTilesGrid.bottomRight()
399                                                              + ONE_TILE) - ONE_PIXEL;
400
401     m_mapScene->viewRectUpdated(QRect(topLeft, bottomRight));
402 }
403
404 void MapEngine::viewResized(const QSize &size)
405 {
406     qDebug() << __PRETTY_FUNCTION__;
407
408     m_viewSize = size;
409     emit locationChanged(m_sceneCoordinate);
410     getTiles(m_sceneCoordinate);
411     m_mapScene->removeOutOfViewTiles();
412 }
413
414 void MapEngine::viewZoomFinished()
415 {
416     qDebug() << __PRETTY_FUNCTION__;
417
418     if (m_zoomedIn) {
419         m_zoomedIn = false;
420         m_mapScene->removeOutOfViewTiles();
421     }
422
423     if (m_zoomLevel == MAX_MAP_ZOOM_LEVEL)
424         emit maxZoomLevelReached();
425     else if (m_zoomLevel == MIN_VIEW_ZOOM_LEVEL)
426         emit minZoomLevelReached();
427 }
428
429 void MapEngine::zoomIn()
430 {
431     qDebug() << __PRETTY_FUNCTION__;
432
433     if (m_zoomLevel < MAX_MAP_ZOOM_LEVEL) {
434         m_zoomLevel++;
435         m_zoomedIn = true;
436         emit zoomLevelChanged(m_zoomLevel);
437
438         m_mapScene->setTilesDrawingLevels(m_zoomLevel);
439
440         getTiles(m_sceneCoordinate);
441     }
442 }
443
444 void MapEngine::zoomOut()
445 {
446     qDebug() << __PRETTY_FUNCTION__;
447
448     if (m_zoomLevel > MIN_VIEW_ZOOM_LEVEL) {
449         m_zoomLevel--;
450         emit zoomLevelChanged(m_zoomLevel);
451
452         m_mapScene->setTilesDrawingLevels(m_zoomLevel);
453
454         getTiles(m_sceneCoordinate);
455     }
456 }