Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Commit

Permalink
[ios] Clarify docs for MGLUserTrackingMode
Browse files Browse the repository at this point in the history
  • Loading branch information
captainbarbosa committed Mar 4, 2017
1 parent 4d058ff commit 9ea4113
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions platform/ios/src/MGLMapView.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,30 @@ typedef NS_ENUM(NSUInteger, MGLAnnotationVerticalAlignment) {
typedef NS_ENUM(NSUInteger, MGLUserTrackingMode) {
/** The map does not follow the user location. */
MGLUserTrackingModeNone = 0,
/** The map follows the user location. */
/** The map follows the user location. This tracking mode falls back
to `MGLUserTrackingModeNone` if the user pans the map view. */
MGLUserTrackingModeFollow,
/** The map follows the user location and rotates when the heading changes. */
/**
The map follows the user location and rotates when the heading changes.
The default user location annotation displays a fan-shaped indicator with
the current heading. The heading indicator represents the direction the
device is facing, which is sized according to the reported accuracy.
This tracking mode is disabled if the user pans the map view, but
remains enabled if the user zooms in. If the user rotates the map
view, this tracking mode will fall back to `MGLUserTrackingModeFollow`.
*/
MGLUserTrackingModeFollowWithHeading,
/** The map follows the user location and rotates when the course changes. */
/**
The map follows the user location and rotates when the course changes.
Course represents the direction in which the device is traveling.
The default user location annotation shows a puck-shaped indicator
that rotates as the course changes.
This tracking mode is disabled if the user pans the map view, but
remains enabled if the user zooms in. If the user rotates the map view,
this tracking mode will fall back to `MGLUserTrackingModeFollow`.
*/
MGLUserTrackingModeFollowWithCourse,
};

Expand Down

0 comments on commit 9ea4113

Please sign in to comment.