RoadObject

 
public struct RoadObject

Describes the object on the road. There are two sources of road objects: active route and the electronic horizon.

  • Identifier of the road object. If we get the same objects (e.g. RoadObject.ObjectType.tunnel) from the electronic horizon and the active route, they will not have the same IDs.

    Declaration

    Swift

    public let identifier: RoadObject.Identifier
    View Source on GitHub

  • Length of the object, nil if the object is point-like.

    Declaration

    Swift

    public let length: CLLocationDistance?
    View Source on GitHub

  • Location of the road object.

    Declaration

    Swift

    public let location: RoadObject.Location
    View Source on GitHub

  • Kind of the road object with metadata.

    Declaration

    Swift

    public let kind: RoadObject.Kind
    View Source on GitHub

  • true if an object is added by user, false if it comes from Mapbox service.

    Declaration

    Swift

    public let isUserDefined: Bool
    View Source on GitHub

  • Indicates whether the road object is located in an urban area. This property is set to nil if the road object comes from a call to the RoadObjectStore.roadObject(identifier:) method and location is set to RoadObject.Location.point(_:).

    Declaration

    Swift

    public let isUrban: Bool?
    View Source on GitHub

  • Initializes a new RoadObject object.

    Declaration

    Swift

    public init(identifier: RoadObject.Identifier,
            length: CLLocationDistance?,
            location: RoadObject.Location,
            kind: RoadObject.Kind,
            isUrban: Bool?)
    View Source on GitHub

  • Represents location of road object on road graph.

    A point object is represented by a single edge whose location has the same fractionFromStart and fractionToEnd.

    Note

    The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of the level of use of the feature.
    See more

    Declaration

    Swift

    public struct EdgeLocation
    View Source on GitHub

  • Type of the road object.

    See more

    Declaration

    Swift

    public enum Kind
    View Source on GitHub

  • The location of a road object in the road graph.

    See more

    Declaration

    Swift

    public enum Location
    View Source on GitHub

  • Contains information about position of the point on the graph and it’s geo-position.

    See more

    Declaration

    Swift

    public struct Position
    View Source on GitHub

  • Identifies a road object in an electronic horizon. A road object represents a notable transition point along a road, such as a toll booth or tunnel entrance. A road object is similar to a RouteAlert but is more closely associated with the routing graph managed by the RoadGraph class.

    Use a RoadObjectStore object to get more information about a road object with a given identifier or get the locations of road objects along RoadGraph.Edges.

    Declaration

    Swift

    public typealias Identifier = String
    View Source on GitHub