Changed comment block style
[situare] / src / map / mapengine.h
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
8    Situare is free software; you can redistribute it and/or
9    modify it under the terms of the GNU General Public License
10    version 2 as published by the Free Software Foundation.
11
12    Situare is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with Situare; if not, write to the Free Software
19    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
20    USA.
21 */
22
23 #ifndef MAPENGINE_H
24 #define MAPENGINE_H
25
26 #include <math.h>
27
28 #include <QtCore>
29
30 #include "mapfetcher.h"
31 #include "mapscene.h"
32 #include "mapview.h"
33
34 /**
35 * @brief Map engine
36 *
37 * Logic for controlling map functionality. Does also include static methods for
38 * converting coordinates.
39 * @author Sami Rämö - sami.ramo (at) ixonos.com
40 */
41 class MapEngine : public QObject
42 {
43     Q_OBJECT
44 public:
45     /**
46     * @brief Constructor
47     *
48     * Does create and add scene to map view.
49     * @param mapView View for map
50     * @param parent Parent
51     */
52     MapEngine(MapView *mapView, QWidget *parent = 0);
53     
54     /**
55     * @brief Convert tile x & y numbers to MapScene coordinates
56     *
57     * @param zoomLevel Zoom level
58     * @param tileNumber x & y numbers of the tile
59     * @return QPoint MapScene coordinate
60     */
61     static QPoint convertTileNumberToSceneCoordinate(int zoomLevel, QPoint tileNumber)
62     {
63         int x = tileNumber.x() * TILE_SIZE_X * pow(2, MAX_ZOOM_LEVEL - zoomLevel);
64         int y = tileNumber.y() * TILE_SIZE_Y * pow(2, MAX_ZOOM_LEVEL - zoomLevel);
65
66         return QPoint(x, y);
67     }
68
69     /**
70     * @brief Set view location
71     *
72     * @param latLonCoordinate Latitude & longitude coordinates for location
73     */
74     void setViewLocation(QPointF latLonCoordinate);
75
76     QPoint latLonToTile(qreal latitude, qreal longitude, int zoom);
77
78     /**
79     * @brief Transforms tile x value to longitude.
80     *
81     * @param x tile x value
82     * @param zoom zoom value
83     * @return qreal longitude
84     */
85     qreal tileXToLongitude(int x, int zoom);
86
87     /**
88     * @brief Transforms tile y value to latitude.
89     *
90     * @param y tile y value
91     * @param zoom zoom value
92     * @return qreal latitude
93     */
94     qreal tileYToLatitude(int y, int zoom);
95
96 private slots:
97     /**
98     * @brief Slot for received map tile images
99     *
100     * Does add MapTile objects to MapScene. Zoom level and location is parsed from URL.
101     * @param url URL of the received image
102     * @param pixmap Received pixmap
103     */
104     void mapImageReceived(const QUrl &url, const QPixmap &pixmap);
105
106 public:
107     static const int TILE_SIZE_X = 256; ///< Tile image size in x direction
108     static const int TILE_SIZE_Y = 256; ///< Tile image size in y direction
109     static const int MIN_ZOOM_LEVEL = 0; ///< Minimum zoom level
110     static const int MAX_ZOOM_LEVEL = 18; ///< Maximum zoom level
111
112 private:
113     MapView *m_mapView; ///< View for viewing map
114     MapScene *m_mapScene; ///< Scene for map tiles
115     MapFetcher *m_mapFetcher; ///< Fetcher for map tiles
116     int m_zoomLevel; ///< Current zoom level
117 };
118
119 #endif // MAPENGINE_H