Описание API

Описание API включает в себя группировку используемых функций и типов

Глава включает следующие разделы:

Управление отладочным выводом
Управление картографическим ядром (сервисом)
Управление стилем отображения векторных карт
Управление областью данных
Управление движком визуализации (рендеринга)
Параметры отображения карты
Движок surfacemanager
Движок renderbuffer

Общие функции и типы данных
Дополнительные API
API для написания пользовательского драйвера форматов карт
Работа с конфигурационными файлами
Работа с таймером
Библиотека kd-tree

Управление отладочным выводом

Функция Описание
Получение имени файла, в который направляется отладочный вывод.
Задание имени файла, в который будет перенаправлен отладочный вывод.
Получение маски отладочного вывода.
Получение строки, описывающей текущий режим работы отладочного вывода.
Установка уровня подробности отладочного вывода.
Установка режима работы отладочного вывода.
Вывод отладочного сообщения.
Вывод отладочного сообщения с заданным уровнем отладки.
Вывод отладочного сообщения с заданной маской режима работы.
Тип Описание
Уровни отладки.
Маска режимов отладки.

Управление картографическим ядром (сервисом)

Функция Описание
Декодирование кода класса, соответствующего оригиналу карты.
Инициализация информации о классе объекта карты.
Освобождение списка классов некоторой карты для выбранного драйвера.
Инициализация списка классов.
Повторная инициализация списка классов.
Подключение к картографическому ядру.
Завершение открытой сессии с картографическим ядром.
Инициализация параметров дескриптора соединения с картографическим ядром.
Освобождение списка доступных для выбранного драйвера карт.
Получение информации о доступной карте по ее идентификатору.
Инициализация списка карт.
Запрос состояния соединения драйвера картографического ядра с источником данных.
Запрос загрузки карт из источника данных.
Запрос на получение акронима драйвера.
Запрос на установление соединения драйвера картографического ядра с источником данных (сервером).
Запрос информации о конкретном драйвере картографического ядра.
Запрос префикса путей источников данных драйверов.
Получение списка классов некоторой карты для выбранного драйвера.
Получение списка доступных карт для выбранного драйвера.
Проверка параметров запроса картографической информации.
Инициализация параметров запроса к ядру.
Установка границ региона запроса к картографическому ядру.
Установка типа запрашиваемых у картографического ядра данных.
Установка типа драйвера в запросе к картографическому ядру.
Получение номера версии и ревизии картографического ядра.
Синхронизация изменений в картографическом кэше.
Обновление карты в картографическом кэше.
Получение строки с названием типа оригинала карты.
Получение типа оригинала карты по уникальному идентификатору драйвера источника данных.
Проверка типа оригинала карты.
Тип Описание
Кода класс объектов в карте во внутреннем формате (GCM).
Расширенное описание кода класса объектов в карте во внутреннем формате (GCM).
Информация о классе объектов в карте во внутреннем формате (GCM).
Список классов карты для выбранного драйвера
Состояние связи с картографическим ядром.
Дескриптор соединения с ядром картографического сервиса.
Уникальный идентификатор драйвера источника данных.
Структура информации о драйвере.
Хэш файла или карты.
Тип оригинала карты во внутреннем формате (GCM).
Информация о карте во внутреннем формате (GCM).
Список карт, доступных для выбранного драйвера.
Структура запроса к ядру картографического сервиса.
Режимы обновления кэша данных.
Макрос Описание
Обход всех доступных драйверов в цикле.
Контроль корректности идентификатора драйвера.
Проверка, является ли выбранный источник данных векторным либо растровым.

Управление стилем отображения векторных карт

Функция Описание
Получение типа стиля карты по формату карты.
Получение строки с названием типа стиля карты.
Проверка корректности типа стиля карты.
Получение списка классификаторов отображаемых карт.
Переключение языка карты на международный/национальный.
Получение индекса активной палитры.
Получение списка палитр для выбранного стиля векторных карт.
Получение параметров отображения глубины.
Получение размера списка палитр.
Получение непосредственно списка палитр из структуры.
Получение стиля векторных карт из списка палитр.
Освобождение списка палитр.
Установка индекса активной палитры.
Установка параметров отображения глубины.
Тип Описание
Тип стиля карты.
Список палитр стиля векторных карт.
Дескриптор векторной палитры.

Управление областью данных

Функция Описание
Функция подключения области данных к программе.
Функция проверки области данных.
Функция запроса данных у картографического ядра для выбранного региона.
Функция отключения области данных от программы.
Задание размера области данных.
Функция запроса размера области данных.
Освобождение памяти объекта из области данных.
Инициализация объекта из области данных.
Тип Описание
Дескриптор разделяемой области данных.
Класс/Метод Описание
Класс, описывающий информацию о конкретном классификаторе.
Класс, описывающий информацию о конкретном слое в классификаторе.
Оповещение о состоянии разделяемой области памяти.
Класс, описывающий информацию о слоях и поверхностях Surface Manager.
Класс, описывающий информацию о карте в РОП.
Класс, предоставляющий интерфейс функций-обработчиков для движка рендеринга Surface Manager.
Функция оповещения о корректности РОП.
Обработчик ошибок рисования.
Флаг необходимости рисования класса объектов векторной карты.
Завершение рисования слоя объектов векторной карты.
Флаг необходимости рисования слоя объектов векторной карты.
Завершение рисования поверхности.
Тип Описание
Информация об объекте из области данных.
Класс/Метод Описание
Список географических объектов.
Функция поиска ближайшего к заданной точке объекта.
Функция поиска ближайшей точки объекта к заданной.
Функция, возвращающая объект в списке по индексу.
Функция, возвращающая количество объектов в списке.
Деструктор класса GisObjectList.
Конструктор класса GisObjectList.

