vcs.maemo.org Git - situare/blob - src/engine/engine.h

   1  /*
   2     Situare - A location system for Facebook
   3     Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5         Kaj Wallin - kaj.wallin@ixonos.com
   6         Henri Lampela - henri.lampela@ixonos.com
   7         Jussi Laitinen - jussi.laitinen@ixonos.com
   8         Sami Rämö - sami.ramo@ixonos.com
   9
  10     Situare is free software; you can redistribute it and/or
  11     modify it under the terms of the GNU General Public License
  12     version 2 as published by the Free Software Foundation.
  13
  14     Situare is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17     GNU General Public License for more details.
  18
  19     You should have received a copy of the GNU General Public License
  20     along with Situare; if not, write to the Free Software
  21     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  22     USA.
  23  */
  24
  25
  26 #ifndef ENGINE_H
  27 #define ENGINE_H
  28
  29 #include <QObject>
  30 #include <QTime>
  31
  32 #include "coordinates/geocoordinate.h"
  33
  34 class QTimer;
  35
  36 class Application;
  37 class ContactManager;
  38 class FacebookAuthentication;
  39 class FacebookCredentials;
  40 class GeocodingService;
  41 class GPSPosition;
  42 class Location;
  43 class MainWindow;
  44 class MapEngine;
  45 class MCE;
  46 class NetworkAccessManager;
  47 class Route;
  48 class RoutingService;
  49 class SituareService;
  50 class User;
  51
  52 /**
  53 * @brief Engine class for Situare Application
  54 *
  55 * This class handles all the underlaying login of the Situare
  56 * application.
  57 */
  58 class SituareEngine : public QObject
  59 {
  60     Q_OBJECT
  61 public:
  62     /**
  63     * @brief Constructor
  64     *
  65     */
  66     SituareEngine();
  67
  68     /**
  69     * @brief Destructor
  70     */
  71     ~SituareEngine();
  72
  73 /*******************************************************************************
  74  * MEMBER FUNCTIONS AND SLOTS
  75  ******************************************************************************/
  76 public slots:
  77     /**
  78     * @brief Slot to intercept error signal from ImageFetcher and SituareService
  79     *
  80     * @param context Error context
  81     * @param error Error message
  82     */
  83     void error(const int context, const int error);
  84
  85     /**
  86     * @brief Slot to intercept signal when location search is issued
  87     *
  88     * @param location QString location
  89     */
  90     void locationSearch(QString location);
  91
  92     /**
  93     * @brief Slot to intercept signal when Login/Logout action is pressed
  94     *
  95     */
  96     void loginActionPressed();
  97
  98     /**
  99     * @brief Slot to intercept signal from successful login
 100     *
 101     */
 102     void onLogin();
 103
 104     /**
 105     * @brief Changes application state when logged out
 106     *
 107     */
 108     void onLogout();
 109
 110     /**
 111     * @brief Calls reverseGeo from SituareService to translate coordinates to street address
 112     *
 113     */
 114     void requestAddress();
 115
 116     /**
 117     * @brief Calls updateLocation from SituareService to send the location update to
 118     *        Situare server.
 119     *
 120     * @param status Status message
 121     * @param publish Publish on Facebook
 122     */
 123     void requestUpdateLocation(const QString &status = QString(), bool publish = false);
 124
 125     /**
 126     * @brief Slot to refresh user data
 127     */
 128     void refreshUserData();
 129
 130     /**
 131     * @brief Slot to intercept signal from successful location update
 132     *
 133     */
 134     void updateWasSuccessful();
 135
 136     /**
 137     * @brief Slot to intercept signal when new user data is available.
 138     *        Splits User and friendsList data and emits them as two different signals.
 139     *
 140     * @param user instance of User
 141     * @param friendsList list of User instances (friends)
 142     */
 143     void userDataChanged(User *user, QList<User *> &friendsList);
 144
 145 private:
 146     /**
 147     * @brief Read settings and determine whether to use GPS and autocentering.
 148     * When values does not found on the settings, GPS and autocentering are enabled as a default.
 149     */
 150     void initializeGpsAndAutocentering();
 151
 152     /**
 153       * @brief Connect signals coming from Facebook authenticator
 154       */
 155     void signalsFromFacebookAuthenticator();
 156
 157     /**
 158       * @brief Connect signals coming from GeocodingService
 159       */
 160     void signalsFromGeocodingService();
 161
 162     /**
 163       * @brief Connect signals coming from GPS
 164       */
 165     void signalsFromGPS();
 166
 167     /**
 168       * @brief Connect signals coming from MainWindow
 169       */
 170     void signalsFromMainWindow();
 171
 172     /**
 173       * @brief Connect signals coming from MapEngine
 174       */
 175     void signalsFromMapEngine();
 176
 177     /**
 178       * @brief Connect signals coming from MapView
 179       */
 180     void signalsFromMapView();
 181
 182     /**
 183       * @brief Connect signals coming from RoutingService
 184       */
 185     void signalsFromRoutingService();
 186
 187     /**
 188       * @brief Connect signals coming from Situare
 189       */
 190     void signalsFromSituareService();
 191
 192 private slots:
 193     /**
 194     * @brief Set auto centering feature enabled / disabled
 195     *
 196     * @param enabled true if enabled, false otherwise
 197     */
 198     void changeAutoCenteringSetting(bool enabled);
 199
 200     /**
 201     * @brief Slot for disabling automatic centering when map is scrolled manually
 202     */
 203     void disableAutoCentering();
 204
 205     /**
 206     * @brief Calls vibration feedback.
 207     */
 208     void draggingModeTriggered();
 209
 210     /**
 211     * @brief Enables automatic location update.
 212     *
 213     * @param enabled true if enabled, false otherwise
 214     * @param updateIntervalMsecs update interval in milliseconds
 215     */
 216     void enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs = 0);
 217
 218     /**
 219     * @brief Slot to intercept signal when user's/friend's image is downloaded
 220     *
 221     * @param user Instance of user/friend
 222     */
 223     void imageReady(User *user);
 224
 225     /**
 226     * @brief Requests automatic update.
 227     *
 228     * Makes automatic location update request if user has moved enough.
 229     *
 230     * @param position geo coordinates
 231     */
 232     void requestAutomaticUpdateIfMoved(GeoCoordinate position);
 233
 234     /**
 235     * @brief Route is parsed and is ready for further processing.
 236     *
 237     * @param route Route item containing parsed route details
 238     */
 239     void routeParsed(Route &route);
 240
 241     /**
 242     * @brief Routes to geo coordinates.
 243     *
 244     * Uses map center coordinates as start point.
 245     * @param endPointCoordinates end point geo coordinates
 246     */
 247     void routeTo(const GeoCoordinate &endPointCoordinates);
 248
 249     /**
 250     * @brief Route to current cursor position
 251     */
 252     void routeToCursor();
 253
 254     /**
 255     * @brief Slot for setting auto centering state.
 256     *
 257     * Calls gps to send last known position
 258     *
 259     * @param enabled true if auto centering was enabled, false otherwise
 260     */
 261     void setAutoCentering(bool enabled);
 262
 263     /**
 264      * @brief Sets zoom level to default when first GPS location is received if autocentering
 265      * is enabled.
 266      */
 267     void setFirstStartZoomLevel();
 268
 269     /**
 270     * @brief Slot for setting GPS state.
 271     *
 272     * @param enabled true if gps should be enabled, false otherwise
 273     */
 274     void setGPS(bool enabled);
 275
 276     /**
 277     * @brief Slot for setting power saving state.
 278     *
 279     * @param enabled true if enabled, false otherwise
 280     */
 281     void setPowerSaving(bool enabled);
 282
 283     /**
 284     * @brief Shows contact dialog.
 285     *
 286     * Calls MainWindow showContactDialog with contact guid defined by contact's Facebook ID.
 287     * @param facebookId contact's facebookId
 288     */
 289     void showContactDialog(const QString &facebookId);
 290
 291     /**
 292     * @brief Automatic update interval timer timeout.
 293     *
 294     * Requests update location if user has moved.
 295     */
 296     void startAutomaticUpdate();
 297
 298     /**
 299     * @brief Called when topmost window is changed
 300     *
 301     * Does set power saving state.
 302     *
 303     * @param isMainWindow True if MainWindow is the topmost one
 304     */
 305     void topmostWindowChanged(bool isMainWindow);
 306
 307 /*******************************************************************************
 308  * SIGNALS
 309  ******************************************************************************/
 310 signals:
 311     /**
 312     * @brief Signals when automatic location update was enabled.
 313     *
 314     * @param enabled true if enabled, false otherwise
 315     */
 316     void automaticLocationUpdateEnabled(bool enabled);
 317
 318     /**
 319     * @brief Signal when direction and distance from current map center point to current GPS
 320     *        location is changed
 321     *
 322     * @param direction Direction in degrees
 323     * @param distance Distance in meters
 324     * @param draw Should the indicator triangle be drawn or not
 325     */
 326     void directionIndicatorValuesUpdate(qreal direction, qreal distance, bool draw);
 327
 328     /**
 329     * @brief Signals when new friends data is ready
 330     *
 331     * @param friendList List of User instances (friends)
 332     */
 333     void friendsLocationsReady(QList<User *> &friendList);
 334
 335     /**
 336     * @brief Signals when friend's image is ready
 337     *
 338     * @param user Instance of friend
 339     */
 340     void friendImageReady(User *user);
 341
 342     /**
 343     * @brief Emited when location request is parsed and is ready for further processing
 344     *
 345     * @param result List of Location items
 346     */
 347     void locationDataParsed(QList<Location> &result);
 348
 349     /**
 350     * @brief Signals when new user data is ready
 351     *
 352     * @param user Instance of User
 353     */
 354     void userLocationReady(User *user);
 355
 356 /*******************************************************************************
 357  * DATA MEMBERS
 358  ******************************************************************************/
 359 private:
 360     bool m_autoCenteringEnabled;        ///< Auto centering flag
 361     bool m_automaticUpdateFirstStart;   ///< Automatic location update first start flag
 362     bool m_automaticUpdateRequest;      ///< Flag for automatic update request
 363     bool m_userMoved;                   ///< Flag for user move
 364
 365     QTimer *m_automaticUpdateIntervalTimer; ///< Automatic update interval timer
 366
 367     ContactManager *m_contactManager;                ///< Instance of contact manager
 368     FacebookAuthentication *m_facebookAuthenticator; ///< Instance for facebook authenticator
 369     GeocodingService *m_geocodingService;            ///< Instance of the geocoding service
 370     GeoCoordinate m_lastUpdatedGPSPosition;          ///< Last updated GPS position
 371     GPSPosition *m_gps;                              ///< Instance of the gps position
 372     MainWindow *m_ui;                                ///< Instance of the MainWindow UI
 373     MapEngine *m_mapEngine;                          ///< MapEngine
 374     NetworkAccessManager *m_networkAccessManager;    ///< NetworkAccessManager
 375     RoutingService *m_routingService;  ///< Instance of the routing service
 376     SituareService *m_situareService;  ///< Instance of the situare server communication service
 377     MCE *m_mce;                        ///< Instance of the MCE
 378 };
 379
 380 #endif // ENGINE_H