Описание API

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

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

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

Функция Описание
gis_helper_debug_file_getpath() Получение имени файла, в который направляется отладочный вывод.
gis_helper_debug_file_setname() Задание имени файла, в который будет перенаправлен отладочный вывод.
gis_helper_debug_mode_getmask() Получение маски отладочного вывода.
gis_helper_debug_mode_name() Получение строки, описывающей текущий режим работы отладочного вывода.
gis_helper_debug_mode_setlvl() Установка уровня подробности отладочного вывода.
gis_helper_debug_mode_setmask() Установка режима работы отладочного вывода.
gis_helper_debug_write() Вывод отладочного сообщения.
gis_helper_debug_write_lvl() Вывод отладочного сообщения с заданным уровнем отладки.
gis_helper_debug_write_mask() Вывод отладочного сообщения с заданной маской режима работы.
Тип Описание
gis_debug_level_t Уровни отладки.
gis_debug_mode_t Маска режимов отладки.

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

Функция Описание
gis_core_class_data_base_code() Декодирование кода класса, соответствующего оригиналу карты.
gis_core_class_data_init() Инициализация информации о классе объекта карты.
gis_core_class_list_free() Освобождение списка классов некторой карты для выбранного драйвера.
gis_core_class_list_init() Инициализация списка классов.
gis_core_class_list_reinit() Повторная инициализация списка классов.
gis_core_link_connect() Подключение к картографическому ядру.
gis_core_link_destroy() Завершение открытой сессии с картографическим ядром.
gis_core_link_init() Инициализация параметров дескриптора соединения с картографическим ядром.
gis_core_map_list_free() Освобождение списка доступных для выбранного драйвера карт.
gis_core_map_list_get_entry() Получение информации о доступной карте по ее идентификатору.
gis_core_map_list_init() Инициализация списка карт.
gis_core_request_connection_state() Запрос состояния соединения драйвера картографического ядра с источником данных.
gis_core_request_download_maps() Запрос загрузки карт из источника данных.
gis_core_request_driver_acronym() Запрос на получение акронима драйвера.
gis_core_request_driver_connect() Запрос на установление соединения драйвера картографического ядра с источником данных (сервером).
gis_core_request_driver_info() Запрос информации о конкретном драйвере картографического ядра.
gis_core_request_drivers_prefix() Запрос префикса путей источников данных драйверов.
gis_core_request_map_class_list() Получение списка классов некоторой карты для выбранного драйвера.
gis_core_request_maps_list() Получение списка доступных карт для выбранного драйвера.
gis_core_request_parameters_are_correct() Проверка параметров запроса картографической информации.
gis_core_request_parameters_init() Инициализация параметров запроса к ядру.
gis_core_request_parameters_set_borders() Установка границ региона запроса к картографическому ядру.
gis_core_request_parameters_set_data_source() Установка типа запрашиваемых у картографического ядра данных.
gis_core_request_parameters_set_driver() Установка типа драйвера в запросе к картографическому ядру.
gis_core_request_update_cached_map() Обновление карты в картографическом кэше.
gis_core_request_update_cache() Синхронизация изменений в картографическом кэше.
gis_helper_get_core_data_source_name() Получение строки с названием типа оригинала карты.
gis_helper_get_map_source_by_driver_id() Получение типа оригинала карты по уникальному идентификатору драйвера источника данных.
gis_helper_get_map_style_by_data_source() Получение типа стиля карты по формату карты.
gis_helper_get_map_style_name() Получение строки с названием типа стиля карты.
gis_helper_is_data_source_valid() Проверка типа оригинала карты.
gis_helper_is_map_style_valid() Проверка корректности типа стиля карты.
Тип Описание
gis_core_class_code_t Кода класс объектов в карте во внутреннем формате (GCM).
gis_core_class_data_t Расширенное описание кода класса объектов в карте во внутреннем формате (GCM).
gis_core_class_info_t Информация о классе объектов в карте во внутреннем формате (GCM).
gis_core_class_list_t Список классов карты для выбранного драйвера
gis_core_connection_state_t Состояние связи с картографическим ядром.
gis_core_connection_t Дескриптор соединения с ядром картографического сервиса.
gis_core_driver_id_t Уникальный идентификатор драйвера источника данных.
gis_core_driver_info_t Структура информации о драйвере.
gis_core_hash_t Хэш файла или карты.
gis_core_map_data_source_t Тип оригинала карты во внутреннем формате (GCM).
gis_core_map_information_t Информация о карте во внутреннем формате (GCM).
gis_core_map_list_t Список карт, доступных для выбранного драйвера.
gis_core_request_parameters_t Структура запроса к ядру картографического сервиса.
gis_core_update_cache_mode_t Режимы обновления кэша данных.
gis_map_style_t Тип стиля карты.

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