Управление движком визуализации (рендеринга)

Функция Описание
Создание контекста движка рендеринга.
Освобождение контекста движка рендеринга.
Получение размера окна отображения движка рендеринга.
Получение списка классификаторов с информацией о слоях.
Получение списка активных классов.
Получение указателя на контекст параметров визуализации.
Получение списка карт с привязкой к классификаторам.
Получение информации о проекции отображения.
Обновление размера окна отображения движка рендеринга.
Установка функции-обработчика на событие изменения состояния области данных.
Обновление области данных движка рендеринга.
Оповещение об изменении состояния движка рендеринга.
Тип Описание
Контекст движка рендеринга.

Параметры отображения карты

Функция Описание
Создание диалога установки проекции отображения.
Создание диалога установки параметров экрана.
Получение названия эллипсоида по его индексу.
Получение названия системы высот по её индексу.
Получение названия проекции по её индексу.
Проверка наличия у проекции разделения на зоны.
Инициализация параметров проекции карты.
Проверка расширенного контекста проекции карты.
Обнуление параметров проекции.
Получение цвета фона карты.
Получение значений яркости и контрастности отображения.
Получение градусных координат центра отображения карты.
Получение установленного разрешения экрана в пикселях.
Получение установленного размера экрана в миллиметрах.
Получение текущего уровня сглаживания карты.
Получение текущего масштаба отображения карты.
Получение текущей проекции отображения карты.
Получение типа заливки для рисования растра.
Получение режима выбора границ высот для растровых файлов.
Получение цвета отображения высот вне заданного диапазона.
Получение нижнего предела высот отображения для растровых файлов.
Получение палитры для рисования растра.
Получение верхнего предела высот отображения для растровых файлов.
Получение режима масштабирования для текущего отображения карты.
Установка цвета фона карты.
Установка яркости и контрастности отображения.
Установка центра отображения карты.
Установка указателя на центр отображения карты.
Установка разрешения экрана для текущего отображения карты.
Установка геометрических размеров экрана для текущего отображения карты.
Установка уровня сглаживания карты.
Установка масштаба текущего отображения карты.
Установка проекции текущего отображения карты.
Установка типа заливки для рисования растра.
Установка диапазона высот отображения для растровых файлов.
Установка режима выбора границ высот для растровых файлов.
Установка цвета отображения высот вне заданного диапазона.
Установка палитры для рисования растра.
Установка режима масштабирования для текущего отображения карты.
Тип Описание
Индекс эллипсоида картографической информации.
Индекс системы высот картографической информации.
Индекс проекции картографической информации.
Расширенный контекст проекции карты.
Контекст параметров визуализации.

Движок surfacemanager

Функция Описание
Создание контекста движка рендеринга.
Вычисление длины траектории, описываемой градусными точками.
Вычисление параметров полигона.
Преобразование градусных координат точки в пиксельные координаты окна отображения с сохранением дробной части.
Преобразование градусных координат точки в пиксельные координаты окна отображения.
Преобразование пиксельных координат точки окна отображения в градусные с сохранением дробной части.
Преобразование пиксельных координат точки окна отображения в метрические координаты с сохранением дробной части.
Преобразование пиксельных координат точки окна отображения в градусные.
Преобразование пиксельных координат точки окна отображения в метрические координаты.
Вызов обработчика рисования движка рендеринга Surface Manager.
Освобождение контекста движка рендеринга Surface Manager.
Получение значений границ холста в градусах.
Получение типа слоя, назначенного указанной поверхности.
Получение режима рисования движка рендеринга Surface Manager.
Получение поверхности окна отображения Surface Manager.
Обработчик перемещения карты.
Перерисовка пользовательского слоя.
Масштабирование карты.
Назначение форматов карт для отображения в заданной поверхности.
Назначение типа слоя заданной поверхности.
Установка режима рисования движка рендеринга Surface Manager.
Установка функции оповещения о состоянии рисования Surface Manager.
Задать тип следующей операции рисования.
Обновление параметров Surface Manager.
Добавление изображения.
Добавление точки контура.
Добавление полигона.
Добавление полилинии.
Удаление точки контура.
Удаление пользовательского объекта.
Изменение цвета объекта.
Изменение точек объекта.
Тип Описание
Контекст движка рендеринга Surface Manager.
Слои движка рендеринга.
Тип пользовательского объекта движка рендеринга Surface Manager.

