query.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_QUERY_H
#define MAPLIBRE_NATIVE_C_QUERY_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "base.h"
#include "map.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct mln_feature_query_result mln_feature_query_result;
typedef struct mln_feature_extension_result mln_feature_extension_result;

typedef enum mln_rendered_query_geometry_type : uint32_t {
  MLN_RENDERED_QUERY_GEOMETRY_TYPE_POINT = 1,
  MLN_RENDERED_QUERY_GEOMETRY_TYPE_BOX = 2,
  MLN_RENDERED_QUERY_GEOMETRY_TYPE_LINE_STRING = 3,
} mln_rendered_query_geometry_type;

typedef struct mln_screen_box {
  mln_screen_point min;
  mln_screen_point max;
} mln_screen_box;

typedef struct mln_screen_line_string {
  const mln_screen_point* points;
  size_t point_count;
} mln_screen_line_string;

typedef struct mln_rendered_query_geometry {
  uint32_t size;
  uint32_t type;
  union {
    mln_screen_point point;
    mln_screen_box box;
    mln_screen_line_string line_string;
  } data;
} mln_rendered_query_geometry;

typedef enum mln_rendered_feature_query_option_field : uint32_t {
  MLN_RENDERED_FEATURE_QUERY_OPTION_LAYER_IDS = 1U << 0U,
} mln_rendered_feature_query_option_field;

typedef struct mln_rendered_feature_query_options {
  uint32_t size;
  uint32_t fields;
  const mln_string_view* layer_ids;
  size_t layer_id_count;
  const mln_json_value* filter;
} mln_rendered_feature_query_options;

typedef enum mln_source_feature_query_option_field : uint32_t {
  MLN_SOURCE_FEATURE_QUERY_OPTION_SOURCE_LAYER_IDS = 1U << 0U,
} mln_source_feature_query_option_field;

typedef struct mln_source_feature_query_options {
  uint32_t size;
  uint32_t fields;
  const mln_string_view* source_layer_ids;
  size_t source_layer_id_count;
  const mln_json_value* filter;
} mln_source_feature_query_options;

typedef enum mln_queried_feature_field : uint32_t {
  MLN_QUERIED_FEATURE_SOURCE_ID = 1U << 0U,
  MLN_QUERIED_FEATURE_SOURCE_LAYER_ID = 1U << 1U,
  MLN_QUERIED_FEATURE_STATE = 1U << 2U,
} mln_queried_feature_field;

typedef struct mln_queried_feature {
  uint32_t size;
  uint32_t fields;
  mln_feature feature;
  mln_string_view source_id;
  mln_string_view source_layer_id;
  const mln_json_value* state;
} mln_queried_feature;

typedef enum mln_feature_extension_result_type : uint32_t {
  MLN_FEATURE_EXTENSION_RESULT_TYPE_VALUE = 1,
  MLN_FEATURE_EXTENSION_RESULT_TYPE_FEATURE_COLLECTION = 2,
} mln_feature_extension_result_type;

typedef struct mln_feature_extension_result_info {
  uint32_t size;
  uint32_t type;
  union {
    const mln_json_value* value;
    mln_feature_collection feature_collection;
  } data;
} mln_feature_extension_result_info;

MLN_API mln_rendered_feature_query_options
mln_rendered_feature_query_options_default(void) MLN_NOEXCEPT;

MLN_API mln_source_feature_query_options
mln_source_feature_query_options_default(void) MLN_NOEXCEPT;

MLN_API mln_rendered_query_geometry
mln_rendered_query_geometry_point(mln_screen_point point) MLN_NOEXCEPT;

MLN_API mln_rendered_query_geometry
mln_rendered_query_geometry_box(mln_screen_box box) MLN_NOEXCEPT;

MLN_API mln_rendered_query_geometry mln_rendered_query_geometry_line_string(
  const mln_screen_point* points, size_t point_count
) MLN_NOEXCEPT;

MLN_API mln_status mln_render_session_query_rendered_features(
  mln_render_session* session, const mln_rendered_query_geometry* geometry,
  const mln_rendered_feature_query_options* options,
  mln_feature_query_result** out_result
) MLN_NOEXCEPT;

MLN_API mln_status mln_render_session_query_source_features(
  mln_render_session* session, mln_string_view source_id,
  const mln_source_feature_query_options* options,
  mln_feature_query_result** out_result
) MLN_NOEXCEPT;

MLN_API mln_status mln_render_session_query_feature_extensions(
  mln_render_session* session, mln_string_view source_id,
  const mln_feature* feature, mln_string_view extension,
  mln_string_view extension_field, const mln_json_value* arguments,
  mln_feature_extension_result** out_result
) MLN_NOEXCEPT;

MLN_API mln_status mln_feature_query_result_count(
  const mln_feature_query_result* result, size_t* out_count
) MLN_NOEXCEPT;

MLN_API mln_status mln_feature_query_result_get(
  const mln_feature_query_result* result, size_t index,
  mln_queried_feature* out_feature
) MLN_NOEXCEPT;

MLN_API void mln_feature_query_result_destroy(
  mln_feature_query_result* result
) MLN_NOEXCEPT;

MLN_API mln_status mln_feature_extension_result_get(
  const mln_feature_extension_result* result,
  mln_feature_extension_result_info* out_info
) MLN_NOEXCEPT;

MLN_API void mln_feature_extension_result_destroy(
  mln_feature_extension_result* result
) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_QUERY_H