Skip to main content

method

no_name_provided​

fun <no name provided>(): Unit

Функциональный интерфейс, предоставляющий возможность распознавания речи для компонентов поиска в пользовательском интерфейсе.

Интерфейс предназначен для обработки голосового ввода и преобразования его в текст, который может быть использован в качестве поискового запроса. Реализован как функциональный интерфейс с единственным абстрактным методом.

Returns
Unit

AttributeValue(value)​

fun AttributeValue(value: Float): AttributeValue
Parameters

value

Float
Returns
AttributeValue

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

fun calcPosition(
	camera: BaseCamera,
	geometry: Geometry,
	styleZoomToTiltRelation: StyleZoomToTiltRelation? = null,
	screenArea: Padding? = null,
	tilt: Tilt? = null,
	bearing: Bearing? = null,
	size: ScreenSize? = null
): CameraPosition

Вычисление позиции камеры такой, что геометрический объект, расположенный на карте, полностью вписан в область экрана, заданную параметром screen_area.

Если не нужно изменять настройки оригинальной камеры, то можно настраивать скопированную через IBaseCamera::clone() камеру.

Parameters

camera

Камера, используемая для вычисления позиции.

geometry

Геометрический объект, который необходимо вписать в область экрана, заданную параметром screen_area.

styleZoomToTiltRelation

Функция зависимости угла наклона камеры от стилевого уровня масштабирования.

screenArea

область экрана, в которую нужно вписать геометрию. Если не задана, то для расчёта используется padding камеры.

tilt

наклон карты. Если не задан, то используется текущий наклон камеры.

bearing

поворот карты. Если не задан, то используется текущий поворот камеры.

size

Размер области просмотра. В случае, если не указано, используется значение ICamera::size().

Returns
CameraPosition

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

fun calcPosition(
	camera: BaseCamera,
	objects: List<SimpleMapObject>,
	styleZoomToTiltRelation: StyleZoomToTiltRelation? = null,
	screenArea: Padding? = null,
	tilt: Tilt? = null,
	bearing: Bearing? = null,
	size: ScreenSize? = null
): CameraPosition

Вычисление позиции камеры такой, что объекты карты полностью вписаны в область экрана, заданную параметром screen_area.

Parameters

camera

Камера, используемая для вычисления позиции.

objects

List<SimpleMapObject>

Объекты карты, которые необходимо вписать в область экрана, заданную параметром screen_area.

styleZoomToTiltRelation

Функция зависимости угла наклона камеры от стилевого уровня масштабирования.

screenArea

область экрана, в которую нужно вписать геометрию. Если не задана, то для расчёта используется padding камеры.

tilt

наклон карты. Если не задан, то используется текущий наклон камеры.

bearing

поворот карты. Если не задан, то используется текущий поворот камеры.

size

Размер области просмотра. В случае, если не указано, используется значение ICamera::size().

Returns
CameraPosition

Color(red,green,blue,alpha)​

fun Color(
	red: Int,
	green: Int,
	blue: Int,
	alpha: Int = 255
): Color
Parameters

red

Int

green

Int

blue

Int

alpha

Int
Returns
Color

computeRouteAltitudes(route,itemCount)​

fun computeRouteAltitudes(route: Route, itemCount: Int): List<RouteAltitudeItem>

Вычислить набор высот на маршруте для графика высот.

Parameters

route

Маршрут.

itemCount

Int

Количество элементов для графика высот, должно быть больше 1.

Returns
List<RouteAltitudeItem>

Набор элементов высот на маршруте для графика высот.

createDefaultMaxTiltRestriction()​

fun createDefaultMaxTiltRestriction(): StyleZoomToTiltRelation

Получаем стандартную зависимость максимального угла наклона от стилевого уровня масштабирования.

Returns
StyleZoomToTiltRelation

createDefaultStyleZoomToTiltRelation()​

fun createDefaultStyleZoomToTiltRelation(): StyleZoomToTiltRelation

Получение зависимости угла наклона камеры от стилевого уровня масштабирования для стандартного контроллера слежения за наклоном.

Returns
StyleZoomToTiltRelation

createModelData(context,data)​

fun createModelData(context: Context, data: ByteArray): ModelData
Parameters

context

data

ByteArray
Returns
ModelData

createModelData(context,loader)​

fun createModelData(context: Context, loader: Function0<ByteArray>): ModelData
Parameters

context

loader

() -> ByteArray
Returns
ModelData

createStyleZoomToTiltRelation(points)​

fun createStyleZoomToTiltRelation(points: Map): StyleZoomToTiltRelation

