Path: blob/master/servers/navigation_2d/navigation_server_2d.h
11322 views
/**************************************************************************/1/* navigation_server_2d.h */2/**************************************************************************/3/* This file is part of: */4/* GODOT ENGINE */5/* https://godotengine.org */6/**************************************************************************/7/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */8/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */9/* */10/* Permission is hereby granted, free of charge, to any person obtaining */11/* a copy of this software and associated documentation files (the */12/* "Software"), to deal in the Software without restriction, including */13/* without limitation the rights to use, copy, modify, merge, publish, */14/* distribute, sublicense, and/or sell copies of the Software, and to */15/* permit persons to whom the Software is furnished to do so, subject to */16/* the following conditions: */17/* */18/* The above copyright notice and this permission notice shall be */19/* included in all copies or substantial portions of the Software. */20/* */21/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */22/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */23/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */24/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */25/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */26/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */27/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */28/**************************************************************************/2930#pragma once3132#include "core/object/class_db.h"33#include "core/templates/rid.h"3435#include "scene/resources/2d/navigation_mesh_source_geometry_data_2d.h"36#include "scene/resources/2d/navigation_polygon.h"37#include "servers/navigation_2d/navigation_path_query_parameters_2d.h"38#include "servers/navigation_2d/navigation_path_query_result_2d.h"3940#ifdef CLIPPER2_ENABLED41class NavMeshGenerator2D;42#endif // CLIPPER2_ENABLED4344struct NavMeshGeometryParser2D {45RID self;46Callable callback;47};4849class NavigationServer2D : public Object {50GDCLASS(NavigationServer2D, Object);5152static NavigationServer2D *singleton;5354protected:55static void _bind_methods();5657public:58static NavigationServer2D *get_singleton();5960virtual TypedArray<RID> get_maps() const = 0;6162/* MAP API */6364virtual RID map_create() = 0;6566virtual void map_set_active(RID p_map, bool p_active) = 0;67virtual bool map_is_active(RID p_map) const = 0;6869virtual void map_set_cell_size(RID p_map, real_t p_cell_size) = 0;70virtual real_t map_get_cell_size(RID p_map) const = 0;7172virtual void map_set_merge_rasterizer_cell_scale(RID p_map, float p_value) = 0;73virtual float map_get_merge_rasterizer_cell_scale(RID p_map) const = 0;7475virtual void map_set_use_edge_connections(RID p_map, bool p_enabled) = 0;76virtual bool map_get_use_edge_connections(RID p_map) const = 0;7778virtual void map_set_edge_connection_margin(RID p_map, real_t p_connection_margin) = 0;79virtual real_t map_get_edge_connection_margin(RID p_map) const = 0;8081virtual void map_set_link_connection_radius(RID p_map, real_t p_connection_radius) = 0;82virtual real_t map_get_link_connection_radius(RID p_map) const = 0;8384virtual Vector<Vector2> map_get_path(RID p_map, Vector2 p_origin, Vector2 p_destination, bool p_optimize, uint32_t p_navigation_layers = 1) = 0;8586virtual Vector2 map_get_closest_point(RID p_map, const Vector2 &p_point) const = 0;87virtual RID map_get_closest_point_owner(RID p_map, const Vector2 &p_point) const = 0;8889virtual TypedArray<RID> map_get_links(RID p_map) const = 0;90virtual TypedArray<RID> map_get_regions(RID p_map) const = 0;91virtual TypedArray<RID> map_get_agents(RID p_map) const = 0;92virtual TypedArray<RID> map_get_obstacles(RID p_map) const = 0;9394virtual void map_force_update(RID p_map) = 0;95virtual uint32_t map_get_iteration_id(RID p_map) const = 0;9697virtual void map_set_use_async_iterations(RID p_map, bool p_enabled) = 0;98virtual bool map_get_use_async_iterations(RID p_map) const = 0;99100virtual Vector2 map_get_random_point(RID p_map, uint32_t p_navigation_layers, bool p_uniformly) const = 0;101102/* REGION API */103104virtual RID region_create() = 0;105virtual uint32_t region_get_iteration_id(RID p_region) const = 0;106107virtual void region_set_use_async_iterations(RID p_region, bool p_enabled) = 0;108virtual bool region_get_use_async_iterations(RID p_region) const = 0;109110virtual void region_set_enabled(RID p_region, bool p_enabled) = 0;111virtual bool region_get_enabled(RID p_region) const = 0;112113virtual void region_set_use_edge_connections(RID p_region, bool p_enabled) = 0;114virtual bool region_get_use_edge_connections(RID p_region) const = 0;115116virtual void region_set_enter_cost(RID p_region, real_t p_enter_cost) = 0;117virtual real_t region_get_enter_cost(RID p_region) const = 0;118119virtual void region_set_travel_cost(RID p_region, real_t p_travel_cost) = 0;120virtual real_t region_get_travel_cost(RID p_region) const = 0;121122virtual void region_set_owner_id(RID p_region, ObjectID p_owner_id) = 0;123virtual ObjectID region_get_owner_id(RID p_region) const = 0;124125virtual bool region_owns_point(RID p_region, const Vector2 &p_point) const = 0;126127virtual void region_set_map(RID p_region, RID p_map) = 0;128virtual RID region_get_map(RID p_region) const = 0;129130virtual void region_set_navigation_layers(RID p_region, uint32_t p_navigation_layers) = 0;131virtual uint32_t region_get_navigation_layers(RID p_region) const = 0;132133virtual void region_set_transform(RID p_region, Transform2D p_transform) = 0;134virtual Transform2D region_get_transform(RID p_region) const = 0;135136virtual void region_set_navigation_polygon(RID p_region, Ref<NavigationPolygon> p_navigation_polygon) = 0;137138virtual int region_get_connections_count(RID p_region) const = 0;139virtual Vector2 region_get_connection_pathway_start(RID p_region, int p_connection_id) const = 0;140virtual Vector2 region_get_connection_pathway_end(RID p_region, int p_connection_id) const = 0;141142virtual Vector2 region_get_closest_point(RID p_region, const Vector2 &p_point) const = 0;143virtual Vector2 region_get_random_point(RID p_region, uint32_t p_navigation_layers, bool p_uniformly) const = 0;144virtual Rect2 region_get_bounds(RID p_region) const = 0;145146/* LINK API */147148virtual RID link_create() = 0;149virtual uint32_t link_get_iteration_id(RID p_link) const = 0;150151virtual void link_set_map(RID p_link, RID p_map) = 0;152virtual RID link_get_map(RID p_link) const = 0;153154virtual void link_set_enabled(RID p_link, bool p_enabled) = 0;155virtual bool link_get_enabled(RID p_link) const = 0;156157virtual void link_set_bidirectional(RID p_link, bool p_bidirectional) = 0;158virtual bool link_is_bidirectional(RID p_link) const = 0;159160virtual void link_set_navigation_layers(RID p_link, uint32_t p_navigation_layers) = 0;161virtual uint32_t link_get_navigation_layers(RID p_link) const = 0;162163virtual void link_set_start_position(RID p_link, Vector2 p_position) = 0;164virtual Vector2 link_get_start_position(RID p_link) const = 0;165166virtual void link_set_end_position(RID p_link, Vector2 p_position) = 0;167virtual Vector2 link_get_end_position(RID p_link) const = 0;168169virtual void link_set_enter_cost(RID p_link, real_t p_enter_cost) = 0;170virtual real_t link_get_enter_cost(RID p_link) const = 0;171172virtual void link_set_travel_cost(RID p_link, real_t p_travel_cost) = 0;173virtual real_t link_get_travel_cost(RID p_link) const = 0;174175virtual void link_set_owner_id(RID p_link, ObjectID p_owner_id) = 0;176virtual ObjectID link_get_owner_id(RID p_link) const = 0;177178/* AGENT API */179180virtual RID agent_create() = 0;181182virtual void agent_set_map(RID p_agent, RID p_map) = 0;183virtual RID agent_get_map(RID p_agent) const = 0;184185virtual void agent_set_paused(RID p_agent, bool p_paused) = 0;186virtual bool agent_get_paused(RID p_agent) const = 0;187188virtual void agent_set_avoidance_enabled(RID p_agent, bool p_enabled) = 0;189virtual bool agent_get_avoidance_enabled(RID p_agent) const = 0;190191virtual void agent_set_neighbor_distance(RID p_agent, real_t p_distance) = 0;192virtual real_t agent_get_neighbor_distance(RID p_agent) const = 0;193194virtual void agent_set_max_neighbors(RID p_agent, int p_count) = 0;195virtual int agent_get_max_neighbors(RID p_agent) const = 0;196197virtual void agent_set_time_horizon_agents(RID p_agent, real_t p_time_horizon) = 0;198virtual real_t agent_get_time_horizon_agents(RID p_agent) const = 0;199virtual void agent_set_time_horizon_obstacles(RID p_agent, real_t p_time_horizon) = 0;200virtual real_t agent_get_time_horizon_obstacles(RID p_agent) const = 0;201202virtual void agent_set_radius(RID p_agent, real_t p_radius) = 0;203virtual real_t agent_get_radius(RID p_agent) const = 0;204205virtual void agent_set_max_speed(RID p_agent, real_t p_max_speed) = 0;206virtual real_t agent_get_max_speed(RID p_agent) const = 0;207208virtual void agent_set_velocity_forced(RID p_agent, Vector2 p_velocity) = 0;209210virtual void agent_set_velocity(RID p_agent, Vector2 p_velocity) = 0;211virtual Vector2 agent_get_velocity(RID p_agent) const = 0;212213virtual void agent_set_position(RID p_agent, Vector2 p_position) = 0;214virtual Vector2 agent_get_position(RID p_agent) const = 0;215216virtual bool agent_is_map_changed(RID p_agent) const = 0;217218virtual void agent_set_avoidance_callback(RID p_agent, Callable p_callback) = 0;219virtual bool agent_has_avoidance_callback(RID p_agent) const = 0;220221virtual void agent_set_avoidance_layers(RID p_agent, uint32_t p_layers) = 0;222virtual uint32_t agent_get_avoidance_layers(RID p_agent) const = 0;223224virtual void agent_set_avoidance_mask(RID p_agent, uint32_t p_mask) = 0;225virtual uint32_t agent_get_avoidance_mask(RID p_agent) const = 0;226227virtual void agent_set_avoidance_priority(RID p_agent, real_t p_priority) = 0;228virtual real_t agent_get_avoidance_priority(RID p_agent) const = 0;229230/* OBSTACLE API */231232virtual RID obstacle_create() = 0;233virtual void obstacle_set_avoidance_enabled(RID p_obstacle, bool p_enabled) = 0;234virtual bool obstacle_get_avoidance_enabled(RID p_obstacle) const = 0;235virtual void obstacle_set_map(RID p_obstacle, RID p_map) = 0;236virtual RID obstacle_get_map(RID p_obstacle) const = 0;237virtual void obstacle_set_paused(RID p_obstacle, bool p_paused) = 0;238virtual bool obstacle_get_paused(RID p_obstacle) const = 0;239virtual void obstacle_set_radius(RID p_obstacle, real_t p_radius) = 0;240virtual real_t obstacle_get_radius(RID p_obstacle) const = 0;241virtual void obstacle_set_velocity(RID p_obstacle, Vector2 p_velocity) = 0;242virtual Vector2 obstacle_get_velocity(RID p_obstacle) const = 0;243virtual void obstacle_set_position(RID p_obstacle, Vector2 p_position) = 0;244virtual Vector2 obstacle_get_position(RID p_obstacle) const = 0;245virtual void obstacle_set_vertices(RID p_obstacle, const Vector<Vector2> &p_vertices) = 0;246virtual Vector<Vector2> obstacle_get_vertices(RID p_obstacle) const = 0;247virtual void obstacle_set_avoidance_layers(RID p_obstacle, uint32_t p_layers) = 0;248virtual uint32_t obstacle_get_avoidance_layers(RID p_obstacle) const = 0;249250/* QUERY API */251252virtual void query_path(const Ref<NavigationPathQueryParameters2D> &p_query_parameters, Ref<NavigationPathQueryResult2D> p_query_result, const Callable &p_callback = Callable()) = 0;253254/* NAVMESH BAKE API */255256virtual void parse_source_geometry_data(const Ref<NavigationPolygon> &p_navigation_mesh, const Ref<NavigationMeshSourceGeometryData2D> &p_source_geometry_data, Node *p_root_node, const Callable &p_callback = Callable()) = 0;257virtual void bake_from_source_geometry_data(const Ref<NavigationPolygon> &p_navigation_mesh, const Ref<NavigationMeshSourceGeometryData2D> &p_source_geometry_data, const Callable &p_callback = Callable()) = 0;258virtual void bake_from_source_geometry_data_async(const Ref<NavigationPolygon> &p_navigation_mesh, const Ref<NavigationMeshSourceGeometryData2D> &p_source_geometry_data, const Callable &p_callback = Callable()) = 0;259virtual bool is_baking_navigation_polygon(Ref<NavigationPolygon> p_navigation_polygon) const = 0;260261protected:262static RWLock geometry_parser_rwlock;263static RID_Owner<NavMeshGeometryParser2D> geometry_parser_owner;264static LocalVector<NavMeshGeometryParser2D *> generator_parsers;265266public:267virtual RID source_geometry_parser_create() = 0;268virtual void source_geometry_parser_set_callback(RID p_parser, const Callable &p_callback) = 0;269270virtual Vector<Vector2> simplify_path(const Vector<Vector2> &p_path, real_t p_epsilon) = 0;271272/* SERVER API */273274virtual void set_active(bool p_active) = 0;275virtual void process(double p_delta_time) = 0;276virtual void physics_process(double p_delta_time) = 0;277virtual void init() = 0;278virtual void sync() = 0;279virtual void finish() = 0;280virtual void free_rid(RID p_rid) = 0;281#ifndef DISABLE_DEPRECATED282[[deprecated("Use `free_rid()` instead.")]] void free(RID p_rid) { free_rid(p_rid); }283#endif // DISABLE_DEPRECATED284285NavigationServer2D();286~NavigationServer2D() override;287288/* DEBUG API */289290enum ProcessInfo {291INFO_ACTIVE_MAPS,292INFO_REGION_COUNT,293INFO_AGENT_COUNT,294INFO_LINK_COUNT,295INFO_POLYGON_COUNT,296INFO_EDGE_COUNT,297INFO_EDGE_MERGE_COUNT,298INFO_EDGE_CONNECTION_COUNT,299INFO_EDGE_FREE_COUNT,300INFO_OBSTACLE_COUNT,301};302303virtual int get_process_info(ProcessInfo p_info) const = 0;304305void set_debug_enabled(bool p_enabled);306bool get_debug_enabled() const;307308protected:309#ifndef DISABLE_DEPRECATED310Vector<Vector2> _map_get_path_bind_compat_100129(RID p_map, Vector2 p_origin, Vector2 p_destination, bool p_optimize, uint32_t p_navigation_layers = 1) const;311void _query_path_bind_compat_100129(const Ref<NavigationPathQueryParameters2D> &p_query_parameters, Ref<NavigationPathQueryResult2D> p_query_result) const;312static void _bind_compatibility_methods();313#endif314315private:316bool debug_enabled = false;317318#ifdef DEBUG_ENABLED319bool debug_dirty = true;320321bool debug_navigation_enabled = false;322bool navigation_debug_dirty = true;323void _emit_navigation_debug_changed_signal();324325bool debug_avoidance_enabled = false;326bool avoidance_debug_dirty = true;327void _emit_avoidance_debug_changed_signal();328329Color debug_navigation_edge_connection_color = Color(1.0, 0.0, 1.0, 1.0);330Color debug_navigation_geometry_edge_color = Color(0.5, 1.0, 1.0, 1.0);331Color debug_navigation_geometry_face_color = Color(0.5, 1.0, 1.0, 0.4);332Color debug_navigation_geometry_edge_disabled_color = Color(0.5, 0.5, 0.5, 1.0);333Color debug_navigation_geometry_face_disabled_color = Color(0.5, 0.5, 0.5, 0.4);334Color debug_navigation_link_connection_color = Color(1.0, 0.5, 1.0, 1.0);335Color debug_navigation_link_connection_disabled_color = Color(0.5, 0.5, 0.5, 1.0);336Color debug_navigation_agent_path_color = Color(1.0, 0.0, 0.0, 1.0);337338real_t debug_navigation_agent_path_point_size = 4.0;339340Color debug_navigation_avoidance_agents_radius_color = Color(1.0, 1.0, 0.0, 0.25);341Color debug_navigation_avoidance_obstacles_radius_color = Color(1.0, 0.5, 0.0, 0.25);342343Color debug_navigation_avoidance_static_obstacle_pushin_face_color = Color(1.0, 0.0, 0.0, 0.0);344Color debug_navigation_avoidance_static_obstacle_pushout_face_color = Color(1.0, 1.0, 0.0, 0.5);345Color debug_navigation_avoidance_static_obstacle_pushin_edge_color = Color(1.0, 0.0, 0.0, 1.0);346Color debug_navigation_avoidance_static_obstacle_pushout_edge_color = Color(1.0, 1.0, 0.0, 1.0);347348bool debug_navigation_enable_edge_connections = true;349bool debug_navigation_enable_edge_lines = true;350bool debug_navigation_enable_geometry_face_random_color = true;351bool debug_navigation_enable_link_connections = true;352bool debug_navigation_enable_agent_paths = true;353354bool debug_navigation_avoidance_enable_agents_radius = true;355bool debug_navigation_avoidance_enable_obstacles_radius = true;356bool debug_navigation_avoidance_enable_obstacles_static = true;357358public:359void set_debug_navigation_enabled(bool p_enabled);360bool get_debug_navigation_enabled() const;361362void set_debug_avoidance_enabled(bool p_enabled);363bool get_debug_avoidance_enabled() const;364365void set_debug_navigation_edge_connection_color(const Color &p_color);366Color get_debug_navigation_edge_connection_color() const;367368void set_debug_navigation_geometry_face_color(const Color &p_color);369Color get_debug_navigation_geometry_face_color() const;370371void set_debug_navigation_geometry_face_disabled_color(const Color &p_color);372Color get_debug_navigation_geometry_face_disabled_color() const;373374void set_debug_navigation_geometry_edge_color(const Color &p_color);375Color get_debug_navigation_geometry_edge_color() const;376377void set_debug_navigation_geometry_edge_disabled_color(const Color &p_color);378Color get_debug_navigation_geometry_edge_disabled_color() const;379380void set_debug_navigation_link_connection_color(const Color &p_color);381Color get_debug_navigation_link_connection_color() const;382383void set_debug_navigation_link_connection_disabled_color(const Color &p_color);384Color get_debug_navigation_link_connection_disabled_color() const;385386void set_debug_navigation_enable_edge_connections(const bool p_value);387bool get_debug_navigation_enable_edge_connections() const;388389void set_debug_navigation_enable_geometry_face_random_color(const bool p_value);390bool get_debug_navigation_enable_geometry_face_random_color() const;391392void set_debug_navigation_enable_edge_lines(const bool p_value);393bool get_debug_navigation_enable_edge_lines() const;394395void set_debug_navigation_agent_path_color(const Color &p_color);396Color get_debug_navigation_agent_path_color() const;397398void set_debug_navigation_enable_agent_paths(const bool p_value);399bool get_debug_navigation_enable_agent_paths() const;400401void set_debug_navigation_agent_path_point_size(real_t p_point_size);402real_t get_debug_navigation_agent_path_point_size() const;403404void set_debug_navigation_avoidance_enable_agents_radius(const bool p_value);405bool get_debug_navigation_avoidance_enable_agents_radius() const;406407void set_debug_navigation_avoidance_enable_obstacles_radius(const bool p_value);408bool get_debug_navigation_avoidance_enable_obstacles_radius() const;409410void set_debug_navigation_avoidance_agents_radius_color(const Color &p_color);411Color get_debug_navigation_avoidance_agents_radius_color() const;412413void set_debug_navigation_avoidance_obstacles_radius_color(const Color &p_color);414Color get_debug_navigation_avoidance_obstacles_radius_color() const;415416void set_debug_navigation_avoidance_static_obstacle_pushin_face_color(const Color &p_color);417Color get_debug_navigation_avoidance_static_obstacle_pushin_face_color() const;418419void set_debug_navigation_avoidance_static_obstacle_pushout_face_color(const Color &p_color);420Color get_debug_navigation_avoidance_static_obstacle_pushout_face_color() const;421422void set_debug_navigation_avoidance_static_obstacle_pushin_edge_color(const Color &p_color);423Color get_debug_navigation_avoidance_static_obstacle_pushin_edge_color() const;424425void set_debug_navigation_avoidance_static_obstacle_pushout_edge_color(const Color &p_color);426Color get_debug_navigation_avoidance_static_obstacle_pushout_edge_color() const;427428void set_debug_navigation_avoidance_enable_obstacles_static(const bool p_value);429bool get_debug_navigation_avoidance_enable_obstacles_static() const;430#endif // DEBUG_ENABLED431};432433typedef NavigationServer2D *(*NavigationServer2DCallback)();434435/// Manager used for the server singleton registration436class NavigationServer2DManager {437static NavigationServer2DCallback create_callback;438439public:440static void set_default_server(NavigationServer2DCallback p_callback);441static NavigationServer2D *new_default_server();442443static void initialize_server();444static void finalize_server();445};446447VARIANT_ENUM_CAST(NavigationServer2D::ProcessInfo);448449450