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