RoadObject Structure Reference


                    
                    
                    identifier

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

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

Declaration

Swift

public let length: CLLocationDistance?

View Source on GitHub


                    
                    
                    location

Location of the road object.

Declaration

Swift

public let location: RoadObject.Location

View Source on GitHub


                    
                    
                    kind

Kind of the road object with metadata.

Declaration

Swift

public let kind: RoadObject.Kind

View Source on GitHub


                    
                    
                    isUserDefined

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


                    
                    
                    init(identifier:length:location:kind:)

Initializes a new RoadObject object.

Declaration

Swift

public init(identifier: RoadObject.Identifier,
            length: CLLocationDistance?,
            location: RoadObject.Location,
            kind: RoadObject.Kind)

View Source on GitHub


                    
                    
                    EdgeLocation

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.

Declaration

Swift

public struct EdgeLocation

View Source on GitHub


                    
                    
                    Kind

Type of the road object.

Declaration

Swift

public enum Kind

View Source on GitHub


                    
                    
                    Location

The location of a road object in the road graph.

Declaration

Swift

public enum Location

View Source on GitHub


                    
                    
                    Position

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

Declaration

Swift

public struct Position

View Source on GitHub


                    
                    
                    Identifier

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