godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/servers/navigation_server_2d.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

342 lines
15 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* navigation_server_2d.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Style: Remove inconsistently used `@author` docstrings Each file in Godot has had multiple contributors who co-authored it over the years, and the information of who was the original person to create that file is not very relevant, especially when used so inconsistently. `git blame` is a much better way to know who initially authored or later modified a given chunk of code, and most IDEs now have good integration to show this information.
2022-01-04 19:26:22 +00:00
#ifndef NAVIGATION_SERVER_2D_H
#define NAVIGATION_SERVER_2D_H
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/object/class_db.h"
#include "core/templates/rid.h"
Add NavigationPathQuery Adds NavigationPathQueryParameters objects that can be used with NavigationServer.query_path() to query a customized navigation path.
2022-06-26 10:43:01 +00:00
Move NavigationPolygon to dedicated resource file Moves NavigationPolygon resource class from NavigationRegion2D file to a dedicated file in resource folder.
2022-12-17 18:40:52 +00:00
#include "scene/resources/navigation_polygon.h"
Add NavigationPathQuery Adds NavigationPathQueryParameters objects that can be used with NavigationServer.query_path() to query a customized navigation path.
2022-06-26 10:43:01 +00:00
#include "servers/navigation/navigation_path_query_parameters_2d.h"
#include "servers/navigation/navigation_path_query_result_2d.h"
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 16:22:57 +00:00
// This server exposes the `NavigationServer3D` features in the 2D world.
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
class NavigationServer2D : public Object {
GDCLASS(NavigationServer2D, Object);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
static NavigationServer2D *singleton;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
void _emit_map_changed(RID p_map);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
protected:
static void _bind_methods();
public:
Fix various typos Found via `codespell`
2020-03-11 17:59:18 +00:00
/// Thread safe, can be used across many threads.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
static NavigationServer2D *get_singleton() { return singleton; }
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Replace Array return types with TypedArray 2
2022-08-05 18:35:08 +00:00
virtual TypedArray<RID> get_maps() const;
Add Navigation function to get all navigation maps Added new function that returns all created navigation map RIDs from the NavigationServer. The function returns both 2D and 3D created navigation maps as technically there is no distinction between them.
2022-06-22 13:33:40 +00:00
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Create a new map.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual RID map_create();
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Set map active.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void map_set_active(RID p_map, bool p_active);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Returns true if the map is active.
virtual bool map_is_active(RID p_map) const;
/// Set the map cell size used to weld the navigation mesh polygons.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void map_set_cell_size(RID p_map, real_t p_cell_size);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Returns the map cell size.
virtual real_t map_get_cell_size(RID p_map) const;
Make navigation mesh edge connections optional Makes navigation mesh edge connections optional.
2023-03-31 23:49:43 +00:00
virtual void map_set_use_edge_connections(RID p_map, bool p_enabled);
virtual bool map_get_use_edge_connections(RID p_map) const;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Set the map edge connection margin used to weld the compatible region edges.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void map_set_edge_connection_margin(RID p_map, real_t p_connection_margin);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Returns the edge connection margin of this map.
virtual real_t map_get_edge_connection_margin(RID p_map) const;
Added node for Navigation links
2022-01-30 23:39:52 +00:00
/// Set the map link connection radius used to attach links to the nav mesh.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void map_set_link_connection_radius(RID p_map, real_t p_connection_radius);
Added node for Navigation links
2022-01-30 23:39:52 +00:00
/// Returns the link connection radius of this map.
virtual real_t map_get_link_connection_radius(RID p_map) const;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Returns the navigation path to reach the destination from the origin.
Streamline Navigation layer function names. Streamline Navigation layer function names.
2022-06-14 21:34:43 +00:00
virtual Vector<Vector2> map_get_path(RID p_map, Vector2 p_origin, Vector2 p_destination, bool p_optimize, uint32_t p_navigation_layers = 1) const;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
virtual Vector2 map_get_closest_point(RID p_map, const Vector2 &p_point) const;
virtual RID map_get_closest_point_owner(RID p_map, const Vector2 &p_point) const;
Added node for Navigation links
2022-01-30 23:39:52 +00:00
virtual TypedArray<RID> map_get_links(RID p_map) const;
Replace Array return types with TypedArray 2
2022-08-05 18:35:08 +00:00
virtual TypedArray<RID> map_get_regions(RID p_map) const;
virtual TypedArray<RID> map_get_agents(RID p_map) const;
Rework Navigation Avoidance Rework Navigation Avoidance.
2023-01-10 06:14:16 +00:00
virtual TypedArray<RID> map_get_obstacles(RID p_map) const;
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
Add NavigationServer map_force_update() function Adds map_force_update() function to NavigationServer. This function immediately flushes the Navigationserver command queue and recalculates all navigationmeshes and region connections for a specific map.
2022-06-22 08:16:38 +00:00
virtual void map_force_update(RID p_map);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Creates a new region.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual RID region_create();
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Make navigation mesh edge connections optional Makes navigation mesh edge connections optional.
2023-03-31 23:49:43 +00:00
virtual void region_set_use_edge_connections(RID p_region, bool p_enabled);
virtual bool region_get_use_edge_connections(RID p_region) const;
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
/// Set the enter_cost of a region
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void region_set_enter_cost(RID p_region, real_t p_enter_cost);
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
virtual real_t region_get_enter_cost(RID p_region) const;
/// Set the travel_cost of a region
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void region_set_travel_cost(RID p_region, real_t p_travel_cost);
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
virtual real_t region_get_travel_cost(RID p_region) const;
Enable assigning an owner to navigation regions and links This allows users of the server APIs to get back the nodes that created certain regions and links.
2022-10-01 05:49:39 +00:00
/// Set the node which manages this region.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void region_set_owner_id(RID p_region, ObjectID p_owner_id);
Enable assigning an owner to navigation regions and links This allows users of the server APIs to get back the nodes that created certain regions and links.
2022-10-01 05:49:39 +00:00
virtual ObjectID region_get_owner_id(RID p_region) const;
Add NavigationServer.region_owns_point() helper function Adds a helper function to check if a world space position is currently owned by a navigation region.
2022-06-23 17:16:47 +00:00
virtual bool region_owns_point(RID p_region, const Vector2 &p_point) const;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Set the map of this region.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void region_set_map(RID p_region, RID p_map);
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
virtual RID region_get_map(RID p_region) const;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Implement Navigation layers
2021-03-08 19:56:33 +00:00
/// Set the region's layers
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void region_set_navigation_layers(RID p_region, uint32_t p_navigation_layers);
Streamline Navigation layer function names. Streamline Navigation layer function names.
2022-06-14 21:34:43 +00:00
virtual uint32_t region_get_navigation_layers(RID p_region) const;
Implement Navigation layers
2021-03-08 19:56:33 +00:00
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Set the global transformation of this region.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void region_set_transform(RID p_region, Transform2D p_transform);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Set the navigation poly of this region.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void region_set_navigation_polygon(RID p_region, Ref<NavigationPolygon> p_navigation_polygon);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
/// Get a list of a region's connection to other regions.
virtual int region_get_connections_count(RID p_region) const;
virtual Vector2 region_get_connection_pathway_start(RID p_region, int p_connection_id) const;
virtual Vector2 region_get_connection_pathway_end(RID p_region, int p_connection_id) const;
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
/// Creates a new link between positions in the nav map.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual RID link_create();
Added node for Navigation links
2022-01-30 23:39:52 +00:00
/// Set the map of this link.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void link_set_map(RID p_link, RID p_map);
Added node for Navigation links
2022-01-30 23:39:52 +00:00
virtual RID link_get_map(RID p_link) const;
/// Set whether this link travels in both directions.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void link_set_bidirectional(RID p_link, bool p_bidirectional);
Added node for Navigation links
2022-01-30 23:39:52 +00:00
virtual bool link_is_bidirectional(RID p_link) const;
/// Set the link's layers.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void link_set_navigation_layers(RID p_link, uint32_t p_navigation_layers);
Added node for Navigation links
2022-01-30 23:39:52 +00:00
virtual uint32_t link_get_navigation_layers(RID p_link) const;
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
/// Set the start position of the link.
virtual void link_set_start_position(RID p_link, Vector2 p_position);
virtual Vector2 link_get_start_position(RID p_link) const;
Added node for Navigation links
2022-01-30 23:39:52 +00:00
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
/// Set the end position of the link.
virtual void link_set_end_position(RID p_link, Vector2 p_position);
virtual Vector2 link_get_end_position(RID p_link) const;
Added node for Navigation links
2022-01-30 23:39:52 +00:00
/// Set the enter cost of the link.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void link_set_enter_cost(RID p_link, real_t p_enter_cost);
Added node for Navigation links
2022-01-30 23:39:52 +00:00
virtual real_t link_get_enter_cost(RID p_link) const;
/// Set the travel cost of the link.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void link_set_travel_cost(RID p_link, real_t p_travel_cost);
Added node for Navigation links
2022-01-30 23:39:52 +00:00
virtual real_t link_get_travel_cost(RID p_link) const;
Enable assigning an owner to navigation regions and links This allows users of the server APIs to get back the nodes that created certain regions and links.
2022-10-01 05:49:39 +00:00
/// Set the node which manages this link.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void link_set_owner_id(RID p_link, ObjectID p_owner_id);
Enable assigning an owner to navigation regions and links This allows users of the server APIs to get back the nodes that created certain regions and links.
2022-10-01 05:49:39 +00:00
virtual ObjectID link_get_owner_id(RID p_link) const;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Creates the agent.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual RID agent_create();
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Put the agent in the map.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void agent_set_map(RID p_agent, RID p_map);
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
virtual RID agent_get_map(RID p_agent) const;
Rework Navigation Avoidance Rework Navigation Avoidance.
2023-01-10 06:14:16 +00:00
virtual void agent_set_avoidance_enabled(RID p_agent, bool p_enabled);
virtual bool agent_get_avoidance_enabled(RID p_agent) const;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// The maximum distance (center point to
/// center point) to other agents this agent
/// takes into account in the navigation. The
/// larger this number, the longer the running
/// time of the simulation. If the number is too
/// low, the simulation will not be safe.
/// Must be non-negative.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void agent_set_neighbor_distance(RID p_agent, real_t p_distance);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// The maximum number of other agents this
/// agent takes into account in the navigation.
/// The larger this number, the longer the
/// running time of the simulation. If the
/// number is too low, the simulation will not
/// be safe.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void agent_set_max_neighbors(RID p_agent, int p_count);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// The minimal amount of time for which this
/// agent's velocities that are computed by the
/// simulation are safe with respect to other
/// agents. The larger this number, the sooner
/// this agent will respond to the presence of
/// other agents, but the less freedom this
/// agent has in choosing its velocities.
/// Must be positive.
Rework Navigation Avoidance Rework Navigation Avoidance.
2023-01-10 06:14:16 +00:00
virtual void agent_set_time_horizon_agents(RID p_agent, real_t p_time_horizon);
virtual void agent_set_time_horizon_obstacles(RID p_agent, real_t p_time_horizon);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// The radius of this agent.
/// Must be non-negative.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void agent_set_radius(RID p_agent, real_t p_radius);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// The maximum speed of this agent.
/// Must be non-negative.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void agent_set_max_speed(RID p_agent, real_t p_max_speed);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Rework Navigation Avoidance Rework Navigation Avoidance.
2023-01-10 06:14:16 +00:00
/// forces and agent velocity change in the avoidance simulation, adds simulation instability if done recklessly
virtual void agent_set_velocity_forced(RID p_agent, Vector2 p_velocity);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Rework Navigation Avoidance Rework Navigation Avoidance.
2023-01-10 06:14:16 +00:00
/// The wanted velocity for the agent as a "suggestion" to the avoidance simulation.
/// The simulation will try to fulfil this velocity wish if possible but may change the velocity depending on other agent's and obstacles'.
virtual void agent_set_velocity(RID p_agent, Vector2 p_velocity);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Position of the agent in world space.
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void agent_set_position(RID p_agent, Vector2 p_position);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Returns true if the map got changed the previous frame.
virtual bool agent_is_map_changed(RID p_agent) const;
/// Callback called at the end of the RVO process
Rework Navigation Avoidance Rework Navigation Avoidance.
2023-01-10 06:14:16 +00:00
virtual void agent_set_avoidance_callback(RID p_agent, Callable p_callback);
virtual void agent_set_avoidance_layers(RID p_agent, uint32_t p_layers);
virtual void agent_set_avoidance_mask(RID p_agent, uint32_t p_mask);
virtual void agent_set_avoidance_priority(RID p_agent, real_t p_priority);
/// Creates the obstacle.
virtual RID obstacle_create();
virtual void obstacle_set_map(RID p_obstacle, RID p_map);
virtual RID obstacle_get_map(RID p_obstacle) const;
virtual void obstacle_set_position(RID p_obstacle, Vector2 p_position);
virtual void obstacle_set_vertices(RID p_obstacle, const Vector<Vector2> &p_vertices);
virtual void obstacle_set_avoidance_layers(RID p_obstacle, uint32_t p_layers);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Allow compiling out the navigation module
2022-11-21 07:35:20 +00:00
/// Returns a customized navigation path using a query parameters object
Add NavigationPathQuery Adds NavigationPathQueryParameters objects that can be used with NavigationServer.query_path() to query a customized navigation path.
2022-06-26 10:43:01 +00:00
virtual void query_path(const Ref<NavigationPathQueryParameters2D> &p_query_parameters, Ref<NavigationPathQueryResult2D> p_query_result) const;
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
/// Destroy the `RID`
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
virtual void free(RID p_object);
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
Renaming of servers for coherency. VisualServer -> RenderingServer PhysicsServer -> PhysicsServer3D Physics2DServer -> PhysicsServer2D NavigationServer -> NavigationServer3D Navigation2DServer -> NavigationServer2D Also renamed corresponding files.
2020-03-27 18:21:27 +00:00
NavigationServer2D();
virtual ~NavigationServer2D();
Add NavigationServer2D debug functions Adds debug functions to NavigationServer2D to mirror NavigationServer3D functions for 2D users.
2022-08-09 10:21:45 +00:00
void set_debug_enabled(bool p_enabled);
bool get_debug_enabled() const;
Fix navigation debug not toggleable in scripts Fixes that navigation debug was not toggleable in script while even the docs mentioned it.
2023-02-13 11:17:24 +00:00
#ifdef DEBUG_ENABLED
Rework Navigation Avoidance Rework Navigation Avoidance.
2023-01-10 06:14:16 +00:00
void set_debug_navigation_enabled(bool p_enabled);
bool get_debug_navigation_enabled() const;
void set_debug_avoidance_enabled(bool p_enabled);
bool get_debug_avoidance_enabled() const;
Add NavigationServer2D debug functions Adds debug functions to NavigationServer2D to mirror NavigationServer3D functions for 2D users.
2022-08-09 10:21:45 +00:00
void set_debug_navigation_edge_connection_color(const Color &p_color);
Color get_debug_navigation_edge_connection_color() const;
void set_debug_navigation_geometry_face_color(const Color &p_color);
Color get_debug_navigation_geometry_face_color() const;
void set_debug_navigation_geometry_face_disabled_color(const Color &p_color);
Color get_debug_navigation_geometry_face_disabled_color() const;
Fix 2D navigation debug visuals ignoring half the ProjectSettings Fixes that NavigationRegion2D and TileMap debug visuals ignored more or less half the ProjectSetting. E.g. random color could not be disabled, edges did not display.
2023-02-13 03:35:42 +00:00
void set_debug_navigation_geometry_edge_color(const Color &p_color);
Color get_debug_navigation_geometry_edge_color() const;
void set_debug_navigation_geometry_edge_disabled_color(const Color &p_color);
Color get_debug_navigation_geometry_edge_disabled_color() const;
Added node for Navigation links
2022-01-30 23:39:52 +00:00
void set_debug_navigation_link_connection_color(const Color &p_color);
Color get_debug_navigation_link_connection_color() const;
void set_debug_navigation_link_connection_disabled_color(const Color &p_color);
Color get_debug_navigation_link_connection_disabled_color() const;
Add NavigationServer2D debug functions Adds debug functions to NavigationServer2D to mirror NavigationServer3D functions for 2D users.
2022-08-09 10:21:45 +00:00
void set_debug_navigation_enable_edge_connections(const bool p_value);
bool get_debug_navigation_enable_edge_connections() const;
Add NavigationAgent Path Debug Visualization Adds path debug visuals for NavigationAgent2D, NavigationAgent3D and NavigationServer.
2023-01-16 16:45:03 +00:00
Fix 2D navigation debug visuals ignoring half the ProjectSettings Fixes that NavigationRegion2D and TileMap debug visuals ignored more or less half the ProjectSetting. E.g. random color could not be disabled, edges did not display.
2023-02-13 03:35:42 +00:00
void set_debug_navigation_enable_geometry_face_random_color(const bool p_value);
bool get_debug_navigation_enable_geometry_face_random_color() const;
void set_debug_navigation_enable_edge_lines(const bool p_value);
bool get_debug_navigation_enable_edge_lines() const;
Add NavigationAgent Path Debug Visualization Adds path debug visuals for NavigationAgent2D, NavigationAgent3D and NavigationServer.
2023-01-16 16:45:03 +00:00
void set_debug_navigation_agent_path_color(const Color &p_color);
Color get_debug_navigation_agent_path_color() const;
void set_debug_navigation_enable_agent_paths(const bool p_value);
bool get_debug_navigation_enable_agent_paths() const;
Fix NavigationServer internals still using float instead of real_t Fixes that some NavigationServer internals still used float instead of real_t in some parts.
2023-03-07 14:16:07 +00:00
void set_debug_navigation_agent_path_point_size(real_t p_point_size);
real_t get_debug_navigation_agent_path_point_size() const;
Rework Navigation Avoidance Rework Navigation Avoidance.
2023-01-10 06:14:16 +00:00
void set_debug_navigation_avoidance_enable_agents_radius(const bool p_value);
bool get_debug_navigation_avoidance_enable_agents_radius() const;
void set_debug_navigation_avoidance_enable_obstacles_radius(const bool p_value);
bool get_debug_navigation_avoidance_enable_obstacles_radius() const;
void set_debug_navigation_avoidance_agents_radius_color(const Color &p_color);
Color get_debug_navigation_avoidance_agents_radius_color() const;
void set_debug_navigation_avoidance_obstacles_radius_color(const Color &p_color);
Color get_debug_navigation_avoidance_obstacles_radius_color() const;
void set_debug_navigation_avoidance_static_obstacle_pushin_face_color(const Color &p_color);
Color get_debug_navigation_avoidance_static_obstacle_pushin_face_color() const;
void set_debug_navigation_avoidance_static_obstacle_pushout_face_color(const Color &p_color);
Color get_debug_navigation_avoidance_static_obstacle_pushout_face_color() const;
void set_debug_navigation_avoidance_static_obstacle_pushin_edge_color(const Color &p_color);
Color get_debug_navigation_avoidance_static_obstacle_pushin_edge_color() const;
void set_debug_navigation_avoidance_static_obstacle_pushout_edge_color(const Color &p_color);
Color get_debug_navigation_avoidance_static_obstacle_pushout_edge_color() const;
void set_debug_navigation_avoidance_enable_obstacles_static(const bool p_value);
bool get_debug_navigation_avoidance_enable_obstacles_static() const;
Add NavigationAgent Path Debug Visualization Adds path debug visuals for NavigationAgent2D, NavigationAgent3D and NavigationServer.
2023-01-16 16:45:03 +00:00
#endif // DEBUG_ENABLED
#ifdef DEBUG_ENABLED
private:
void _emit_navigation_debug_changed_signal();
Add NavigationServer2D debug functions Adds debug functions to NavigationServer2D to mirror NavigationServer3D functions for 2D users.
2022-08-09 10:21:45 +00:00
#endif // DEBUG_ENABLED
- Integrated NavigationServer and Navigation2DServer. - Added Navigation Agents and Obstacles. - Integrated Collision Avoidance. This work has been kindly sponsored by IMVU.
2020-01-10 11:22:34 +00:00
};
Style: Remove inconsistently used `@author` docstrings Each file in Godot has had multiple contributors who co-authored it over the years, and the information of who was the original person to create that file is not very relevant, especially when used so inconsistently. `git blame` is a much better way to know who initially authored or later modified a given chunk of code, and most IDEs now have good integration to show this information.
2022-01-04 19:26:22 +00:00
#endif // NAVIGATION_SERVER_2D_H