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