map.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_MAP_H
#define MAPLIBRE_NATIVE_C_MAP_H
 
#ifndef __cplusplus
#include <stdbool.h>
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "base.h"
#include "runtime.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum mln_camera_option_field : uint32_t {
  MLN_CAMERA_OPTION_CENTER = 1U << 0U,
  MLN_CAMERA_OPTION_ZOOM = 1U << 1U,
  MLN_CAMERA_OPTION_BEARING = 1U << 2U,
  MLN_CAMERA_OPTION_PITCH = 1U << 3U,
  MLN_CAMERA_OPTION_CENTER_ALTITUDE = 1U << 4U,
  MLN_CAMERA_OPTION_PADDING = 1U << 5U,
  MLN_CAMERA_OPTION_ANCHOR = 1U << 6U,
  MLN_CAMERA_OPTION_ROLL = 1U << 7U,
  MLN_CAMERA_OPTION_FOV = 1U << 8U,
} mln_camera_option_field;

typedef enum mln_animation_option_field : uint32_t {
  MLN_ANIMATION_OPTION_DURATION = 1U << 0U,
  MLN_ANIMATION_OPTION_VELOCITY = 1U << 1U,
  MLN_ANIMATION_OPTION_MIN_ZOOM = 1U << 2U,
  MLN_ANIMATION_OPTION_EASING = 1U << 3U,
} mln_animation_option_field;

typedef enum mln_camera_fit_option_field : uint32_t {
  MLN_CAMERA_FIT_OPTION_PADDING = 1U << 0U,
  MLN_CAMERA_FIT_OPTION_BEARING = 1U << 1U,
  MLN_CAMERA_FIT_OPTION_PITCH = 1U << 2U,
} mln_camera_fit_option_field;

typedef enum mln_bound_option_field : uint32_t {
  MLN_BOUND_OPTION_BOUNDS = 1U << 0U,
  MLN_BOUND_OPTION_MIN_ZOOM = 1U << 1U,
  MLN_BOUND_OPTION_MAX_ZOOM = 1U << 2U,
  MLN_BOUND_OPTION_MIN_PITCH = 1U << 3U,
  MLN_BOUND_OPTION_MAX_PITCH = 1U << 4U,
} mln_bound_option_field;

typedef enum mln_free_camera_option_field : uint32_t {
  MLN_FREE_CAMERA_OPTION_POSITION = 1U << 0U,
  MLN_FREE_CAMERA_OPTION_ORIENTATION = 1U << 1U,
} mln_free_camera_option_field;

typedef enum mln_projection_mode_field : uint32_t {
  MLN_PROJECTION_MODE_AXONOMETRIC = 1U << 0U,
  MLN_PROJECTION_MODE_X_SKEW = 1U << 1U,
  MLN_PROJECTION_MODE_Y_SKEW = 1U << 2U,
} mln_projection_mode_field;

typedef enum mln_map_debug_option : uint32_t {
  MLN_MAP_DEBUG_TILE_BORDERS = 1U << 1U,
  MLN_MAP_DEBUG_PARSE_STATUS = 1U << 2U,
  MLN_MAP_DEBUG_TIMESTAMPS = 1U << 3U,
  MLN_MAP_DEBUG_COLLISION = 1U << 4U,
  MLN_MAP_DEBUG_OVERDRAW = 1U << 5U,
  MLN_MAP_DEBUG_STENCIL_CLIP = 1U << 6U,
  MLN_MAP_DEBUG_DEPTH_BUFFER = 1U << 7U,
} mln_map_debug_option;

typedef enum mln_north_orientation : uint32_t {
  MLN_NORTH_ORIENTATION_UP = 0,
  MLN_NORTH_ORIENTATION_RIGHT = 1,
  MLN_NORTH_ORIENTATION_DOWN = 2,
  MLN_NORTH_ORIENTATION_LEFT = 3,
} mln_north_orientation;