Функция Описание
gis_core_databuffer_attach() Функция подключения области данных к программе.
gis_core_databuffer_check() Функция проверки области данных.
gis_core_databuffer_data_request() Функция запроса данных у картографического ядра для выбранного региона.
gis_core_databuffer_detach() Функция отключения области данных от программы.
gis_core_databuffer_resize() Задание размера области данных.
gis_core_databuffer_size() Функция запроса размера области данных.
Тип Описание
gis_databuffer_desc_t Дескриптор разделяемой области данных.
Класс/Метод Описание
class ClassifierInfo Класс, описывающий информацию о конкретном классификаторе.
class ClassifierLayerInfo Класс, описывающий информацию о конкретном слое в классификаторе.
class DBCallbacks Оповещение о состоянии разделяемой области памяти.
class LayerInfo Класс, описывающий информацию о слоях и поверхностях Surface Manager.
class MapInfo Класс, описывающий информацию о карте в РОП.
class SMCallbacks Класс, предоставляющий интерфейс функций-обработчиков для движка рендеринга Surface Manager.
DBCallbacks::databufferValidityChangedCallback() Функция оповещения о корректности РОП.
SMCallbacks::errorCallback() Обработчик ошибок рисования.
SMCallbacks::mapClassRequiredCallback() Флаг необходимости рисования класса объектов векторной карты.
SMCallbacks::mapLayerCompleteCallback() Завершение рисования слоя объектов векторной карты.
SMCallbacks::mapLayerRequiredCallback() Флаг необходимости рисования слоя объектов векторной карты.
SMCallbacks::surfaceCompleteCallback() Завершение рисования поверхности.
Тип Описание
gis_object_t Информация об объекте из области данных.
Класс/Метод Описание
class GisObjectList Список географических объектов.
GisObjectList::find_nearest_object() Функция поиска ближайшего к заданной точке объекта.
GisObjectList::find_nearest_point() Функция поиска ближайшей точки объекта к заданной.
GisObjectList::get_object_count() Функция, возвращаюшая количество объектов в списке.
GisObjectList::get_object() Функция, возвращаюшая объект в списке по индексу.
GisObjectList::~GisObjectList() Деструктор класса GisObjectList.
GisObjectList::GisObjectList() Конструктор класса GisObjectList.

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

Функция Описание
gis_data_engine_alloc() Создание контекста движка рендеринга.
gis_data_engine_free() Освобождение контекста движка рендеринга.
gis_data_engine_get_classifier_list() Получение списка классификаторов с информацией о слоях.
gis_data_engine_get_class_list() Получение списка активных классов.
gis_data_engine_get_display_parameters() Получение указателя на контекст параметров визуализации.
gis_data_engine_get_map_list() Получение списка карт с привязкой к классификаторам.
gis_data_engine_get_maps_projection() Получение информации о проекции отображения.
gis_data_engine_set_canvas_size() Обновление размера окна отображения движка рендеринга.
gis_data_engine_set_notify_func() Установка функции-обработчика на событие изменения состояния области данных.
gis_data_engine_update() Обновление области данных движка рендеринга.
gis_data_engine_validity_changed() Оповещение об изменении состояния движка рендеринга.
Тип Описание
gis_data_engine_context_t Контекст движка рендеринга.

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