Движок renderbuffer

Функция Описание
Создание контекста движка рендеринга.
Рисование карты.
Освобождение контекста движка рендеринга.
Тип Описание
Контекст движка рендеринга Render Buffer.

Общие функции и типы данных

Функция Описание
Создание контекста RAW для работы с областью данных.
Удаление контекста RAW, необходимого для работы с областью данных.
Получение указателя на разделяемую область памяти.
Получение количества карт в разделяемой области памяти.
Получение количества блоков растровых данных в текущей карте разделяемой области памяти
Получение высоты блока растровых данных
Получение координат верхнего левого угла указанного блока растровой карты (метры в проекции растра)
Получение ширины блока растровых данных
Получение данных блока растровых данных
Получение высоты текущей растровой карты в блоках
Получение высоты растровой карты (в элементах)
Получение разрешения растровой карты (метры на элемент)
Получение координат верхнего левого угла растровой карты (метры в проекции растра)
Получение ширины текущей растровой карты в блоках
Получение ширины растровой карты (в элементах)
Получение градусных границ текущей карты в разделяемой области памяти
Получение типа выбранной карты.
Получение названия текущей карты в разделяемой области памяти
Получение количества объектов в текущей выбранной карте разделяемой области памяти.
Получение проекции текущей карты в разделяемой области памяти
Выбор первого объекта в текущей карте разделяемой области памяти.
Выбор следующего объекта в текущей карте разделяемой области памяти.
Выбор объекта в текущей карте разделяемой области памяти по индексу.
Получение описывающего прямоугольника для объекта.
Получение кода класса выбранного объекта текущей карты.
Получение массива точек выбранного объекта текущей карты.
Получение высоты выбранного объекта текущей карты.
Получение количества точек в выбранном объекте текущей карты.
Получение типа примитива выбранного объекта текущей карты.
Получение пределов высот для всех растровых карт в разделяемой области памяти.
Выбор первой карты в разделяемой области памяти.
Выбор требуемой карты в разделяемой области памяти.
Выбор карты в разделяемой области памяти по индексу.
Выбор следующей карты в разделяемой области памяти.
Вывод информации о ПК ЦКИ.
Сравнение двух карт.
Преобразование координат точки (градусы) в координаты точки в метрической системе проекции.
Преобразование координат точки в метрах (проекции) в координаты градусной меры.
Преобразование координат массива точек в метрах (проекции) в координаты градусной меры.
Получение пути к директории, содержащей конфигурационные файлы.
Получение текущего значения переменной окружения GIS_ROOT.
Получение текущего значения переменной окружения GIS_CORE_MAP_CACHE.
Освобождение памяти списка строк.
Освобождение математического контекста.
Заполнение метрических параметров математического контекста по переданным параметрам проекции.
Получение строки, описывающей градусную проекцию, в формате PROJ.4.
Получение строки, описывающей метрическую проекцию, в формате PROJ.4.
Инициализация математического контекста.
Разбить строку по разделителю.
Получение строки с названием типа примитива объекта карты.
Тип Описание
Границы картографической информации.
Контекст низкоуровневого доступа к данным.
Контекст математических операций.
Типы примитивов объекта карты.
Представление примитива 'точка'.
Представление 'точки' объекта.
Макрос Описание
Контроль нахождения в диапазоне между двумя числами.
Конвертация градусных углов в радианы.
Проверка двух координат на равенство.
Проверка двух координат на равенство с использованием указателей.
Получение знака числа.
Конвертация радиан в градусные углы.

Дополнительные API

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

API для написания пользовательского драйвера форматов карт

Функция Описание
Проверить наличие папок с картами и стилями.
Заполнить список расширений карт.
Получить базовое имя карты без расширения.
Получить из файла конфигурации ядра один из основных (обязателньых) параметров драйвера.
Восстановить базу данных GCM.
Очистить базу данных GCM.
Синхронизировать кэш карт.
Переконвертировать карту в GCM.
Обновить информацию о картах GCM с одноимённой исходной картой.
Тип Описание
Список возможных расширений файлов карт.
Контекст драйвера формата карт.
Интерфейс драйвера формата исходной карты.
Макрос Описание
Маркер названия директории, хранящей карты формата GCM.
Маркер расширения карт формата GCM

Работа с конфигурационными файлами

Функция Описание
Получить из файла конфигурации ядра параметр драйвера.
Получить параметр из файла конфигурации ядра.
Обновить значение параметра драйвера в файле конфигурации ядра.
Макрос Описание
Маркеры названий разделов драйверов в конфигурационном файле ядра.

Работа с таймером

Функция Описание
Получение значения таймера.
Запустить таймер.
Остановить таймер.
Тип Описание
Таймер.

Библиотека kd-tree

Функция Описание
Добавление нового узла.
Удаление КД дерева.
Поиск узлов в заданном радиусе.
Создание КД дерева.
Поиск K ближайших узлов.
Поиск узлов в заданном диапазоне.
Тип Описание
Структура узла дерева.
Структура КД дерева.
Структура идентификатора узла.




Предыдущий раздел: Руководство разработчика