CoCalc -- godot_navigation_server

GitHub Repository: godotengine/godot
Path: blob/master/modules/navigation_3d/3d/godot_navigation_server_3d.h
¹⁰²⁷⁸ views
1
/**************************************************************************/
2
/*  godot_navigation_server_3d.h                                          */
3
/**************************************************************************/
4
/*                         This file is part of:                          */
5
/*                             GODOT ENGINE                               */
6
/*                        https://godotengine.org                         */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
10
/*                                                                        */
11
/* Permission is hereby granted, free of charge, to any person obtaining  */
12
/* a copy of this software and associated documentation files (the        */
13
/* "Software"), to deal in the Software without restriction, including    */
14
/* without limitation the rights to use, copy, modify, merge, publish,    */
15
/* distribute, sublicense, and/or sell copies of the Software, and to     */
16
/* permit persons to whom the Software is furnished to do so, subject to  */
17
/* the following conditions:                                              */
18
/*                                                                        */
19
/* The above copyright notice and this permission notice shall be         */
20
/* included in all copies or substantial portions of the Software.        */
21
/*                                                                        */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
29
/**************************************************************************/
30

31
#pragma once
32

33
#include "../nav_agent_3d.h"
34
#include "../nav_link_3d.h"
35
#include "../nav_map_3d.h"
36
#include "../nav_obstacle_3d.h"
37
#include "../nav_region_3d.h"
38

39
#include "core/templates/local_vector.h"
40
#include "core/templates/rid.h"
41
#include "core/templates/rid_owner.h"
42
#include "servers/navigation/navigation_path_query_parameters_3d.h"
43
#include "servers/navigation/navigation_path_query_result_3d.h"
44
#include "servers/navigation_server_3d.h"
45

46
/// The commands are functions executed during the `sync` phase.
47

48
#define MERGE_INTERNAL(A, B) A##B
49
#define MERGE(A, B) MERGE_INTERNAL(A, B)
50

51
#define COMMAND_1(F_NAME, T_0, D_0)        \
52
	virtual void F_NAME(T_0 D_0) override; \
53
	void MERGE(_cmd_, F_NAME)(T_0 D_0)
54

55
#define COMMAND_2(F_NAME, T_0, D_0, T_1, D_1)       \
56
	virtual void F_NAME(T_0 D_0, T_1 D_1) override; \
57
	void MERGE(_cmd_, F_NAME)(T_0 D_0, T_1 D_1)
58

59
class GodotNavigationServer3D;
60
class NavMeshGenerator3D;
61

62
struct SetCommand3D {
63
	virtual ~SetCommand3D() {}
64
	virtual void exec(GodotNavigationServer3D *server) = 0;
65
};
66

