Navigation camera viewport API. #2826

MaximAlien · 2021-02-22T19:39:12Z

Description

NavigationCamera viewport APIs bring the ability to control camera related behavior, which is specific for navigation (mostly free-drive and active guidance navigation).

NavigationCamera API introduces such components:

NavigationCamera class, which works as a manager for all camera related operations (allows to move camera to following, overview and idle states).
ViewportDataSource protocol.
NavigationViewportDataSource class, which conforms to ViewportDataSource and listens to location changes in free drive and active guidance modes and prepares CameraOptions. This class prepares CameraOptions for both iOS and CarPlay, as they're different. Can be overridden by the end user to provide custom data source.
CameraView class, which allows to run UIViewPropertyAnimator animations. Will be removed when such feature appears in Maps SDK.
CameraStateTransition protocol.
NavigationCameraStateTransition class, which conforms to CameraStateTransition and provides set of specific animated transitions. Can be overridden by the end user.

Current PR also contains an attempt to decouple location related APIs (e.g. UserCourseView) and camera related APIs in NavigationMapView, this leads to removal/replacement of certain properties (defaultAltitude, zoomedOutMotorwayAltitude etc).

Example application with custom camera implementation can be found here: mapbox/mapbox-navigation-ios-examples#92.

/cc @mapbox/navigation-ios @d-prukop

Initial results

camera_maneuver_behavior_building_highlighting.mov

navigation_camera_zoom_out_behavior.mov

overview_camera_behavior.mov

transitions_behavior.mov

car_play_behavior.mov

Known issues

Sources/MapboxNavigation/UserHaloCourseView.swift

Sources/MapboxNavigation/NavigationCameraType.swift

Sources/MapboxNavigation/NavigationMapViewDelegate.swift

Sources/MapboxNavigation/NavigationCameraType.swift

Sources/MapboxNavigation/BoundingBox.swift

Sources/MapboxNavigation/CLLocation.swift

Sources/MapboxNavigation/CLLocationDegrees.swift

Sources/MapboxNavigation/CameraOptions.swift

Sources/MapboxNavigation/NavigationMapView.swift

1ec5 · 2021-04-08T01:55:39Z

Sources/MapboxNavigation/NavigationMapView.swift

     */
