summaryrefslogtreecommitdiff
path: root/platform
diff options
context:
space:
mode:
authorJordan Kiley <jmkiley@users.noreply.github.com>2017-03-07 17:39:42 -0800
committerGitHub <noreply@github.com>2017-03-07 17:39:42 -0800
commitece19acd10a09922a3106872c720b00089bf4b5b (patch)
tree1f6ee8ff60a6897af6750e36bd48964e1385ea6e /platform
parenta6bbf09fa6a05dab63102fbdfab310fb71cd113d (diff)
downloadqtlocation-mapboxgl-ece19acd10a09922a3106872c720b00089bf4b5b.tar.gz
[ios, macos] Added a timing note for two delegate methods (#8259)
Diffstat (limited to 'platform')
-rw-r--r--platform/ios/src/MGLMapViewDelegate.h20
-rw-r--r--platform/macos/src/MGLMapViewDelegate.h14
2 files changed, 20 insertions, 14 deletions
diff --git a/platform/ios/src/MGLMapViewDelegate.h b/platform/ios/src/MGLMapViewDelegate.h
index 12320a63a5..c1faaa3d07 100644
--- a/platform/ios/src/MGLMapViewDelegate.h
+++ b/platform/ios/src/MGLMapViewDelegate.h
@@ -22,12 +22,11 @@ NS_ASSUME_NONNULL_BEGIN
#pragma mark Responding to Map Position Changes
/**
- Tells the delegate that the viewpoint depicted by the map view is about to
- change.
-
+ Tells the delegate that the viewpoint depicted by the map view is about to change.
+
This method is called whenever the currently displayed map camera will start
changing for any reason.
-
+
@param mapView The map view whose viewpoint will change.
@param animated Whether the change will cause an animated effect on the map.
*/
@@ -38,10 +37,12 @@ NS_ASSUME_NONNULL_BEGIN
This method is called as the currently displayed map camera changes as part of
an animation, whether due to a user gesture or due to a call to a method such
- as `-[MGLMapView setCamera:animated:]`. During the animation, this method may
- be called many times to report updates to the viewpoint. Therefore, your
- implementation of this method should be as lightweight as possible to avoid
- affecting performance.
+ as `-[MGLMapView setCamera:animated:]`. This method can be called before
+ `-mapViewDidFinishLoadingMap:` is called.
+
+ During the animation, this method may be called many times to report updates to
+ the viewpoint. Therefore, your implementation of this method should be as lightweight
+ as possible to avoid affecting performance.
@param mapView The map view whose viewpoint is changing.
*/
@@ -52,7 +53,8 @@ NS_ASSUME_NONNULL_BEGIN
changing.
This method is called whenever the currently displayed map camera has finished
- changing, after any calls to `-mapViewRegionIsChanging:` due to animation.
+ changing, after any calls to `-mapViewRegionIsChanging:` due to animation. Therefore,
+ this method can be called before `-mapViewDidFinishLoadingMap:` is called.
@param mapView The map view whose viewpoint has changed.
@param animated Whether the change caused an animated effect on the map.
diff --git a/platform/macos/src/MGLMapViewDelegate.h b/platform/macos/src/MGLMapViewDelegate.h
index 08a9f7eff4..dae5b40286 100644
--- a/platform/macos/src/MGLMapViewDelegate.h
+++ b/platform/macos/src/MGLMapViewDelegate.h
@@ -40,10 +40,12 @@ NS_ASSUME_NONNULL_BEGIN
This method is called as the currently displayed map camera changes as part of
an animation, whether due to a user gesture or due to a call to a method such
- as `-[MGLMapView setCamera:animated:]`. During the animation, this method may
- be called many times to report updates to the viewpoint. Therefore, your
- implementation of this method should be as lightweight as possible to avoid
- affecting performance.
+ as `-[MGLMapView setCamera:animated:]`. This method can be called before
+ `-mapViewDidFinishLoadingMap:` is called.
+
+ During the animation, this method may be called many times to report updates
+ to the viewpoint. Therefore, your implementation of this method should be as
+ lightweight as possible to avoid affecting performance.
@param mapView The map view whose viewpoint is changing.
*/
@@ -55,7 +57,9 @@ NS_ASSUME_NONNULL_BEGIN
This method is called whenever the currently displayed map camera has finished
changing, after any calls to `-mapViewRegionIsChanging:` due to animation.
-
+ This method can be called before `-mapViewDidFinishLoadingMap:` is
+ called.
+
@param mapView The map view whose viewpoint has changed.
@param animated Whether the change caused an animated effect on the map.
*/