typedef enum mln_constrain_mode : uint32_t {
  MLN_CONSTRAIN_MODE_NONE = 0,
  MLN_CONSTRAIN_MODE_HEIGHT_ONLY = 1,
  MLN_CONSTRAIN_MODE_WIDTH_AND_HEIGHT = 2,
  MLN_CONSTRAIN_MODE_SCREEN = 3,
} mln_constrain_mode;

typedef enum mln_viewport_mode : uint32_t {
  MLN_VIEWPORT_MODE_DEFAULT = 0,
  MLN_VIEWPORT_MODE_FLIPPED_Y = 1,
} mln_viewport_mode;

typedef enum mln_map_viewport_option_field : uint32_t {
  MLN_MAP_VIEWPORT_OPTION_NORTH_ORIENTATION = 1U << 0U,
  MLN_MAP_VIEWPORT_OPTION_CONSTRAIN_MODE = 1U << 1U,
  MLN_MAP_VIEWPORT_OPTION_VIEWPORT_MODE = 1U << 2U,
  MLN_MAP_VIEWPORT_OPTION_FRUSTUM_OFFSET = 1U << 3U,
} mln_map_viewport_option_field;

typedef enum mln_tile_lod_mode : uint32_t {
  MLN_TILE_LOD_MODE_DEFAULT = 0,
  MLN_TILE_LOD_MODE_DISTANCE = 1,
} mln_tile_lod_mode;

typedef enum mln_map_tile_option_field : uint32_t {
  MLN_MAP_TILE_OPTION_PREFETCH_ZOOM_DELTA = 1U << 0U,
  MLN_MAP_TILE_OPTION_LOD_MIN_RADIUS = 1U << 1U,
  MLN_MAP_TILE_OPTION_LOD_SCALE = 1U << 2U,
  MLN_MAP_TILE_OPTION_LOD_PITCH_THRESHOLD = 1U << 3U,
  MLN_MAP_TILE_OPTION_LOD_ZOOM_SHIFT = 1U << 4U,
  MLN_MAP_TILE_OPTION_LOD_MODE = 1U << 5U,
} mln_map_tile_option_field;

typedef enum mln_map_mode : uint32_t {
  MLN_MAP_MODE_CONTINUOUS = 0,
  MLN_MAP_MODE_STATIC = 1,
  MLN_MAP_MODE_TILE = 2,
} mln_map_mode;

typedef struct mln_map_options {
  uint32_t size;
  uint32_t width;
  uint32_t height;
  double scale_factor;
  uint32_t map_mode;
} mln_map_options;

typedef struct mln_screen_point {
  double x;
  double y;
} mln_screen_point;

typedef struct mln_edge_insets {
  double top;
  double left;
  double bottom;
  double right;
} mln_edge_insets;

typedef struct mln_camera_options {
  uint32_t size;
  uint32_t fields;
  double latitude;
  double longitude;
  double center_altitude;
  mln_edge_insets padding;
  mln_screen_point anchor;
  double zoom;
  double bearing;
  double pitch;
  double roll;
  double field_of_view;
} mln_camera_options;

typedef struct mln_unit_bezier {
  double x1;
  double y1;
  double x2;
  double y2;
} mln_unit_bezier;

typedef struct mln_animation_options {
  uint32_t size;
  uint32_t fields;
  double duration_ms;
  double velocity;
  double min_zoom;
  mln_unit_bezier easing;
} mln_animation_options;

typedef struct mln_camera_fit_options {
  uint32_t size;
  uint32_t fields;
  mln_edge_insets padding;
  double bearing;
  double pitch;
} mln_camera_fit_options;

typedef struct mln_vec3 {
  double x;
  double y;
  double z;
} mln_vec3;

typedef struct mln_quaternion {
  double x;
  double y;
  double z;
  double w;
} mln_quaternion;