-    open func updatePreferredFrameRate(for routeProgress: RouteProgress) {
-        guard tracksUserCourse else { return }
+    public func updatePreferredFrameRate(for routeProgress: RouteProgress) {


I thought that was supposed to be fixed as part of #2643?

Sources/MapboxNavigation/NavigationMapViewDelegate.swift

CHANGELOG.md

avi-c

Thank you. This looks good.

…mera` setup process.

1ec5

I think we should try to get some more certainty on #2826 (comment) and #2826 (comment) before landing, but otherwise the code looks to be in good shape.

Sources/MapboxNavigation/NavigationCameraType.swift

…ngleDiffWhenSmoothing`, which allow to control `NavigationCamera` behavior.

…entation.

MaximAlien · 2021-04-12T23:31:56Z

Sources/MapboxNavigation/NavigationViewportDataSource.swift

+    /**
+     Controls the distance on route after the current maneuver to include in the frame.
+
+     Defaults to `100.0` meters.
+     */
+    public var distanceToFrameAfterManeuver: CLLocationDistance = 100.0
+
+    /**
+     Controls how much the bearing can deviate from the location's bearing, in degrees.
+
+     In case if set, the `bearing` property of `CameraOptions` during active guidance navigation
+     won't exactly reflect the bearing returned by the location, but will also be affected by the
+     direction to the upcoming framed geometry, to maximize the viewable area.
+
+     Defaults to `20.0` degrees.
+     */
+    public var maximumBearingSmoothingAngle: CLLocationDirection? = 20.0


As per our discussion with @d-prukop distanceToFrameAfterManeuver and maximumBearingSmoothingAngle were made publicly available to provide more control over default camera behavior. There are several other properties, which are exposed in Mapbox Navigation for Android, but haven't made their way into main branch yet (and not yet present on iOS). We can add those in scope of tail-work. iOS implementation also doesn't use boolean flags to control usage of such properties (to simplify API), instead certain parameters provided as optionals.

bamx23 · 2021-04-17T07:34:43Z

Sources/MapboxNavigation/NavigationViewportDataSource.swift

+     Delegate, which is used to notify `NavigationCamera` regarding upcoming `CameraOptions`
+     related changes.
+     */
+    public var delegate: ViewportDataSourceDelegate?


@MaximAlien Should we use weak here? I see a possible retain loop

Good catch, will be addressed in another PR.

By the way, SwiftLint produces a warning for such issues.

1ec5 · 2021-07-29T18:03:28Z

Example/ViewController+FreeDrive.swift

@@ -116,7 +122,6 @@ extension ViewController {
            let branchNames = branchEdgeIdentifiers.flatMap { edgeNames(identifier: $0) }
            statusString += " at \(branchNames.joined(separator: ", "))"
        }
-        print(statusString)


This print statement was intentional: otherwise, all the electronic horizon work above is for naught. Ideally there would be some UI associated with this output, but a print statement was more expedient at the time.

Fixed in ca8be54.

MaximAlien requested a review from a team February 22, 2021 19:39

MaximAlien self-assigned this Feb 22, 2021

MaximAlien marked this pull request as draft February 22, 2021 19:39

MaximAlien force-pushed the maxim/camera-viewport-api branch from 13e87df to 9c8f2b7 Compare February 22, 2021 21:36

MaximAlien changed the base branch from release-v2.0 to vk/430-tile-manager February 22, 2021 21:36

1ec5 modified the milestones: v2.0.0 (Public Preview), v2.0.0 (GA) Feb 23, 2021

1ec5 added feature New feature request. op-ex Refactoring, Tech Debt or any other operational excellence work. labels Feb 23, 2021

MaximAlien force-pushed the vk/430-tile-manager branch from 95e1936 to a7e26cf Compare March 2, 2021 00:51

MaximAlien force-pushed the maxim/camera-viewport-api branch 3 times, most recently from 4ab3cab to 92e7897 Compare March 2, 2021 21:13

Base automatically changed from vk/430-tile-manager to release-v2.0 March 2, 2021 21:30

MaximAlien force-pushed the maxim/camera-viewport-api branch 3 times, most recently from f0853c7 to f4ede64 Compare March 4, 2021 18:00

truburt modified the milestones: v2.0.0 (GA) (iOS), v2.0.0 (GA) Mar 5, 2021

1ec5 modified the milestones: v2.0.0 (GA), v2.0.0 (RC) Mar 5, 2021

MaximAlien force-pushed the maxim/camera-viewport-api branch 2 times, most recently from 7ae6b7b to 861f66f Compare March 5, 2021 23:26

MaximAlien commented Mar 6, 2021

View reviewed changes

Sources/MapboxNavigation/UserHaloCourseView.swift Show resolved Hide resolved

MaximAlien force-pushed the maxim/camera-viewport-api branch from 861f66f to 6faf76a Compare March 8, 2021 23:00

MaximAlien commented Mar 9, 2021

View reviewed changes

Sources/MapboxNavigation/NavigationCameraType.swift Show resolved Hide resolved

MaximAlien commented Mar 9, 2021

View reviewed changes

Sources/MapboxNavigation/NavigationMapViewDelegate.swift Show resolved Hide resolved

MaximAlien force-pushed the maxim/camera-viewport-api branch 2 times, most recently from 335fda5 to 0d079f9 Compare March 9, 2021 20:13

Fix memory leak in NavigationMapView.

3cc94c5

1ec5 reviewed Apr 8, 2021

View reviewed changes

Merge branch 'release-v2.0' into maxim/camera-viewport-api

77e68c8

MaximAlien mentioned this pull request Apr 8, 2021

Fix RouteMapViewController deallocation issue. #2915

Merged

MaximAlien added 9 commits April 8, 2021 11:52

Address code review feedback.

3de06ff

Remove excessive CLLocation extension.

6900f49

Address code review feedback.

4e47417

Update FrameIntervalOptions.

56cd738

Merge branch 'release-v2.0' into maxim/camera-viewport-api

8bb685d

Update changelog.

578b705

Disable debugging view, improve comments.

c4ae428

Fix issue related to incorrect UserCourseView bearing.

1f60266

Merge branch 'release-v2.0' into maxim/camera-viewport-api

242ee49

This was referenced Apr 8, 2021

CameraOptions are incorrect during active guidance navigation on CarPlay. #2891

Closed

Unable to zoom-in to current location if CarPlay example was opened independently. #2889

Closed

avi-c approved these changes Apr 9, 2021

View reviewed changes

MaximAlien added 2 commits April 9, 2021 11:50

Add defaultAltitude, which is used as part of initial `NavigationCa…

465fb2a

…mera` setup process.

Remove unused CLLocationDegrees extension.

3fff0f1

1ec5 reviewed Apr 9, 2021

View reviewed changes

Sources/MapboxNavigation/NavigationCameraType.swift Show resolved Hide resolved

MaximAlien added 4 commits April 12, 2021 15:05

Add two new public properties: useBearingSmoothing and `maxBearingA…

41d0db0

…ngleDiffWhenSmoothing`, which allow to control `NavigationCamera` behavior.

Change default value for maxBearingAngleDiffWhenSmoothing.

dc51870

Add distanceToFrameAfterManeuver public property.

c4ee83a

Simplify NavigationViewportDataSource public APIs and improve docum…

04694a9

…entation.

MaximAlien commented Apr 12, 2021

View reviewed changes

Merge branch 'release-v2.0' into maxim/camera-viewport-api

371729d

MaximAlien merged commit c28e1e7 into release-v2.0 Apr 13, 2021

MaximAlien deleted the maxim/camera-viewport-api branch April 13, 2021 19:34

MaximAlien mentioned this pull request Apr 13, 2021

Add passive location manager to CarPlay pre-navigation map #2588

Closed

bamx23 reviewed Apr 17, 2021

View reviewed changes

1ec5 reviewed Jul 29, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Navigation camera viewport API. #2826

Navigation camera viewport API. #2826

MaximAlien commented Feb 22, 2021 •

edited

Loading

1ec5 Apr 8, 2021

avi-c left a comment

1ec5 left a comment

MaximAlien Apr 12, 2021

bamx23 Apr 17, 2021 •

edited

Loading

MaximAlien Apr 21, 2021

bamx23 Apr 22, 2021

1ec5 Jul 29, 2021

1ec5 Jul 29, 2021

Navigation camera viewport API. #2826

Navigation camera viewport API. #2826

Conversation

MaximAlien commented Feb 22, 2021 • edited Loading

Description

Initial results

Known issues

1ec5 Apr 8, 2021

Choose a reason for hiding this comment

avi-c left a comment

Choose a reason for hiding this comment

1ec5 left a comment

Choose a reason for hiding this comment

MaximAlien Apr 12, 2021

Choose a reason for hiding this comment

bamx23 Apr 17, 2021 • edited Loading

Choose a reason for hiding this comment

MaximAlien Apr 21, 2021

Choose a reason for hiding this comment

bamx23 Apr 22, 2021

Choose a reason for hiding this comment

1ec5 Jul 29, 2021

Choose a reason for hiding this comment

1ec5 Jul 29, 2021

Choose a reason for hiding this comment

MaximAlien commented Feb 22, 2021 •

edited

Loading

bamx23 Apr 17, 2021 •

edited

Loading