Fixed remaining 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
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     /**
38     * @brief View scaling
39     *
40     * @property viewScale
41     */
42     Q_PROPERTY(qreal viewScale READ viewScale WRITE setViewScale)
43
44 public:
45     /**
46     * @brief Constructor
47     *
48     * @param parent Parent
49     */
50     MapView(QWidget *parent = 0);
51
52 /*******************************************************************************
53  * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
54  ******************************************************************************/
55 protected:
56     /**
57     * @brief Called when view is resized.
58     *
59     * @param event resize event
60     */
61     void resizeEvent(QResizeEvent *event);
62
63 private:
64     /**
65     * @brief Event handler for mouse move events
66     *
67     * Does calculate mouse movement delta from last event position and new view center
68     * based on that delta. Saves current event position for next round. Emits viewScrolled
69     * signal and doesn't actually scroll the view.
70     * @param event Mouse event
71     */
72     void mouseMoveEvent(QMouseEvent *event);
73
74     /**
75     * @brief Event handler for mouse press events
76     *
77     * Saves inial values for mouse and scene location for dragging view.
78     * @param event Mouse event
79     */
80     void mousePressEvent(QMouseEvent *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 Set new view scale
103     *
104     * @param viewScale New scaling factor
105     */
106     void setViewScale(qreal viewScale);
107
108     /**
109     * @brief Get current view scale
110     *
111     * @return Current view scaling factor
112     */
113     qreal viewScale();
114
115 /*******************************************************************************
116  * SIGNALS
117  ******************************************************************************/
118 signals:
119     /**
120     * @brief Signal for view resize events.
121     *
122     * Signal is emitted when view has been resized.
123     * @param size view size
124     */
125     void viewResized(const QSize &size);
126
127     /**
128     * @brief Signal for view scroll events
129     *
130     * Signal is emitted when view is scrolled.
131     * @param sceneCoordinate Scene coordinates of the new center point of the view
132     */
133     void viewScrolled(QPoint sceneCoordinate);
134
135     /**
136     * @brief Signal for informing that zooming animation is finished
137     *
138     */
139     void viewZoomFinished();
140
141     /**
142     * @brief Signal for updating view content
143     *
144     * Signal is emitted when view content needs an update.
145     * @param viewTopLeft Scene coordinate of the viewport top left corner
146     */
147     void viewContentChanged(QPoint viewTopLeft);
148
149 /*******************************************************************************
150  * DATA MEMBERS
151  ******************************************************************************/
152 private:
153     QPoint m_mousePosition; ///< Previous mouse event position
154     QPoint m_scenePosition; ///< New center position
155     QPropertyAnimation *m_zoomAnimation; ///< Zoom animation
156 };
157
158 #endif // MAPVIEW_H