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
9 Henri Lampela - henri.lampela@ixonos.com
11 Situare is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License
13 version 2 as published by the Free Software Foundation.
15 Situare is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with Situare; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
26 #include <QtAlgorithms>
28 #include <QGraphicsView>
30 #include <QStringList>
33 #include <QHashIterator>
37 #include "coordinates/geocoordinate.h"
38 #include "frienditemshandler.h"
39 #include "gpslocationitem.h"
40 #include "mapcommon.h"
41 #include "mapfetcher.h"
42 #include "maprouteitem.h"
44 #include "mapscroller.h"
46 #include "network/networkaccessmanager.h"
47 #include "ownlocationitem.h"
48 #include "user/user.h"
50 #include "mapengine.h"
52 const int SMOOTH_CENTERING_TIME_MS = 1000;
54 MapEngine::MapEngine(QObject *parent)
56 m_autoCenteringEnabled(false),
57 m_scrollStartedByGps(false),
58 m_smoothScrollRunning(false),
60 m_zoomLevel(MAP_DEFAULT_ZOOM_LEVEL),
61 m_centerTile(QPoint(UNDEFINED, UNDEFINED)),
62 m_sceneCoordinate(SceneCoordinate(GeoCoordinate(MAP_DEFAULT_LATITUDE, MAP_DEFAULT_LONGITUDE))),
63 m_tilesGridSize(QSize(0, 0)),
64 m_viewSize(QSize(DEFAULT_SCREEN_WIDTH, DEFAULT_SCREEN_HEIGHT)),
67 qDebug() << __PRETTY_FUNCTION__;
69 m_mapScene = new MapScene(this);
71 m_mapFetcher = new MapFetcher(new NetworkAccessManager(this), this);
72 connect(this, SIGNAL(fetchImage(int, int, int)),
73 m_mapFetcher, SLOT(enqueueFetchMapImage(int, int, int)));
74 connect(m_mapFetcher, SIGNAL(mapImageReceived(int, int, int, QPixmap)),
75 this, SLOT(mapImageReceived(int, int, int, QPixmap)));
76 connect(m_mapFetcher, SIGNAL(error(int, int)),
77 this, SIGNAL(error(int, int)));
79 m_ownLocation = new OwnLocationItem();
80 m_ownLocation->hide(); // hide until first location info is received
81 m_mapScene->addItem(m_ownLocation);
83 m_gpsLocationItem = new GPSLocationItem();
84 m_mapScene->addItem(m_gpsLocationItem);
86 m_friendItemsHandler = new FriendItemsHandler(m_mapScene, this);
87 connect(this, SIGNAL(zoomLevelChanged(int)),
88 m_friendItemsHandler, SLOT(refactorFriendItems(int)));
90 connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
91 m_friendItemsHandler, SLOT(friendListUpdated(QList<User*>&)));
93 connect(this, SIGNAL(friendImageReady(User*)),
94 m_friendItemsHandler, SLOT(friendImageReady(User*)));
96 connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
97 this, SLOT(friendsPositionsUpdated()));
99 connect(m_friendItemsHandler, SIGNAL(locationItemClicked(QList<QString>)),
100 this, SIGNAL(locationItemClicked(QList<QString>)));
102 m_scroller = &MapScroller::getInstance();
104 connect(m_scroller, SIGNAL(coordinateUpdated(SceneCoordinate)),
105 this, SLOT(setCenterPosition(SceneCoordinate)));
107 connect(m_scroller, SIGNAL(stateChanged(QAbstractAnimation::State, QAbstractAnimation::State)),
108 this, SLOT(scrollerStateChanged(QAbstractAnimation::State)));
111 MapEngine::~MapEngine()
113 qDebug() << __PRETTY_FUNCTION__;
115 QSettings settings(DIRECTORY_NAME, FILE_NAME);
117 settings.setValue(MAP_LAST_POSITION, QVariant::fromValue(centerGeoCoordinate()));
118 settings.setValue(MAP_LAST_ZOOMLEVEL, m_zoomLevel);
121 QRect MapEngine::calculateTileGrid(SceneCoordinate coordinate)
123 qDebug() << __PRETTY_FUNCTION__;
125 QPoint tileCoordinate = convertSceneCoordinateToTileNumber(m_zoomLevel, coordinate);
128 topLeft.setX(tileCoordinate.x() - (m_tilesGridSize.width() / 2));
129 topLeft.setY(tileCoordinate.y() - (m_tilesGridSize.height() / 2));
131 return QRect(topLeft, m_tilesGridSize);
134 void MapEngine::centerAndZoomTo(QRect rect, bool useMargins)
136 qDebug() << __PRETTY_FUNCTION__;
138 int marginHorizontal = 0;
139 int marginVertical = 0;
142 marginHorizontal = 5;
146 // calculate the usable size of the view
147 int viewUsableHeight = m_viewSize.height() - 2 * marginVertical;
148 int viewUsableWidth = m_viewSize.width() - 2 * marginHorizontal;
150 // calculate how many levels must be zoomed out from the closest zoom level to get the rect
151 // fit inside the usable view area
153 while ((rect.height() > (viewUsableHeight * (1 << shift)))
154 || (rect.width() > (viewUsableWidth * (1 << shift)))) {
160 scrollToPosition(SceneCoordinate(double(rect.center().x()), double(rect.center().y())));
162 int zoomLevel = qBound(OSM_MIN_ZOOM_LEVEL, OSM_MAX_ZOOM_LEVEL - shift, OSM_MAX_ZOOM_LEVEL);
163 setZoomLevel(zoomLevel);
166 GeoCoordinate MapEngine::centerGeoCoordinate()
168 qDebug() << __PRETTY_FUNCTION__;
170 return GeoCoordinate(m_sceneCoordinate);
173 void MapEngine::centerToCoordinates(GeoCoordinate coordinate)
175 qDebug() << __PRETTY_FUNCTION__;
177 scrollToPosition(SceneCoordinate(coordinate));
180 void MapEngine::clearRoute()
182 qDebug() << __PRETTY_FUNCTION__;
184 if (m_mapRouteItem) {
185 m_mapScene->removeItem(m_mapRouteItem);
186 delete m_mapRouteItem;
191 QPoint MapEngine::convertSceneCoordinateToTileNumber(int zoomLevel, SceneCoordinate coordinate)
193 qDebug() << __PRETTY_FUNCTION__;
195 int pow = 1 << (OSM_MAX_ZOOM_LEVEL - zoomLevel);
196 int x = static_cast<int>(coordinate.x() / (OSM_TILE_SIZE_X * pow));
197 int y = static_cast<int>(coordinate.y() / (OSM_TILE_SIZE_Y * pow));
202 QRectF MapEngine::currentViewSceneRect() const
204 qDebug() << __PRETTY_FUNCTION__;
206 const QPoint ONE_PIXEL = QPoint(1, 1);
208 QGraphicsView *view = m_mapScene->views().first();
209 QPointF sceneTopLeft = view->mapToScene(0, 0);
210 QPoint viewBottomRight = QPoint(view->size().width(), view->size().height()) - ONE_PIXEL;
211 QPointF sceneBottomRight = view->mapToScene(viewBottomRight);
213 return QRectF(sceneTopLeft, sceneBottomRight);
216 void MapEngine::disableAutoCenteringIfRequired(SceneCoordinate coordinate)
218 if (isAutoCenteringEnabled()) {
219 int zoomFactor = (1 << (OSM_MAX_ZOOM_LEVEL - m_zoomLevel));
221 SceneCoordinate oldPixelValue(m_lastAutomaticPosition.x() / zoomFactor,
222 m_lastAutomaticPosition.y() / zoomFactor);
224 SceneCoordinate newPixelValue(coordinate.x() / zoomFactor,
225 coordinate.y() / zoomFactor);
227 if ((abs(oldPixelValue.x() - newPixelValue.x()) > AUTO_CENTERING_DISABLE_DISTANCE)
228 || (abs(oldPixelValue.y() - newPixelValue.y()) > AUTO_CENTERING_DISABLE_DISTANCE)) {
230 emit mapScrolledManually();
235 void MapEngine::friendsPositionsUpdated()
237 qDebug() << __PRETTY_FUNCTION__;
239 m_mapScene->spanItems(currentViewSceneRect());
242 void MapEngine::getTiles(SceneCoordinate coordinate)
244 qDebug() << __PRETTY_FUNCTION__;
246 m_viewTilesGrid = calculateTileGrid(coordinate);
247 updateViewTilesSceneRect();
248 m_mapScene->setTilesGrid(m_viewTilesGrid);
250 int topLeftX = m_viewTilesGrid.topLeft().x();
251 int topLeftY = m_viewTilesGrid.topLeft().y();
252 int bottomRightX = m_viewTilesGrid.bottomRight().x();
253 int bottomRightY = m_viewTilesGrid.bottomRight().y();
255 int tileMaxVal = MapTile::lastTileIndex(m_zoomLevel);
257 for (int x = topLeftX; x <= bottomRightX; ++x) {
258 for (int y = topLeftY; y <= bottomRightY; ++y) {
260 // map doesn't span in vertical direction, so y index must be inside the limits
261 if (y >= MAP_TILE_MIN_INDEX && y <= tileMaxVal) {
262 if (!m_mapScene->tileInScene(MapTile::tilePath(m_zoomLevel, x, y)))
263 emit fetchImage(m_zoomLevel, normalize(x, MAP_TILE_MIN_INDEX, tileMaxVal), y);
269 void MapEngine::gpsPositionUpdate(GeoCoordinate position, qreal accuracy)
271 qDebug() << __PRETTY_FUNCTION__;
273 m_gpsPosition = position;
275 // update GPS location item (but only if accuracy is a valid number)
276 if (!isnan(accuracy)) {
277 qreal resolution = MapScene::horizontalResolutionAtLatitude(position.latitude());
278 m_gpsLocationItem->updateItem(SceneCoordinate(position).toPointF(), accuracy, resolution);
281 m_mapScene->spanItems(currentViewSceneRect());
283 // do automatic centering (if enabled)
284 if (m_autoCenteringEnabled) {
285 m_lastAutomaticPosition = SceneCoordinate(position);
286 m_scrollStartedByGps = true;
287 scrollToPosition(m_lastAutomaticPosition);
290 updateDirectionIndicator();
293 void MapEngine::init()
295 qDebug() << __PRETTY_FUNCTION__;
297 QSettings settings(DIRECTORY_NAME, FILE_NAME);
299 // init can be only done if both values exists in the settings
300 if (settings.contains(MAP_LAST_POSITION) && settings.contains(MAP_LAST_ZOOMLEVEL)) {
301 QVariant zoomLevel = settings.value(MAP_LAST_ZOOMLEVEL);
302 QVariant location = settings.value(MAP_LAST_POSITION);
304 // also the init can be only done if we are able to convert variants into target data types
305 if (zoomLevel.canConvert<int>() && location.canConvert<GeoCoordinate>()) {
306 m_zoomLevel = zoomLevel.toInt();
307 m_sceneCoordinate = SceneCoordinate(location.value<GeoCoordinate>());
311 // emit zoom level and center coordinate so that all parts of the map system gets initialized
312 // NOTE: emit is also done even if we weren't able to read initial valuef from the settings
313 // so that the default values set in the constructor are used
314 emit zoomLevelChanged(m_zoomLevel);
315 scrollToPosition(m_sceneCoordinate);
318 bool MapEngine::isAutoCenteringEnabled()
320 return m_autoCenteringEnabled;
323 bool MapEngine::isCenterTileChanged(SceneCoordinate coordinate)
325 qDebug() << __PRETTY_FUNCTION__;
327 QPoint centerTile = convertSceneCoordinateToTileNumber(m_zoomLevel, coordinate);
328 QPoint temp = m_centerTile;
329 m_centerTile = centerTile;
331 return (centerTile != temp);
334 void MapEngine::mapImageReceived(int zoomLevel, int x, int y, const QPixmap &image)
336 qDebug() << __PRETTY_FUNCTION__;
338 // add normal tile inside the world
339 QPoint tileNumber(x, y);
340 m_mapScene->addTile(zoomLevel, tileNumber, image, m_zoomLevel);
342 // note: add 1 so odd width is rounded up and even is rounded down
343 int tilesGridWidthHalf = (m_viewTilesGrid.width() + 1) / 2;
345 // duplicate to east side? (don't need to duplicate over padding)
346 if (tileNumber.x() < (tilesGridWidthHalf - MAP_GRID_PADDING)) {
347 QPoint adjustedTileNumber(tileNumber.x() + MapTile::lastTileIndex(zoomLevel) + 1,
349 m_mapScene->addTile(zoomLevel, adjustedTileNumber, image, m_zoomLevel);
352 // duplicate to west side? (don't need to duplicate over padding)
353 if (tileNumber.x() > (MapTile::lastTileIndex(zoomLevel)
355 + MAP_GRID_PADDING)) {
356 QPoint adjustedTileNumber(tileNumber.x() - MapTile::lastTileIndex(zoomLevel) - 1,
358 m_mapScene->addTile(zoomLevel, adjustedTileNumber, image, m_zoomLevel);
362 int MapEngine::normalize(int value, int min, int max)
364 qDebug() << __PRETTY_FUNCTION__;
365 Q_ASSERT_X(max >= min, "parameters", "max can't be smaller than min");
368 value += max - min + 1;
371 value -= max - min + 1;
376 void MapEngine::receiveOwnLocation(User *user)
378 qDebug() << __PRETTY_FUNCTION__;
381 m_ownLocation->setPos(SceneCoordinate(user->coordinates()).toPointF());
382 if (!m_ownLocation->isVisible())
383 m_ownLocation->show();
385 m_ownLocation->hide();
388 m_mapScene->spanItems(currentViewSceneRect());
391 QGraphicsScene* MapEngine::scene()
393 qDebug() << __PRETTY_FUNCTION__;
398 void MapEngine::scrollerStateChanged(QAbstractAnimation::State newState)
400 qDebug() << __PRETTY_FUNCTION__;
402 if (m_smoothScrollRunning
403 && newState != QAbstractAnimation::Running) {
404 m_smoothScrollRunning = false;
406 // don't disable auto centering if current animation was stopped by new update from GPS
407 if (!m_scrollStartedByGps)
408 disableAutoCenteringIfRequired(m_sceneCoordinate);
411 m_scrollStartedByGps = false;
414 void MapEngine::scrollToPosition(SceneCoordinate coordinate)
416 qDebug() << __PRETTY_FUNCTION__;
419 m_scroller->setEasingCurve(QEasingCurve::InOutQuart);
420 m_scroller->setDuration(SMOOTH_CENTERING_TIME_MS);
421 m_scroller->setStartValue(m_sceneCoordinate);
422 m_scroller->setEndValue(coordinate);
423 m_smoothScrollRunning = true;
427 void MapEngine::setAutoCentering(bool enabled)
429 qDebug() << __PRETTY_FUNCTION__;
431 m_autoCenteringEnabled = enabled;
433 if (!m_autoCenteringEnabled && m_gpsLocationItem->isVisible())
434 updateDirectionIndicator();
437 void MapEngine::setCenterPosition(SceneCoordinate coordinate)
439 qDebug() << __PRETTY_FUNCTION__;
441 // jump to opposite side of the world if world horizontal limit is exceeded
442 coordinate.setX(normalize(coordinate.x(), OSM_MAP_MIN_PIXEL_X, OSM_MAP_MAX_PIXEL_X));
444 // don't allow vertical scene coordinates go out of the map
445 coordinate.setY(qBound(double(OSM_MAP_MIN_PIXEL_Y),
447 double(OSM_MAP_MAX_PIXEL_Y)));
449 if (!m_smoothScrollRunning)
450 disableAutoCenteringIfRequired(coordinate);
452 m_sceneCoordinate = coordinate;
453 emit locationChanged(m_sceneCoordinate);
455 if (isCenterTileChanged(coordinate)) {
456 getTiles(coordinate);
457 m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
460 m_mapScene->spanItems(currentViewSceneRect());
461 emit newMapResolution(viewResolution());
463 updateDirectionIndicator();
466 void MapEngine::setGPSEnabled(bool enabled)
468 qDebug() << __PRETTY_FUNCTION__;
470 m_gpsLocationItem->setEnabled(enabled);
473 void MapEngine::setRoute(Route &route)
475 qDebug() << __PRETTY_FUNCTION__;
479 m_mapRouteItem = new MapRouteItem(&route);
480 m_mapScene->addItem(m_mapRouteItem);
482 centerAndZoomTo(m_mapRouteItem->boundingRect().toRect());
485 void MapEngine::setZoomLevel(int newZoomLevel)
487 qDebug() << __PRETTY_FUNCTION__;
489 m_zoomLevel = newZoomLevel;
493 void MapEngine::setTilesGridSize(const QSize &viewSize)
495 qDebug() << __PRETTY_FUNCTION__;
497 // there must be scrolling reserve of at least half tile added to tile amount
498 // calculated from view size
499 const qreal SCROLLING_RESERVE = 0.5;
501 // converting scene tile to tile number does cause grid centering inaccuracy of one tile
502 const int CENTER_TILE_INACCURACY = 1;
504 int gridWidth = ceil(qreal(viewSize.width()) / OSM_TILE_SIZE_X + SCROLLING_RESERVE)
505 + CENTER_TILE_INACCURACY + (MAP_GRID_PADDING * 2);
506 int gridHeight = ceil(qreal(viewSize.height()) / OSM_TILE_SIZE_Y + SCROLLING_RESERVE)
507 + CENTER_TILE_INACCURACY + (MAP_GRID_PADDING * 2);
509 m_mapFetcher->setDownloadQueueSize(gridWidth * gridHeight);
511 m_tilesGridSize.setHeight(gridHeight);
512 m_tilesGridSize.setWidth(gridWidth);
515 void MapEngine::showMapArea(const GeoCoordinate &swBound, const GeoCoordinate &neBound)
517 qDebug() << __PRETTY_FUNCTION__;
520 area.setTopRight(SceneCoordinate(neBound).toPointF().toPoint());
521 area.setBottomLeft(SceneCoordinate(swBound).toPointF().toPoint());
523 centerAndZoomTo(area, false);
526 void MapEngine::updateDirectionIndicator()
528 qDebug() << __PRETTY_FUNCTION__;
530 qreal distance = m_gpsPosition.distanceTo(m_sceneCoordinate);
532 qreal direction = m_sceneCoordinate.azimuthTo(SceneCoordinate(m_gpsPosition));
534 // direction indicator triangle should be drawn only if the gps location item is not currently
535 // visible on the view
536 bool drawDirectionIndicatorTriangle = true;
537 if (currentViewSceneRect().contains(m_gpsLocationItem->pos()))
538 drawDirectionIndicatorTriangle = false;
540 emit directionIndicatorValuesUpdate(direction, distance, drawDirectionIndicatorTriangle);
543 void MapEngine::updateViewTilesSceneRect()
545 qDebug() << __PRETTY_FUNCTION__;
547 const QPoint ONE_TILE = QPoint(1, 1);
548 const double ONE_PIXEL = 1;
550 SceneCoordinate topLeft = MapTile::convertTileNumberToSceneCoordinate(m_zoomLevel,
551 m_viewTilesGrid.topLeft());
553 // one tile - one pixel is added because returned coordinates are pointing to upper left corner
555 SceneCoordinate bottomRight
556 = MapTile::convertTileNumberToSceneCoordinate(m_zoomLevel,
557 m_viewTilesGrid.bottomRight() + ONE_TILE);
558 bottomRight.setX(bottomRight.x() - ONE_PIXEL);
559 bottomRight.setY(bottomRight.y() - ONE_PIXEL);
561 m_mapScene->tilesSceneRectUpdated(QRect(topLeft.toPointF().toPoint(),
562 bottomRight.toPointF().toPoint()));
565 void MapEngine::viewResized(const QSize &size)
567 qDebug() << __PRETTY_FUNCTION__;
570 setTilesGridSize(m_viewSize);
572 emit locationChanged(m_sceneCoordinate);
573 getTiles(m_sceneCoordinate);
574 m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
575 m_mapScene->setSceneVerticalOverlap(m_viewSize.height(), m_zoomLevel);
578 qreal MapEngine::viewResolution()
580 qDebug() << __PRETTY_FUNCTION__;
582 qreal scale = (1 << (OSM_MAX_ZOOM_LEVEL - m_zoomLevel));
584 return MapScene::horizontalResolutionAtLatitude(centerGeoCoordinate().latitude()) * scale;
587 void MapEngine::viewZoomFinished()
589 qDebug() << __PRETTY_FUNCTION__;
591 updateDirectionIndicator();
595 m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
598 if (m_zoomLevel == OSM_MAX_ZOOM_LEVEL)
599 emit maxZoomLevelReached();
600 else if (m_zoomLevel == MAP_VIEW_MIN_ZOOM_LEVEL)
601 emit minZoomLevelReached();
604 void MapEngine::zoomed()
606 emit zoomLevelChanged(m_zoomLevel);
607 m_mapScene->setTilesDrawingLevels(m_zoomLevel);
608 m_mapScene->setZoomLevel(m_zoomLevel);
609 getTiles(m_sceneCoordinate);
610 m_mapScene->setSceneVerticalOverlap(m_viewSize.height(), m_zoomLevel);
611 m_mapScene->spanItems(currentViewSceneRect());
612 emit newMapResolution(viewResolution());
615 void MapEngine::zoomIn()
617 qDebug() << __PRETTY_FUNCTION__;
619 if (m_zoomLevel < OSM_MAX_ZOOM_LEVEL) {
626 void MapEngine::zoomOut()
628 qDebug() << __PRETTY_FUNCTION__;
630 if (m_zoomLevel > MAP_VIEW_MIN_ZOOM_LEVEL) {