Skip to main content

method

calcPosition(camera:geometry:styleZoomToTiltRelation:screenArea:tilt:bearing:size:)​

public nonisolated func calcPosition(
    camera: BaseCamera,
    geometry: Geometry,
    styleZoomToTiltRelation: StyleZoomToTiltRelation? = nil,
    screenArea: Padding? = nil,
    tilt: Tilt? = nil,
    bearing: Bearing? = nil,
    size: ScreenSize? = nil
) throws -> CameraPosition
Parameters

camera

Camera used for position calculation.

geometry

Geometry object to be embedded into the screen area defined by the screen_area parameter.

styleZoomToTiltRelation

Dependence function of the camera tilt angle on the style scaling level.

screenArea

Screen area in which to embed the geometry. If not specified, camera padding is used for calculation.

tilt

Map tilt. If not set, the current camera tilt is used.

bearing

Map bearing. If not set, the current camera bearing is used.

size

Size of the view area. If not specified, the ICamera::size() value is used.

Returns
CameraPosition

calcPosition(camera:objects:styleZoomToTiltRelation:screenArea:tilt:bearing:size:)​

public nonisolated func calcPosition(
    camera: BaseCamera,
    objects: [SimpleMapObject],
    styleZoomToTiltRelation: StyleZoomToTiltRelation? = nil,
    screenArea: Padding? = nil,
    tilt: Tilt? = nil,
    bearing: Bearing? = nil,
    size: ScreenSize? = nil
) throws -> CameraPosition
Parameters

camera

Camera used for position calculation.

objects

Map objects that must be embedded into the screen area defined by the screen_area parameter.

styleZoomToTiltRelation

Dependence function of the camera tilt angle on the style scaling level.

screenArea

Screen area in which to embed the geometry. If not specified, camera padding is used for calculation.

tilt

Camera tilt. If not specified, the current camera tilt in used.

bearing

Camera bearing. If not specified, the current camera bearing is used.

size

Size of the view area. If not specified, the ICamera::size() value is used.

Returns
CameraPosition

computeRouteAltitudes(route:itemCount:)​

public nonisolated func computeRouteAltitudes(
    route: Route,
    itemCount: UInt32
) -> [RouteAltitudeItem]
Parameters

route

Route.

itemCount

Number of elements for the elevation chart, must be greater than 1.

Returns
RouteAltitudeItem[]

Set of route height elements, for the elevation chart.

createDefaultMaxTiltRestriction()​

public nonisolated func createDefaultMaxTiltRestriction() throws -> StyleZoomToTiltRelation
Returns
StyleZoomToTiltRelation

createDefaultStyleZoomToTiltRelation()​

public nonisolated func createDefaultStyleZoomToTiltRelation() throws -> StyleZoomToTiltRelation
Returns
StyleZoomToTiltRelation

createStyleZoomToTiltRelation(points:)​

public nonisolated func createStyleZoomToTiltRelation(
    points: [StyleZoom: Tilt]
) throws -> StyleZoomToTiltRelation
Returns
StyleZoomToTiltRelation

Dependence of the camera tilt angle on the style zoom level, if the dependence could not be created - throw an exception.

getInstructionManeuver(extraInstructionInfo:)​

public nonisolated func getInstructionManeuver(
    extraInstructionInfo: ExtraInstructionInfo
) -> InstructionManeuver
Parameters

extraInstructionInfo

Returns
InstructionManeuver

getLanesControlImages(laneSign:maxCount:ignoreActiveManeuver:)​

public nonisolated func getLanesControlImages(
    laneSign: RouteLaneSign,
    maxCount: UInt32,
    ignoreActiveManeuver: Bool
) -> [LanesControlImage]
Parameters

laneSign

maxCount

ignoreActiveManeuver

Returns
LanesControlImage[]

getRouteEnclosingRects(routeGeometry:options:)​

public nonisolated func getRouteEnclosingRects(
    routeGeometry: GeoPointRouteAttribute,
    options: RouteEnclosingRectsOptions
) -> [Geometry]
Parameters

routeGeometry

Route geometry.

options

Returns
Geometry[]

Geometry with a set of rectangles corresponding to route segments or nil if a set of rectangles could not be obtained.

parseGeoJson(geoJsonData:)​

public nonisolated func parseGeoJson(
    geoJsonData: String
) -> [GeometryMapObject]
Parameters

geoJsonData

Returns
GeometryMapObject[]

parseGeoJsonFile(fsPath:)​

public nonisolated func parseGeoJsonFile(
    fsPath: String
) -> [GeometryMapObject]
Parameters

fsPath

Returns
GeometryMapObject[]

projectionZToStyleZ(projectionZ:latitude:)​

public nonisolated func projectionZToStyleZ(
    projectionZ: Zoom,
    latitude: Latitude
) -> StyleZoom
Parameters

projectionZ

latitude

Returns
StyleZoom

remainingRouteGeometry(fullRouteGeometry:currentRoutePoint:)​

public nonisolated func remainingRouteGeometry(
    fullRouteGeometry: GeoPointRouteAttribute,
    currentRoutePoint: RoutePoint
) -> GeoPointRouteAttribute
Parameters

fullRouteGeometry

Full geometry of the entire route.

currentRoutePoint

Current position on the route.

Returns
GeoPointRouteAttribute

Geometry of the rest of the route.

routeMatchesTruckPassZonePasses(truckPassZoneIds:passZonePasses:)​

public nonisolated func routeMatchesTruckPassZonePasses(
    truckPassZoneIds: TruckPassZoneIdRouteLongAttribute,
    passZonePasses: [TruckPassZonePass]
) -> Bool
Parameters

truckPassZoneIds

Route attribute with truck pass zone identifiers.

passZonePasses

Passes for passing through truck pass zones.

Returns
Bool

Signifies whether there are enough passes to pass a route.

styleZToProjectionZ(styleZ:latitude:)​

public nonisolated func styleZToProjectionZ(
    styleZ: StyleZoom,
    latitude: Latitude
) -> Zoom
Parameters

styleZ

latitude

Returns
Zoom

toMapGeometry(geometry:)​

public nonisolated func toMapGeometry(
    geometry: GeoPointRouteAttribute
) -> Geometry
Parameters

geometry

Returns
Geometry

zoomOutToFit(camera:geometry:styleZoomToTiltRelation:size:)​

public nonisolated func zoomOutToFit(
    camera: BaseCamera,
    geometry: Geometry,
    styleZoomToTiltRelation: StyleZoomToTiltRelation? = nil,
    size: ScreenSize? = nil
) throws -> CameraPosition
Parameters

camera

Camera used for position calculation.

geometry

Geometry object to be embedded into the screen area defined by camera paddings.

styleZoomToTiltRelation

Dependence function of the camera tilt angle on the style scaling level.

size

Size of the view area. If not specified, the ICamera::size() value is used.

Returns
CameraPosition

zoomOutToFit(camera:objects:styleZoomToTiltRelation:size:)​

public nonisolated func zoomOutToFit(
    camera: BaseCamera,
    objects: [SimpleMapObject],
    styleZoomToTiltRelation: StyleZoomToTiltRelation? = nil,
    size: ScreenSize? = nil
) throws -> CameraPosition
Parameters

camera

Camera used for position calculation.

objects

Map objects that must be embedded into the screen area defined by internal camera paddings.

styleZoomToTiltRelation

Dependence function of the camera tilt angle on the style zoom level.

size

Size of the view area. If not specified, the ICamera::size() value is used.

Returns
CameraPosition