1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
|
#pragma once
#include "map/api_mark_point.hpp"
#include "map/booking_api.hpp"
#include "map/bookmark.hpp"
#include "map/bookmark_manager.hpp"
#include "map/displacement_mode_manager.hpp"
#include "map/feature_vec_model.hpp"
#include "map/mwm_url.hpp"
#include "map/place_page_info.hpp"
#include "map/track.hpp"
#include "drape_frontend/gui/skin.hpp"
#include "drape_frontend/drape_engine.hpp"
#include "drape_frontend/user_event_stream.hpp"
#include "drape_frontend/watch/frame_image.hpp"
#include "drape/oglcontextfactory.hpp"
#include "indexer/data_header.hpp"
#include "indexer/map_style.hpp"
#include "indexer/new_feature_categories.hpp"
#include "indexer/index_helpers.hpp"
#include "editor/user_stats.hpp"
#include "search/displayed_categories.hpp"
#include "search/downloader_search_callback.hpp"
#include "search/engine.hpp"
#include "search/mode.hpp"
#include "search/query_saver.hpp"
#include "search/viewport_search_callback.hpp"
#include "storage/downloading_policy.hpp"
#include "storage/storage.hpp"
#include "platform/country_defines.hpp"
#include "platform/location.hpp"
#include "platform/platform.hpp"
#include "routing/router.hpp"
#include "routing/routing_session.hpp"
#include "geometry/rect2d.hpp"
#include "geometry/screenbase.hpp"
#include "base/deferred_task.hpp"
#include "base/macros.hpp"
#include "base/strings_bundle.hpp"
#include "base/thread_checker.hpp"
#include "std/list.hpp"
#include "std/target_os.hpp"
#include "std/unique_ptr.hpp"
#include "std/vector.hpp"
#include "std/weak_ptr.hpp"
namespace osm
{
class EditableMapObject;
}
namespace search
{
class Result;
class Results;
struct AddressInfo;
struct EverywhereSearchParams;
struct ViewportSearchParams;
}
namespace storage
{
class CountryInfoGetter;
struct DownloaderSearchParams;
}
namespace routing { namespace turns{ class Settings; } }
namespace df
{
namespace watch
{
class CPUDrawer;
}
}
/// Uncomment line to make fixed position settings and
/// build version for screenshots.
//#define FIXED_LOCATION
class Framework : public search::ViewportSearchCallback::Delegate,
public search::DownloaderSearchCallback::Delegate
{
DISALLOW_COPY(Framework);
#ifdef FIXED_LOCATION
class FixedPosition
{
pair<double, double> m_latlon;
double m_dirFromNorth;
bool m_fixedLatLon, m_fixedDir;
public:
FixedPosition();
void GetLat(double & l) const { if (m_fixedLatLon) l = m_latlon.first; }
void GetLon(double & l) const { if (m_fixedLatLon) l = m_latlon.second; }
void GetNorth(double & n) const { if (m_fixedDir) n = m_dirFromNorth; }
bool HasNorth() const { return m_fixedDir; }
} m_fixedPos;
#endif
protected:
using TDrapeFunction = function<void (df::DrapeEngine *)>;
StringsBundle m_stringsBundle;
model::FeaturesFetcher m_model;
// The order matters here: DisplayedCategories may be used only
// after classificator is loaded by |m_model|.
unique_ptr<search::DisplayedCategories> m_displayedCategories;
// The order matters here: storage::CountryInfoGetter and
// m_model::FeaturesFetcher must be initialized before
// search::Engine and, therefore, destroyed after search::Engine.
unique_ptr<storage::CountryInfoGetter> m_infoGetter;
unique_ptr<search::Engine> m_searchEngine;
search::QuerySaver m_searchQuerySaver;
ScreenBase m_currentModelView;
using TViewportChanged = df::DrapeEngine::TModelViewListenerFn;
TViewportChanged m_viewportChanged;
routing::RoutingSession m_routingSession;
drape_ptr<df::DrapeEngine> m_drapeEngine;
drape_ptr<df::watch::CPUDrawer> m_cpuDrawer;
double m_startForegroundTime;
double m_startBackgroundTime;
StorageDownloadingPolicy m_storageDownloadingPolicy;
storage::Storage m_storage;
location::TMyPositionModeChanged m_myPositionListener;
BookmarkManager m_bmManager;
BookingApi m_bookingApi;
bool m_isRenderingEnabled;
/// This function will be called by m_storage when latest local files
/// is downloaded.
void OnCountryFileDownloaded(storage::TCountryId const & countryId, storage::Storage::TLocalFilePtr const localFile);
/// This function will be called by m_storage before latest local files
/// is deleted.
bool OnCountryFileDelete(storage::TCountryId const & countryId, storage::Storage::TLocalFilePtr const localFile);
/// This function is called by m_model when the map file is deregistered.
void OnMapDeregistered(platform::LocalCountryFile const & localFile);
void ClearAllCaches();
void StopLocationFollow();
void OnViewportChanged(ScreenBase const & screen);
void CallDrapeFunction(TDrapeFunction const & fn) const;
public:
Framework();
virtual ~Framework();
/// Get access to booking api helpers
BookingApi & GetBookingApi() { return m_bookingApi; }
BookingApi const & GetBookingApi() const { return m_bookingApi; }
/// Migrate to new version of very different data.
bool IsEnoughSpaceForMigrate() const;
storage::TCountryId PreMigrate(ms::LatLon const & position, storage::Storage::TChangeCountryFunction const & change,
storage::Storage::TProgressFunction const & progress);
void Migrate(bool keepDownloaded = true);
void InitWatchFrameRenderer(float visualScale);
/// @param center - map center in Mercator
/// @param zoomModifier - result zoom calculate like "base zoom" + zoomModifier
/// if we are have search result "base zoom" calculate that my position and search result
/// will be see with some bottom clamp.
/// if we are't have search result "base zoom" == scales::GetUpperComfortScale() - 1
/// @param pxWidth - result image width.
/// It must be equal render buffer width. For retina it's equal 2.0 * displayWidth
/// @param pxHeight - result image height.
/// It must be equal render buffer height. For retina it's equal 2.0 * displayHeight
/// @param symbols - configuration for symbols on the frame
/// @param image [out] - result image
void DrawWatchFrame(m2::PointD const & center, int zoomModifier,
uint32_t pxWidth, uint32_t pxHeight,
df::watch::FrameSymbols const & symbols,
df::watch::FrameImage & image);
void ReleaseWatchFrameRenderer();
bool IsWatchFrameRendererInited() const;
/// \returns true if there're unsaved changes in map with |countryId| and false otherwise.
/// \note It works for group and leaf node.
bool HasUnsavedEdits(storage::TCountryId const & countryId);
/// Registers all local map files in internal indexes.
void RegisterAllMaps();
/// Deregisters all registered map files.
void DeregisterAllMaps();
/// Registers a local map file in internal indexes.
pair<MwmSet::MwmId, MwmSet::RegResult> RegisterMap(
platform::LocalCountryFile const & localFile);
//@}
/// Shows group or leaf mwm on the map.
void ShowNode(storage::TCountryId const & countryId);
/// Checks, whether the country which contains the specified point is loaded.
bool IsCountryLoaded(m2::PointD const & pt) const;
/// Checks, whether the country is loaded.
bool IsCountryLoadedByName(string const & name) const;
//@}
void InvalidateRect(m2::RectD const & rect);
/// @name Get any country info by point.
//@{
storage::TCountryId GetCountryIndex(m2::PointD const & pt) const;
string GetCountryName(m2::PointD const & pt) const;
//@}
storage::Storage & GetStorage() { return m_storage; }
storage::Storage const & GetStorage() const { return m_storage; }
search::DisplayedCategories const & GetDisplayedCategories() const
{
return *m_displayedCategories;
}
storage::CountryInfoGetter & GetCountryInfoGetter() { return *m_infoGetter; }
StorageDownloadingPolicy & GetDownloadingPolicy() { return m_storageDownloadingPolicy; }
/// @name Bookmarks, Tracks and other UserMarks
//@{
/// Scans and loads all kml files with bookmarks in WritableDir.
void LoadBookmarks();
/// @return Created bookmark index in category.
size_t AddBookmark(size_t categoryIndex, m2::PointD const & ptOrg, BookmarkData & bm);
/// @return New moved bookmark index in category.
size_t MoveBookmark(size_t bmIndex, size_t curCatIndex, size_t newCatIndex);
void ReplaceBookmark(size_t catIndex, size_t bmIndex, BookmarkData const & bm);
/// @return Created bookmark category index.
size_t AddCategory(string const & categoryName);
inline size_t GetBmCategoriesCount() const { return m_bmManager.GetBmCategoriesCount(); }
/// @returns 0 if category is not found
BookmarkCategory * GetBmCategory(size_t index) const;
size_t LastEditedBMCategory() { return m_bmManager.LastEditedBMCategory(); }
string LastEditedBMType() const { return m_bmManager.LastEditedBMType(); }
/// Delete bookmarks category with all bookmarks.
/// @return true if category was deleted
bool DeleteBmCategory(size_t index);
void ShowBookmark(BookmarkAndCategory const & bnc);
void ShowTrack(Track const & track);
void ClearBookmarks();
bool AddBookmarksFile(string const & filePath);
BookmarkAndCategory FindBookmark(UserMark const * mark) const;
BookmarkManager & GetBookmarkManager() { return m_bmManager; }
m2::PointD GetSearchMarkSize(SearchMarkType searchMarkType);
protected:
// search::ViewportSearchCallback::Delegate overrides:
void RunUITask(function<void()> fn) override { GetPlatform().RunOnGuiThread(move(fn)); }
void SetHotelDisplacementMode() override
{
SetDisplacementMode(DisplacementModeManager::SLOT_INTERACTIVE_SEARCH, true /* show */);
}
bool IsViewportSearchActive() const override
{
return !m_searchIntents[static_cast<size_t>(search::Mode::Viewport)].m_params.m_query.empty();
}
void ShowViewportSearchResults(search::Results const & results) override
{
FillSearchResultsMarks(results);
}
void ClearViewportSearchResults() override { ClearSearchResultsMarks(); }
private:
void ActivateMapSelection(bool needAnimation,
df::SelectionShape::ESelectedObject selectionType,
place_page::Info const & info);
void InvalidateUserMarks();
public:
void DeactivateMapSelection(bool notifyUI);
/// Used to "refresh" UI in some cases (e.g. feature editing).
void UpdatePlacePageInfoForCurrentSelection();
/// Called to notify UI that object on a map was selected (UI should show Place Page, for example).
using TActivateMapSelectionFn = function<void (place_page::Info const &)>;
/// Called to notify UI that object on a map was deselected (UI should hide Place Page).
/// If switchFullScreenMode is true, ui can [optionally] enter or exit full screen mode.
using TDeactivateMapSelectionFn = function<void (bool /*switchFullScreenMode*/)>;
void SetMapSelectionListeners(TActivateMapSelectionFn const & activator,
TDeactivateMapSelectionFn const & deactivator);
void ResetLastTapEvent();
void InvalidateRendering();
void EnableChoosePositionMode(bool enable, bool enableBounds, bool applyPosition, m2::PointD const & position);
void BlockTapEvents(bool block);
using TCurrentCountryChanged = function<void(storage::TCountryId const &)>;
storage::TCountryId const & GetLastReportedCountry() { return m_lastReportedCountry; }
/// Guarantees that listener is called in the main thread context.
void SetCurrentCountryChangedListener(TCurrentCountryChanged const & listener);
private:
struct TapEvent
{
enum class Source
{
User,
Search,
Other
};
TapEvent(df::TapInfo const & info, Source source) : m_info(info), m_source(source) {}
df::TapInfo const m_info;
Source const m_source;
};
unique_ptr<TapEvent> m_lastTapEvent;
void OnTapEvent(TapEvent const & tapEvent);
/// outInfo is valid only if return value is not df::SelectionShape::OBJECT_EMPTY.
df::SelectionShape::ESelectedObject OnTapEventImpl(TapEvent const & tapEvent,
place_page::Info & outInfo) const;
unique_ptr<TapEvent> MakeTapEvent(m2::PointD const & center, FeatureID const & fid,
TapEvent::Source source) const;
FeatureID FindBuildingAtPoint(m2::PointD const & mercator) const;
void UpdateMinBuildingsTapZoom();
int m_minBuildingsTapZoom;
TActivateMapSelectionFn m_activateMapSelectionFn;
TDeactivateMapSelectionFn m_deactivateMapSelectionFn;
/// Here we store last selected feature to get its polygons in case of adding organization.
mutable FeatureID m_selectedFeature;
vector<m2::PointU> m_searchMarksSizes;
private:
vector<m2::TriangleD> GetSelectedFeatureTriangles() const;
public:
/// @name GPS location updates routine.
//@{
void OnLocationError(location::TLocationError error);
void OnLocationUpdate(location::GpsInfo const & info);
void OnCompassUpdate(location::CompassInfo const & info);
void SwitchMyPositionNextMode();
/// Should be set before Drape initialization. Guarantees that fn is called in main thread context.
void SetMyPositionModeListener(location::TMyPositionModeChanged && fn);
private:
void OnUserPositionChanged(m2::PointD const & position);
//@}
public:
struct DrapeCreationParams
{
float m_visualScale = 1.0f;
int m_surfaceWidth = 0;
int m_surfaceHeight = 0;
gui::TWidgetsInitInfo m_widgetsInitInfo;
bool m_hasMyPositionState = false;
location::EMyPositionMode m_initialMyPositionState = location::PendingPosition;
bool m_isChoosePositionMode = false;
bool m_isFirstLaunch = false;
};
void CreateDrapeEngine(ref_ptr<dp::OGLContextFactory> contextFactory, DrapeCreationParams && params);
ref_ptr<df::DrapeEngine> GetDrapeEngine();
bool IsDrapeEngineCreated() const { return m_drapeEngine != nullptr; }
void DestroyDrapeEngine();
/// Called when graphics engine should be temporarily paused and then resumed.
void SetRenderingEnabled(ref_ptr<dp::OGLContextFactory> contextFactory = nullptr);
void SetRenderingDisabled(bool destroyContext);
void UpdateDrapeEngine(int width, int height);
private:
/// Depends on initialized Drape engine.
void SaveViewport();
/// Depends on initialized Drape engine.
void LoadViewport();
public:
void ConnectToGpsTracker();
void DisconnectFromGpsTracker();
void SetMapStyle(MapStyle mapStyle);
void MarkMapStyle(MapStyle mapStyle);
MapStyle GetMapStyle() const;
void SetupMeasurementSystem();
void SetWidgetLayout(gui::TWidgetsLayoutInfo && layout);
void PrepareToShutdown();
void SetDisplacementMode(DisplacementModeManager::Slot slot, bool show);
private:
struct SearchIntent
{
search::SearchParams m_params;
weak_ptr<search::ProcessorHandle> m_handle;
m2::RectD m_viewport;
};
void InitCountryInfoGetter();
void InitSearchEngine();
DisplacementModeManager m_displacementModeManager;
bool m_connectToGpsTrack; // need to connect to tracker when Drape is being constructed
void Search(SearchIntent const & intent);
void SetCurrentPositionIfPossible(search::SearchParams & params);
void FillSearchResultsMarks(search::Results const & results);
void ClearSearchResultsMarks();
void OnUpdateCurrentCountry(m2::PointF const & pt, int zoomLevel);
storage::TCountryId m_lastReportedCountry;
TCurrentCountryChanged m_currentCountryChanged;
// Descriptions of last search queries for different modes. May be
// used for search requests skipping. This field is not guarded
// because it must be used from the UI thread only.
SearchIntent m_searchIntents[static_cast<size_t>(search::Mode::Count)];
bool Search(search::SearchParams const & params);
// Returns true when |params| and |viewport| are almost the same as
// the latest search query's params and viewport in the |intent|.
bool QueryMayBeSkipped(SearchIntent const & intent, search::SearchParams const & params,
m2::RectD const & viewport) const;
void OnUpdateGpsTrackPointsCallback(vector<pair<size_t, location::GpsTrackInfo>> && toAdd,
pair<size_t, size_t> const & toRemove);
public:
using TSearchRequest = search::QuerySaver::TSearchRequest;
void UpdateUserViewportChanged();
/// Search everywhere.
bool SearchEverywhere(search::EverywhereSearchParams const & params);
/// Search in the viewport.
bool SearchInViewport(search::ViewportSearchParams const & params);
/// Search for maps by countries or cities.
bool SearchInDownloader(storage::DownloaderSearchParams const & params);
void CancelSearch(search::Mode mode);
void CancelAllSearches();
bool GetCurrentPosition(double & lat, double & lon) const;
void ShowSearchResult(search::Result const & res);
size_t ShowSearchResults(search::Results const & results);
list<TSearchRequest> const & GetLastSearchQueries() const { return m_searchQuerySaver.Get(); }
void SaveSearchQuery(TSearchRequest const & query) { m_searchQuerySaver.Add(query); }
void ClearSearchHistory() { m_searchQuerySaver.Clear(); }
/// Calculate distance and direction to POI for the given position.
/// @param[in] point POI's position;
/// @param[in] lat, lon, north Current position and heading from north;
/// @param[out] distance Formatted distance string;
/// @param[out] azimut Azimut to point from (lat, lon);
/// @return true If the POI is near the current position (distance < 25 km);
bool GetDistanceAndAzimut(m2::PointD const & point,
double lat, double lon, double north,
string & distance, double & azimut);
/// @name Manipulating with model view
//@{
inline m2::PointD PtoG(m2::PointD const & p) const { return m_currentModelView.PtoG(p); }
inline m2::PointD GtoP(m2::PointD const & p) const { return m_currentModelView.GtoP(p); }
inline m2::PointD GtoP3d(m2::PointD const & p) const { return m_currentModelView.PtoP3d(m_currentModelView.GtoP(p)); }
/// Show all model by it's world rect.
void ShowAll();
m2::PointD GetPixelCenter() const;
m2::PointD const & GetViewportCenter() const;
void SetViewportCenter(m2::PointD const & pt);
void SetViewportCenter(m2::PointD const & pt, int zoomLevel);
m2::RectD GetCurrentViewport() const;
/// - Check minimal visible scale according to downloaded countries.
void ShowRect(m2::RectD const & rect, int maxScale = -1);
void ShowRect(m2::AnyRectD const & rect);
void GetTouchRect(m2::PointD const & center, uint32_t pxRadius, m2::AnyRectD & rect);
void SetViewportListener(TViewportChanged const & fn);
/// Resize event from window.
void OnSize(int w, int h);
enum EScaleMode
{
SCALE_MAG,
SCALE_MAG_LIGHT,
SCALE_MIN,
SCALE_MIN_LIGHT
};
void Scale(EScaleMode mode, bool isAnim);
void Scale(EScaleMode mode, m2::PointD const & pxPoint, bool isAnim);
void Scale(double factor, bool isAnim);
void Scale(double factor, m2::PointD const & pxPoint, bool isAnim);
void TouchEvent(df::TouchEvent const & touch);
//@}
int GetDrawScale() const;
/// Set correct viewport, parse API, show balloon.
bool ShowMapForURL(string const & url);
url_scheme::ParsedMapApi::ParsingResult ParseAndSetApiURL(string const & url);
struct ParsedRoutingData
{
ParsedRoutingData(vector<url_scheme::RoutePoint> const & points, routing::RouterType type)
: m_points(points), m_type(type)
{
}
vector<url_scheme::RoutePoint> m_points;
routing::RouterType m_type;
};
ParsedRoutingData GetParsedRoutingData() const;
private:
// TODO(vng): Uncomment when needed.
//void GetLocality(m2::PointD const & pt, search::AddressInfo & info) const;
/// @returns true if command was handled by editor.
bool ParseEditorDebugCommand(search::SearchParams const & params);
void FillFeatureInfo(FeatureID const & fid, place_page::Info & info) const;
/// @param customTitle, if not empty, overrides any other calculated name.
void FillPointInfo(m2::PointD const & mercator, string const & customTitle, place_page::Info & info) const;
void FillInfoFromFeatureType(FeatureType const & ft, place_page::Info & info) const;
void FillApiMarkInfo(ApiMarkPoint const & api, place_page::Info & info) const;
void FillSearchResultInfo(SearchMarkPoint const & smp, place_page::Info & info) const;
void FillMyPositionInfo(place_page::Info & info) const;
public:
void FillBookmarkInfo(Bookmark const & bmk, BookmarkAndCategory const & bac, place_page::Info & info) const;
/// @returns address of nearby building with house number in approx 1km distance.
search::AddressInfo GetAddressInfoAtPoint(m2::PointD const & pt) const;
/// @returns Valid street address only if it was specified in OSM for given feature;
/// @todo This functions are used in desktop app only. Should we really need them?
//@{
search::AddressInfo GetFeatureAddressInfo(FeatureType & ft) const;
search::AddressInfo GetFeatureAddressInfo(FeatureID const & fid) const;
//@}
vector<string> GetPrintableFeatureTypes(FeatureType const & ft) const;
/// Get "best for the user" feature at given point even if it's invisible on the screen.
/// Ignores coastlines and prefers buildings over other area features.
/// @returns nullptr if no feature was found at the given mercator point.
unique_ptr<FeatureType> GetFeatureAtPoint(m2::PointD const & mercator) const;
template <typename TFn>
void ForEachFeatureAtPoint(TFn && fn, m2::PointD const & mercator) const
{
indexer::ForEachFeatureAtPoint(m_model.GetIndex(), fn, mercator, 0.0);
}
/// Set parse to false if you don't need all feature fields ready.
/// TODO(AlexZ): Refactor code which uses this method to get rid of it.
/// FeatureType instances shoud not be used outside ForEach* core methods.
WARN_UNUSED_RESULT bool GetFeatureByID(FeatureID const & fid, FeatureType & ft) const;
void MemoryWarning();
void EnterBackground();
void EnterForeground();
/// Set the localized strings bundle
inline void AddString(string const & name, string const & value)
{
m_stringsBundle.SetString(name, value);
}
StringsBundle const & GetStringsBundle();
/// [in] lat, lon - last known location
/// [out] lat, lon - predicted location
static void PredictLocation(double & lat, double & lon, double accuracy,
double bearing, double speed, double elapsedSeconds);
public:
string CodeGe0url(Bookmark const * bmk, bool addName);
string CodeGe0url(double lat, double lon, double zoomLevel, string const & name);
/// @name Api
//@{
string GenerateApiBackUrl(ApiMarkPoint const & point) const;
url_scheme::ParsedMapApi const & GetApiDataHolder() const { return m_ParsedMapApi; }
private:
url_scheme::ParsedMapApi m_ParsedMapApi;
public:
//@}
/// @name Data versions
//@{
bool IsDataVersionUpdated();
void UpdateSavedDataVersion();
int64_t GetCurrentDataVersion() const;
//@}
public:
using TRouteBuildingCallback = function<void(routing::IRouter::ResultCode,
storage::TCountriesVec const &)>;
using TRouteProgressCallback = function<void(float)>;
/// @name Routing mode
//@{
void SetRouter(routing::RouterType type);
routing::RouterType GetRouter() const;
bool IsRoutingActive() const { return m_routingSession.IsActive(); }
bool IsRouteBuilt() const { return m_routingSession.IsBuilt(); }
bool IsRouteBuilding() const { return m_routingSession.IsBuilding(); }
bool IsRouteBuildingOnly() const { return m_routingSession.IsBuildingOnly(); }
bool IsRouteRebuildingOnly() const { return m_routingSession.IsRebuildingOnly(); }
bool IsRouteNotReady() const { return m_routingSession.IsNotReady(); }
bool IsRouteFinished() const { return m_routingSession.IsFinished(); }
bool IsRouteNoFollowing() const { return m_routingSession.IsNoFollowing(); }
bool IsOnRoute() const { return m_routingSession.IsOnRoute(); }
bool IsRouteNavigable() const { return m_routingSession.IsNavigable(); }
void BuildRoute(m2::PointD const & finish, uint32_t timeoutSec);
void BuildRoute(m2::PointD const & start, m2::PointD const & finish, uint32_t timeoutSec);
// FollowRoute has a bug where the router follows the route even if the method hads't been called.
// This method was added because we do not want to break the behaviour that is familiar to our users.
bool DisableFollowMode();
/// @TODO(AlexZ): Warning! These two routing callbacks are the only callbacks which are not called in the main thread context.
/// UI code should take it into an account. This is a result of current implementation, that can be improved:
/// Drape core calls some RunOnGuiThread with "this" pointers, and it causes crashes on Android, when Drape engine is destroyed
/// while switching between activities. Current workaround cleans all callbacks when destroying Drape engine
/// (@see MwmApplication.clearFunctorsOnUiThread on Android). Better soulution can be fair copying of all needed information into
/// lambdas/functors before calling RunOnGuiThread.
void SetRouteBuildingListener(TRouteBuildingCallback const & buildingCallback) { m_routingCallback = buildingCallback; }
/// See warning above.
void SetRouteProgressListener(TRouteProgressCallback const & progressCallback) { m_progressCallback = progressCallback; }
void FollowRoute();
void CloseRouting();
void GetRouteFollowingInfo(location::FollowingInfo & info) const { m_routingSession.GetRouteFollowingInfo(info); }
m2::PointD GetRouteEndPoint() const { return m_routingSession.GetEndPoint(); }
routing::RouterType GetLastUsedRouter() const;
void SetLastUsedRouter(routing::RouterType type);
/// Returns the most situable router engine type. Bases on distance and the last used router.
routing::RouterType GetBestRouter(m2::PointD const & startPoint, m2::PointD const & finalPoint);
// Sound notifications for turn instructions.
inline void EnableTurnNotifications(bool enable) { m_routingSession.EnableTurnNotifications(enable); }
inline bool AreTurnNotificationsEnabled() const { return m_routingSession.AreTurnNotificationsEnabled(); }
/// \brief Sets a locale for TTS.
/// \param locale is a string with locale code. For example "en", "ru", "zh-Hant" and so on.
/// \note See sound/tts/languages.txt for the full list of available locales.
inline void SetTurnNotificationsLocale(string const & locale) { m_routingSession.SetTurnNotificationsLocale(locale); }
/// @return current TTS locale. For example "en", "ru", "zh-Hant" and so on.
/// In case of error returns an empty string.
/// \note The method returns correct locale after SetTurnNotificationsLocale has been called.
/// If not, it returns an empty string.
inline string GetTurnNotificationsLocale() const { return m_routingSession.GetTurnNotificationsLocale(); }
/// \brief When an end user is going to a turn he gets sound turn instructions.
/// If C++ part wants the client to pronounce an instruction GenerateTurnNotifications (in
/// turnNotifications) returns
/// an array of one of more strings. C++ part assumes that all these strings shall be pronounced
/// by the client's TTS.
/// For example if C++ part wants the client to pronounce "Make a right turn." this method returns
/// an array with one string "Make a right turn.". The next call of the method returns nothing.
/// GenerateTurnNotifications shall be called by the client when a new position is available.
inline void GenerateTurnNotifications(vector<string> & turnNotifications)
{
return m_routingSession.GenerateTurnNotifications(turnNotifications);
}
void SetRouteStartPoint(m2::PointD const & pt, bool isValid);
void SetRouteFinishPoint(m2::PointD const & pt, bool isValid);
void Allow3dMode(bool allow3d, bool allow3dBuildings);
void Save3dMode(bool allow3d, bool allow3dBuildings);
void Load3dMode(bool & allow3d, bool & allow3dBuildings);
bool LoadAutoZoom();
void AllowAutoZoom(bool allowAutoZoom);
void SaveAutoZoom(bool allowAutoZoom);
/// \returns true if altitude information along |m_route| is available and
/// false otherwise.
bool HasRouteAltitude() const;
/// \brief Generates 4 bytes per point image (RGBA) and put the data to |imageRGBAData|.
/// \param width is width of chart shall be generated in pixels.
/// \param height is height of chart shall be generated in pixels.
/// \param imageRGBAData is bits of result image in RGBA.
/// \param minRouteAltitude is min altitude along the route in altitudeUnits.
/// \param maxRouteAltitude is max altitude along the route in altitudeUnits.
/// \param altitudeUnits is units (meters or feet) which is used to pass min and max altitudes.
/// \returns If there is valid route info and the chart was generated returns true
/// and false otherwise. If the method returns true it is guaranteed that the size of
/// |imageRGBAData| is not zero.
/// \note If HasRouteAltitude() method returns true, GenerateRouteAltitudeChart(...)
/// could return false if route was deleted or rebuilt between the calls.
bool GenerateRouteAltitudeChart(uint32_t width, uint32_t height,
vector<uint8_t> & imageRGBAData,
int32_t & minRouteAltitude, int32_t & maxRouteAltitude,
measurement_utils::Units & altitudeUnits) const;
public:
/// @name Editor interface.
//@{
/// Initializes feature for Create Object UI.
/// @returns false in case when coordinate is in the ocean or mwm is not downloaded.
bool CanEditMap() const;
bool CreateMapObject(m2::PointD const & mercator, uint32_t const featureType, osm::EditableMapObject & emo) const;
/// @returns false if feature is invalid or can't be edited.
bool GetEditableMapObject(FeatureID const & fid, osm:: EditableMapObject & emo) const;
osm::Editor::SaveResult SaveEditedMapObject(osm::EditableMapObject emo);
void DeleteFeature(FeatureID const & fid) const;
osm::NewFeatureCategories GetEditorCategories() const;
bool RollBackChanges(FeatureID const & fid);
void CreateNote(ms::LatLon const & latLon, FeatureID const & fid,
osm::Editor::NoteProblemType const type, string const & note);
//@}
private:
void SetRouterImpl(routing::RouterType type);
void RemoveRoute(bool deactivateFollowing);
void InsertRoute(routing::Route const & route);
void CheckLocationForRouting(location::GpsInfo const & info);
void CallRouteBuilded(routing::IRouter::ResultCode code,
storage::TCountriesVec const & absentCountries);
void MatchLocationToRoute(location::GpsInfo & info, location::RouteMatchingInfo & routeMatchingInfo) const;
string GetRoutingErrorMessage(routing::IRouter::ResultCode code);
TRouteBuildingCallback m_routingCallback;
TRouteProgressCallback m_progressCallback;
routing::RouterType m_currentRouterType;
//@}
public:
//@{
// User statistics.
editor::UserStats GetUserStats(string const & userName) const
{
return m_userStatsLoader.GetStats(userName);
}
// Reads user stats from server or gets it from cache calls |fn| on success.
void UpdateUserStats(string const & userName, editor::UserStatsLoader::UpdatePolicy policy,
editor::UserStatsLoader::TOnUpdateCallback fn)
{
m_userStatsLoader.Update(userName, policy, fn);
}
void DropUserStats(string const & userName) { m_userStatsLoader.DropStats(userName); }
private:
editor::UserStatsLoader m_userStatsLoader;
//@}
public:
bool OriginalFeatureHasDefaultName(FeatureID const & fid) const;
private:
DECLARE_THREAD_CHECKER(m_threadChecker);
};
|