2 Situare - A location system for Facebook
3 Copyright (C) 2010 Ixonos Plc. Authors:
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
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.
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.
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,
32 #include "coordinates/geocoordinate.h"
37 class FacebookAuthentication;
38 class FacebookCredentials;
39 class GeocodingService;
45 class NetworkAccessManager;
52 * @brief Engine class for Situare Application
54 * This class handles all the underlaying login of the Situare
57 class SituareEngine : public QObject
72 /*******************************************************************************
73 * MEMBER FUNCTIONS AND SLOTS
74 ******************************************************************************/
77 * @brief Slot to intercept error signal from ImageFetcher and SituareService
79 * @param context Error context
80 * @param error Error message
82 void error(const int context, const int error);
85 * @brief Slot to intercept signal when username is fetched from settings
88 void fetchUsernameFromSettings();
91 * @brief Slot to intercept signal when location search is issued
93 * @param location QString location
95 void locationSearch(QString location);
98 * @brief Slot to intercept signal when Login/Logout action is pressed
101 void loginActionPressed();
104 * @brief Slot to intercept signal from successful login
110 * @brief Slot to intercept signal when user has cancelled login process
112 void loginProcessCancelled();
115 * @brief Changes application state when logged out
121 * @brief Calls reverseGeo from SituareService to translate coordinates to street address
124 void requestAddress();
127 * @brief Calls updateLocation from SituareService to send the location update to
130 * @param status Status message
131 * @param publish Publish on Facebook
133 void requestUpdateLocation(const QString &status = QString(), bool publish = false);
136 * @brief Slot to refresh user data
138 void refreshUserData();
141 * @brief Slot to intercept signal from successful location update
144 void updateWasSuccessful();
147 * @brief Slot to intercept signal when new user data is available.
148 * Splits User and friendsList data and emits them as two different signals.
150 * @param user instance of User
151 * @param friendsList list of User instances (friends)
153 void userDataChanged(User *user, QList<User *> &friendsList);
157 * @brief Read settings and determine whether to use GPS and autocentering.
158 * When values does not found on the settings, GPS and autocentering are enabled as a default.
160 void initializeGpsAndAutocentering();
163 * @brief Connect signals coming from Facebook authenticator
165 void signalsFromFacebookAuthenticator();
168 * @brief Connect signals coming from GeocodingService
170 void signalsFromGeocodingService();
173 * @brief Connect signals coming from GPS
175 void signalsFromGPS();
178 * @brief Connect signals coming from MainWindow
180 void signalsFromMainWindow();
183 * @brief Connect signals coming from MapEngine
185 void signalsFromMapEngine();
188 * @brief Connect signals coming from MapView
190 void signalsFromMapView();
193 * @brief Connect signals coming from RoutingService
195 void signalsFromRoutingService();
198 * @brief Connect signals coming from Situare
200 void signalsFromSituareService();
204 * @brief Set auto centering feature enabled / disabled
206 * @param enabled true if enabled, false otherwise
208 void changeAutoCenteringSetting(bool enabled);
211 * @brief Slot for disabling automatic centering when map is scrolled manually
213 void disableAutoCentering();
216 * @brief Calls vibration feedback.
218 void draggingModeTriggered();
221 * @brief Enables automatic location update.
223 * @param enabled true if enabled, false otherwise
224 * @param updateIntervalMsecs update interval in milliseconds
226 void enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs = 0);
229 * @brief Slot to intercept signal when user's/friend's image is downloaded
231 * @param user Instance of user/friend
233 void imageReady(User *user);
236 * @brief Requests automatic update.
238 * Makes automatic location update request if user has moved enough.
240 * @param position geo coordinates
242 void requestAutomaticUpdateIfMoved(GeoCoordinate position);
245 * @brief Route is parsed and is ready for further processing.
247 * @param route Route item containing parsed route details
249 void routeParsed(Route &route);
252 * @brief Routes to geo coordinates.
254 * Uses map center coordinates as start point.
255 * @param endPointCoordinates end point geo coordinates
257 void routeTo(const GeoCoordinate &endPointCoordinates);
260 * @brief Slot for setting auto centering state.
262 * Calls gps to send last known position
264 * @param enabled true if auto centering was enabled, false otherwise
266 void setAutoCentering(bool enabled);
269 * @brief Sets zoom level to default when first GPS location is received if autocentering
272 void setFirstStartZoomLevel();
275 * @brief Slot for setting GPS state.
277 * @param enabled true if gps should be enabled, false otherwise
279 void setGPS(bool enabled);
282 * @brief Slot for setting power saving state.
284 * @param enabled true if enabled, false otherwise
286 void setPowerSaving(bool enabled);
289 * @brief Automatic update interval timer timeout.
291 * Requests update location if user has moved.
293 void startAutomaticUpdate();
296 * @brief Called when topmost window is changed
298 * Does set power saving state.
300 * @param isMainWindow True if MainWindow is the topmost one
302 void topmostWindowChanged(bool isMainWindow);
304 /*******************************************************************************
306 ******************************************************************************/
309 * @brief Signals when automatic location update was enabled.
311 * @param enabled true if enabled, false otherwise
313 void automaticLocationUpdateEnabled(bool enabled);
316 * @brief Signal to clear locationUpdateDialog's data
319 void clearUpdateLocationDialogData();
322 * @brief Signal when direction and distance from current map center point to current GPS
323 * location is changed
325 * @param direction Direction in degrees
326 * @param distance Distance in meters
327 * @param draw Should the indicator triangle be drawn or not
329 void directionIndicatorValuesUpdate(qreal direction, qreal distance, bool draw);
332 * @brief Signals when new friends data is ready
334 * @param friendList List of User instances (friends)
336 void friendsLocationsReady(QList<User *> &friendList);
339 * @brief Signals when friend's image is ready
341 * @param user Instance of friend
343 void friendImageReady(User *user);
346 * @brief Emited when location request is parsed and is ready for further processing
348 * @param result List of Location items
350 void locationDataParsed(QList<Location> &result);
353 * @brief Signals when new user data is ready
355 * @param user Instance of User
357 void userLocationReady(User *user);
359 /*******************************************************************************
361 ******************************************************************************/
363 bool m_autoCenteringEnabled; ///< Auto centering flag
364 bool m_automaticUpdateFirstStart; ///< Automatic location update first start flag
365 bool m_automaticUpdateRequest; ///< Flag for automatic update request
366 bool m_userMoved; ///< Flag for user move
368 QTimer *m_automaticUpdateIntervalTimer; ///< Automatic update interval timer
370 FacebookAuthentication *m_facebookAuthenticator; ///< Instance for facebook authenticator
371 GeocodingService *m_geocodingService; ///< Instance of the geocoding service
372 GeoCoordinate m_lastUpdatedGPSPosition; ///< Last updated GPS position
373 GPSPosition *m_gps; ///< Instance of the gps position
374 MainWindow *m_ui; ///< Instance of the MainWindow UI
375 MapEngine *m_mapEngine; ///< MapEngine
376 NetworkAccessManager *m_networkAccessManager; ///< NetworkAccessManager
377 RoutingService *m_routingService; ///< Instance of the routing service
378 SituareService *m_situareService; ///< Instance of the situare server communication service
379 MCE *m_mce; ///< Instance of the MCE