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