Функция Описание
gis_gui_get_projection_parameters() Создание диалога установки проекции отображения.
gis_gui_get_screen_parameters() Создание диалога установки параметров экрана.
gis_map_ellipsoid_get_full_name() Получение названия эллипсоида по его индексу.
gis_map_height_system_get_full_name() Получение названия системы высот по её индексу.
gis_map_projection_get_full_name() Получение названия проекции по её индексу.
gis_map_projection_has_zone() Проверка наличия у проекции разделения на зоны.
gis_map_projection_init() Инициализация параметров проекции карты.
gis_map_projection_is_filled() Проверка расширенного контекста проекции карты.
gis_map_projection_zero() Обнуление параметров проекции.
gis_mdp_get_center_point_deg() Получение градусных координат центра отображения карты.
gis_mdp_get_display_resolution() Получение установленного разрешения экрана в пикселях.
gis_mdp_get_display_size() Получение установленного размера экрана в миллиметрах.
gis_mdp_get_map_antialiasing_level() Получение текущего уровня сглаживания карты.
gis_mdp_get_phys_scale() Получение текущего масштаба отображения карты.
gis_mdp_get_projection() Получение текущей проекции отображения карты.
gis_mdp_get_raster_height_mode() Получение режима выбора границ высот для растровых файлов.
gis_mdp_get_raster_lower_height_limit() Получение нижнего предела высот отображения для растровых файлов.
gis_mdp_get_raster_upper_height_limit() Получение верхнего предела высот отображения для растровых файлов.
gis_mdp_get_scaling_mode() Получение режима масштабирования для текущего отображения карты.
gis_mdp_set_background_color() Установка цвета фона карты.
gis_mdp_set_brightness_contrast() Установка яркости и контрастности отображения.
gis_mdp_set_center_point() Установка центра отображения карты.
gis_mdp_set_center_point_ptr() Установка указателя на центр отображения карты.
gis_mdp_set_display_resolution() Установка разрешения экрана для текущего отображения карты.
gis_mdp_set_display_size() Установка геометрических размеров экрана для текущего отображения карты.
gis_mdp_set_map_antialiasing_level() Установка уровня сглаживания карты.
gis_mdp_set_phys_scale() Установка масштаба текущего отображения карты.
gis_mdp_set_projection() Установка проекции текущего отображения карты.
gis_mdp_set_raster_color_mode() Установка типа заливки для рисования растра.
gis_mdp_set_raster_height_limits() Установка диапазона высот отображения для растровых файлов.
gis_mdp_set_raster_height_mode() Установка режима выбора границ высот для растровых файлов.
gis_mdp_set_raster_palette() Установка параметров для рисования растра.
gis_mdp_set_scaling_mode() Установка режима масштабирования для текущего отображения карты.
Тип Описание
gis_map_ellipsoid_idx_t Индекс эллипсоида картографической информации.
gis_map_height_system_idx_t Индекс системы высот картографической информации.
gis_map_projection_idx_t Индекс проекции картографической информации.
gis_map_projection_t Расширенный контекст проекции карты.
gis_mdp_t Контекст параметров визуализации.

Движок surface-manager

Функция Описание
gis_render_sm_alloc() Создание контекста движка рендеринга.
gis_render_sm_calculate_distance() Вычисление метрического расстояния между градусными точками.
gis_render_sm_calculate_polygon() Вычисление параметров полигона.
gis_render_sm_convert_degree2fpx() Преобразование градусных координат точки в пиксельные координаты окна отображения с сохранением дробной части.
gis_render_sm_convert_degree2px() Преобразование градусных координат точки в пиксельные координаты окна отображения.
gis_render_sm_convert_fpx2degree() Преобразование пиксельных координат точки окна отображения в градусные с сохранением дробной части.
gis_render_sm_convert_fpx2meters() Преобразование пиксельных координат точки окна отображения в метрические координаты с сохранением дробной части.
gis_render_sm_convert_px2degree() Преобразование пиксельных координат точки окна отображения в градусные.
gis_render_sm_convert_px2meters() Преобразование пиксельных координат точки окна отображения в метрические координаты.
gis_render_sm_draw() Вызов обработчика рисования движка рендеринга Surface Manager.
gis_render_sm_free() Освобождение контекста движка рендеринга Surface Manager.
gis_render_sm_get_layer_type() Получение типа слоя, назначенного указанной поверхности.
gis_render_sm_get_view_pixmap() Получение поверхности окна отображения Surface Manager.
gis_render_sm_move() Перемещение карты.
gis_render_sm_redraw_userobject() Перериоовка пользовательского слоя.
gis_render_sm_rescale() Масштабирование карты.
gis_render_sm_set_layer_type() Назначение конкретного слоя заданной поверхности.
gis_render_sm_set_render_mode() Установка режима рисования движка рендеринга Surface Manager.
gis_render_sm_set_update_func() Установка функции оповещения о состоянии рисования Surface Manager.
gis_render_sm_sync() Перерисовка поверхности отображения.
gis_render_sm_update() Масштабирование карты.
gis_render_sm_userdata_add_bitmap() Добавление изображения.
gis_render_sm_userdata_add_polygon() Добавление полигона.
gis_render_sm_userdata_add_polyline() Добавление полилинии.
gis_render_sm_userdata_delete_object() Удаление пользовательского объекта.
gis_render_sm_userdata_edit_object_color() Изменение цвета объекта.
gis_render_sm_userdata_edit_object_points() Изменение точек объекта.
Тип Описание
gis_render_sm_context_t Контекст движка рендеринга Surface Manager.
gis_render_sm_layer_type_t Слои движка рендеринга.
userobject_t Тип пользовательского объекта движка рендеринга Surface Manager.

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