typedef struct mln_free_camera_options {
  uint32_t size;
  uint32_t fields;
  mln_vec3 position;
  mln_quaternion orientation;
} mln_free_camera_options;

typedef struct mln_lat_lng {
  double latitude;
  double longitude;
} mln_lat_lng;

typedef struct mln_string_view {
  const char* data;
  size_t size;
} mln_string_view;
 
typedef struct mln_json_value mln_json_value;
typedef struct mln_geometry mln_geometry;

typedef enum mln_geometry_type : uint32_t {
  MLN_GEOMETRY_TYPE_EMPTY = 0,
  MLN_GEOMETRY_TYPE_POINT = 1,
  MLN_GEOMETRY_TYPE_LINE_STRING = 2,
  MLN_GEOMETRY_TYPE_POLYGON = 3,
  MLN_GEOMETRY_TYPE_MULTI_POINT = 4,
  MLN_GEOMETRY_TYPE_MULTI_LINE_STRING = 5,
  MLN_GEOMETRY_TYPE_MULTI_POLYGON = 6,
  MLN_GEOMETRY_TYPE_GEOMETRY_COLLECTION = 7,
} mln_geometry_type;

typedef struct mln_coordinate_span {
  const mln_lat_lng* coordinates;
  size_t coordinate_count;
} mln_coordinate_span;

typedef struct mln_polygon_geometry {
  const mln_coordinate_span* rings;
  size_t ring_count;
} mln_polygon_geometry;

typedef struct mln_multi_line_geometry {
  const mln_coordinate_span* lines;
  size_t line_count;
} mln_multi_line_geometry;

typedef struct mln_multi_polygon_geometry {
  const mln_polygon_geometry* polygons;
  size_t polygon_count;
} mln_multi_polygon_geometry;

typedef struct mln_geometry_collection {
  const mln_geometry* geometries;
  size_t geometry_count;
} mln_geometry_collection;

typedef struct mln_geometry {
  uint32_t size;
  uint32_t type;
  union {
    mln_lat_lng point;
    mln_coordinate_span line_string;
    mln_polygon_geometry polygon;
    mln_coordinate_span multi_point;
    mln_multi_line_geometry multi_line_string;
    mln_multi_polygon_geometry multi_polygon;
    mln_geometry_collection geometry_collection;
  } data;
} mln_geometry;

typedef enum mln_json_value_type : uint32_t {
  MLN_JSON_VALUE_TYPE_NULL = 0,
  MLN_JSON_VALUE_TYPE_BOOL = 1,
  MLN_JSON_VALUE_TYPE_UINT = 2,
  MLN_JSON_VALUE_TYPE_INT = 3,
  MLN_JSON_VALUE_TYPE_DOUBLE = 4,
  MLN_JSON_VALUE_TYPE_STRING = 5,
  MLN_JSON_VALUE_TYPE_ARRAY = 6,
  MLN_JSON_VALUE_TYPE_OBJECT = 7,
} mln_json_value_type;

typedef struct mln_json_array {
  const mln_json_value* values;
  size_t value_count;
} mln_json_array;

typedef struct mln_json_member {
  mln_string_view key;
  const mln_json_value* value;
} mln_json_member;

typedef struct mln_json_object {
  const mln_json_member* members;
  size_t member_count;
} mln_json_object;

typedef struct mln_json_value {
  uint32_t size;
  uint32_t type;
  union {
    bool bool_value;
    uint64_t uint_value;
    int64_t int_value;
    double double_value;
    mln_string_view string_value;
    mln_json_array array_value;
    mln_json_object object_value;
  } data;
} mln_json_value;

typedef enum mln_feature_state_selector_field : uint32_t {
  MLN_FEATURE_STATE_SELECTOR_SOURCE_LAYER_ID = 1U << 0U,
  MLN_FEATURE_STATE_SELECTOR_FEATURE_ID = 1U << 1U,
  MLN_FEATURE_STATE_SELECTOR_STATE_KEY = 1U << 2U,
} mln_feature_state_selector_field;