Создаем зависимость угла наклона камеры от стилевого уровня масштабирования.

Parameters

points

Map

Точки, по которым строится зависимость.

Returns
StyleZoomToTiltRelation

зависимость угла наклона камеры от стилевого уровня масштабирования, если создать зависимость не удалось - бросаем исключение.

Зависимость должна представлять собой монотонную непрерывную функцию. Если точками задана зависимость, не удовлетворяющая условиям, то функция бросает исключение. Зависимость, примерно как в 2гис, можно задать последовательностью точек 17,0,19,15,20,25 в режиме карты и 15,0,16,34,17,48 в режиме навигатора. Пусть нужно получить значение угла наклона камеры T для стилевого уровня масштабирования Z, такого что Z0 < = Z < Z1 и зависимость задана точками Z0,T0,Z1,T1. Тогда искомое значение рассчитывается по формуле T = T0 + k * (T1 - T0), где k = (Z - Z0) / (Z1 - Z0). Если Z < Z0, то T = T0. Если Z >= Z1, то T = T1.

createTrafficLineDrawable(context,height,routeLength,entries,colors)​

suspend fun createTrafficLineDrawable(
	context: Context,
	height: Int,
	routeLength: Double,
	entries: List<TrafficSpeedColorRouteLongEntry>,
	colors: TrafficLineColors
): Drawable?
Parameters

context

Context

height

Int

routeLength

Double

entries

List<TrafficSpeedColorRouteLongEntry>

colors

Returns
Drawable?

formatMeters(meters,context)​

fun formatMeters(meters: Int, context: Context): FormattedMeasure

Преобразование размера в метрах в FormattedMeasure для показа в UI-элементах навигатора.

Parameters

meters

Int

context

Context
Returns
FormattedMeasure

GeoPoint(latitude,longitude)​

fun GeoPoint(latitude: Double, longitude: Double): GeoPoint
Parameters

latitude

Double

longitude

Double
Returns
GeoPoint

GeoPointWithElevation(latitude,longitude,elevation)​

fun GeoPointWithElevation(
	latitude: Double,
	longitude: Double,
	elevation: Elevation = Elevation(0.0f)
): GeoPointWithElevation
Parameters

latitude

Double

longitude

Double

elevation

Returns
GeoPointWithElevation

GeoPointWithElevation(point,elevation)​

fun GeoPointWithElevation(point: GeoPoint, elevation: Elevation = Elevation(0.0f)): GeoPointWithElevation
Parameters

point

elevation

Returns
GeoPointWithElevation

getInstructionManeuver(extraInstructionInfo)​

fun getInstructionManeuver(extraInstructionInfo: ExtraInstructionInfo): InstructionManeuver

Получить манёвр, который необходимо совершить для движения по маршруту.

Parameters

extraInstructionInfo

Returns
InstructionManeuver

getLanesControlImages(laneSign,maxCount,ignoreActiveManeuver)​

fun getLanesControlImages(
	laneSign: RouteLaneSign,
	maxCount: Int,
	ignoreActiveManeuver: Boolean
): List<LanesControlImage>

Получить список изображений для отображения в контроле полосности. Количество изображений (без учета разделителей и многоточий) ограничено maxCount, если оно превышено, изображения с одной или обеих сторон обрезаются таким образом, чтобы осталось как можно больше изображений активных маневров. На стороне, где произошло удаление, отображается многоточие. В случае, если параметр ignoreActiveManeuver равен true, активный манёвр будет проигнорирован, и будет возвращено изображение, соответствующее всем разрешенным направлениям движения.

Parameters

laneSign

maxCount

Int

ignoreActiveManeuver

Boolean
Returns
List<LanesControlImage>

getPointObjects(routeLength,events,intermediatePoints)​

fun getPointObjects(
	routeLength: Double,
	events: List<RoadEventRouteEntry>,
	intermediatePoints: List<GeoPointRouteEntry>
): List<TrafficLinePointObject>
Parameters

routeLength

Double

events

List<RoadEventRouteEntry>

intermediatePoints

List<GeoPointRouteEntry>
Returns
List<TrafficLinePointObject>

getRouteEnclosingRects(routeGeometry,options)​

fun getRouteEnclosingRects(routeGeometry: GeoPointRouteAttribute, options: RouteEnclosingRectsOptions): List<Geometry>

Функция для получения набора прямоугольников, описанных вокруг упрощённой геометрии маршрута. Геометрия маршрута аппроксимируется ломаной линией с размером сегмента линии, равным segment_size. Для каждого сегмента формируется прямоугольник, отступающий в стороны от концов этого сегмента на offset метров.

