diff options
Diffstat (limited to 'servers/navigation_2d_server.h')
| -rw-r--r-- | servers/navigation_2d_server.h | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/servers/navigation_2d_server.h b/servers/navigation_2d_server.h new file mode 100644 index 0000000000..0cab699c68 --- /dev/null +++ b/servers/navigation_2d_server.h @@ -0,0 +1,160 @@ +/*************************************************************************/ +/* navigation_2d_server.h */ +/*************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* https://godotengine.org */ +/*************************************************************************/ +/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */ +/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md) */ +/* */ +/* 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. */ +/*************************************************************************/ + +/** + @author AndreaCatania +*/ + +#ifndef NAVIGATION_2D_SERVER_H +#define NAVIGATION_2D_SERVER_H + +#include "core/object.h" +#include "core/rid.h" +#include "scene/2d/navigation_polygon.h" + +// This server exposes the 3D `NavigationServer` features in the 2D world. +class Navigation2DServer : public Object { + GDCLASS(Navigation2DServer, Object); + + static Navigation2DServer *singleton; + +protected: + static void _bind_methods(); + +public: + /// Thread safe, can be used accross many threads. + static const Navigation2DServer *get_singleton() { return singleton; } + + /// MUST be used in single thread! + static Navigation2DServer *get_singleton_mut() { return singleton; } + + /// Create a new map. + virtual RID map_create() const; + + /// Set map active. + virtual void map_set_active(RID p_map, bool p_active) const; + + /// 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. + virtual void map_set_cell_size(RID p_map, real_t p_cell_size) const; + + /// Returns the map cell size. + virtual real_t map_get_cell_size(RID p_map) const; + + /// Set the map edge connection margin used to weld the compatible region edges. + virtual void map_set_edge_connection_margin(RID p_map, real_t p_connection_margin) const; + + /// Returns the edge connection margin of this map. + virtual real_t map_get_edge_connection_margin(RID p_map) const; + + /// Returns the navigation path to reach the destination from the origin. + virtual Vector<Vector2> map_get_path(RID p_map, Vector2 p_origin, Vector2 p_destination, bool p_optimize) const; + + /// Creates a new region. + virtual RID region_create() const; + + /// Set the map of this region. + virtual void region_set_map(RID p_region, RID p_map) const; + + /// Set the global transformation of this region. + virtual void region_set_transform(RID p_region, Transform2D p_transform) const; + + /// Set the navigation poly of this region. + virtual void region_set_navpoly(RID p_region, Ref<NavigationPolygon> p_nav_mesh) const; + + /// Creates the agent. + virtual RID agent_create() const; + + /// Put the agent in the map. + virtual void agent_set_map(RID p_agent, RID p_map) const; + + /// 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. + virtual void agent_set_neighbor_dist(RID p_agent, real_t p_dist) const; + + /// 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. + virtual void agent_set_max_neighbors(RID p_agent, int p_count) const; + + /// 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. + virtual void agent_set_time_horizon(RID p_agent, real_t p_time) const; + + /// The radius of this agent. + /// Must be non-negative. + virtual void agent_set_radius(RID p_agent, real_t p_radius) const; + + /// The maximum speed of this agent. + /// Must be non-negative. + virtual void agent_set_max_speed(RID p_agent, real_t p_max_speed) const; + + /// Current velocity of the agent + virtual void agent_set_velocity(RID p_agent, Vector2 p_velocity) const; + + /// The new target velocity. + virtual void agent_set_target_velocity(RID p_agent, Vector2 p_velocity) const; + + /// Position of the agent in world space. + virtual void agent_set_position(RID p_agent, Vector2 p_position) const; + + /// Agent ignore the Y axis and avoid collisions by moving only on the horizontal plane + virtual void agent_set_ignore_y(RID p_agent, bool p_ignore) const; + + /// 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 + virtual void agent_set_callback(RID p_agent, Object *p_receiver, StringName p_method, Variant p_udata = Variant()) const; + + /// Destroy the `RID` + virtual void free(RID p_object) const; + + Navigation2DServer(); + virtual ~Navigation2DServer(); +}; + +#endif |