Review, updating functional tests
[situare] / src / map / mapview.h
index 8f86892..6715fa6 100644 (file)
 #define MAPVIEW_H
 
 #include <QGraphicsView>
-#include <QPropertyAnimation>
+#include <QTime>
+
+#include "coordinates/scenecoordinate.h"
+
+class QParallelAnimationGroup;
+class QPropertyAnimation;
+
+class MapScroller;
+
+#define VALUES 4
 
 /**
 * @brief Map view widget
@@ -43,6 +52,13 @@ class MapView : public QGraphicsView
     */
     Q_PROPERTY(qreal viewScale READ viewScale WRITE setViewScale)
 
+    /**
+    * @brief View shifting
+    *
+    * @property viewShift
+    */
+    Q_PROPERTY(qreal viewShift READ viewShift WRITE setViewShift)
+
 public:
     /**
     * @brief Constructor
@@ -51,6 +67,14 @@ public:
     */
     MapView(QWidget *parent = 0);
 
+    /**
+    * @brief Destructor.
+    *
+    * Takes MapScroller animation from double click zoom animation group and
+    * deletes animation group.
+    */
+    ~MapView();
+
 /*******************************************************************************
  * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
  ******************************************************************************/
@@ -64,11 +88,23 @@ protected:
 
 private:
     /**
+    * @brief Event handler for mouse double click event
+    *
+    * Emits zoomIn signal.
+    * @param event QMouseEvent
+    */
+    void mouseDoubleClickEvent(QMouseEvent *event);
+
+    /**
     * @brief Event handler for mouse move events
     *
     * Does calculate mouse movement delta from last event position and new view center
     * based on that delta. Saves current event position for next round. Emits viewScrolled
     * signal and doesn't actually scroll the view.
+    *
+    * Saves mouse movement deltas and durations for last few move events to be used for
+    * calculating the kinetic scrolling speed.
+    *
     * @param event Mouse event
     */
     void mouseMoveEvent(QMouseEvent *event);
@@ -76,11 +112,26 @@ private:
     /**
     * @brief Event handler for mouse press events
     *
-    * Saves inial values for mouse and scene location for dragging view.
+    * Saves inial values for mouse and scene location for dragging the view. Does stop currently
+    * running kinetic scroll effect.
+    *
     * @param event Mouse event
     */
     void mousePressEvent(QMouseEvent *event);
 
+    /**
+    * @brief Event handler for mouse release events
+    *
+    * Set up and start kinetic scrolling effect if time elapsed from last mouseMoveEvent is below
+    * the limit and drag length is over the limit.
+    *
+    * Kinetic scroll distance is calculated based on mouse movement event values saved in
+    * mouseMoveEvent(). The distance is also limited so that map doesn't run too far.
+    *
+    * @param event Mouse event
+    */
+    void mouseReleaseEvent(QMouseEvent *event);
+
 /*******************************************************************************
  * MEMBER FUNCTIONS AND SLOTS
  ******************************************************************************/
@@ -88,9 +139,11 @@ public slots:
     /**
     * @brief Slot for centering view to new location
     *
-    * @param sceneCoordinate Scene coordinates of the new center point
+    * Does also shift the center point horizontally, if required.
+    *
+    * @param coordinate Scene coordinates of the new center point
     */
-    void centerToSceneCoordinates(QPoint sceneCoordinate);
+    void centerToSceneCoordinates(const SceneCoordinate &coordinate);
 
     /**
     * @brief Set zoom level of the view
@@ -99,19 +152,35 @@ public slots:
     */
     void setZoomLevel(int zoomLevel);
 
+private slots:
     /**
-    * @brief updates view ports content
+    * @brief Disables shifting of the center point
     */
-    void updateViewPortContent();
+    void disableCenterShift();
 
     /**
-    * @brief Slot for catching request to get view port contents.
-    * implementation of this slot sends signal that includes visble area of view port.
+    * @brief Double tap zoom finished.
+    *
+    * Disables double tap zoom flag and emits zoomIn signal.
+    */
+    void doubleTapZoomFinished();
+
+    /**
+    * @brief Enables shifting of the center point
     */
