Modified mapfetcher.cpp and mapfetcher.h files.
[situare] / src / map / mapengine.h
1 /*
2    Situare - A location system for Facebook
3    Copyright (C) 2010  Ixonos Plc. Authors:
4
5        Jussi Laitinen - jussi.laitinen@ixonos.com
6
7    Situare is free software; you can redistribute it and/or
8    modify it under the terms of the GNU General Public License
9    version 2 as published by the Free Software Foundation.
10
11    Situare is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with Situare; if not, write to the Free Software
18    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
19    USA.
20 */
21
22 #ifndef MAPENGINE_H
23 #define MAPENGINE_H
24
25 #include <QtCore>
26
27
28 /**
29 * @brief MapEngine controls Map.
30 *
31 * @class MapEngine mapengine.h "map/mapengine.h"
32 */
33 class MapEngine : public QObject
34 {
35     Q_OBJECT
36
37 public:
38     /**
39     * @brief Constructor for the MapEngine.
40     *
41     * @fn MapEngine
42     * @param parent QObject
43     */
44     MapEngine(QObject *parent = 0);
45
46     /**
47     * @brief Transforms coordinates to tile x,y values.
48     *
49     * @fn latLonToTile
50     * @param latitude latitude value
51     * @param longitude longitude value
52     * @param zoom zoom level
53     * @return QPoint tile x,y
54     */
55     QPoint latLonToTile(qreal latitude, qreal longitude, int zoom);
56
57     /**
58     * @brief Transforms tile x value to longitude.
59     *
60     * @fn tileXToLongitude
61     * @param x tile x value
62     * @param zoom zoom value
63     * @return qreal longitude
64     */
65     qreal tileXToLongitude(int x, int zoom);
66
67     /**
68     * @brief Transforms tile y value to latitude.
69     *
70     * @fn tileYToLatitude
71     * @param y tile y value
72     * @param zoom zoom value
73     * @return qreal latitude
74     */
75     qreal tileYToLatitude(int y, int zoom);
76 };
77
78 #endif // MAPENGINE_H