67
class GodotNavigationServer3D : public NavigationServer3D {
68
	Mutex commands_mutex;
69
	/// Mutex used to make any operation threadsafe.
70
	Mutex operations_mutex;
71

72
	LocalVector<SetCommand3D *> commands;
73

74
	mutable RID_Owner<NavLink3D> link_owner;
75
	mutable RID_Owner<NavMap3D> map_owner;
76
	mutable RID_Owner<NavRegion3D> region_owner;
77
	mutable RID_Owner<NavAgent3D> agent_owner;
78
	mutable RID_Owner<NavObstacle3D> obstacle_owner;
79

80
	bool active = true;
81
	LocalVector<NavMap3D *> active_maps;
82

83
	NavMeshGenerator3D *navmesh_generator_3d = nullptr;
84

85
	// Performance Monitor
86
	int pm_region_count = 0;
87
	int pm_agent_count = 0;
88
	int pm_link_count = 0;
89
	int pm_polygon_count = 0;
90
	int pm_edge_count = 0;
91
	int pm_edge_merge_count = 0;
92
	int pm_edge_connection_count = 0;
93
	int pm_edge_free_count = 0;
94
	int pm_obstacle_count = 0;
95

96
public:
97
	GodotNavigationServer3D();
98
	virtual ~GodotNavigationServer3D();
99

100
	void add_command(SetCommand3D *command);
101

102
	virtual TypedArray<RID> get_maps() const override;
103

104
	virtual RID map_create() override;
105
	COMMAND_2(map_set_active, RID, p_map, bool, p_active);
106
	virtual bool map_is_active(RID p_map) const override;
107

108
	COMMAND_2(map_set_up, RID, p_map, Vector3, p_up);
109
	virtual Vector3 map_get_up(RID p_map) const override;
110

111
	COMMAND_2(map_set_cell_size, RID, p_map, real_t, p_cell_size);
112
	virtual real_t map_get_cell_size(RID p_map) const override;
113

114
	COMMAND_2(map_set_cell_height, RID, p_map, real_t, p_cell_height);
115
	virtual real_t map_get_cell_height(RID p_map) const override;
116

117
	COMMAND_2(map_set_merge_rasterizer_cell_scale, RID, p_map, float, p_value);
118
	virtual float map_get_merge_rasterizer_cell_scale(RID p_map) const override;
119

120
	COMMAND_2(map_set_use_edge_connections, RID, p_map, bool, p_enabled);
121
	virtual bool map_get_use_edge_connections(RID p_map) const override;
122

123
	COMMAND_2(map_set_edge_connection_margin, RID, p_map, real_t, p_connection_margin);
124
	virtual real_t map_get_edge_connection_margin(RID p_map) const override;
125

126
	COMMAND_2(map_set_link_connection_radius, RID, p_map, real_t, p_connection_radius);
127
	virtual real_t map_get_link_connection_radius(RID p_map) const override;
128

129
	virtual Vector<Vector3> map_get_path(RID p_map, Vector3 p_origin, Vector3 p_destination, bool p_optimize, uint32_t p_navigation_layers = 1) override;
130

131
	virtual Vector3 map_get_closest_point_to_segment(RID p_map, const Vector3 &p_from, const Vector3 &p_to, const bool p_use_collision = false) const override;
132
	virtual Vector3 map_get_closest_point(RID p_map, const Vector3 &p_point) const override;
133
	virtual Vector3 map_get_closest_point_normal(RID p_map, const Vector3 &p_point) const override;
134
	virtual RID map_get_closest_point_owner(RID p_map, const Vector3 &p_point) const override;
135

136
	virtual TypedArray<RID> map_get_links(RID p_map) const override;
137
	virtual TypedArray<RID> map_get_regions(RID p_map) const override;
138
	virtual TypedArray<RID> map_get_agents(RID p_map) const override;
139
	virtual TypedArray<RID> map_get_obstacles(RID p_map) const override;
140

141
	virtual void map_force_update(RID p_map) override;
142
	virtual uint32_t map_get_iteration_id(RID p_map) const override;
143

144
	COMMAND_2(map_set_use_async_iterations, RID, p_map, bool, p_enabled);
145
	virtual bool map_get_use_async_iterations(RID p_map) const override;
146

147
	virtual Vector3 map_get_random_point(RID p_map, uint32_t p_navigation_layers, bool p_uniformly) const override;
148

149
	virtual RID region_create() override;
150
	virtual uint32_t region_get_iteration_id(RID p_region) const override;
151

152
	COMMAND_2(region_set_use_async_iterations, RID, p_region, bool, p_enabled);
153
	virtual bool region_get_use_async_iterations(RID p_region) const override;
154

155
	COMMAND_2(region_set_enabled, RID, p_region, bool, p_enabled);
156
	virtual bool region_get_enabled(RID p_region) const override;
157

158
	COMMAND_2(region_set_use_edge_connections, RID, p_region, bool, p_enabled);
159
	virtual bool region_get_use_edge_connections(RID p_region) const override;
160

161
	COMMAND_2(region_set_enter_cost, RID, p_region, real_t, p_enter_cost);
162
	virtual real_t region_get_enter_cost(RID p_region) const override;
163
	COMMAND_2(region_set_travel_cost, RID, p_region, real_t, p_travel_cost);
164
	virtual real_t region_get_travel_cost(RID p_region) const override;
165

166
	COMMAND_2(region_set_owner_id, RID, p_region, ObjectID, p_owner_id);
167
	virtual ObjectID region_get_owner_id(RID p_region) const override;
168

169
	virtual bool region_owns_point(RID p_region, const Vector3 &p_point) const override;
170

171
	COMMAND_2(region_set_map, RID, p_region, RID, p_map);
172
	virtual RID region_get_map(RID p_region) const override;
173
	COMMAND_2(region_set_navigation_layers, RID, p_region, uint32_t, p_navigation_layers);
174
	virtual uint32_t region_get_navigation_layers(RID p_region) const override;
175
	COMMAND_2(region_set_transform, RID, p_region, Transform3D, p_transform);
176
	virtual Transform3D region_get_transform(RID p_region) const override;
177
	COMMAND_2(region_set_navigation_mesh, RID, p_region, Ref<NavigationMesh>, p_navigation_mesh);
178
#ifndef DISABLE_DEPRECATED
179
	virtual void region_bake_navigation_mesh(Ref<NavigationMesh> p_navigation_mesh, Node *p_root_node) override;
180
#endif // DISABLE_DEPRECATED
181
	virtual int region_get_connections_count(RID p_region) const override;
182
	virtual Vector3 region_get_connection_pathway_start(RID p_region, int p_connection_id) const override;
183
	virtual Vector3 region_get_connection_pathway_end(RID p_region, int p_connection_id) const override;
184
	virtual Vector3 region_get_closest_point_to_segment(RID p_region, const Vector3 &p_from, const Vector3 &p_to, bool p_use_collision = false) const override;
185
	virtual Vector3 region_get_closest_point(RID p_region, const Vector3 &p_point) const override;
186
	virtual Vector3 region_get_closest_point_normal(RID p_region, const Vector3 &p_point) const override;
187
	virtual Vector3 region_get_random_point(RID p_region, uint32_t p_navigation_layers, bool p_uniformly) const override;
188
	virtual AABB region_get_bounds(RID p_region) const override;
189

190
	virtual RID link_create() override;
191
	virtual uint32_t link_get_iteration_id(RID p_link) const override;
192
	COMMAND_2(link_set_map, RID, p_link, RID, p_map);
193
	virtual RID link_get_map(RID p_link) const override;
194
	COMMAND_2(link_set_enabled, RID, p_link, bool, p_enabled);
195
	virtual bool link_get_enabled(RID p_link) const override;
196
	COMMAND_2(link_set_bidirectional, RID, p_link, bool, p_bidirectional);
197
	virtual bool link_is_bidirectional(RID p_link) const override;
198
	COMMAND_2(link_set_navigation_layers, RID, p_link, uint32_t, p_navigation_layers);
199
	virtual uint32_t link_get_navigation_layers(RID p_link) const override;
200
	COMMAND_2(link_set_start_position, RID, p_link, Vector3, p_position);
201
	virtual Vector3 link_get_start_position(RID p_link) const override;
202
	COMMAND_2(link_set_end_position, RID, p_link, Vector3, p_position);
203
	virtual Vector3 link_get_end_position(RID p_link) const override;
204
	COMMAND_2(link_set_enter_cost, RID, p_link, real_t, p_enter_cost);
205
	virtual real_t link_get_enter_cost(RID p_link) const override;
206
	COMMAND_2(link_set_travel_cost, RID, p_link, real_t, p_travel_cost);
207
	virtual real_t link_get_travel_cost(RID p_link) const override;
208
	COMMAND_2(link_set_owner_id, RID, p_link, ObjectID, p_owner_id);
209
	virtual ObjectID link_get_owner_id(RID p_link) const override;
210

211
	virtual RID agent_create() override;
212
	COMMAND_2(agent_set_avoidance_enabled, RID, p_agent, bool, p_enabled);
213
	virtual bool agent_get_avoidance_enabled(RID p_agent) const override;
214
	COMMAND_2(agent_set_use_3d_avoidance, RID, p_agent, bool, p_enabled);
215
	virtual bool agent_get_use_3d_avoidance(RID p_agent) const override;
216
	COMMAND_2(agent_set_map, RID, p_agent, RID, p_map);
217
	virtual RID agent_get_map(RID p_agent) const override;
218
	COMMAND_2(agent_set_paused, RID, p_agent, bool, p_paused);
219
	virtual bool agent_get_paused(RID p_agent) const override;
220
	COMMAND_2(agent_set_neighbor_distance, RID, p_agent, real_t, p_distance);
221
	virtual real_t agent_get_neighbor_distance(RID p_agent) const override;
222
	COMMAND_2(agent_set_max_neighbors, RID, p_agent, int, p_count);
223
	virtual int agent_get_max_neighbors(RID p_agent) const override;
224
	COMMAND_2(agent_set_time_horizon_agents, RID, p_agent, real_t, p_time_horizon);
225
	virtual real_t agent_get_time_horizon_agents(RID p_agent) const override;
226
	COMMAND_2(agent_set_time_horizon_obstacles, RID, p_agent, real_t, p_time_horizon);
227
	virtual real_t agent_get_time_horizon_obstacles(RID p_agent) const override;
228
	COMMAND_2(agent_set_radius, RID, p_agent, real_t, p_radius);
229
	virtual real_t agent_get_radius(RID p_agent) const override;
230
	COMMAND_2(agent_set_height, RID, p_agent, real_t, p_height);
231
	virtual real_t agent_get_height(RID p_agent) const override;
232
	COMMAND_2(agent_set_max_speed, RID, p_agent, real_t, p_max_speed);
233
	virtual real_t agent_get_max_speed(RID p_agent) const override;
234
	COMMAND_2(agent_set_velocity, RID, p_agent, Vector3, p_velocity);
235
	virtual Vector3 agent_get_velocity(RID p_agent) const override;
236
	COMMAND_2(agent_set_velocity_forced, RID, p_agent, Vector3, p_velocity);
237
	COMMAND_2(agent_set_position, RID, p_agent, Vector3, p_position);
238
	virtual Vector3 agent_get_position(RID p_agent) const override;
239
	virtual bool agent_is_map_changed(RID p_agent) const override;
240
	COMMAND_2(agent_set_avoidance_callback, RID, p_agent, Callable, p_callback);
241
	virtual bool agent_has_avoidance_callback(RID p_agent) const override;
242
	COMMAND_2(agent_set_avoidance_layers, RID, p_agent, uint32_t, p_layers);
243
	virtual uint32_t agent_get_avoidance_layers(RID p_agent) const override;
244
	COMMAND_2(agent_set_avoidance_mask, RID, p_agent, uint32_t, p_mask);
245
	virtual uint32_t agent_get_avoidance_mask(RID p_agent) const override;
246
	COMMAND_2(agent_set_avoidance_priority, RID, p_agent, real_t, p_priority);
247
	virtual real_t agent_get_avoidance_priority(RID p_agent) const override;
248

249
	virtual RID obstacle_create() override;
250
	COMMAND_2(obstacle_set_avoidance_enabled, RID, p_obstacle, bool, p_enabled);
251
	virtual bool obstacle_get_avoidance_enabled(RID p_obstacle) const override;
252
	COMMAND_2(obstacle_set_use_3d_avoidance, RID, p_obstacle, bool, p_enabled);
253
	virtual bool obstacle_get_use_3d_avoidance(RID p_obstacle) const override;
254
	COMMAND_2(obstacle_set_map, RID, p_obstacle, RID, p_map);
255
	virtual RID obstacle_get_map(RID p_obstacle) const override;
256
	COMMAND_2(obstacle_set_paused, RID, p_obstacle, bool, p_paused);
257
	virtual bool obstacle_get_paused(RID p_obstacle) const override;
258
	COMMAND_2(obstacle_set_radius, RID, p_obstacle, real_t, p_radius);
259
	virtual real_t obstacle_get_radius(RID p_obstacle) const override;
260
	COMMAND_2(obstacle_set_velocity, RID, p_obstacle, Vector3, p_velocity);
261
	virtual Vector3 obstacle_get_velocity(RID p_obstacle) const override;
262
	COMMAND_2(obstacle_set_position, RID, p_obstacle, Vector3, p_position);
263
	virtual Vector3 obstacle_get_position(RID p_obstacle) const override;
264
	COMMAND_2(obstacle_set_height, RID, p_obstacle, real_t, p_height);
265
	virtual real_t obstacle_get_height(RID p_obstacle) const override;
266
	virtual void obstacle_set_vertices(RID p_obstacle, const Vector<Vector3> &p_vertices) override;
267
	virtual Vector<Vector3> obstacle_get_vertices(RID p_obstacle) const override;
268
	COMMAND_2(obstacle_set_avoidance_layers, RID, p_obstacle, uint32_t, p_layers);
269
	virtual uint32_t obstacle_get_avoidance_layers(RID p_obstacle) const override;
270

271
	virtual void parse_source_geometry_data(const Ref<NavigationMesh> &p_navigation_mesh, const Ref<NavigationMeshSourceGeometryData3D> &p_source_geometry_data, Node *p_root_node, const Callable &p_callback = Callable()) override;
272
	virtual void bake_from_source_geometry_data(const Ref<NavigationMesh> &p_navigation_mesh, const Ref<NavigationMeshSourceGeometryData3D> &p_source_geometry_data, const Callable &p_callback = Callable()) override;
273
	virtual void bake_from_source_geometry_data_async(const Ref<NavigationMesh> &p_navigation_mesh, const Ref<NavigationMeshSourceGeometryData3D> &p_source_geometry_data, const Callable &p_callback = Callable()) override;
274
	virtual bool is_baking_navigation_mesh(Ref<NavigationMesh> p_navigation_mesh) const override;
275
	virtual String get_baking_navigation_mesh_state_msg(Ref<NavigationMesh> p_navigation_mesh) const override;
276

277
	virtual RID source_geometry_parser_create() override;
278
	virtual void source_geometry_parser_set_callback(RID p_parser, const Callable &p_callback) override;
279

280
	virtual Vector<Vector3> simplify_path(const Vector<Vector3> &p_path, real_t p_epsilon) override;
281

282
public:
283
	COMMAND_1(free, RID, p_object);
284

285
	virtual void set_active(bool p_active) override;
286

287
	void flush_queries();
288

289
	virtual void process(double p_delta_time) override;
290
	virtual void physics_process(double p_delta_time) override;
291
	virtual void init() override;
292
	virtual void sync() override;
293
	virtual void finish() override;
294

295
	virtual void query_path(const Ref<NavigationPathQueryParameters3D> &p_query_parameters, Ref<NavigationPathQueryResult3D> p_query_result, const Callable &p_callback = Callable()) override;
296

297
	int get_process_info(ProcessInfo p_info) const override;
298

299
private:
300
	void internal_free_agent(RID p_object);
301
	void internal_free_obstacle(RID p_object);
302
};
303

304
#undef COMMAND_1
305
#undef COMMAND_2
306

307
Product

Resources

Company
