Added OpenStreetMaps license text feature
[situare] / src / map / mapview.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
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 MAPVIEW_H
23 #define MAPVIEW_H
24
25 #include <QGraphicsView>
26 #include <QPropertyAnimation>
27
28 /**
29 * @brief Map view widget
30 *
31 * @author Sami Rämö - sami.ramo (at) ixonos.com
32 */
33 class MapView : public QGraphicsView
34 {
35     Q_OBJECT
36
37     /**
38     * @brief View scaling
39     *
40     * @property viewScale
41     */
42     Q_PROPERTY(qreal viewScale READ viewScale WRITE setViewScale)
43
44 public:
45     /**
46     * @brief Constructor
47     *
48     * @param parent Parent
49     */
50     MapView(QWidget *parent = 0);
51
52 /*******************************************************************************
53  * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
54  ******************************************************************************/
55 protected:
56     /**
57     * @brief Called when view is resized.
58     *
59     * @param event resize event
60     */
61     void resizeEvent(QResizeEvent *event);
62
63     /**
64     * @brief Called when view is displayed.
65     *
66     * @param event show event
67     */
68     void showEvent(QShowEvent *event);
69
70 private:
71     /**
72     * @brief Event handler for mouse move events
73     *
74     * Does calculate mouse movement delta from last event position and new view center
75     * based on that delta. Saves current event position for next round. Emits viewScrolled
76     * signal and doesn't actually scroll the view.
77     * @param event Mouse event
78     */
79     void mouseMoveEvent(QMouseEvent *event);
80
81     /**
82     * @brief Event handler for mouse press events
83     *
84     * Saves inial values for mouse and scene location for dragging view.
85     * @param event Mouse event
86     */
87     void mousePressEvent(QMouseEvent *event);
88
89 /*******************************************************************************
90  * MEMBER FUNCTIONS AND SLOTS
91  ******************************************************************************/
92 public slots:
93     /**
94     * @brief Slot for centering view to new location
95     *
96     * @param sceneCoordinate Scene coordinates of the new center point
97     */
98     void centerToSceneCoordinates(QPoint sceneCoordinate);
99
100     /**
101     * @brief Set zoom level of the view
102     *
103     * @param zoomLevel Zoom level
104     */
105     void setZoomLevel(int zoomLevel);
106
107 private:
108     /**
109     * @brief Set new view scale
110     *
111     * @param viewScale New scaling factor
112     */
113     void setViewScale(qreal viewScale);
114
115     /**
116     * @brief Get current view scale
117     *
118     * @return Current view scaling factor
119     */
120     qreal viewScale();
121
122 /*******************************************************************************
123  * SIGNALS
124  ******************************************************************************/
125 signals:
126     /**
127     * @brief Signal for view resize events.
128     *
129     * Signal is emitted when view has been resized.
130     * @param size view size
131     */
132     void viewResized(const QSize &size);
133
134     /**
135     * @brief Signal for view scroll events
136     *
137     * Signal is emitted when view is scrolled.
138     * @param sceneCoordinate Scene coordinates of the new center point of the view
139     */
140     void viewScrolled(QPoint sceneCoordinate);
141
142     /**
143     * @brief Signal for informing that zooming animation is finished
144     *
145     */
146     void viewZoomFinished();
147
148     /**
149     * @brief Signal for updating view content
150     *
151     * Signal is emitted when view content needs an update.
152     * @param viewTopLeft Scene coordinate of the viewport top left corner
153     */
154     void viewContentChanged(QPoint viewTopLeft);
155
156     /**
157     * @brief Signal for drawing OSM license
158     *
159     * Signal is emitted when view is resized.
160     * @param width Viewport width
161     * @param height Viewport height
162     */
163     void viewResizedNewSize(int width, int height);
164
165 /*******************************************************************************
166  * DATA MEMBERS
167  ******************************************************************************/
168 private:
169     QPoint m_mousePosition; ///< Previous mouse event position
170     QPoint m_scenePosition; ///< New center position
171     QPropertyAnimation *m_zoomAnimation; ///< Zoom animation
172 };
173
174 #endif // MAPVIEW_H