Added new scalable panels, deleted obsolite bitmaps and made some minor cosmetic...
[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 "network/networkaccessmanager.h"
42 #include "ownlocationitem.h"
43 #include "user/user.h"
44
45 #include "mapengine.h"
46
47 MapEngine::MapEngine(QObject *parent)
48     : QObject(parent),
49       m_autoCenteringEnabled(false),
50       m_zoomedIn(false),
51       m_zoomLevel(DEFAULT_ZOOM_LEVEL),
52       m_centerTile(QPoint(UNDEFINED, UNDEFINED)),
53       m_lastManualPosition(QPoint(0, 0)),
54       m_tilesGridSize(QSize(0, 0)),
55       m_viewSize(QSize(DEFAULT_SCREEN_WIDTH, DEFAULT_SCREEN_HEIGHT))
56 {
57     qDebug() << __PRETTY_FUNCTION__;
58
59     m_mapScene = new MapScene(this);
60
61     m_mapFetcher = new MapFetcher(NetworkAccessManager::instance(), this);
62     connect(this, SIGNAL(fetchImage(int, int, int)),
63             m_mapFetcher, SLOT(enqueueFetchMapImage(int, int, int)));
64     connect(m_mapFetcher, SIGNAL(mapImageReceived(int, int, int, QPixmap)),
65             this, SLOT(mapImageReceived(int, int, int, QPixmap)));
66     connect(m_mapFetcher, SIGNAL(error(int)),
67             this, SIGNAL(error(int)));
68
69     m_ownLocation = new OwnLocationItem();
70     m_ownLocation->hide(); // hide until first location info is received
71     m_mapScene->addItem(m_ownLocation);
72
73     m_gpsLocationItem = new GPSLocationItem();
74     m_mapScene->addItem(m_gpsLocationItem);
75
76     m_friendItemsHandler = new FriendItemsHandler(m_mapScene, this);
77     connect(this, SIGNAL(zoomLevelChanged(int)),
78             m_friendItemsHandler, SLOT(refactorFriendItems(int)));
79
80     connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
81             m_friendItemsHandler, SLOT(friendListUpdated(QList<User*>&)));
82
83     connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
84             this, SLOT(friendsPositionsUpdated()));
85
86     connect(m_friendItemsHandler, SIGNAL(locationItemClicked(QList<QString>)),
87             this, SIGNAL(locationItemClicked(QList<QString>)));
88 }
89
90 MapEngine::~MapEngine()
91 {
92     qDebug() << __PRETTY_FUNCTION__;
93
94     QSettings settings(DIRECTORY_NAME, FILE_NAME);
95     settings.setValue(MAP_LAST_POSITION,
96                       convertSceneCoordinateToLatLon(m_zoomLevel, m_sceneCoordinate));
97     settings.setValue(MAP_LAST_ZOOMLEVEL, m_zoomLevel);
98 }
99
100 QRect MapEngine::calculateTileGrid(QPoint sceneCoordinate)
101 {
102     qDebug() << __PRETTY_FUNCTION__;
103
104     QPoint tileCoordinate = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
105
106     QPoint topLeft;
107     topLeft.setX(tileCoordinate.x() - (m_tilesGridSize.width() / 2));
108     topLeft.setY(tileCoordinate.y() - (m_tilesGridSize.height() / 2));
109
110     return QRect(topLeft, m_tilesGridSize);
111 }
112
113 QPointF MapEngine::centerGeoCoordinate()
114 {
115     qDebug() << __PRETTY_FUNCTION__;
116
117     return convertSceneCoordinateToLatLon(m_zoomLevel, m_sceneCoordinate);
118 }
119
120 QPoint MapEngine::convertLatLonToSceneCoordinate(QPointF latLonCoordinate)
121 {
122     qDebug() << __PRETTY_FUNCTION__;
123
124     qreal longitude = latLonCoordinate.x();
125     qreal latitude = latLonCoordinate.y();
126
127     if ((longitude > MAX_LONGITUDE) || (longitude < MIN_LONGITUDE))
128         return QPoint(UNDEFINED, UNDEFINED);
129     if ((latitude > MAX_LATITUDE) || (latitude < MIN_LATITUDE))
130         return QPoint(UNDEFINED, UNDEFINED);
131
132     qreal z = static_cast<qreal>(MapEngine::tilesPerSide(MAX_MAP_ZOOM_LEVEL));
133
134     qreal x = static_cast<qreal>((longitude + 180.0) / 360.0);
135     qreal y = static_cast<qreal>((1.0 - log(tan(latitude * M_PI / 180.0) + 1.0
136                                 / cos(latitude * M_PI / 180.0)) / M_PI) / 2.0);
137
138     return QPointF(x * z * TILE_SIZE_X, y * z * TILE_SIZE_Y).toPoint();
139 }
140
141 QPointF MapEngine::convertSceneCoordinateToLatLon(int zoomLevel, QPoint sceneCoordinate)
142 {
143     qDebug() << __PRETTY_FUNCTION__;
144
145     double tileFactor = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
146     double xFactor = (sceneCoordinate.x() / (TILE_SIZE_X*tileFactor));
147     double yFactor = (sceneCoordinate.y() / (TILE_SIZE_Y*tileFactor));
148
149     tileFactor = 1 << zoomLevel;
150     double longitude = xFactor / tileFactor * 360.0 - 180;
151
152     double n = M_PI - 2.0 * M_PI * yFactor / tileFactor;
153     double latitude = 180.0 / M_PI * atan(0.5 * (exp(n) - exp(-n)));
154
155     return QPointF(longitude, latitude);
156 }
157
158 QPoint MapEngine::convertSceneCoordinateToTileNumber(int zoomLevel, QPoint sceneCoordinate)
159 {
160     qDebug() << __PRETTY_FUNCTION__;
161
162     int pow = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
163     int x = static_cast<int>(sceneCoordinate.x() / (TILE_SIZE_X * pow));
164     int y = static_cast<int>(sceneCoordinate.y() / (TILE_SIZE_Y * pow));
165
166     return QPoint(x, y);
167 }
168
169 QPoint MapEngine::convertTileNumberToSceneCoordinate(int zoomLevel, QPoint tileNumber)
170 {
171     qDebug() << __PRETTY_FUNCTION__;
172
173     int pow = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
174     int x = tileNumber.x() * TILE_SIZE_X * pow;
175     int y = tileNumber.y() * TILE_SIZE_Y * pow;
176
177     return QPoint(x, y);
178 }
179
180 bool MapEngine::disableAutoCentering(QPoint sceneCoordinate)
181 {
182     if (isAutoCenteringEnabled()) {
183         int zoomFactor = (1 << (MAX_MAP_ZOOM_LEVEL - m_zoomLevel));
184
185         QPoint oldPixelValue = QPoint(m_lastManualPosition.x() / zoomFactor,
186                                       m_lastManualPosition.y() / zoomFactor);
187
188         QPoint newPixelValue = QPoint(sceneCoordinate.x() / zoomFactor,
189                                       sceneCoordinate.y() / zoomFactor);
190
191         if ((abs(oldPixelValue.x() - newPixelValue.x()) > AUTO_CENTERING_DISABLE_DISTANCE) ||
192             (abs(oldPixelValue.y() - newPixelValue.y()) > AUTO_CENTERING_DISABLE_DISTANCE))
193             return true;
194     }
195
196     return false;
197 }
198
199 void MapEngine::friendsPositionsUpdated()
200 {
201     qDebug() << __PRETTY_FUNCTION__;
202
203     m_mapScene->spanItems(m_zoomLevel, m_sceneCoordinate, m_viewSize);
204 }
205
206 void MapEngine::getTiles(QPoint sceneCoordinate)
207 {
208     qDebug() << __PRETTY_FUNCTION__;
209
210     m_viewTilesGrid = calculateTileGrid(sceneCoordinate);
211     updateViewTilesSceneRect();
212     m_mapScene->setTilesGrid(m_viewTilesGrid);
213
214     int topLeftX = m_viewTilesGrid.topLeft().x();
215     int topLeftY = m_viewTilesGrid.topLeft().y();
216     int bottomRightX = m_viewTilesGrid.bottomRight().x();
217     int bottomRightY = m_viewTilesGrid.bottomRight().y();
218
219     int tileMaxVal = tileMaxIndex(m_zoomLevel);
220
221     for (int x = topLeftX; x <= bottomRightX; ++x) {
222         for (int y = topLeftY; y <= bottomRightY; ++y) {
223
224             // map doesn't span in vertical direction, so y index must be inside the limits
225             if (y >= MAP_TILE_MIN_INDEX && y <= tileMaxVal) {
226                 if (!m_mapScene->tileInScene(tilePath(m_zoomLevel, x, y)))
227                     emit fetchImage(m_zoomLevel, normalize(x, MAP_TILE_MIN_INDEX, tileMaxVal), y);
228             }
229         }
230     }
231 }
232
233 void MapEngine::gpsPositionUpdate(QPointF position, qreal accuracy)
234 {
235     qDebug() << __PRETTY_FUNCTION__;
236
237     m_gpsLocationItem->updatePosition(convertLatLonToSceneCoordinate(position), accuracy);
238     m_mapScene->spanItems(m_zoomLevel, m_sceneCoordinate, m_viewSize);
239
240     if (m_autoCenteringEnabled)
241         setViewLocation(position);
242 }
243
244 qreal MapEngine::greatCircleDistance(QPointF firstLocation, QPointF secondLocation)
245 {
246     qDebug() << __PRETTY_FUNCTION__;
247
248     const qreal TORAD = (M_PI/180);
249
250     qreal dLat = (secondLocation.y() - firstLocation.y())*TORAD;
251     qreal dLon = (secondLocation.x() - firstLocation.x())*TORAD;
252     qreal a = pow(sin(dLat/2),2) + cos(firstLocation.y()*TORAD) * cos(secondLocation.y()*TORAD)
253               * pow(sin(dLon/2),2);
254     qreal c = 2 * atan2(sqrt(a), sqrt(1-a));
255
256     return (EARTH_RADIUS * c);
257 }
258
259 void MapEngine::init()
260 {
261     qDebug() << __PRETTY_FUNCTION__;
262
263     QPointF startLocation;
264     QSettings settings(DIRECTORY_NAME, FILE_NAME);
265
266     if (settings.value(MAP_LAST_POSITION, ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toString()
267         == ERROR_VALUE_NOT_FOUND_ON_SETTINGS || settings.value(MAP_LAST_ZOOMLEVEL,
268         ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toString() == ERROR_VALUE_NOT_FOUND_ON_SETTINGS) {
269
270         startLocation = QPointF(DEFAULT_LONGITUDE, DEFAULT_LATITUDE);
271         m_zoomLevel = qBound(MIN_VIEW_ZOOM_LEVEL, DEFAULT_START_ZOOM_LEVEL, MAX_MAP_ZOOM_LEVEL);
272     } else {
273         m_zoomLevel = settings.value(MAP_LAST_ZOOMLEVEL, ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toInt();
274         startLocation = settings.value(MAP_LAST_POSITION,
275                                        ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toPointF();
276     }
277
278     emit zoomLevelChanged(m_zoomLevel);
279     setViewLocation(QPointF(startLocation.x(), startLocation.y()));
280 }
281
282 bool MapEngine::isAutoCenteringEnabled()
283 {
284     return m_autoCenteringEnabled;
285 }
286
287 bool MapEngine::isCenterTileChanged(QPoint sceneCoordinate)
288 {
289     qDebug() << __PRETTY_FUNCTION__;
290
291     QPoint centerTile = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
292     QPoint temp = m_centerTile;
293     m_centerTile = centerTile;
294
295     return (centerTile != temp);
296 }
297
298 qreal MapEngine::sceneResolution()
299 {
300     qDebug() << __PRETTY_FUNCTION__;
301
302     const int SHIFT = 200;
303     const int KM_TO_M = 1000;
304     qreal scale = (1 << (MAX_MAP_ZOOM_LEVEL - m_zoomLevel));
305     QPointF centerCoordinate = centerGeoCoordinate();
306     QPoint shiftedSceneCoordinate = QPoint(m_sceneCoordinate.x() + SHIFT*scale
307                                            , m_sceneCoordinate.y());
308     QPointF shiftedCoordinate = convertSceneCoordinateToLatLon(m_zoomLevel, shiftedSceneCoordinate);
309     qreal dist = greatCircleDistance(centerCoordinate, shiftedCoordinate) * KM_TO_M;
310     return (dist / SHIFT);
311 }
312
313 void MapEngine::mapImageReceived(int zoomLevel, int x, int y, const QPixmap &image)
314 {
315     qDebug() << __PRETTY_FUNCTION__;
316
317     // add normal tile inside the world
318     QPoint tileNumber(x, y);
319     m_mapScene->addTile(zoomLevel, tileNumber, image, m_zoomLevel);
320
321     // note: add 1 so odd width is rounded up and even is rounded down
322     int tilesGridWidthHalf = (m_viewTilesGrid.width() + 1) / 2;
323
324     // duplicate to east side? (don't need to duplicate over padding)
325     if (tileNumber.x() < (tilesGridWidthHalf - GRID_PADDING)) {
326         QPoint adjustedTileNumber(tileNumber.x() + tileMaxIndex(zoomLevel) + 1, tileNumber.y());
327         m_mapScene->addTile(zoomLevel, adjustedTileNumber, image, m_zoomLevel);
328     }
329
330     // duplicate to west side? (don't need to duplicate over padding)
331     if (tileNumber.x() > (tileMaxIndex(zoomLevel) - tilesGridWidthHalf + GRID_PADDING)) {
332         QPoint adjustedTileNumber(tileNumber.x() - tileMaxIndex(zoomLevel) - 1, tileNumber.y());
333         m_mapScene->addTile(zoomLevel, adjustedTileNumber, image, m_zoomLevel);
334     }
335 }
336
337 int MapEngine::normalize(int value, int min, int max)
338 {
339     qDebug() << __PRETTY_FUNCTION__;
340     Q_ASSERT_X(max >= min, "parameters", "max can't be smaller than min");
341
342     while (value < min)
343         value += max - min + 1;
344
345     while (value > max)
346         value -= max - min + 1;
347
348     return value;
349 }
350
351 void MapEngine::receiveOwnLocation(User *user)
352 {
353     qDebug() << __PRETTY_FUNCTION__;
354
355     if(user) {
356         QPoint newPosition = convertLatLonToSceneCoordinate(user->coordinates());
357         if (m_ownLocation->pos().toPoint() != newPosition) {
358             m_ownLocation->setPos(newPosition);
359         }
360
361         if (!m_ownLocation->isVisible())
362             m_ownLocation->show();
363     } else {
364         m_ownLocation->hide();
365     }
366
367     m_mapScene->spanItems(m_zoomLevel, m_sceneCoordinate, m_viewSize);
368 }
369
370 QGraphicsScene* MapEngine::scene()
371 {
372     qDebug() << __PRETTY_FUNCTION__;
373
374     return m_mapScene;
375 }
376
377 void MapEngine::setAutoCentering(bool enabled)
378 {
379     m_autoCenteringEnabled = enabled;
380 }
381
382 void MapEngine::setGPSEnabled(bool enabled)
383 {
384     m_gpsLocationItem->setEnabled(enabled);
385 }
386
387 void MapEngine::setLocation(QPoint sceneCoordinate)
388 {
389     qDebug() << __PRETTY_FUNCTION__;
390
391     // jump to opposite side of the world if world horizontal limit is exceeded
392     if (sceneCoordinate.x() < MAP_MIN_PIXEL_X)
393         sceneCoordinate.setX(sceneCoordinate.x() + MAP_PIXELS_X);
394     else if (sceneCoordinate.x() > MAP_MAX_PIXEL_X)
395         sceneCoordinate.setX(sceneCoordinate.x() - MAP_PIXELS_X);
396
397     // don't allow vertical scene coordinates go out of the map
398     sceneCoordinate.setY(qBound(MAP_MIN_PIXEL_Y, sceneCoordinate.y(), MAP_MAX_PIXEL_Y));
399
400     if (disableAutoCentering(sceneCoordinate))
401         emit mapScrolledManually();
402
403     m_sceneCoordinate = sceneCoordinate;
404     emit locationChanged(m_sceneCoordinate);
405
406     if (isCenterTileChanged(sceneCoordinate)) {
407         getTiles(sceneCoordinate);
408         m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
409     }
410
411     m_mapScene->spanItems(m_zoomLevel, m_sceneCoordinate, m_viewSize);
412     emit newMapResolution(sceneResolution());
413 }
414
415 void MapEngine::setZoomLevel(int newZoomLevel)
416 {
417     qDebug() << __PRETTY_FUNCTION__;
418
419     m_zoomLevel = newZoomLevel;
420     zoomed();
421 }
422
423 void MapEngine::setTilesGridSize(const QSize &viewSize)
424 {
425     qDebug() << __PRETTY_FUNCTION__;
426
427     // there must be scrolling reserve of at least half tile added to tile amount
428     // calculated from view size
429     const qreal SCROLLING_RESERVE = 0.5;
430
431     // converting scene tile to tile number does cause grid centering inaccuracy of one tile
432     const int CENTER_TILE_INACCURACY = 1;
433
434     int gridWidth = ceil(qreal(viewSize.width()) / TILE_SIZE_X + SCROLLING_RESERVE)
435                     + CENTER_TILE_INACCURACY + (GRID_PADDING * 2);
436     int gridHeight = ceil(qreal(viewSize.height()) / TILE_SIZE_Y + SCROLLING_RESERVE)
437                      + CENTER_TILE_INACCURACY + (GRID_PADDING * 2);
438
439     m_mapFetcher->setDownloadQueueSize(gridWidth * gridHeight);
440
441     m_tilesGridSize.setHeight(gridHeight);
442     m_tilesGridSize.setWidth(gridWidth);
443 }
444
445 void MapEngine::setViewLocation(QPointF latLonCoordinate)
446 {
447     qDebug() << __PRETTY_FUNCTION__;
448
449     QPoint sceneCoordinate = convertLatLonToSceneCoordinate(latLonCoordinate);
450
451     m_lastManualPosition = sceneCoordinate;
452
453     setLocation(sceneCoordinate);
454 }
455
456 int MapEngine::tileMaxIndex(int zoomLevel)
457 {
458     qDebug() << __PRETTY_FUNCTION__;
459
460     // subtract one because first tile index is zero
461     return tilesPerSide(zoomLevel) - 1;
462 }
463
464 QString MapEngine::tilePath(int zoomLevel, int x, int y)
465 {
466     qDebug() << __PRETTY_FUNCTION__;
467
468     QString tilePathString(QString::number(zoomLevel) + "/");
469     tilePathString.append(QString::number(x) + "/");
470     tilePathString.append(QString::number(y));
471
472     return tilePathString;
473 }
474
475 int MapEngine::tilesPerSide(int zoomLevel)
476 {
477     return (1 << zoomLevel);
478 }
479
480 void MapEngine::updateViewTilesSceneRect()
481 {
482     qDebug() << __PRETTY_FUNCTION__;
483
484     const QPoint ONE_TILE = QPoint(1, 1);
485     const QPoint ONE_PIXEL = QPoint(1, 1);
486
487     QPoint topLeft = convertTileNumberToSceneCoordinate(m_zoomLevel, m_viewTilesGrid.topLeft());
488     // one tile - one pixel is added because returned coordinates are pointing to upper left corner
489     // of the last tile.
490     QPoint bottomRight = convertTileNumberToSceneCoordinate(m_zoomLevel,
491                                                             m_viewTilesGrid.bottomRight()
492                                                              + ONE_TILE) - ONE_PIXEL;
493
494     m_mapScene->tilesSceneRectUpdated(QRect(topLeft, bottomRight));
495 }
496
497 void MapEngine::viewResized(const QSize &size)
498 {
499     qDebug() << __PRETTY_FUNCTION__;
500
501     m_viewSize = size;
502     setTilesGridSize(m_viewSize);
503
504     emit locationChanged(m_sceneCoordinate);
505     getTiles(m_sceneCoordinate);
506     m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
507     m_mapScene->setSceneVerticalOverlap(m_viewSize.height(), m_zoomLevel);
508 }
509
510 void MapEngine::viewZoomFinished()
511 {
512     qDebug() << __PRETTY_FUNCTION__;
513
514     if (m_zoomedIn) {
515         m_zoomedIn = false;
516         m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
517     }
518
519     if (m_zoomLevel == MAX_MAP_ZOOM_LEVEL)
520         emit maxZoomLevelReached();
521     else if (m_zoomLevel == MIN_VIEW_ZOOM_LEVEL)
522         emit minZoomLevelReached();
523 }
524
525 void MapEngine::zoomed()
526 {
527     emit zoomLevelChanged(m_zoomLevel);
528     m_mapScene->setTilesDrawingLevels(m_zoomLevel);
529     m_mapScene->setZoomLevel(m_zoomLevel);
530     getTiles(m_sceneCoordinate);
531     m_mapScene->setSceneVerticalOverlap(m_viewSize.height(), m_zoomLevel);
532     m_mapScene->spanItems(m_zoomLevel, m_sceneCoordinate, m_viewSize);
533     emit newMapResolution(sceneResolution());
534 }
535
536 void MapEngine::zoomIn()
537 {
538     qDebug() << __PRETTY_FUNCTION__;
539
540     if (m_zoomLevel < MAX_MAP_ZOOM_LEVEL) {
541         m_zoomLevel++;
542         m_zoomedIn = true;
543         zoomed();
544     }
545 }
546
547 void MapEngine::zoomOut()
548 {
549     qDebug() << __PRETTY_FUNCTION__;
550
551     if (m_zoomLevel > MIN_VIEW_ZOOM_LEVEL) {
552         m_zoomLevel--;
553         zoomed();
554     }
555 }