Changed header comment block texts
[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 public:
36     /**
37     * @brief Constructor
38     *
39     * @param parent Parent
40     */
41     MapView(QWidget *parent = 0);
42
43 /*******************************************************************************
44  * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
45  ******************************************************************************/
46 protected:
47     /**
48     * @brief Called when view is resized.
49     *
50     * @event resize event
51     */
52     void resizeEvent(QResizeEvent *event);
53
54 private:
55     /**
56     * @brief Event handler for mouse move events
57     *
58     * Does calculate mouse movement delta from last event position and new view center
59     * based on that delta. Saves current event position for next round. Emits viewScrolled
60     * signal and doesn't actually scroll the view.
61     * @param event Mouse event
62     */
63     void mouseMoveEvent(QMouseEvent *event);
64
65     /**
66     * @brief Event handler for mouse press events
67     *
68     * Saves inial values for mouse and scene location for dragging view.
69     * @param event Mouse event
70     */
71     void mousePressEvent(QMouseEvent *event);
72
73     /**
74     * @brief Event handler for timer events, used for smooth zoom effect
75     *
76     * @param event
77     */
78     void timerEvent(QTimerEvent *event);
79
80 /*******************************************************************************
81  * MEMBER FUNCTIONS AND SLOTS
82  ******************************************************************************/
83 public slots:
84     /**
85     * @brief Slot for centering view to new location
86     *
87     * @param sceneCoordinate Scene coordinates of the new center point
88     */
89     void centerToSceneCoordinates(QPoint sceneCoordinate);
90
91     /**
92     * @brief Set zoom level of the view
93     *
94     * @param zoomLevel Zoom level
95     */
96     void setZoomLevel(int zoomLevel);
97
98 private:
99     /**
100     * @brief get current horizontal scale (vertical should be same)
101     *
102     * @return qreal Current horizontal scale value
103     */
104     qreal currentScale();
105
106 /*******************************************************************************
107  * SIGNALS
108  ******************************************************************************/
109 signals:
110     /**
111     * @brief Signal for view scale factor change events
112     *
113     * Can be used to trigger scaling of zoom buttons, friend indicators and other
114     * MapScene elements which should retain their visual size
115     * @param scaleFactor view's scale factor
116     */
117     void scalingFactorChanged(qreal scaleFactor);
118
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  * DATA MEMBERS
137  ******************************************************************************/
138 private:
139     QPoint m_mousePosition; ///< Previous mouse event position
140     QPoint m_scenePosition; ///< New center position
141     qreal m_zoomScaleDelta; ///< Scaling factor delta for smooth zoom transition effect
142     qreal m_zoomTargetScale; ///< Scaling factor of the target zoom level
143 };
144
145 #endif // MAPVIEW_H