Parameters

routeGeometry

Геометрия маршрута.

options

Параметры для получения набора прямоугольников.

Returns
List<Geometry>

Геометрия с набором прямоугольников, соответствующих сегментам маршрута, или null, если не удалось получить набор прямоугольников.

imageFromAsset(context,assetName,size)​

fun imageFromAsset(
	context: Context,
	assetName: String,
	size: Size? = null
): Image

context - Android контекст assetName - файл изображения size - целевой размер изображения (для SVG и Lottie игнорируется)

Parameters

context

assetName

String

size

Size?
Returns
Image

imageFromBitmap(context,bitmap)​

fun imageFromBitmap(context: Context, bitmap: Bitmap): Image
Parameters

context

bitmap

Bitmap
Returns
Image

imageFromBitmap(context,loader)​

fun imageFromBitmap(context: Context, loader: Function0<Bitmap>): Image
Parameters

context

loader

() -> Bitmap
Returns
Image

imageFromCanvas(context,size,block)​

fun imageFromCanvas(
	context: Context,
	size: Size,
	block: Function1
): Image
Parameters

context

size

Size

block

Canvas.() -> Unit
Returns
Image

imageFromLottieJSON(context,data)​

fun imageFromLottieJSON(context: Context, data: ByteArray): Image
Parameters

context

data

ByteArray
Returns
Image

imageFromLottieJSON(context,loader)​

fun imageFromLottieJSON(context: Context, loader: Function0<ByteArray>): Image
Parameters

context

loader

() -> ByteArray
Returns
Image

imageFromResource(context,resourceId,size)​

fun imageFromResource(
	context: Context,
	resourceId: Int,
	size: Size? = null
): Image

context - Android контекст resourceId - Android ресурс size - целевой размер изображения (для SVG и Lottie игнорируется)

Parameters

context

resourceId

Int

size

Size?
Returns
Image

imageFromSvg(context,data)​

fun imageFromSvg(context: Context, data: ByteArray): Image
Parameters

context

data

ByteArray
Returns
Image

imageFromSvg(context,loader)​

fun imageFromSvg(context: Context, loader: Function0<ByteArray>): Image
Parameters

context

loader

() -> ByteArray
Returns
Image

isBetterLocation(location,currentBestLocation)​

fun isBetterLocation(location: Location, currentBestLocation: Location?): Boolean
Parameters

location

Location

currentBestLocation

Location?
Returns
Boolean

kilometersPerHourToMetersPerSecond(kilometersPerHour)​

fun kilometersPerHourToMetersPerSecond(kilometersPerHour: Double): Double

Преобразование скорости в километрах в час в скорость в метрах в секунду.

Parameters

kilometersPerHour

Double
Returns
Double

max(a,b)​

fun max(a: TimePoint, b: TimePoint): TimePoint
Parameters

a

b

Returns
TimePoint

metersPerSecondToKilometersPerHour(metersPerSecond)​

fun metersPerSecondToKilometersPerHour(metersPerSecond: Double): Double

Преобразование скорости в метрах в секунду в скорость в километрах в час.

Parameters

metersPerSecond

Double
Returns
Double

metersToUiString(meters,context)​

fun metersToUiString(meters: Int, context: Context): String

Преобразование размера в метрах в строку для показа в UI-элементах навигатора.

Parameters

meters

Int

context

Context
Returns
String

min(a,b)​

fun min(a: TimePoint, b: TimePoint): TimePoint
Parameters

a

b

Returns
TimePoint

modelDataFromAsset(context,assetName)​

fun modelDataFromAsset(context: Context, assetName: String): ModelData

context - Android контекст assetName - файл модели

Parameters

context

assetName

String
Returns
ModelData

MutableChannel()​

fun MutableChannel(): MutableChannel<T>
Returns
MutableChannel<T>

MutableStatefulChannel(initialValue)​

fun MutableStatefulChannel(initialValue: T): MutableStatefulChannel<T>
Parameters

initialValue

T
Returns
MutableStatefulChannel<T>

parseGeoJson(geoJsonData)​

fun parseGeoJson(geoJsonData: String): List<GeometryMapObject>
Parameters

geoJsonData

String
Returns
List<GeometryMapObject>

parseGeoJsonFile(fsPath)​

fun parseGeoJsonFile(fsPath: String): List<GeometryMapObject>
Parameters

fsPath

String
Returns
List<GeometryMapObject>

projectionZToStyleZ(projectionZ,latitude)​

