Adding comments
[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        Pekka Nissinen - pekka.nissinen@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 MAPVIEW_H
24 #define MAPVIEW_H
25
26 #include <QGraphicsView>
27 #include <QTime>
28
29 #include "coordinates/scenecoordinate.h"
30
31 class QPropertyAnimation;
32 class QParallelAnimationGroup;
33
34 class MapScroller;
35
36 #define VALUES 4
37
38 /**
39 * @brief Map view widget
40 *
41 * @author Sami Rämö - sami.ramo (at) ixonos.com
42 * @author Pekka Nissinen - pekka.nissinen (at) ixonos.com
43 */
44 class MapView : public QGraphicsView
45 {
46     Q_OBJECT
47
48     /**
49     * @brief View scaling
50     *
51     * @property viewScale
52     */
53     Q_PROPERTY(qreal viewScale READ viewScale WRITE setViewScale)
54
55 public:
56     /**
57     * @brief Constructor
58     *
59     * @param parent Parent
60     */
61     MapView(QWidget *parent = 0);
62
63     /**
64     * @brief Destructor.
65     *
66     * Takes MapScroller animation from double click zoom animation group and
67     * deletes animation group.
68     */
69     ~MapView();
70
71 /*******************************************************************************
72  * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
73  ******************************************************************************/
74 protected:
75     /**
76     * @brief Called when view is resized.
77     *
78     * @param event resize event
79     */
80     void resizeEvent(QResizeEvent *event);
81
82 private:
83     /**
84     * @brief Event handler for mouse double click event
85     *
86     * Emits zoomIn signal.
87     * @param event QMouseEvent
88     */
89     void mouseDoubleClickEvent(QMouseEvent *event);
90
91     /**
92     * @brief Event handler for mouse move events
93     *
94     * Does calculate mouse movement delta from last event position and new view center
95     * based on that delta. Saves current event position for next round. Emits viewScrolled
96     * signal and doesn't actually scroll the view.
97     *
98     * Saves mouse movement deltas and durations for last few move events to be used for
99     * calculating the kinetic scrolling speed.
100     *
101     * @param event Mouse event
102     */
103     void mouseMoveEvent(QMouseEvent *event);
104
105     /**
106     * @brief Event handler for mouse press events
107     *
108     * Saves inial values for mouse and scene location for dragging the view. Does stop currently
109     * running kinetic scroll effect.
110     *
111     * @param event Mouse event
112     */
113     void mousePressEvent(QMouseEvent *event);
114
115     /**
116     * @brief Event handler for mouse release events
117     *
118     * Set up and start kinetic scrolling effect if time elapsed from last mouseMoveEvent is below
119     * the limit and drag length is over the limit.
120     *
121     * Kinetic scroll distance is calculated based on mouse movement event values saved in
122     * mouseMoveEvent(). The distance is also limited so that map doesn't run too far.
123     *
124     * @param event Mouse event
125     */
126     void mouseReleaseEvent(QMouseEvent *event);
127
128 /*******************************************************************************
129  * MEMBER FUNCTIONS AND SLOTS
130  ******************************************************************************/
131 public slots:
132     /**
133     * @brief Slot for centering view to new location
134     *
135     * Does also shift the center point horizontally, if required.
136     *
137     * @param coordinate Scene coordinates of the new center point
138     * @param isUserDragAction True if caused by user dragging action. Does not shift the center
139     *                         point if true.
140     */
141     void centerToSceneCoordinates(const SceneCoordinate &coordinate, bool isUserDragAction = false);
142
143     /**
144     * @brief Set zoom level of the view
145     *
146     * @param zoomLevel Zoom level
147     */
148     void setZoomLevel(int zoomLevel);
149
150 private slots:
151     /**
152     * @brief Disables shifting of the center point
153     */
154     void disableCenterShift();
155
156     /**
157     * @brief Double tap zoom finished.
158     *
159     * Disables double tap zoom flag and emits zoomIn signal.
160     */
161     void doubleTapZoomFinished();
162
163     /**
164     * @brief Enables shifting of the center point
165     */
166     void enableCenterShift();
167
168 private:
169     /**
170     * @brief Set new view scale
171     *
172     * @param viewScale New scaling factor
173     */
174     void setViewScale(qreal viewScale);
175
176     /**
177     * @brief Toggles the shifting of the center point
178     *
179     * @param enabled True if shifting is enabled
180     */
181     void toggleCenterShift(bool enabled);
182
183     /**
184     * @brief Update center shifting value
185     */
186     void updateCenterShift();
187
188     /**
189     * @brief Get current view scale
190     *
191     * @return Current view scaling factor
192     */
193     qreal viewScale();
194
195 /*******************************************************************************
196  * SIGNALS
197  ******************************************************************************/
198 signals:
199     /**
200     * @brief Signal for view resize events.
201     *
202     * Signal is emitted when view has been resized.
203     * @param size view size
204     */
205     void viewResized(const QSize &size);
206
207     /**
208     * @brief Signal for view scroll events
209     *
210     * Signal is emitted when view is scrolled.
211     * @param coordinate Scene coordinates of the new center point of the view
212     * @param isUserDragAction True if caused by user dragging action
213     */
214     void viewScrolled(const SceneCoordinate &coordinate, bool isUserDragAction);
215
216     /**
217     * @brief Signal for informing that zooming animation is finished
218     */
219     void viewZoomFinished();
220
221     /**
222     * @brief Signal for informing that double click zoom is finished
223     */
224     void zoomIn();
225
226 /*******************************************************************************
227  * DATA MEMBERS
228  ******************************************************************************/
229 private:
230     bool m_centerShiftEnabled;            ///< Is the center point shifting enabled?
231     bool m_doubleTapZoomRunning;          ///< Double tap zoom running flag
232
233     int m_dragTime[VALUES];               ///< Table of mouse event durations
234     int m_index;                          ///< Index of mouse event values tables
235     int m_zoomLevel;                      ///< Current zoom level
236
237     qreal m_kineticMaxViewDistance;       ///< Maximum kinetic scroll distance in view pixels
238
239     QPoint m_dragMovement[VALUES];        ///< Table of mouse event distances
240     QPoint m_internalScenePosition;       ///< New center position
241     QPoint m_lastMouseEventScenePosition; ///< Previous mouse event position in the scene
242     QPoint m_lastMouseEventViewPosition;  ///< Previous mouse event position in the view
243
244     QPointF m_centerHorizontalShift;      ///< Current amount of center point shifting
245
246     QParallelAnimationGroup *m_scrollAndZoomAnimation;  ///< Double click zoom animation
247     QPropertyAnimation *m_zoomAnimation;  ///< Zoom animation
248
249     QTime m_time;                         ///< Elapsed times in mouse events
250
251     MapScroller *m_scroller;                    ///< Kinetic scroller
252     SceneCoordinate m_lastSetScenePosition;     ///< Last center point coordinate set by MapEngine
253 };
254
255 #endif // MAPVIEW_H