Функция Описание
gis_data_raw_ctx_alloc() Создание контекста RAW для работы с областью данных.
gis_data_raw_ctx_free() Удаление контекста RAW, необходимого для работы с областью данных.
gis_data_raw_ctx_import_databuffer() Получение указателя на разделяемую область памяти.
gis_data_raw_get_map_count() Получение количества карт в разделяемой области памяти.
gis_data_raw_map_get_data_source() Получение типа выбранной карты.
gis_data_raw_map_get_object_count() Получение количества объектов в текущей выбранной карте разделяемой области памяти.
gis_data_raw_map_select_first_object() Выбор первого объекта в текущей карте разделяемой области памяти.
gis_data_raw_map_select_next_object() Выбор следующего объекта в текущей карте разделяемой области памяти.
gis_data_raw_map_select_object() Выбор объекта в текущей карте разделяемой области памяти по индексу.
gis_data_raw_object_get_class_code() Получение кода класса выбранного объекта текущей карты.
gis_data_raw_object_get_data() Получение массива точек выбранного объекта текущей карты.
gis_data_raw_object_get_height() Получение высоты выбранного объекта текущей карты.
gis_data_raw_object_get_point_count() Получение количества точек в выбранном объекте текущей карты.
gis_data_raw_object_get_type() Получение типа примитива выбранного объекта текущей карты.
gis_data_raw_raster_maps_get_height_limits() Получение пределов высот для всех растровых карт в разделяемой области памяти.
gis_data_raw_select_first_map() Выбор первой карты в разделяемой области памяти.
gis_data_raw_select_map_by_index() Выбор карты в разделяемой области памяти по индексу.
gis_data_raw_select_next_map() Выбор следующей карты в разделяемой области памяти.
gis_helper_are_maps_equal() Сравнение двух карт.
gis_helper_convert_point_degrees_2_meters() Преобразование координат точки (градусы) в координаты точки в метрической системе проекции.
gis_helper_convert_point_meters_2_degrees_array() Преобразование координат массива точек в метрах (проекции) в координаты градусной меры.
gis_helper_convert_point_meters_2_degrees() Преобразование координат точки в метрах (проекции) в координаты градусной меры.
gis_helper_env_get_gis_root_directory() Получение текущего значения переменной окружения GIS_ROOT.
gis_helper_env_get_maps_cache_directory() Получение текущего значения переменной окружения GIS_CORE_MAP_CACHE.
gis_helper_math_free_ctx() Освобождение математического контекста.
gis_helper_math_generate_meters_projection() Заполнение метрических параметров математического контекста по переданным параметрам проекции.
gis_helper_math_get_degrees_projection() Получение строки, описывающей градусную проекцию, в формате PROJ.4.
gis_helper_math_get_meters_projection() Получение строки, описывающей метрическую проекцию, в формате PROJ.4.
gis_helper_math_init_ctx() Инициализация математического контекста.
gis_object_primitive_type_get_full_name() Получение строки с названием типа примитива объекта карты.
Тип Описание
gis_borders_t Границы картографической информации.
gis_data_raw_context_t Контекст низкоуровневого доступа к данным.
gis_helper_math_ctx_t Контекст математических операций.
gis_object_primitive_type_t Типы примитивов объекта карты.
int32_point_t, float_point_t, double_point_t Представление примитива 'точка'.
object_point_t Представление 'точки' объекта.

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

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

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

Функция Описание
kd_add() Добавление нового узла.
kd_destroy() Удаление КД дерева.
kd_dnn() Поиск узлов в заданном радиусе.
kd_init() Создание КД дерева.
kd_knn() Поиск K ближайших узлов.
kd_rnn() Поиск узлов в заданном диапазоне.
Тип Описание
gis_kd_tree_t Структура КД дерева.
gis_kd_uniq_id Структура идентификатора узла.




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