2 Situare - A location system for Facebook
3 Copyright (C) 2010 Ixonos Plc. Authors:
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
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.
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.
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,
25 #include <QtAlgorithms>
28 #include <QStringList>
31 #include <QHashIterator>
35 #include "frienditemshandler.h"
36 #include "gpslocationitem.h"
37 #include "mapcommon.h"
38 #include "mapfetcher.h"
41 #include "network/networkaccessmanager.h"
42 #include "ownlocationitem.h"
43 #include "user/user.h"
45 #include "mapengine.h"
47 MapEngine::MapEngine(QObject *parent)
49 m_autoCenteringEnabled(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))
57 qDebug() << __PRETTY_FUNCTION__;
59 m_mapScene = new MapScene(this);
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)));
69 m_ownLocation = new OwnLocationItem();
70 m_ownLocation->hide(); // hide until first location info is received
71 m_mapScene->addItem(m_ownLocation);
73 m_gpsLocationItem = new GPSLocationItem();
74 m_mapScene->addItem(m_gpsLocationItem);
76 m_friendItemsHandler = new FriendItemsHandler(m_mapScene, this);
77 connect(this, SIGNAL(zoomLevelChanged(int)),
78 m_friendItemsHandler, SLOT(refactorFriendItems(int)));
80 connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
81 m_friendItemsHandler, SLOT(friendListUpdated(QList<User*>&)));
83 connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
84 this, SLOT(friendsPositionsUpdated()));
86 connect(m_friendItemsHandler, SIGNAL(locationItemClicked(QList<QString>)),
87 this, SIGNAL(locationItemClicked(QList<QString>)));
90 MapEngine::~MapEngine()
92 qDebug() << __PRETTY_FUNCTION__;
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);
100 QRect MapEngine::calculateTileGrid(QPoint sceneCoordinate)
102 qDebug() << __PRETTY_FUNCTION__;
104 QPoint tileCoordinate = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
107 topLeft.setX(tileCoordinate.x() - (m_tilesGridSize.width() / 2));
108 topLeft.setY(tileCoordinate.y() - (m_tilesGridSize.height() / 2));
110 return QRect(topLeft, m_tilesGridSize);
113 QPointF MapEngine::centerGeoCoordinate()
115 qDebug() << __PRETTY_FUNCTION__;
117 return convertSceneCoordinateToLatLon(m_zoomLevel, m_sceneCoordinate);
120 QPoint MapEngine::convertLatLonToSceneCoordinate(QPointF latLonCoordinate)
122 qDebug() << __PRETTY_FUNCTION__;
124 qreal longitude = latLonCoordinate.x();
125 qreal latitude = latLonCoordinate.y();
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);
132 qreal z = static_cast<qreal>(MapEngine::tilesPerSide(MAX_MAP_ZOOM_LEVEL));
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);
138 return QPointF(x * z * TILE_SIZE_X, y * z * TILE_SIZE_Y).toPoint();
141 QPointF MapEngine::convertSceneCoordinateToLatLon(int zoomLevel, QPoint sceneCoordinate)
143 qDebug() << __PRETTY_FUNCTION__;
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));
149 tileFactor = 1 << zoomLevel;
150 double longitude = xFactor / tileFactor * 360.0 - 180;
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)));
155 return QPointF(longitude, latitude);
158 QPoint MapEngine::convertSceneCoordinateToTileNumber(int zoomLevel, QPoint sceneCoordinate)
160 qDebug() << __PRETTY_FUNCTION__;
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));
169 QPoint MapEngine::convertTileNumberToSceneCoordinate(int zoomLevel, QPoint tileNumber)
171 qDebug() << __PRETTY_FUNCTION__;
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;
180 bool MapEngine::disableAutoCentering(QPoint sceneCoordinate)
182 if (isAutoCenteringEnabled()) {
183 int zoomFactor = (1 << (MAX_MAP_ZOOM_LEVEL - m_zoomLevel));
185 QPoint oldPixelValue = QPoint(m_lastManualPosition.x() / zoomFactor,
186 m_lastManualPosition.y() / zoomFactor);
188 QPoint newPixelValue = QPoint(sceneCoordinate.x() / zoomFactor,
189 sceneCoordinate.y() / zoomFactor);
191 if ((abs(oldPixelValue.x() - newPixelValue.x()) > AUTO_CENTERING_DISABLE_DISTANCE) ||
192 (abs(oldPixelValue.y() - newPixelValue.y()) > AUTO_CENTERING_DISABLE_DISTANCE))
199 void MapEngine::friendsPositionsUpdated()
201 qDebug() << __PRETTY_FUNCTION__;
203 m_mapScene->spanItems(m_zoomLevel, m_sceneCoordinate, m_viewSize);
206 void MapEngine::getTiles(QPoint sceneCoordinate)
208 qDebug() << __PRETTY_FUNCTION__;
210 m_viewTilesGrid = calculateTileGrid(sceneCoordinate);
211 updateViewTilesSceneRect();
212 m_mapScene->setTilesGrid(m_viewTilesGrid);
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();
219 int tileMaxVal = tileMaxIndex(m_zoomLevel);
221 for (int x = topLeftX; x <= bottomRightX; ++x) {
222 for (int y = topLeftY; y <= bottomRightY; ++y) {
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);
233 void MapEngine::gpsPositionUpdate(QPointF position, qreal accuracy)
235 qDebug() << __PRETTY_FUNCTION__;
237 m_gpsLocationItem->updatePosition(convertLatLonToSceneCoordinate(position), accuracy);
238 m_mapScene->spanItems(m_zoomLevel, m_sceneCoordinate, m_viewSize);
240 if (m_autoCenteringEnabled)
241 setViewLocation(position);
244 qreal MapEngine::greatCircleDistance(QPointF firstLocation, QPointF secondLocation)
246 qDebug() << __PRETTY_FUNCTION__;
248 const qreal TORAD = (M_PI/180);
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));
256 return (EARTH_RADIUS * c);
259 void MapEngine::init()
261 qDebug() << __PRETTY_FUNCTION__;
263 QPointF startLocation;
264 QSettings settings(DIRECTORY_NAME, FILE_NAME);
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) {
270 startLocation = QPointF(DEFAULT_LONGITUDE, DEFAULT_LATITUDE);
271 m_zoomLevel = qBound(MIN_VIEW_ZOOM_LEVEL, DEFAULT_START_ZOOM_LEVEL, MAX_MAP_ZOOM_LEVEL);
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();
278 emit zoomLevelChanged(m_zoomLevel);
279 setViewLocation(QPointF(startLocation.x(), startLocation.y()));
282 bool MapEngine::isAutoCenteringEnabled()
284 return m_autoCenteringEnabled;
287 bool MapEngine::isCenterTileChanged(QPoint sceneCoordinate)
289 qDebug() << __PRETTY_FUNCTION__;
291 QPoint centerTile = convertSceneCoordinateToTileNumber(m_zoomLevel, sceneCoordinate);
292 QPoint temp = m_centerTile;
293 m_centerTile = centerTile;
295 return (centerTile != temp);
298 qreal MapEngine::sceneResolution()
300 qDebug() << __PRETTY_FUNCTION__;
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);
313 void MapEngine::mapImageReceived(int zoomLevel, int x, int y, const QPixmap &image)
315 qDebug() << __PRETTY_FUNCTION__;
317 // add normal tile inside the world
318 QPoint tileNumber(x, y);
319 m_mapScene->addTile(zoomLevel, tileNumber, image, m_zoomLevel);
321 // note: add 1 so odd width is rounded up and even is rounded down
322 int tilesGridWidthHalf = (m_viewTilesGrid.width() + 1) / 2;
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);
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);
337 int MapEngine::normalize(int value, int min, int max)
339 qDebug() << __PRETTY_FUNCTION__;
340 Q_ASSERT_X(max >= min, "parameters", "max can't be smaller than min");
343 value += max - min + 1;
346 value -= max - min + 1;
351 void MapEngine::receiveOwnLocation(User *user)
353 qDebug() << __PRETTY_FUNCTION__;
356 QPoint newPosition = convertLatLonToSceneCoordinate(user->coordinates());
357 if (m_ownLocation->pos().toPoint() != newPosition) {
358 m_ownLocation->setPos(newPosition);
361 if (!m_ownLocation->isVisible())
362 m_ownLocation->show();
364 m_ownLocation->hide();
367 m_mapScene->spanItems(m_zoomLevel, m_sceneCoordinate, m_viewSize);
370 QGraphicsScene* MapEngine::scene()
372 qDebug() << __PRETTY_FUNCTION__;
377 void MapEngine::setAutoCentering(bool enabled)
379 m_autoCenteringEnabled = enabled;
382 void MapEngine::setGPSEnabled(bool enabled)
384 m_gpsLocationItem->setEnabled(enabled);
387 void MapEngine::setLocation(QPoint sceneCoordinate)
389 qDebug() << __PRETTY_FUNCTION__;
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);
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));
400 if (disableAutoCentering(sceneCoordinate))
401 emit mapScrolledManually();
403 m_sceneCoordinate = sceneCoordinate;
404 emit locationChanged(m_sceneCoordinate);
406 if (isCenterTileChanged(sceneCoordinate)) {
407 getTiles(sceneCoordinate);
408 m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
411 m_mapScene->spanItems(m_zoomLevel, m_sceneCoordinate, m_viewSize);
412 emit newMapResolution(sceneResolution());
415 void MapEngine::setZoomLevel(int newZoomLevel)
417 qDebug() << __PRETTY_FUNCTION__;
419 m_zoomLevel = newZoomLevel;
423 void MapEngine::setTilesGridSize(const QSize &viewSize)
425 qDebug() << __PRETTY_FUNCTION__;
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;
431 // converting scene tile to tile number does cause grid centering inaccuracy of one tile
432 const int CENTER_TILE_INACCURACY = 1;
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);
439 m_mapFetcher->setDownloadQueueSize(gridWidth * gridHeight);
441 m_tilesGridSize.setHeight(gridHeight);
442 m_tilesGridSize.setWidth(gridWidth);
445 void MapEngine::setViewLocation(QPointF latLonCoordinate)
447 qDebug() << __PRETTY_FUNCTION__;
449 QPoint sceneCoordinate = convertLatLonToSceneCoordinate(latLonCoordinate);
451 m_lastManualPosition = sceneCoordinate;
453 setLocation(sceneCoordinate);
456 int MapEngine::tileMaxIndex(int zoomLevel)
458 qDebug() << __PRETTY_FUNCTION__;
460 // subtract one because first tile index is zero
461 return tilesPerSide(zoomLevel) - 1;
464 QString MapEngine::tilePath(int zoomLevel, int x, int y)
466 qDebug() << __PRETTY_FUNCTION__;
468 QString tilePathString(QString::number(zoomLevel) + "/");
469 tilePathString.append(QString::number(x) + "/");
470 tilePathString.append(QString::number(y));
472 return tilePathString;
475 int MapEngine::tilesPerSide(int zoomLevel)
477 return (1 << zoomLevel);
480 void MapEngine::updateViewTilesSceneRect()
482 qDebug() << __PRETTY_FUNCTION__;
484 const QPoint ONE_TILE = QPoint(1, 1);
485 const QPoint ONE_PIXEL = QPoint(1, 1);
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
490 QPoint bottomRight = convertTileNumberToSceneCoordinate(m_zoomLevel,
491 m_viewTilesGrid.bottomRight()
492 + ONE_TILE) - ONE_PIXEL;
494 m_mapScene->tilesSceneRectUpdated(QRect(topLeft, bottomRight));
497 void MapEngine::viewResized(const QSize &size)
499 qDebug() << __PRETTY_FUNCTION__;
502 setTilesGridSize(m_viewSize);
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);
510 void MapEngine::viewZoomFinished()
512 qDebug() << __PRETTY_FUNCTION__;
516 m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
519 if (m_zoomLevel == MAX_MAP_ZOOM_LEVEL)
520 emit maxZoomLevelReached();
521 else if (m_zoomLevel == MIN_VIEW_ZOOM_LEVEL)
522 emit minZoomLevelReached();
525 void MapEngine::zoomed()
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());
536 void MapEngine::zoomIn()
538 qDebug() << __PRETTY_FUNCTION__;
540 if (m_zoomLevel < MAX_MAP_ZOOM_LEVEL) {
547 void MapEngine::zoomOut()
549 qDebug() << __PRETTY_FUNCTION__;
551 if (m_zoomLevel > MIN_VIEW_ZOOM_LEVEL) {