typedef struct mln_feature_state_selector {
  uint32_t size;
  uint32_t fields;
  mln_string_view source_id;
  mln_string_view source_layer_id;
  mln_string_view feature_id;
  mln_string_view state_key;
} mln_feature_state_selector;

typedef enum mln_feature_identifier_type : uint32_t {
  MLN_FEATURE_IDENTIFIER_TYPE_NULL = 0,
  MLN_FEATURE_IDENTIFIER_TYPE_UINT = 1,
  MLN_FEATURE_IDENTIFIER_TYPE_INT = 2,
  MLN_FEATURE_IDENTIFIER_TYPE_DOUBLE = 3,
  MLN_FEATURE_IDENTIFIER_TYPE_STRING = 4,
} mln_feature_identifier_type;

typedef struct mln_feature {
  uint32_t size;
  const mln_geometry* geometry;
  const mln_json_member* properties;
  size_t property_count;
  uint32_t identifier_type;
  union {
    uint64_t uint_value;
    int64_t int_value;
    double double_value;
    mln_string_view string_value;
  } identifier;
} mln_feature;

typedef enum mln_geojson_type : uint32_t {
  MLN_GEOJSON_TYPE_GEOMETRY = 1,
  MLN_GEOJSON_TYPE_FEATURE = 2,
  MLN_GEOJSON_TYPE_FEATURE_COLLECTION = 3,
} mln_geojson_type;

typedef struct mln_feature_collection {
  const mln_feature* features;
  size_t feature_count;
} mln_feature_collection;

typedef struct mln_geojson {
  uint32_t size;
  uint32_t type;
  union {
    const mln_geometry* geometry;
    const mln_feature* feature;
    mln_feature_collection feature_collection;
  } data;
} mln_geojson;

typedef struct mln_lat_lng_bounds {
  mln_lat_lng southwest;
  mln_lat_lng northeast;
} mln_lat_lng_bounds;

typedef struct mln_bound_options {
  uint32_t size;
  uint32_t fields;
  mln_lat_lng_bounds bounds;
  double min_zoom;
  double max_zoom;
  double min_pitch;
  double max_pitch;
} mln_bound_options;

typedef struct mln_offline_tile_pyramid_region_definition {
  uint32_t size;
  const char* style_url;
  mln_lat_lng_bounds bounds;
  double min_zoom;
  double max_zoom;
  float pixel_ratio;
  bool include_ideographs;
} mln_offline_tile_pyramid_region_definition;

typedef struct mln_offline_geometry_region_definition {
  uint32_t size;
  const char* style_url;
  const mln_geometry* geometry;
  double min_zoom;
  double max_zoom;
  float pixel_ratio;
  bool include_ideographs;
} mln_offline_geometry_region_definition;

typedef struct mln_offline_region_definition {
  uint32_t size;
  uint32_t type;
  union {
    mln_offline_tile_pyramid_region_definition tile_pyramid;
    mln_offline_geometry_region_definition geometry;
  } data;
} mln_offline_region_definition;

typedef struct mln_offline_region_info {
  uint32_t size;
  mln_offline_region_id id;
  mln_offline_region_definition definition;
  const uint8_t* metadata;
  size_t metadata_size;
} mln_offline_region_info;

