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)
136 const int MARGIN_HORIZONTAL = 50;
137 const int MARGIN_VERTICAL = 5;
139 // calculate the usable size of the view
140 int viewUsableHeight = m_viewSize.height() - 2 * MARGIN_VERTICAL;
141 int viewUsableWidth = m_viewSize.width() - 2 * MARGIN_HORIZONTAL;
143 // calculate how many levels must be zoomed out from the closest zoom level to get the rect
144 // fit inside the usable view area
146 while ((rect.height() > (viewUsableHeight * (1 << shift)))
147 || (rect.width() > (viewUsableWidth * (1 << shift)))) {
153 scrollToPosition(SceneCoordinate(double(rect.center().x()), double(rect.center().y())));
155 int zoomLevel = qBound(OSM_MIN_ZOOM_LEVEL, OSM_MAX_ZOOM_LEVEL - shift, OSM_MAX_ZOOM_LEVEL);
156 setZoomLevel(zoomLevel);
159 GeoCoordinate MapEngine::centerGeoCoordinate()
161 qDebug() << __PRETTY_FUNCTION__;
163 return GeoCoordinate(m_sceneCoordinate);
166 void MapEngine::centerToCoordinates(GeoCoordinate coordinate)
168 qDebug() << __PRETTY_FUNCTION__;
170 scrollToPosition(SceneCoordinate(coordinate));
173 QPoint MapEngine::convertSceneCoordinateToTileNumber(int zoomLevel, SceneCoordinate coordinate)
175 qDebug() << __PRETTY_FUNCTION__;
177 int pow = 1 << (OSM_MAX_ZOOM_LEVEL - zoomLevel);
178 int x = static_cast<int>(coordinate.x() / (OSM_TILE_SIZE_X * pow));
179 int y = static_cast<int>(coordinate.y() / (OSM_TILE_SIZE_Y * pow));
184 QRectF MapEngine::currentViewSceneRect() const
186 qDebug() << __PRETTY_FUNCTION__;
188 const QPoint ONE_PIXEL = QPoint(1, 1);
190 QGraphicsView *view = m_mapScene->views().first();
191 QPointF sceneTopLeft = view->mapToScene(0, 0);
192 QPoint viewBottomRight = QPoint(view->size().width(), view->size().height()) - ONE_PIXEL;
193 QPointF sceneBottomRight = view->mapToScene(viewBottomRight);
195 return QRectF(sceneTopLeft, sceneBottomRight);
198 void MapEngine::disableAutoCenteringIfRequired(SceneCoordinate coordinate)
200 if (isAutoCenteringEnabled()) {
201 int zoomFactor = (1 << (OSM_MAX_ZOOM_LEVEL - m_zoomLevel));
203 SceneCoordinate oldPixelValue(m_lastAutomaticPosition.x() / zoomFactor,
204 m_lastAutomaticPosition.y() / zoomFactor);
206 SceneCoordinate newPixelValue(coordinate.x() / zoomFactor,
207 coordinate.y() / zoomFactor);
209 if ((abs(oldPixelValue.x() - newPixelValue.x()) > AUTO_CENTERING_DISABLE_DISTANCE)
210 || (abs(oldPixelValue.y() - newPixelValue.y()) > AUTO_CENTERING_DISABLE_DISTANCE)) {
212 emit mapScrolledManually();
217 void MapEngine::friendsPositionsUpdated()
219 qDebug() << __PRETTY_FUNCTION__;
221 m_mapScene->spanItems(currentViewSceneRect());
224 void MapEngine::getTiles(SceneCoordinate coordinate)
226 qDebug() << __PRETTY_FUNCTION__;
228 m_viewTilesGrid = calculateTileGrid(coordinate);
229 updateViewTilesSceneRect();
230 m_mapScene->setTilesGrid(m_viewTilesGrid);
232 int topLeftX = m_viewTilesGrid.topLeft().x();
233 int topLeftY = m_viewTilesGrid.topLeft().y();
234 int bottomRightX = m_viewTilesGrid.bottomRight().x();
235 int bottomRightY = m_viewTilesGrid.bottomRight().y();
237 int tileMaxVal = MapTile::lastTileIndex(m_zoomLevel);
239 for (int x = topLeftX; x <= bottomRightX; ++x) {
240 for (int y = topLeftY; y <= bottomRightY; ++y) {
242 // map doesn't span in vertical direction, so y index must be inside the limits
243 if (y >= MAP_TILE_MIN_INDEX && y <= tileMaxVal) {
244 if (!m_mapScene->tileInScene(MapTile::tilePath(m_zoomLevel, x, y)))
245 emit fetchImage(m_zoomLevel, normalize(x, MAP_TILE_MIN_INDEX, tileMaxVal), y);
251 void MapEngine::gpsPositionUpdate(GeoCoordinate position, qreal accuracy)
253 qDebug() << __PRETTY_FUNCTION__;
255 m_gpsPosition = position;
257 // update GPS location item (but only if accuracy is a valid number)
258 if (!isnan(accuracy)) {
259 qreal resolution = MapScene::horizontalResolutionAtLatitude(position.latitude());
260 m_gpsLocationItem->updateItem(SceneCoordinate(position).toPointF(), accuracy, resolution);
263 m_mapScene->spanItems(currentViewSceneRect());
265 // do automatic centering (if enabled)
266 if (m_autoCenteringEnabled) {
267 m_lastAutomaticPosition = SceneCoordinate(position);
268 m_scrollStartedByGps = true;
269 scrollToPosition(m_lastAutomaticPosition);
272 updateDirectionIndicator();
275 void MapEngine::init()
277 qDebug() << __PRETTY_FUNCTION__;
279 QSettings settings(DIRECTORY_NAME, FILE_NAME);
281 // init can be only done if both values exists in the settings
282 if (settings.contains(MAP_LAST_POSITION) && settings.contains(MAP_LAST_ZOOMLEVEL)) {
283 QVariant zoomLevel = settings.value(MAP_LAST_ZOOMLEVEL);
284 QVariant location = settings.value(MAP_LAST_POSITION);
286 // also the init can be only done if we are able to convert variants into target data types
287 if (zoomLevel.canConvert<int>() && location.canConvert<GeoCoordinate>()) {
288 m_zoomLevel = zoomLevel.toInt();
289 m_sceneCoordinate = SceneCoordinate(location.value<GeoCoordinate>());
293 // emit zoom level and center coordinate so that all parts of the map system gets initialized
294 // NOTE: emit is also done even if we weren't able to read initial valuef from the settings
295 // so that the default values set in the constructor are used
296 emit zoomLevelChanged(m_zoomLevel);
297 scrollToPosition(m_sceneCoordinate);
300 bool MapEngine::isAutoCenteringEnabled()
302 return m_autoCenteringEnabled;
305 bool MapEngine::isCenterTileChanged(SceneCoordinate coordinate)
307 qDebug() << __PRETTY_FUNCTION__;
309 QPoint centerTile = convertSceneCoordinateToTileNumber(m_zoomLevel, coordinate);
310 QPoint temp = m_centerTile;
311 m_centerTile = centerTile;
313 return (centerTile != temp);
316 void MapEngine::mapImageReceived(int zoomLevel, int x, int y, const QPixmap &image)
318 qDebug() << __PRETTY_FUNCTION__;
320 // add normal tile inside the world
321 QPoint tileNumber(x, y);
322 m_mapScene->addTile(zoomLevel, tileNumber, image, m_zoomLevel);
324 // note: add 1 so odd width is rounded up and even is rounded down
325 int tilesGridWidthHalf = (m_viewTilesGrid.width() + 1) / 2;
327 // duplicate to east side? (don't need to duplicate over padding)
328 if (tileNumber.x() < (tilesGridWidthHalf - MAP_GRID_PADDING)) {
329 QPoint adjustedTileNumber(tileNumber.x() + MapTile::lastTileIndex(zoomLevel) + 1,
331 m_mapScene->addTile(zoomLevel, adjustedTileNumber, image, m_zoomLevel);
334 // duplicate to west side? (don't need to duplicate over padding)
335 if (tileNumber.x() > (MapTile::lastTileIndex(zoomLevel)
337 + MAP_GRID_PADDING)) {
338 QPoint adjustedTileNumber(tileNumber.x() - MapTile::lastTileIndex(zoomLevel) - 1,
340 m_mapScene->addTile(zoomLevel, adjustedTileNumber, image, m_zoomLevel);
344 int MapEngine::normalize(int value, int min, int max)
346 qDebug() << __PRETTY_FUNCTION__;
347 Q_ASSERT_X(max >= min, "parameters", "max can't be smaller than min");
350 value += max - min + 1;
353 value -= max - min + 1;
358 void MapEngine::receiveOwnLocation(User *user)
360 qDebug() << __PRETTY_FUNCTION__;
363 m_ownLocation->setPos(SceneCoordinate(user->coordinates()).toPointF());
364 if (!m_ownLocation->isVisible())
365 m_ownLocation->show();
367 m_ownLocation->hide();
370 m_mapScene->spanItems(currentViewSceneRect());
373 QGraphicsScene* MapEngine::scene()
375 qDebug() << __PRETTY_FUNCTION__;
380 void MapEngine::scrollerStateChanged(QAbstractAnimation::State newState)
382 qDebug() << __PRETTY_FUNCTION__;
384 if (m_smoothScrollRunning
385 && newState != QAbstractAnimation::Running) {
386 m_smoothScrollRunning = false;
388 // don't disable auto centering if current animation was stopped by new update from GPS
389 if (!m_scrollStartedByGps)
390 disableAutoCenteringIfRequired(m_sceneCoordinate);
393 m_scrollStartedByGps = false;
396 void MapEngine::scrollToPosition(SceneCoordinate coordinate)
398 qDebug() << __PRETTY_FUNCTION__;
401 m_scroller->setEasingCurve(QEasingCurve::InOutQuart);
402 m_scroller->setDuration(SMOOTH_CENTERING_TIME_MS);
403 m_scroller->setStartValue(m_sceneCoordinate);
404 m_scroller->setEndValue(coordinate);
405 m_smoothScrollRunning = true;
409 void MapEngine::setAutoCentering(bool enabled)
411 qDebug() << __PRETTY_FUNCTION__;
413 m_autoCenteringEnabled = enabled;
415 if (!m_autoCenteringEnabled && m_gpsLocationItem->isVisible())
416 updateDirectionIndicator();
419 void MapEngine::setCenterPosition(SceneCoordinate coordinate)
421 qDebug() << __PRETTY_FUNCTION__;
423 // jump to opposite side of the world if world horizontal limit is exceeded
424 coordinate.setX(normalize(coordinate.x(), OSM_MAP_MIN_PIXEL_X, OSM_MAP_MAX_PIXEL_X));
426 // don't allow vertical scene coordinates go out of the map
427 coordinate.setY(qBound(double(OSM_MAP_MIN_PIXEL_Y),
429 double(OSM_MAP_MAX_PIXEL_Y)));
431 if (!m_smoothScrollRunning)
432 disableAutoCenteringIfRequired(coordinate);
434 m_sceneCoordinate = coordinate;
435 emit locationChanged(m_sceneCoordinate);
437 if (isCenterTileChanged(coordinate)) {
438 getTiles(coordinate);
439 m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
442 m_mapScene->spanItems(currentViewSceneRect());
443 emit newMapResolution(viewResolution());
445 updateDirectionIndicator();
448 void MapEngine::setGPSEnabled(bool enabled)
450 qDebug() << __PRETTY_FUNCTION__;
452 m_gpsLocationItem->setEnabled(enabled);
455 void MapEngine::setRoute(Route &route)
457 qDebug() << __PRETTY_FUNCTION__;
461 // delete old route track (if exists)
462 if (m_mapRouteItem) {
463 m_mapScene->removeItem(m_mapRouteItem);
464 delete m_mapRouteItem;
468 // create new route track
469 m_mapRouteItem = new MapRouteItem(&m_route);
470 m_mapScene->addItem(m_mapRouteItem);
472 centerAndZoomTo(m_mapRouteItem->boundingRect().toRect());
475 void MapEngine::setZoomLevel(int newZoomLevel)
477 qDebug() << __PRETTY_FUNCTION__;
479 m_zoomLevel = newZoomLevel;
483 void MapEngine::setTilesGridSize(const QSize &viewSize)
485 qDebug() << __PRETTY_FUNCTION__;
487 // there must be scrolling reserve of at least half tile added to tile amount
488 // calculated from view size
489 const qreal SCROLLING_RESERVE = 0.5;
491 // converting scene tile to tile number does cause grid centering inaccuracy of one tile
492 const int CENTER_TILE_INACCURACY = 1;
494 int gridWidth = ceil(qreal(viewSize.width()) / OSM_TILE_SIZE_X + SCROLLING_RESERVE)
495 + CENTER_TILE_INACCURACY + (MAP_GRID_PADDING * 2);
496 int gridHeight = ceil(qreal(viewSize.height()) / OSM_TILE_SIZE_Y + SCROLLING_RESERVE)
497 + CENTER_TILE_INACCURACY + (MAP_GRID_PADDING * 2);
499 m_mapFetcher->setDownloadQueueSize(gridWidth * gridHeight);
501 m_tilesGridSize.setHeight(gridHeight);
502 m_tilesGridSize.setWidth(gridWidth);
505 void MapEngine::updateDirectionIndicator()
507 qDebug() << __PRETTY_FUNCTION__;
509 qreal distance = m_gpsPosition.distanceTo(m_sceneCoordinate);
511 qreal direction = m_sceneCoordinate.azimuthTo(SceneCoordinate(m_gpsPosition));
513 // direction indicator triangle should be drawn only if the gps location item is not currently
514 // visible on the view
515 bool drawDirectionIndicatorTriangle = true;
516 if (currentViewSceneRect().contains(m_gpsLocationItem->pos()))
517 drawDirectionIndicatorTriangle = false;
519 emit directionIndicatorValuesUpdate(direction, distance, drawDirectionIndicatorTriangle);
522 void MapEngine::updateViewTilesSceneRect()
524 qDebug() << __PRETTY_FUNCTION__;
526 const QPoint ONE_TILE = QPoint(1, 1);
527 const double ONE_PIXEL = 1;
529 SceneCoordinate topLeft = MapTile::convertTileNumberToSceneCoordinate(m_zoomLevel,
530 m_viewTilesGrid.topLeft());
532 // one tile - one pixel is added because returned coordinates are pointing to upper left corner
534 SceneCoordinate bottomRight
535 = MapTile::convertTileNumberToSceneCoordinate(m_zoomLevel,
536 m_viewTilesGrid.bottomRight() + ONE_TILE);
537 bottomRight.setX(bottomRight.x() - ONE_PIXEL);
538 bottomRight.setY(bottomRight.y() - ONE_PIXEL);
540 m_mapScene->tilesSceneRectUpdated(QRect(topLeft.toPointF().toPoint(),
541 bottomRight.toPointF().toPoint()));
544 void MapEngine::viewResized(const QSize &size)
546 qDebug() << __PRETTY_FUNCTION__;
549 setTilesGridSize(m_viewSize);
551 emit locationChanged(m_sceneCoordinate);
552 getTiles(m_sceneCoordinate);
553 m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
554 m_mapScene->setSceneVerticalOverlap(m_viewSize.height(), m_zoomLevel);
557 qreal MapEngine::viewResolution()
559 qDebug() << __PRETTY_FUNCTION__;
561 qreal scale = (1 << (OSM_MAX_ZOOM_LEVEL - m_zoomLevel));
563 return MapScene::horizontalResolutionAtLatitude(centerGeoCoordinate().latitude()) * scale;
566 void MapEngine::viewZoomFinished()
568 qDebug() << __PRETTY_FUNCTION__;
570 updateDirectionIndicator();
574 m_mapScene->removeOutOfViewTiles(m_viewTilesGrid, m_zoomLevel);
577 if (m_zoomLevel == OSM_MAX_ZOOM_LEVEL)
578 emit maxZoomLevelReached();
579 else if (m_zoomLevel == MAP_VIEW_MIN_ZOOM_LEVEL)
580 emit minZoomLevelReached();
583 void MapEngine::zoomed()
585 emit zoomLevelChanged(m_zoomLevel);
586 m_mapScene->setTilesDrawingLevels(m_zoomLevel);
587 m_mapScene->setZoomLevel(m_zoomLevel);
588 getTiles(m_sceneCoordinate);
589 m_mapScene->setSceneVerticalOverlap(m_viewSize.height(), m_zoomLevel);
590 m_mapScene->spanItems(currentViewSceneRect());
591 emit newMapResolution(viewResolution());
594 void MapEngine::zoomIn()
596 qDebug() << __PRETTY_FUNCTION__;
598 if (m_zoomLevel < OSM_MAX_ZOOM_LEVEL) {
605 void MapEngine::zoomOut()
607 qDebug() << __PRETTY_FUNCTION__;
609 if (m_zoomLevel > MAP_VIEW_MIN_ZOOM_LEVEL) {