merged with use_last_location
[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 <QNetworkAccessManager>
28 #include <QString>
29 #include <QStringList>
30 #include <QUrl>
31 #include <QHash>
32 #include <QHashIterator>
33 #include <QRect>
34
35 #include "common.h"
36 #include "frienditemshandler.h"
37 #include "gpslocationitem.h"
38 #include "mapcommon.h"
39 #include "mapfetcher.h"
40 #include "mapscene.h"
41 #include "maptile.h"
42 #include "ownlocationitem.h"
43
44 #include "mapengine.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(new QNetworkAccessManager(this), 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
65     m_ownLocation = new OwnLocationItem();
66     m_ownLocation->hide(); // hide until first location info is received
67     m_mapScene->addItem(m_ownLocation);
68
69     m_gpsLocationItem = new GPSLocationItem();
70     m_mapScene->addItem(m_gpsLocationItem);
71
72     m_friendItemsHandler = new FriendItemsHandler(m_mapScene, this);
73     connect(this, SIGNAL(zoomLevelChanged(int)),
74             m_friendItemsHandler, SLOT(refactorFriendItems(int)));
75
76     connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
77             m_friendItemsHandler, SLOT(friendListUpdated(QList<User*>&)));
78
79     connect(m_friendItemsHandler, SIGNAL(locationItemClicked(QList<QString>)),
80             this, SIGNAL(locationItemClicked(QList<QString>)));
81 }
82
83 MapEngine::~MapEngine()
84 {
85     qDebug() << __PRETTY_FUNCTION__;
86
87     QSettings settings(DIRECTORY_NAME, FILE_NAME);
88     settings.setValue(MAP_LAST_POSITION,
89                       convertSceneCoordinateToLatLon(m_zoomLevel, m_sceneCoordinate));
90     settings.setValue(MAP_LAST_ZOOMLEVEL, m_zoomLevel);
91 }
92
93 QRect MapEngine::calculateTileGrid(QPoint sceneCoordinate)
94 {
95     qDebug() << __PRETTY_FUNCTION__;
96
97     QPoint tileCoordinate = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
98     int gridWidth = (m_viewSize.width() / TILE_SIZE_X + 1) + (GRID_PADDING * 2);
99     int gridHeight = (m_viewSize.height() / TILE_SIZE_Y + 1) + (GRID_PADDING * 2);
100     int topLeftX = tileCoordinate.x() - (gridWidth / 2);
101     int topLeftY = tileCoordinate.y() - (gridHeight / 2);
102
103     m_mapFetcher->setDownloadQueueSize(gridWidth * gridHeight);
104
105     return QRect(topLeftX, topLeftY, gridWidth, gridHeight);
106 }
107
108 QPointF MapEngine::centerGeoCoordinate()
109 {
110     qDebug() << __PRETTY_FUNCTION__;
111
112     return convertSceneCoordinateToLatLon(m_zoomLevel, m_sceneCoordinate);
113 }
114
115 QPoint MapEngine::convertLatLonToSceneCoordinate(QPointF latLonCoordinate)
116 {
117     qDebug() << __PRETTY_FUNCTION__;
118
119     qreal longitude = latLonCoordinate.x();
120     qreal latitude = latLonCoordinate.y();
121
122     if ((longitude > MAX_LONGITUDE) || (longitude < MIN_LONGITUDE))
123         return QPoint(UNDEFINED, UNDEFINED);
124     if ((latitude > MAX_LATITUDE) || (latitude < MIN_LATITUDE))
125         return QPoint(UNDEFINED, UNDEFINED);
126
127     qreal z = static_cast<qreal>(1 << MAX_MAP_ZOOM_LEVEL);
128
129     qreal x = static_cast<qreal>((longitude + 180.0) / 360.0);
130     qreal y = static_cast<qreal>((1.0 - log(tan(latitude * M_PI / 180.0) + 1.0
131                                 / cos(latitude * M_PI / 180.0)) / M_PI) / 2.0);
132
133     return QPointF(x * z * TILE_SIZE_X, y * z * TILE_SIZE_Y).toPoint();
134 }
135
136 QPointF MapEngine::convertSceneCoordinateToLatLon(int zoomLevel, QPoint sceneCoordinate)
137 {
138     qDebug() << __PRETTY_FUNCTION__;
139
140     double tileFactor = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
141     double xFactor = (sceneCoordinate.x() / (TILE_SIZE_X*tileFactor));
142     double yFactor = (sceneCoordinate.y() / (TILE_SIZE_Y*tileFactor));
143
144     tileFactor = 1 << zoomLevel;
145     double longitude = xFactor / tileFactor * 360.0 - 180;
146
147     double n = M_PI - 2.0 * M_PI * yFactor / tileFactor;
148     double latitude = 180.0 / M_PI * atan(0.5 * (exp(n) - exp(-n)));
149
150     return QPointF(longitude, latitude);
151 }
152
153 QPoint MapEngine::convertSceneCoordinateToTileNumber(int zoomLevel, QPoint sceneCoordinate)
154 {
155     qDebug() << __PRETTY_FUNCTION__;
156
157     int pow = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
158     int x = static_cast<int>(sceneCoordinate.x() / (TILE_SIZE_X * pow));
159     int y = static_cast<int>(sceneCoordinate.y() / (TILE_SIZE_Y * pow));
160
161     return QPoint(x, y);
162 }
163
164 QPoint MapEngine::convertTileNumberToSceneCoordinate(int zoomLevel, QPoint tileNumber)
165 {
166     qDebug() << __PRETTY_FUNCTION__;
167
168     int pow = 1 << (MAX_MAP_ZOOM_LEVEL - zoomLevel);
169     int x = tileNumber.x() * TILE_SIZE_X * pow;
170     int y = tileNumber.y() * TILE_SIZE_Y * pow;
171
172     return QPoint(x, y);
173 }
174
175 bool MapEngine::disableAutoCentering(QPoint sceneCoordinate)
176 {
177     if (isAutoCenteringEnabled()) {
178         int zoomFactor = (1 << (MAX_MAP_ZOOM_LEVEL - m_zoomLevel));
179
180         QPoint oldPixelValue = QPoint(m_lastManualPosition.x() / zoomFactor,
181                                       m_lastManualPosition.y() / zoomFactor);
182
183         QPoint newPixelValue = QPoint(sceneCoordinate.x() / zoomFactor,
184                                       sceneCoordinate.y() / zoomFactor);
185
186         if ((abs(oldPixelValue.x() - newPixelValue.x()) > AUTO_CENTERING_DISABLE_DISTANCE) ||
187             (abs(oldPixelValue.y() - newPixelValue.y()) > AUTO_CENTERING_DISABLE_DISTANCE))
188             return true;
189     }
190
191     return false;
192 }
193
194 void MapEngine::getTiles(QPoint sceneCoordinate)
195 {
196     qDebug() << __PRETTY_FUNCTION__;
197
198     m_viewTilesGrid = calculateTileGrid(sceneCoordinate);
199     updateViewTilesSceneRect();
200
201     int topLeftX = m_viewTilesGrid.topLeft().x();
202     int topLeftY = m_viewTilesGrid.topLeft().y();
203     int bottomRightX = m_viewTilesGrid.bottomRight().x();
204     int bottomRightY = m_viewTilesGrid.bottomRight().y();
205
206     int tileMaxVal = tileMaxValue(m_zoomLevel);
207
208     for (int x = topLeftX; x <= bottomRightX; ++x) {
209         for (int y = topLeftY; y <= bottomRightY; ++y) {
210
211             int tileX = x;
212             int tileY = y;
213
214             if (tileX < 0)
215                 tileX += tileMaxVal;
216             else if (tileX > tileMaxVal)
217                 tileX -= tileMaxVal;
218
219             if (tileY < 0)
220                 tileY += tileMaxVal;
221             else if (tileY > tileMaxVal)
222                 tileY -= tileMaxVal;
223
224             if (!m_mapScene->isTileInScene(tilePath(m_zoomLevel, tileX, tileY)))
225                 emit fetchImage(m_zoomLevel, tileX, tileY);
226         }
227     }
228 }
229
230 void MapEngine::gpsPositionUpdate(QPointF position, qreal accuracy)
231 {
232     qDebug() << __PRETTY_FUNCTION__;
233
234     m_gpsLocationItem->updatePosition(convertLatLonToSceneCoordinate(position), accuracy);
235
236     if (m_autoCenteringEnabled)
237         setViewLocation(position);
238 }
239
240 void MapEngine::init()
241 {
242     qDebug() << __PRETTY_FUNCTION__;
243
244     QPointF startLocation;
245     QSettings settings(DIRECTORY_NAME, FILE_NAME);
246
247     if (settings.value(MAP_LAST_POSITION, ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toString() ==
248         ERROR_VALUE_NOT_FOUND_ON_SETTINGS ||
249         settings.value(MAP_LAST_ZOOMLEVEL, ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toString() ==
250         ERROR_VALUE_NOT_FOUND_ON_SETTINGS) {
251
252         startLocation = QPointF(DEFAULT_LONGITUDE, DEFAULT_LATITUDE);
253         m_zoomLevel = DEFAULT_START_ZOOM_LEVEL;
254     }
255
256     else {
257         m_zoomLevel = settings.value(MAP_LAST_ZOOMLEVEL, ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toInt();
258         startLocation = settings.value(MAP_LAST_POSITION,
259                                        ERROR_VALUE_NOT_FOUND_ON_SETTINGS).toPointF();
260     }
261
262     emit zoomLevelChanged(m_zoomLevel);
263     setViewLocation(QPointF(startLocation.x(), startLocation.y()));
264 }
265
266 bool MapEngine::isAutoCenteringEnabled()
267 {
268     return m_autoCenteringEnabled;
269 }
270
271 bool MapEngine::isCenterTileChanged(QPoint sceneCoordinate)
272 {
273     qDebug() << __PRETTY_FUNCTION__;
274
275     QPoint centerTile = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
276     QPoint temp = m_centerTile;
277     m_centerTile = centerTile;
278
279     return (centerTile != temp);
280 }
281
282 void MapEngine::mapImageReceived(int zoomLevel, int x, int y, const QPixmap &image)
283 {
284     qDebug() << __PRETTY_FUNCTION__;
285
286     QString hashKey = tilePath(zoomLevel, x, y);
287     if (!m_mapScene->isTileInScene(hashKey)) {
288
289         MapTile *mapTile = new MapTile();
290         mapTile->setZoomLevel(zoomLevel, m_zoomLevel);
291         mapTile->setTileNumber(QPoint(x, y));
292         mapTile->setPixmap(image);
293
294         m_mapScene->addTile(mapTile, hashKey);
295
296         m_mapScene->enqueueRemoveStackedTiles(mapTile);
297    }
298 }
299
300 void MapEngine::receiveOwnLocation(User *user)
301 {
302     qDebug() << __PRETTY_FUNCTION__;
303
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
313 QGraphicsScene* MapEngine::scene()
314 {
315     qDebug() << __PRETTY_FUNCTION__;
316
317     return m_mapScene;
318 }
319
320 void MapEngine::setAutoCentering(bool enabled)
321 {
322     m_autoCenteringEnabled = enabled;
323 }
324
325 void MapEngine::setGPSEnabled(bool enabled)
326 {
327     m_gpsLocationItem->setEnabled(enabled);
328 }
329
330 void MapEngine::setLocation(QPoint sceneCoordinate)
331 {
332     qDebug() << __PRETTY_FUNCTION__;
333
334     if (disableAutoCentering(sceneCoordinate))
335         emit mapScrolledManually();
336
337     m_sceneCoordinate = sceneCoordinate;
338     emit locationChanged(m_sceneCoordinate);
339
340     if (isCenterTileChanged(sceneCoordinate)) {
341         getTiles(sceneCoordinate);
342         m_mapScene->removeOutOfViewTiles();
343     }
344 }
345
346 void MapEngine::setViewLocation(QPointF latLonCoordinate)
347 {
348     qDebug() << __PRETTY_FUNCTION__;
349
350     QPoint sceneCoordinate = convertLatLonToSceneCoordinate(latLonCoordinate);
351
352     m_lastManualPosition = sceneCoordinate;
353
354     setLocation(sceneCoordinate);
355 }
356
357 int MapEngine::tileMaxValue(int zoomLevel)
358 {
359     qDebug() << __PRETTY_FUNCTION__;
360
361     return (1 << zoomLevel) - 1;
362 }
363
364 QString MapEngine::tilePath(int zoomLevel, int x, int y)
365 {
366     qDebug() << __PRETTY_FUNCTION__;
367
368     QString tilePathString(QString::number(zoomLevel) + "/");
369     tilePathString.append(QString::number(x) + "/");
370     tilePathString.append(QString::number(y));
371
372     return tilePathString;
373 }
374
375 void MapEngine::updateViewTilesSceneRect()
376 {
377     qDebug() << __PRETTY_FUNCTION__;
378
379     const QPoint ONE_TILE = QPoint(1, 1);
380     const QPoint ONE_PIXEL = QPoint(1, 1);
381
382     QPoint topLeft = convertTileNumberToSceneCoordinate(m_zoomLevel, m_viewTilesGrid.topLeft());
383     // one tile - one pixel is added because returned coordinates are pointing to upper left corner
384     // of the last tile.
385     QPoint bottomRight = convertTileNumberToSceneCoordinate(m_zoomLevel,
386                                                             m_viewTilesGrid.bottomRight()
387                                                              + ONE_TILE) - ONE_PIXEL;
388
389     m_mapScene->viewRectUpdated(QRect(topLeft, bottomRight));
390 }
391
392 void MapEngine::viewResized(const QSize &size)
393 {
394     qDebug() << __PRETTY_FUNCTION__;
395
396     m_viewSize = size;
397     emit locationChanged(m_sceneCoordinate);
398     getTiles(m_sceneCoordinate);
399     m_mapScene->removeOutOfViewTiles();
400 }
401
402 void MapEngine::viewZoomFinished()
403 {
404     qDebug() << __PRETTY_FUNCTION__;
405
406     if (m_zoomedIn) {
407         m_zoomedIn = false;
408         m_mapScene->removeOutOfViewTiles();
409     }
410
411     if (m_zoomLevel == MAX_MAP_ZOOM_LEVEL)
412         emit maxZoomLevelReached();
413     else if (m_zoomLevel == MIN_VIEW_ZOOM_LEVEL)
414         emit minZoomLevelReached();
415 }
416
417 void MapEngine::zoomIn()
418 {
419     qDebug() << __PRETTY_FUNCTION__;
420
421     if (m_zoomLevel < MAX_MAP_ZOOM_LEVEL) {
422         m_zoomLevel++;
423         m_zoomedIn = true;
424         emit zoomLevelChanged(m_zoomLevel);
425
426         m_mapScene->setTilesDrawingLevels(m_zoomLevel);
427
428         getTiles(m_sceneCoordinate);
429     }
430 }
431
432 void MapEngine::zoomOut()
433 {
434     qDebug() << __PRETTY_FUNCTION__;
435
436     if (m_zoomLevel > MIN_VIEW_ZOOM_LEVEL) {
437         m_zoomLevel--;
438         emit zoomLevelChanged(m_zoomLevel);
439
440         m_mapScene->setTilesDrawingLevels(m_zoomLevel);
441
442         getTiles(m_sceneCoordinate);
443     }
444 }