TomTomSDKMapDisplay

Represents camera events.

A protocol that defines camera actions.

The camera configuration for a given distance to the next instruction on the route. Intermediate values are obtained by linear interpolation between the corresponding points.

The configuration for follow camera operators.

A type that represents CameraProperties: position, zoom, tilt and rotation

A type that represents camera tracking modes.

The CameraUpdate class specifies the map view’s camera position, zoom, tilt, rotation and more.

There are two ways to set a camera update:

• Call TomTomMap.applyCamera(_:, animationDuration:, completion:) or TomTomMap.moveCamera(_:) which sets the camera update with a corresponding animation for the former or no animation for the latter.

• Set it directly through the MapView, i.e.: mapView.cameraUpdate = CameraUpdate(position: .AMSTERDAM, zoom: 11).

Each method has its limitations:

• When calling applyCamera(_:, animationDuration:, completion:) and moveCamera(_:) through the TomTomMap, there are certain CameraUpate properties that can and cannot be used in conjunction with others:

init(position:zoom:tilt:rotation:positionMarkerVerticalOffset:scale:fieldOfView:):

• zoom - cannot be used together with scale.
• scale - cannot be used together with zoom.

init(zoomBy:zoomIn:zoomOut:tiltBy:rotateBy:moveBy:fieldOfViewChangeBy:):

• zoomBy - cannot be used together with zoomIn or zoomOut.
• zoomIn- cannot be used together with zoomOut or zoomBy.
• zoomOut- cannot be used together with zoomIn or zoomBy.

• moveBy - cannot be used together with any of the other properties.

  • When setting directly the cameraUpdate field through the MapView, no animation is applied and only these specific properties can be set:

• position.

• zoom - cannot be used together with scale.

• tilt.

• rotation.

• scale - cannot be used together with zoom.

• fieldOfView.

• moveBy - cannot be used together with any of the other properties.

A type that represents a set of coordinates and the padding around them.

Defines map visible region as CLLocationCoordinate2D coordinates.

Provides methods to fetch copyrights and caption.

Defines the gesture state.

An OptionSet that defines available gestures for ExclusiveGestureManager.

Describes possible cases of MapInteractionEvent.

Class to add a key for the map. The key must be injected before a MapView can be used.

• Example: “” func application(_: UIApplication, didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { MapsDisplayService.apiKey = “MAP_KEY” […] return true }

- Important: This is a Public Preview API. It may be changed or removed at any time.

CopyrightsServiceProtocol defines a method used to obtain the copyright informations.

Default implementation of CopyrightsService.

Types of the location marker visualization.

Type to control location features.

Cache configuration for caching both tiles and styles.

It provides control over the system memory and disk capacity used for caching, as well as the maximum cache duration for style resources and a mapping of cache durations to corresponding request URL filters. Unlike style caching, the tiles’ cache duration is handled by the server, utilizing the max-age header.

The cache which is being used while fetching map tiles.

MapActions defines a set of methods closely connected to the map.

MapGestureDisableOption An option set defining the map gestures to be disabled.

Allows the user to configure the initial parameters of the map.

MapOptions is used in conjunction with MapViewinitialization, i.e: When creating a MapView, it is possible to pass a MapOptions object to configure the MapView before it is showing on the screen, for example, creating a MapView object with the default TomTom style, and a dark style mode: let mapOptions = MapOptions(mapStyle: .defaultStyle, apiKey: "your-key", styleMode: .dark) let mapView = MapView(mapOptions: mapOptions)

Creating a MapView without passing a MapOptions object, will result in the MapView being created using the deafult values. In such case, the API Key that will be used for the map will be taken from MapsDisplayService.apiKey.

The OnDiskCachePolicy sets rules for caching: time interval of storing the cache, maximum cache size, etc.

Holder struct for main and dark version of the style definition. If darkStyle is not provided, setting TomTomMap.styleMode has no effect.

The map style definition. For style file format see map style specification. Style Specification is a formal definition of all properties that define the map’s appearance.

Defines size for chevron or pointer for particular zoom level.

Defines the map styles available to the user.

The Layer protocol that represents map layer.

Type of this layer.

The Metadata is used to carry extra information.

Tile source definition. Details can be found: https://github.com/mapbox/tilejson-spec

The SourceCollection

This class provides a container for tiles sources information and map layers.

Base protocol for AnnotationOptions

Base protocol for any Annotation: polygon, line, circle, marker etc.

A type that represents circle options.

Represents the circle on the map.

Scene level where the specified color should be used.

The offset of the line to be created.

Dash length units.

Line cap placement

Line join type.

Line pattern type.

Line unit.

Line pattern repeat.

Line outline style.

Line cap type.

Scene color.

Width scene.

Outline width scene.

Reserve coordinate.

Coordinate along line.

Line pattern.

Pattern length scene.

Pattern begin offset scene.

Represents the line on the map.

Line options.

A type that represents marker options.

Represents the marker on the map.

Text anchoring

Options that define label inside marker. Can be used with MarkerOptions.

Options that defines inner polygon. Can be used with PolygonOverlayOptions.

A polygon overlay can be built by setting the outer area color and adding inner polygons. Only one inner polygon is supported, but the inner polygons can be nested. Example:

   let innerOptions = InnerPolygonOptions(fillColor: .red
                                      coordinates: coordinates)

   innerOptions.nestedPolygonOptions = InnerPolygonOptions(
       fillColor: UIColor.blue,
       coordinates: coordinates
   )

   let polygonOptions = PolygonOverlayOptions(outerColor: .green,
                                          innerPolygonOptions: innerOptions)

   try? mapView.map.addPolygonOverlay(options: polygonOptions)

}

