Zoom animation & min level change, queued stacked tiles removal
[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     Q_PROPERTY(qreal viewScale READ viewScale WRITE setViewScale)
38
39 public:
40     /**
41     * @brief Constructor
42     *
43     * @param parent Parent
44     */
45     MapView(QWidget *parent = 0);
46
47 /*******************************************************************************
48  * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
49  ******************************************************************************/
50 protected:
51     /**
52     * @brief Called when view is resized.
53     *
54     * @param event resize event
55     */
56     void resizeEvent(QResizeEvent *event);
57
58 private:
59     /**
60     * @brief Event handler for mouse move events
61     *
62     * Does calculate mouse movement delta from last event position and new view center
63     * based on that delta. Saves current event position for next round. Emits viewScrolled
64     * signal and doesn't actually scroll the view.
65     * @param event Mouse event
66     */
67     void mouseMoveEvent(QMouseEvent *event);
68
69     /**
70     * @brief Event handler for mouse press events
71     *
72     * Saves inial values for mouse and scene location for dragging view.
73     * @param event Mouse event
74     */
75     void mousePressEvent(QMouseEvent *event);
76
77     /**
78     * @brief Event handler for timer events, used for smooth zoom effect
79     *
80     * @param event
81     */
82     void timerEvent(QTimerEvent *event);
83
84 /*******************************************************************************
85  * MEMBER FUNCTIONS AND SLOTS
86  ******************************************************************************/
87 public slots:
88     /**
89     * @brief Slot for centering view to new location
90     *
91     * @param sceneCoordinate Scene coordinates of the new center point
92     */
93     void centerToSceneCoordinates(QPoint sceneCoordinate);
94
95     /**
96     * @brief Set zoom level of the view
97     *
98     * @param zoomLevel Zoom level
99     */
100     void setZoomLevel(int zoomLevel);
101
102 private:
103     /**
104     * @brief get current horizontal scale (vertical should be same)
105     *
106     * @return qreal Current horizontal scale value
107     */
108     qreal currentScale();
109
110     void setViewScale(qreal viewScale);
111
112     qreal viewScale();
113
114 /*******************************************************************************
115  * SIGNALS
116  ******************************************************************************/
117 signals:
118     /**
119     * @brief Signal for view resize events.
120     *
121     * Signal is emitted when view has been resized.
122     * @param size view size
123     */
124     void viewResized(const QSize &size);
125
126     /**
127     * @brief Signal for view scroll events
128     *
129     * Signal is emitted when view is scrolled.
130     * @param sceneCoordinate Scene coordinates of the new center point of the view
131     */
132     void viewScrolled(QPoint sceneCoordinate);
133
134     /**
135     * @brief Signal for informing that zooming animation is finished
136     *
137     */
138     void viewZoomFinished();
139
140     /**
141     * @brief Signal for updating view content
142     *
143     * Signal is emitted when view content needs an update.
144     * @param viewTopLeft Scene coordinate of the viewport top left corner
145     */
146     void viewContentChanged(QPoint viewTopLeft);
147
148 /*******************************************************************************
149  * DATA MEMBERS
150  ******************************************************************************/
151 private:           
152     QPoint m_mousePosition; ///< Previous mouse event position
153     QPoint m_scenePosition; ///< New center position
154     int m_timerID; ///< ID number of the timer used for smooth zoom effect
155     QPropertyAnimation *m_zoomAnimation;
156     qreal m_zoomScaleDelta; ///< Scaling factor delta for smooth zoom transition effect
157     qreal m_zoomTargetScale; ///< Scaling factor of the target zoom level
158 };
159
160 #endif // MAPVIEW_H