fun projectionZToStyleZ(projectionZ: Zoom, latitude: Latitude): StyleZoom
Parameters

projectionZ

latitude

Returns
StyleZoom

registerPlatformLocationSource(context,source)​

fun registerPlatformLocationSource(context: Context, source: LocationSource?): Unit

Регистрация источника геопозиции. В качестве источника по-умолчанию можно использовать DefaultLocationSource.

Parameters

context

source

Returns
Unit

registerPlatformMagneticSource(context,source)​

fun registerPlatformMagneticSource(context: Context, source: MagneticHeadingSource?): Unit
Parameters

context

source

Returns
Unit

remainingRouteGeometry(fullRouteGeometry,currentRoutePoint)​

fun remainingRouteGeometry(fullRouteGeometry: GeoPointRouteAttribute, currentRoutePoint: RoutePoint): GeoPointRouteAttribute

Вычисляет геометрию оставшейся части маршрута, т.е. геометрию, начинающуюся с точки, соответствующей текущей точке маршрута, и до конца маршрута. Если маршрут полностью пройден или текущая точка находится за пределами маршрута, возвращается пустая геометрия.

Parameters

fullRouteGeometry

Полная геометрия всего маршрута.

currentRoutePoint

Текущая позиция на маршруте.

Returns
GeoPointRouteAttribute

Геометрия оставшейся части маршрута

Сложность операции O(N), где N = full_route_geometry.size()

routeMatchesTruckPassZonePasses(truckPassZoneIds,passZonePasses)​

fun routeMatchesTruckPassZonePasses(truckPassZoneIds: TruckPassZoneIdRouteLongAttribute, passZonePasses: List<TruckPassZonePass>): Boolean

Проверяет, достаточен ли предоставленный список пропусков для проезда пропускных зон грузового транспорта, через которые проходит маршрут.

Если маршрут не проходит через какие-либо пропускные зоны для грузового транспорта, функция возвращает true

Parameters

truckPassZoneIds

Атрибут маршрута с идентификаторами пропускных зон для грузового транспорта.

passZonePasses

List<TruckPassZonePass>

Пропуски для проезда пропускных зон грузового транспорта.

Returns
Boolean

Признак достаточности пропусков для проезда по маршруту.

styleZToProjectionZ(styleZ,latitude)​

fun styleZToProjectionZ(styleZ: StyleZoom, latitude: Latitude): Zoom
Parameters

styleZ

latitude

Returns
Zoom

toMapGeometry(geometry)​

fun toMapGeometry(geometry: GeoPointRouteAttribute): Geometry

Преобразовать геометрию маршрута в IGeometryPtr.

Parameters

geometry

Returns
Geometry

zoomOutToFit(camera,geometry,styleZoomToTiltRelation,size)​

fun zoomOutToFit(
	camera: BaseCamera,
	geometry: Geometry,
	styleZoomToTiltRelation: StyleZoomToTiltRelation? = null,
	size: ScreenSize? = null
): CameraPosition

Вычисление позиции камеры, такой, что при неизменной точке установки камеры геометрический объект, расположенный на карте, умещается в область экрана, заданную padding'ом камеры.

Если не нужно изменять настройки оригинальной камеры, то можно настраивать скопированную через IBaseCamera::clone() камеру.

Parameters

camera

Камера, используемая для вычисления позиции.

geometry

Геометрический объект, который необходимо вписать в область экрана, заданную внутренними отступами (padding) камеры.

styleZoomToTiltRelation

Функция зависимости угла наклона камеры от стилевого уровня масштабирования.

size

Размер области просмотра. В случае, если не указано, используется значение ICamera::size().

Returns
CameraPosition

zoomOutToFit(camera,objects,styleZoomToTiltRelation,size)​

fun zoomOutToFit(
	camera: BaseCamera,
	objects: List<SimpleMapObject>,
	styleZoomToTiltRelation: StyleZoomToTiltRelation? = null,
	size: ScreenSize? = null
): CameraPosition

Вычисление позиции камеры, такой, что при неизменной точке установки камеры геометрический объект, расположенный на карте, умещается в область экрана, заданную padding'ом камеры.

Parameters

camera

Камера, используемая для вычисления позиции.

objects

List<SimpleMapObject>

Объекты карты, которые необходимо вписать в область экрана, заданную внутренними отступами (padding) камеры.

styleZoomToTiltRelation

Функция зависимости угла наклона камеры от стилевого уровня масштабирования.

size

Размер области просмотра. В случае, если не указано, используется значение ICamera::size().

Returns
CameraPosition