-    QRect viewportContent();
+    void enableCenterShift();
 
 private:
     /**
+    * @brief Returns the point which is considered by user as the visible center point
+    *
+    * Differs from view's center point when panel is open and view center point is shifted.
+    *
+    * @returns Center point
+    */
+    QPointF center() const;
+
+    /**
     * @brief Set new view scale
     *
     * @param viewScale New scaling factor
@@ -119,17 +188,43 @@ private:
     void setViewScale(qreal viewScale);
 
     /**
+    * @brief Set new view shifting
+    *
+    * @param viewShift New shifting amount
+    */
+    void setViewShift(qreal viewShift);
+
+    /**
+    * @brief Update center shifting value
+    */
+    void updateCenterShift();
+
+    /**
     * @brief Get current view scale
     *
     * @return Current view scaling factor
     */
-    qreal viewScale();
+    qreal viewScale() const;
+
+    /**
+    * @brief Get current view shifting
+    *
+    * @return Current view shifting amount
+    */
+    qreal viewShift() const;
 
 /*******************************************************************************
  * SIGNALS
  ******************************************************************************/
 signals:
     /**
+    * @brief Emitted when map center point shiftin is changed
+    *
+    * @param shifting New shifting value
+    */
+    void horizontalShiftingChanged(int shifting);
+
+    /**
     * @brief Signal for view resize events.
     *
     * Signal is emitted when view has been resized.
@@ -141,9 +236,9 @@ signals:
     * @brief Signal for view scroll events
     *
     * Signal is emitted when view is scrolled.
-    * @param sceneCoordinate Scene coordinates of the new center point of the view
+    * @param coordinate Scene coordinates of the new center point of the view
     */
-    void viewScrolled(QPoint sceneCoordinate);
+    void viewScrolled(const SceneCoordinate &coordinate);
 
     /**
     * @brief Signal for informing that zooming animation is finished
@@ -151,36 +246,41 @@ signals:
     void viewZoomFinished();
 
     /**
-    * @brief Signal for updating view content
-    *
-    * Signal is emitted when view content needs an update.
-    * @param viewTopLeft Scene coordinate of the viewport top left corner
-    */
-    void viewContentChanged(QPoint viewTopLeft);
-
-    /**
-    * @brief Signal that sends visible area of map scene
-    *
-    * @param viewArea visible area of map scene
+    * @brief Signal for informing that double click zoom is finished
     */
-    void updateViewContent(QRect viewArea);
-
-    /**
-    * @brief Signal for drawing OSM license
-    *
-    * Signal is emitted when view is resized.
-    * @param width Viewport width
-    * @param height Viewport height
-    */
-    void viewResizedNewSize(int width, int height);
+    void zoomIn();
 
 /*******************************************************************************
  * DATA MEMBERS
  ******************************************************************************/
 private:
-    QPoint m_mousePosition; ///< Previous mouse event position
-    QPoint m_scenePosition; ///< New center position
-    QPropertyAnimation *m_zoomAnimation; ///< Zoom animation
+    bool m_doubleTapZoomRunning;                ///< Double tap zoom running flag
+
+    int m_dragTime[VALUES];                     ///< Table of mouse event durations
+    int m_index;                                ///< Current index of mouse event values table
+    int m_zoomLevel;                            ///< Current zoom level
+
+    qreal m_centerHorizontalShiftViewPixels;    ///< Center point horizontal shift in the view
+    qreal m_kineticMaxViewDistance;             ///< Maximum kinetic scroll distance in view pixels
+
+    QParallelAnimationGroup *m_scrollAndZoomAnimation;  ///< Double click zoom animation
+
+    QPoint m_dragMovement[VALUES];              ///< Table of mouse event distances
+    QPoint m_internalScenePosition;             ///< New center position (used for dragging)
+    QPoint m_lastMouseEventScenePosition;       ///< Previous mouse event position in the scene
+    QPoint m_lastMouseEventViewPosition;        ///< Previous mouse event position in the view
+    QPoint m_viewCenterPoint;                   ///< Center point of the MapView
+
+    QPointF m_centerHorizontalShiftPoint;       ///< Current amount of center point shifting
+
+    QPropertyAnimation *m_zoomAnimation;        ///< Zoom animation
+
+    QTime m_time;                               ///< Elapsed time between mouse events
+
+    QPropertyAnimation *m_centerShiftAnimation; ///< Animation for shifting the center point
+
+    MapScroller *m_scroller;                    ///< Kinetic scroller
+    SceneCoordinate m_lastSetScenePosition;     ///< Last center point coordinate set by MapEngine
 };
 
 #endif // MAPVIEW_H