vcs.maemo.org Git - situare/blob - 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     * @brief Event handler for timer events, used for smooth zoom effect
  84     *
  85     * @param event
  86     */
  87     void timerEvent(QTimerEvent *event);
  88
  89 /*******************************************************************************
  90  * MEMBER FUNCTIONS AND SLOTS
  91  ******************************************************************************/
  92 public slots:
  93     /**
  94     * @brief Slot for centering view to new location
  95     *
  96     * @param sceneCoordinate Scene coordinates of the new center point
  97     */
  98     void centerToSceneCoordinates(QPoint sceneCoordinate);
  99
 100     /**
 101     * @brief Set zoom level of the view
 102     *
 103     * @param zoomLevel Zoom level
 104     */
 105     void setZoomLevel(int zoomLevel);
 106
 107 private:
 108     /**
 109     * @brief get current horizontal scale (vertical should be same)
 110     *
 111     * @return qreal Current horizontal scale value
 112     */
 113     qreal currentScale();
 114
 115     /**
 116     * @brief Set new view scale
 117     *
 118     * @param viewScale New scaling factor
 119     */
 120     void setViewScale(qreal viewScale);
 121
 122     /**
 123     * @brief Get current view scale
 124     *
 125     * @return Current view scaling factor
 126     */
 127     qreal viewScale();
 128
 129 /*******************************************************************************
 130  * SIGNALS
 131  ******************************************************************************/
 132 signals:
 133     /**
 134     * @brief Signal for view resize events.
 135     *
 136     * Signal is emitted when view has been resized.
 137     * @param size view size
 138     */
 139     void viewResized(const QSize &size);
 140
 141     /**
 142     * @brief Signal for view scroll events
 143     *
 144     * Signal is emitted when view is scrolled.
 145     * @param sceneCoordinate Scene coordinates of the new center point of the view
 146     */
 147     void viewScrolled(QPoint sceneCoordinate);
 148
 149     /**
 150     * @brief Signal for informing that zooming animation is finished
 151     *
 152     */
 153     void viewZoomFinished();
 154
 155     /**
 156     * @brief Signal for updating view content
 157     *
 158     * Signal is emitted when view content needs an update.
 159     * @param viewTopLeft Scene coordinate of the viewport top left corner
 160     */
 161     void viewContentChanged(QPoint viewTopLeft);
 162
 163 /*******************************************************************************
 164  * DATA MEMBERS
 165  ******************************************************************************/
 166 private:
 167     QPoint m_mousePosition; ///< Previous mouse event position
 168     QPoint m_scenePosition; ///< New center position
 169     int m_timerID; ///< ID number of the timer used for smooth zoom effect
 170     QPropertyAnimation *m_zoomAnimation; ///< Zoom animation
 171     qreal m_zoomScaleDelta; ///< Scaling factor delta for smooth zoom transition effect
 172     qreal m_zoomTargetScale; ///< Scaling factor of the target zoom level
 173 };
 174
 175 #endif // MAPVIEW_H