MLN_API mln_status mln_runtime_offline_region_create_start(
  mln_runtime* runtime, const mln_offline_region_definition* definition,
  const uint8_t* metadata, size_t metadata_size,
  mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_get_start(
  mln_runtime* runtime, mln_offline_region_id region_id,
  mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_regions_list_start(
  mln_runtime* runtime, mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_regions_merge_database_start(
  mln_runtime* runtime, const char* side_database_path,
  mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_update_metadata_start(
  mln_runtime* runtime, mln_offline_region_id region_id,
  const uint8_t* metadata, size_t metadata_size,
  mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_get_status_start(
  mln_runtime* runtime, mln_offline_region_id region_id,
  mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_set_observed_start(
  mln_runtime* runtime, mln_offline_region_id region_id, bool observed,
  mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_set_download_state_start(
  mln_runtime* runtime, mln_offline_region_id region_id, uint32_t state,
  mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_invalidate_start(
  mln_runtime* runtime, mln_offline_region_id region_id,
  mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_delete_start(
  mln_runtime* runtime, mln_offline_region_id region_id,
  mln_offline_operation_id* out_operation_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_create_take_result(
  mln_runtime* runtime, mln_offline_operation_id operation_id,
  mln_offline_region_snapshot** out_region
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_get_take_result(
  mln_runtime* runtime, mln_offline_operation_id operation_id,
  mln_offline_region_snapshot** out_region, bool* out_found
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_regions_list_take_result(
  mln_runtime* runtime, mln_offline_operation_id operation_id,
  mln_offline_region_list** out_regions
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_regions_merge_database_take_result(
  mln_runtime* runtime, mln_offline_operation_id operation_id,
  mln_offline_region_list** out_regions
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_update_metadata_take_result(
  mln_runtime* runtime, mln_offline_operation_id operation_id,
  mln_offline_region_snapshot** out_region
) MLN_NOEXCEPT;

MLN_API mln_status mln_runtime_offline_region_get_status_take_result(
  mln_runtime* runtime, mln_offline_operation_id operation_id,
  mln_offline_region_status* out_status
) MLN_NOEXCEPT;

MLN_API mln_status mln_offline_region_snapshot_get(
  const mln_offline_region_snapshot* snapshot, mln_offline_region_info* out_info
) MLN_NOEXCEPT;

MLN_API void mln_offline_region_snapshot_destroy(
  mln_offline_region_snapshot* snapshot
) MLN_NOEXCEPT;

MLN_API mln_status mln_offline_region_list_count(
  const mln_offline_region_list* list, size_t* out_count
) MLN_NOEXCEPT;

MLN_API mln_status mln_offline_region_list_get(
  const mln_offline_region_list* list, size_t index,
  mln_offline_region_info* out_info
) MLN_NOEXCEPT;

MLN_API void mln_offline_region_list_destroy(
  mln_offline_region_list* list
) MLN_NOEXCEPT;

typedef struct mln_projected_meters {
  double northing;
  double easting;
} mln_projected_meters;

typedef struct mln_projection_mode {
  uint32_t size;
  uint32_t fields;
  bool axonometric;
  double x_skew;
  double y_skew;
} mln_projection_mode;

typedef struct mln_map_viewport_options {
  uint32_t size;
  uint32_t fields;
  uint32_t north_orientation;
  uint32_t constrain_mode;
  uint32_t viewport_mode;
  mln_edge_insets frustum_offset;
} mln_map_viewport_options;

typedef struct mln_map_tile_options {
  uint32_t size;
  uint32_t fields;
  uint32_t prefetch_zoom_delta;
  double lod_min_radius;
  double lod_scale;
  double lod_pitch_threshold;
  double lod_zoom_shift;
  uint32_t lod_mode;
} mln_map_tile_options;

MLN_API mln_map_options mln_map_options_default(void) MLN_NOEXCEPT;

MLN_API mln_status mln_map_create(
  mln_runtime* runtime, const mln_map_options* options, mln_map** out_map
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_request_repaint(mln_map* map) MLN_NOEXCEPT;

MLN_API mln_status mln_map_request_still_image(mln_map* map) MLN_NOEXCEPT;

MLN_API mln_status mln_map_destroy(mln_map* map) MLN_NOEXCEPT;

MLN_API mln_status
mln_map_set_style_url(mln_map* map, const char* url) MLN_NOEXCEPT;

MLN_API mln_status
mln_map_set_style_json(mln_map* map, const char* json) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_MAP_H