Merge branch 'crosshair2'

[situare] / src / map / mapview.h

diff --git a/src/map/mapview.h b/src/map/mapview.h
index 8844fd8..8f86892 100644 (file)
--- a/src/map/mapview.h
+++ b/src/map/mapview.h
@@ -3,6 +3,7 @@
    Copyright (C) 2010  Ixonos Plc. Authors:
 
        Sami Rämö - sami.ramo@ixonos.com
+       Pekka Nissinen - pekka.nissinen@ixonos.com
 
    Situare is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
@@ -23,16 +24,163 @@
 #define MAPVIEW_H
 
 #include <QGraphicsView>
+#include <QPropertyAnimation>
 
+/**
+* @brief Map view widget
+*
+* @author Sami Rämö - sami.ramo (at) ixonos.com
+* @author Pekka Nissinen - pekka.nissinen (at) ixonos.com
+*/
 class MapView : public QGraphicsView
 {
     Q_OBJECT
+
+    /**
+    * @brief View scaling
+    *
+    * @property viewScale
+    */
+    Q_PROPERTY(qreal viewScale READ viewScale WRITE setViewScale)
+
 public:
+    /**
+    * @brief Constructor
+    *
+    * @param parent Parent
+    */
     MapView(QWidget *parent = 0);
-    void setZoomLevel(int zoomLevel);
 
-public slots:
+/*******************************************************************************
+ * BASE CLASS INHERITED AND REIMPLEMENTED MEMBER FUNCTIONS
+ ******************************************************************************/
+protected:
+    /**
+    * @brief Called when view is resized.
+    *
+    * @param event resize event
+    */
+    void resizeEvent(QResizeEvent *event);
+
+private:
+    /**
+    * @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.
+    * @param event Mouse event
+    */
+    void mouseMoveEvent(QMouseEvent *event);
+
+    /**
+    * @brief Event handler for mouse press events
+    *
+    * Saves inial values for mouse and scene location for dragging view.
+    * @param event Mouse event
+    */
     void mousePressEvent(QMouseEvent *event);
+
+/*******************************************************************************
+ * MEMBER FUNCTIONS AND SLOTS
+ ******************************************************************************/
+public slots:
+    /**
+    * @brief Slot for centering view to new location
+    *
+    * @param sceneCoordinate Scene coordinates of the new center point
+    */
+    void centerToSceneCoordinates(QPoint sceneCoordinate);
+
+    /**
+    * @brief Set zoom level of the view
+    *
+    * @param zoomLevel Zoom level
+    */
+    void setZoomLevel(int zoomLevel);
+
+    /**
+    * @brief updates view ports content
+    */
+    void updateViewPortContent();
+
+    /**
+    * @brief Slot for catching request to get view port contents.
+    * implementation of this slot sends signal that includes visble area of view port.
+    */
+    QRect viewportContent();
+
+private:
+    /**
+    * @brief Set new view scale
+    *
+    * @param viewScale New scaling factor
+    */
+    void setViewScale(qreal viewScale);
+
+    /**
+    * @brief Get current view scale
+    *
+    * @return Current view scaling factor
+    */
+    qreal viewScale();
+
+/*******************************************************************************
+ * SIGNALS
+ ******************************************************************************/
+signals:
+    /**
+    * @brief Signal for view resize events.
+    *
+    * Signal is emitted when view has been resized.
+    * @param size view size
+    */
+    void viewResized(const QSize &size);
+
+    /**
+    * @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
+    */
+    void viewScrolled(QPoint sceneCoordinate);
+
+    /**
+    * @brief Signal for informing that zooming animation is finished
+    */
+    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
+    */
+    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);
+
+/*******************************************************************************
+ * DATA MEMBERS
+ ******************************************************************************/
+private:
+    QPoint m_mousePosition; ///< Previous mouse event position
+    QPoint m_scenePosition; ///< New center position
+    QPropertyAnimation *m_zoomAnimation; ///< Zoom animation
 };
 
 #endif // MAPVIEW_H