Remove ElectronicHorizon struct
#2949
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
azarovalex
added
the
op-ex
azarovalex
changed the title
ElectronicHorizon struct
bamx23
reviewed
Apr 23, 2021
Sources/MapboxCoreNavigation/EHorizon/ElectronicHorizonEdge.swift
Outdated
Show resolved
Hide resolved
1ec5
reviewed
Apr 24, 2021
Sources/MapboxCoreNavigation/EHorizon/ElectronicHorizonEdge.swift
Outdated
Show resolved
Hide resolved
Comment on lines
4
to
10
| /** | ||
| An electronic horizon is a probable path (or paths) of a vehicle. This structure contains metadata about an edge in a routing graph. For example, an edge may represent a road segment between two intersections or between the two ends of a bridge. An edge may traverse multiple road objects, and a road object may be associated with multiple edges. The road network ahead of the user is represented as a tree of edges. Each intersection has outlet edges. In turn, each edge has a probability of transition to another edge, as well as details about the road segment that the edge traverses. You can use these details to influence application behavior based on predicted upcoming conditions. | ||
|
|
||
| During active turn-by-turn navigation, the user-selected route and its metadata influence the path of the electronic horizon determined by `RouteController`. During passive navigation (free-driving), no route is actively selected, so `PassiveLocationDataSource` will determine the most probable path from the vehicle’s current location. You can receive notifications about changes in the current state of the electronic horizon by observing the `Notification.Name.electronicHorizonDidUpdatePosition`, `Notification.Name.electronicHorizonDidEnterRoadObject`, and `Notification.Name.electronicHorizonDidExitRoadObject` notifications. | ||
|
|
||
| Use a `RoadGraph` object to get an edge with a given identifier. | ||
| */ |
There was a problem hiding this comment.
Since this is now the documentation comment for the edge type specifically, we shouldn’t bury the lede in terms of describing an edge. Let’s start off with the first paragraph of the old documentation, then follow with the rest.
There was a problem hiding this comment.
Rearranged some lines in this doc.
| @@ -343,7 +343,8 @@ extension ElectronicHorizon { | |||
| public static let positionKey: NotificationUserInfoKey = .init(rawValue: "position") | |||
|
|
|||
| /** | |||
| A key in the user info dictionary of a `Notification.Name.electronicHorizonDidUpdatePosition` notification. The corresponding value is an `ElectronicHorizon` at the root of a tree of edges in the routing graph. */ | |||
| A key in the user info dictionary of a `Notification.Name.electronicHorizonDidUpdatePosition` notification. The corresponding value is an `ElectronicHorizonEdge` at the root of a tree of edges in the routing graph. This graph represents a probable path (or paths) of a vehicle within the routing graph for a certain distance in front of the vehicle, thus extending the user’s perspective beyond the “visible” horizon as the vehicle’s position and trajectory change. | |||
There was a problem hiding this comment.
👍 It’s good that we’re putting some more detail here, now that there isn’t a general “electronic horizon” type to look up.
azarovalex
force-pushed
the
azarovalex/electronic-horizon-edge
branch
from
75fb502
to
83595ec
Compare
bamx23
reviewed
Apr 28, 2021
| @@ -308,28 +308,28 @@ public extension Notification.Name { | |||
| /** | |||
| Posted when the user’s position in the electronic horizon changes. This notification may be posted multiple times after `electronicHorizonDidEnterRoadObject` until the user transitions to a new electronic horizon. | |||
|
|
|||
| The user info dictionary contains the keys `ElectronicHorizon.NotificationUserInfoKey.positionKey`, `ElectronicHorizon.NotificationUserInfoKey.treeKey`, `ElectronicHorizon.NotificationUserInfoKey.updatesMostProbablePathKey`, and `ElectronicHorizon.NotificationUserInfoKey.distancesByRoadObjectKey`. | |||
| The user info dictionary contains the keys `RoadGraph.Edge.NotificationUserInfoKey.positionKey`, `RoadGraph.Edge.NotificationUserInfoKey.treeKey`, `RoadGraph.Edge.NotificationUserInfoKey.updatesMostProbablePathKey`, and `RoadGraph.Edge.NotificationUserInfoKey.distancesByRoadObjectKey`. | |||
There was a problem hiding this comment.
RoadGraph.NotificationUserInfoKey? Here and everywhere else
| The most probable path may be split at some point if some of edges have a low probability difference (±0.05). For example, `outletEdges` can contain more than one edge with `level` set to 0. Currently, there is a maximum limit of one split per electronic horizon. | ||
| */ | ||
| public let outletEdges: [Edge] | ||
| public let outletEdges: [RoadGraph.Edge] |
azarovalex
force-pushed
the
azarovalex/electronic-horizon-edge
branch
from
fc9b495
to
7ac85dc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #2906.
Implementation
Removed the
ElectronicHorizonstruct and renamedElectronicHorizon.EdgetoRoadGraph.Edge.