Options for creating a PolygonOverlay.

Type that represents texture options.

Polygon options.

Represents the polygon on the map.

The PolygonError enum contains possible errors that can occurs during Polygon init.

A protocol that defines map annotation actions.

Annotation service error.

RenderedFeature class

Rendered features query.

Rendered Feature Actions protocol.

A Route representation which can be added and displayed on the map.

To show a Route on the map, call the TomTomMap.addRoute(RouteOptions) method. You can configure its shape and appearance with the RouteOptions class. Drawing a Route on the map requires a list with coordinates of the Route points.

RouteDelegate.

The coordinate region.

Enumeration of route errors.

Protocol allowing management of the route representation on the map.

Route instruction.

Class that contains configuration of the route that will be drawn on the map.

Example:

let routeOption: RouteOptions = RouteOptions(coordinates: route.geometry)
guard let mapRoute = try? self.mapView.map.addRoute(routeOption) else { return }

A model that represents a part of the road under some special conditions, i.e., a tunnel or a non-drivable road, with a respective range. This model describes these road segments, and then passes these segments to RouteOptions as part of the route’s configuration that is drawn on the map.

The traffic category icon.

The traffic magnitude.

Represents traffic incident details.

Protocol that defines method that will be performed when user clicked on traffic incidents icon.

Defines available actions according to vehicle restriction feature.

The MapView object to wrap the underlying map renderer.

It contains the map created by the renderer in the view hierarchy and provides UI and view life-cycle functionalities. The view can be created programmatically, via xib or storyboards.

For example, displaying a simple MapView programmatically using a constraints-based layout:

Initialization:

lazy var mapView: MapView = {
  let mapOptions = MapOptions(mapStyle: .defaultStyle, apiKey: "your-key")
  let mapView = MapView(mapOptions: mapOptions)
  return mapView
}()

Layout:

mapView.translatesAutoresizingMaskIntoConstraints = false
view.addSubview(mapView)
NSLayoutConstraint.activate([
  mapView.widthAnchor.constraint(equalTo: view.widthAnchor),
  mapView.heightAnchor.constraint(equalTo: view.heightAnchor),
])

Setting up the receival of life-cycle events and updates, as well as setting the initial zoom and position of the map view:

mapView.delegate = self
mapView.cameraUpdate = .init(position: .AMSTERDAM, zoom: 13)

There will also be a need to conform your UIViewController to MapViewDelegate and implement the required methods.

Enumeration of TomTomMap View errors.

MapMetalRendererFrameCaptureDelegate exposes possibility to get currently drawn frame as a texture. Using this delegate may have impact of performance rendering.

The MapViewDelegate protocol defines a set of methods that can be implemented to receive events and updates related to the MapView life cycle.

Provides control over current location button, use it to manage visibility and the icon of it.

The MapDisplayDataProvider protocol that can be used to add custom data providers. FileOutput - Default logger output - prints logs using Swift.print

A cancellable task of a data provider which gathers the resource.

Protobuf-encoded map tile data. The format of the tile data is formally described using the protobuf schema available on: https://developer.tomtom.com/map-display-api/documentation/vector/content#schema-data

Describes options to request map tiles for given zoom and coordinate.

Detailed explanation of values can be found on: https://developer.tomtom.com/map-display-api/documentation/zoom-levels-and-tile-grid

Responsible for creating instances of MapDisplayDataProvider for handling online map tile requests.

Methods for managing map interactions and events.

The methods that an object adopts to manage callout views for a MapView.

The TomTomMap class serves as the foundational class, acting as the primary gateway for integrating a multitude of map-related features. It offers a rich set of functionalities enabling developer interaction with the map and customizing its behavior.

TomTomMap can be accessed in several ways through the MapView class:

• Through the property mapView.map.
• By calling mapView.getMapAsync, i.e., mapView.getMapAsync { map in // do something with map }
• By assigning mapView.onMapReadyCallback, i.e., mapView.onMapReadyCallback = { map in // do something with map }
• By defining mapView(_:, onMapReady:) through the MapDelegate, i.e., func mapView(_: MapView, onMapReady map: TomTomMap) { // do something with the map } In most cases, the preferred way to access the map would be through the property mapView.map, but in some cases where the map should be ready first, such as when calling showVehicleRestrictions(vehicle:) the preferred way would be mapView.getMapAsync or mapView.onMapReadyCallback.