/*************************************************************************/ /* a_star.cpp */ /*************************************************************************/ /* 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. */ /*************************************************************************/ #include "a_star.h" #include "core/math/geometry.h" #include "core/script_language.h" #include "scene/scene_string_names.h" int AStar::get_available_point_id() const { if (points.empty()) { return 1; } // calculate our new next available point id if bigger than before or next id already contained in set of points. if (points.has(last_free_id)) { int cur_new_id = last_free_id; while (points.has(cur_new_id)) { cur_new_id++; } int &non_const = const_cast(last_free_id); non_const = cur_new_id; } return last_free_id; } void AStar::add_point(int p_id, const Vector3 &p_pos, real_t p_weight_scale) { ERR_FAIL_COND(p_id < 0); ERR_FAIL_COND(p_weight_scale < 1); Point *found_pt; bool p_exists = points.lookup(p_id, found_pt); if (!p_exists) { Point *pt = memnew(Point); pt->id = p_id; pt->pos = p_pos; pt->weight_scale = p_weight_scale; pt->prev_point = NULL; pt->open_pass = 0; pt->closed_pass = 0; pt->enabled = true; points.set(p_id, pt); } else { found_pt->pos = p_pos; found_pt->weight_scale = p_weight_scale; } } Vector3 AStar::get_point_position(int p_id) const { Point *p; bool p_exists = points.lookup(p_id, p); ERR_FAIL_COND_V(!p_exists, Vector3()); return p->pos; } void AStar::set_point_position(int p_id, const Vector3 &p_pos) { Point *p; bool p_exists = points.lookup(p_id, p); ERR_FAIL_COND(!p_exists); p->pos = p_pos; } real_t AStar::get_point_weight_scale(int p_id) const { Point *p; bool p_exists = points.lookup(p_id, p); ERR_FAIL_COND_V(!p_exists, 0); return p->weight_scale; } void AStar::set_point_weight_scale(int p_id, real_t p_weight_scale) { Point *p; bool p_exists = points.lookup(p_id, p); ERR_FAIL_COND(!p_exists); ERR_FAIL_COND(p_weight_scale < 1); p->weight_scale = p_weight_scale; } void AStar::remove_point(int p_id) { Point *p; bool p_exists = points.lookup(p_id, p); ERR_FAIL_COND(!p_exists); for (OAHashMap::Iterator it = p->neighbours.iter(); it.valid; it = p->neighbours.next_iter(it)) { Segment s(p_id, (*it.key)); segments.erase(s); (*it.value)->neighbours.remove(p->id); (*it.value)->unlinked_neighbours.remove(p->id); } for (OAHashMap::Iterator it = p->unlinked_neighbours.iter(); it.valid; it = p->unlinked_neighbours.next_iter(it)) { Segment s(p_id, (*it.key)); segments.erase(s); (*it.value)->neighbours.remove(p->id); (*it.value)->unlinked_neighbours.remove(p->id); } memdelete(p); points.remove(p_id); last_free_id = p_id; } void AStar::connect_points(int p_id, int p_with_id, bool bidirectional) { ERR_FAIL_COND(p_id == p_with_id); Point *a; bool from_exists = points.lookup(p_id, a); ERR_FAIL_COND(!from_exists); Point *b; bool to_exists = points.lookup(p_with_id, b); ERR_FAIL_COND(!to_exists); a->neighbours.set(b->id, b); if (bidirectional) { b->neighbours.set(a->id, a); } else { b->unlinked_neighbours.set(a->id, a); } Segment s(p_id, p_with_id); if (bidirectional) s.direction = Segment::BIDIRECTIONAL; Set::Element *element = segments.find(s); if (element != NULL) { s.direction |= element->get().direction; if (s.direction == Segment::BIDIRECTIONAL) { // Both are neighbours of each other now a->unlinked_neighbours.remove(b->id); b->unlinked_neighbours.remove(a->id); } segments.erase(element); } segments.insert(s); } void AStar::disconnect_points(int p_id, int p_with_id, bool bidirectional) { Point *a; bool a_exists = points.lookup(p_id, a); ERR_FAIL_COND(!a_exists); Point *b; bool b_exists = points.lookup(p_with_id, b); ERR_FAIL_COND(!b_exists); Segment s(p_id, p_with_id); int remove_direction = bidirectional ? (int)Segment::BIDIRECTIONAL : s.direction; Set::Element *element = segments.find(s); if (element != NULL) { // s is the new segment // Erase the directions to be removed s.direction = (element->get().direction & ~remove_direction); a->neighbours.remove(b->id); if (bidirectional) { b->neighbours.remove(a->id); if (element->get().direction != Segment::BIDIRECTIONAL) { a->unlinked_neighbours.remove(b->id); b->unlinked_neighbours.remove(a->id); } } else { if (s.direction == Segment::NONE) b->unlinked_neighbours.remove(a->id); else a->unlinked_neighbours.set(b->id, b); } segments.erase(element); if (s.direction != Segment::NONE) segments.insert(s); } } bool AStar::has_point(int p_id) const { return points.has(p_id); } Array AStar::get_points() { Array point_list; for (OAHashMap::Iterator it = points.iter(); it.valid; it = points.next_iter(it)) { point_list.push_back(*(it.key)); } return point_list; } Vector AStar::get_point_connections(int p_id) { Point *p; bool p_exists = points.lookup(p_id, p); ERR_FAIL_COND_V(!p_exists, Vector()); Vector point_list; for (OAHashMap::Iterator it = p->neighbours.iter(); it.valid; it = p->neighbours.next_iter(it)) { point_list.push_back((*it.key)); } return point_list; } bool AStar::are_points_connected(int p_id, int p_with_id, bool bidirectional) const { Segment s(p_id, p_with_id); const Set::Element *element = segments.find(s); return element != NULL && (bidirectional || (element->get().direction & s.direction) == s.direction); } void AStar::clear() { last_free_id = 0; for (OAHashMap::Iterator it = points.iter(); it.valid; it = points.next_iter(it)) { memdelete(*(it.value)); } segments.clear(); points.clear(); } int AStar::get_point_count() const { return points.get_num_elements(); } int AStar::get_point_capacity() const { return points.get_capacity(); } void AStar::reserve_space(int p_num_nodes) { ERR_FAIL_COND_MSG(p_num_nodes <= 0, "New capacity must be greater than 0, was: " + itos(p_num_nodes) + "."); ERR_FAIL_COND_MSG((uint32_t)p_num_nodes < points.get_capacity(), "New capacity must be greater than current capacity: " + itos(points.get_capacity()) + ", new was: " + itos(p_num_nodes) + "."); points.reserve(p_num_nodes); } int AStar::get_closest_point(const Vector3 &p_point, bool p_include_disabled) const { int closest_id = -1; real_t closest_dist = 1e20; for (OAHashMap::Iterator it = points.iter(); it.valid; it = points.next_iter(it)) { if (!p_include_disabled && !(*it.value)->enabled) continue; // Disabled points should not be considered. real_t d = p_point.distance_squared_to((*it.value)->pos); if (closest_id < 0 || d < closest_dist) { closest_dist = d; closest_id = *(it.key); } } return closest_id; } Vector3 AStar::get_closest_position_in_segment(const Vector3 &p_point) const { bool found = false; real_t closest_dist = 1e20; Vector3 closest_point; for (const Set::Element *E = segments.front(); E; E = E->next()) { Point *from_point = nullptr, *to_point = nullptr; points.lookup(E->get().u, from_point); points.lookup(E->get().v, to_point); if (!(from_point->enabled && to_point->enabled)) { continue; } Vector3 segment[2] = { from_point->pos, to_point->pos, }; Vector3 p = Geometry::get_closest_point_to_segment(p_point, segment); real_t d = p_point.distance_squared_to(p); if (!found || d < closest_dist) { closest_point = p; closest_dist = d; found = true; } } return closest_point; } bool AStar::_solve(Point *begin_point, Point *end_point) { pass++; if (!end_point->enabled) return false; bool found_route = false; Vector open_list; SortArray sorter; begin_point->g_score = 0; begin_point->f_score = _estimate_cost(begin_point->id, end_point->id); open_list.push_back(begin_point); while (!open_list.empty()) { Point *p = open_list[0]; // The currently processed point if (p == end_point) { found_route = true; break; } sorter.pop_heap(0, open_list.size(), open_list.ptrw()); // Remove the current point from the open list open_list.remove(open_list.size() - 1); p->closed_pass = pass; // Mark the point as closed for (OAHashMap::Iterator it = p->neighbours.iter(); it.valid; it = p->neighbours.next_iter(it)) { Point *e = *(it.value); // The neighbour point if (!e->enabled || e->closed_pass == pass) { continue; } real_t tentative_g_score = p->g_score + _compute_cost(p->id, e->id) * e->weight_scale; bool new_point = false; if (e->open_pass != pass) { // The point wasn't inside the open list. e->open_pass = pass; open_list.push_back(e); new_point = true; } else if (tentative_g_score >= e->g_score) { // The new path is worse than the previous. continue; } e->prev_point = p; e->g_score = tentative_g_score; e->f_score = e->g_score + _estimate_cost(e->id, end_point->id); if (new_point) { // The position of the new points is already known. sorter.push_heap(0, open_list.size() - 1, 0, e, open_list.ptrw()); } else { sorter.push_heap(0, open_list.find(e), 0, e, open_list.ptrw()); } } } return found_route; } float AStar::_estimate_cost(int p_from_id, int p_to_id) { if (get_script_instance() && get_script_instance()->has_method(SceneStringNames::get_singleton()->_estimate_cost)) return get_script_instance()->call(SceneStringNames::get_singleton()->_estimate_cost, p_from_id, p_to_id); Point *from_point; bool from_exists = points.lookup(p_from_id, from_point); ERR_FAIL_COND_V(!from_exists, 0); Point *to_point; bool to_exists = points.lookup(p_to_id, to_point); ERR_FAIL_COND_V(!to_exists, 0); return from_point->pos.distance_to(to_point->pos); } float AStar::_compute_cost(int p_from_id, int p_to_id) { if (get_script_instance() && get_script_instance()->has_method(SceneStringNames::get_singleton()->_compute_cost)) return get_script_instance()->call(SceneStringNames::get_singleton()->_compute_cost, p_from_id, p_to_id); Point *from_point; bool from_exists = points.lookup(p_from_id, from_point); ERR_FAIL_COND_V(!from_exists, 0); Point *to_point; bool to_exists = points.lookup(p_to_id, to_point); ERR_FAIL_COND_V(!to_exists, 0); return from_point->pos.distance_to(to_point->pos); } Vector AStar::get_point_path(int p_from_id, int p_to_id) { Point *a; bool from_exists = points.lookup(p_from_id, a); ERR_FAIL_COND_V(!from_exists, Vector()); Point *b; bool to_exists = points.lookup(p_to_id, b); ERR_FAIL_COND_V(!to_exists, Vector()); if (a == b) { Vector ret; ret.push_back(a->pos); return ret; } Point *begin_point = a; Point *end_point = b; bool found_route = _solve(begin_point, end_point); if (!found_route) return Vector(); Point *p = end_point; int pc = 1; // Begin point while (p != begin_point) { pc++; p = p->prev_point; } Vector path; path.resize(pc); { Vector3 *w = path.ptrw(); Point *p2 = end_point; int idx = pc - 1; while (p2 != begin_point) { w[idx--] = p2->pos; p2 = p2->prev_point; } w[0] = p2->pos; // Assign first } return path; } Vector AStar::get_id_path(int p_from_id, int p_to_id) { Point *a; bool from_exists = points.lookup(p_from_id, a); ERR_FAIL_COND_V(!from_exists, Vector()); Point *b; bool to_exists = points.lookup(p_to_id, b); ERR_FAIL_COND_V(!to_exists, Vector()); if (a == b) { Vector ret; ret.push_back(a->id); return ret; } Point *begin_point = a; Point *end_point = b; bool found_route = _solve(begin_point, end_point); if (!found_route) return Vector(); Point *p = end_point; int pc = 1; // Begin point while (p != begin_point) { pc++; p = p->prev_point; } Vector path; path.resize(pc); { int *w = path.ptrw(); p = end_point; int idx = pc - 1; while (p != begin_point) { w[idx--] = p->id; p = p->prev_point; } w[0] = p->id; // Assign first } return path; } void AStar::set_point_disabled(int p_id, bool p_disabled) { Point *p; bool p_exists = points.lookup(p_id, p); ERR_FAIL_COND(!p_exists); p->enabled = !p_disabled; } bool AStar::is_point_disabled(int p_id) const { Point *p; bool p_exists = points.lookup(p_id, p); ERR_FAIL_COND_V(!p_exists, false); return !p->enabled; } void AStar::_bind_methods() { ClassDB::bind_method(D_METHOD("get_available_point_id"), &AStar::get_available_point_id); ClassDB::bind_method(D_METHOD("add_point", "id", "position", "weight_scale"), &AStar::add_point, DEFVAL(1.0)); ClassDB::bind_method(D_METHOD("get_point_position", "id"), &AStar::get_point_position); ClassDB::bind_method(D_METHOD("set_point_position", "id", "position"), &AStar::set_point_position); ClassDB::bind_method(D_METHOD("get_point_weight_scale", "id"), &AStar::get_point_weight_scale); ClassDB::bind_method(D_METHOD("set_point_weight_scale", "id", "weight_scale"), &AStar::set_point_weight_scale); ClassDB::bind_method(D_METHOD("remove_point", "id"), &AStar::remove_point); ClassDB::bind_method(D_METHOD("has_point", "id"), &AStar::has_point); ClassDB::bind_method(D_METHOD("get_point_connections", "id"), &AStar::get_point_connections); ClassDB::bind_method(D_METHOD("get_points"), &AStar::get_points); ClassDB::bind_method(D_METHOD("set_point_disabled", "id", "disabled"), &AStar::set_point_disabled, DEFVAL(true)); ClassDB::bind_method(D_METHOD("is_point_disabled", "id"), &AStar::is_point_disabled); ClassDB::bind_method(D_METHOD("connect_points", "id", "to_id", "bidirectional"), &AStar::connect_points, DEFVAL(true)); ClassDB::bind_method(D_METHOD("disconnect_points", "id", "to_id", "bidirectional"), &AStar::disconnect_points, DEFVAL(true)); ClassDB::bind_method(D_METHOD("are_points_connected", "id", "to_id", "bidirectional"), &AStar::are_points_connected, DEFVAL(true)); ClassDB::bind_method(D_METHOD("get_point_count"), &AStar::get_point_count); ClassDB::bind_method(D_METHOD("get_point_capacity"), &AStar::get_point_capacity); ClassDB::bind_method(D_METHOD("reserve_space", "num_nodes"), &AStar::reserve_space); ClassDB::bind_method(D_METHOD("clear"), &AStar::clear); ClassDB::bind_method(D_METHOD("get_closest_point", "to_position", "include_disabled"), &AStar::get_closest_point, DEFVAL(false)); ClassDB::bind_method(D_METHOD("get_closest_position_in_segment", "to_position"), &AStar::get_closest_position_in_segment); ClassDB::bind_method(D_METHOD("get_point_path", "from_id", "to_id"), &AStar::get_point_path); ClassDB::bind_method(D_METHOD("get_id_path", "from_id", "to_id"), &AStar::get_id_path); BIND_VMETHOD(MethodInfo(Variant::REAL, "_estimate_cost", PropertyInfo(Variant::INT, "from_id"), PropertyInfo(Variant::INT, "to_id"))); BIND_VMETHOD(MethodInfo(Variant::REAL, "_compute_cost", PropertyInfo(Variant::INT, "from_id"), PropertyInfo(Variant::INT, "to_id"))); } AStar::AStar() { last_free_id = 0; pass = 1; } AStar::~AStar() { clear(); } ///////////////////////////////////////////////////////////// int AStar2D::get_available_point_id() const { return astar.get_available_point_id(); } void AStar2D::add_point(int p_id, const Vector2 &p_pos, real_t p_weight_scale) { astar.add_point(p_id, Vector3(p_pos.x, p_pos.y, 0), p_weight_scale); } Vector2 AStar2D::get_point_position(int p_id) const { Vector3 p = astar.get_point_position(p_id); return Vector2(p.x, p.y); } void AStar2D::set_point_position(int p_id, const Vector2 &p_pos) { astar.set_point_position(p_id, Vector3(p_pos.x, p_pos.y, 0)); } real_t AStar2D::get_point_weight_scale(int p_id) const { return astar.get_point_weight_scale(p_id); } void AStar2D::set_point_weight_scale(int p_id, real_t p_weight_scale) { astar.set_point_weight_scale(p_id, p_weight_scale); } void AStar2D::remove_point(int p_id) { astar.remove_point(p_id); } bool AStar2D::has_point(int p_id) const { return astar.has_point(p_id); } Vector AStar2D::get_point_connections(int p_id) { return astar.get_point_connections(p_id); } Array AStar2D::get_points() { return astar.get_points(); } void AStar2D::set_point_disabled(int p_id, bool p_disabled) { astar.set_point_disabled(p_id, p_disabled); } bool AStar2D::is_point_disabled(int p_id) const { return astar.is_point_disabled(p_id); } void AStar2D::connect_points(int p_id, int p_with_id, bool p_bidirectional) { astar.connect_points(p_id, p_with_id, p_bidirectional); } void AStar2D::disconnect_points(int p_id, int p_with_id) { astar.disconnect_points(p_id, p_with_id); } bool AStar2D::are_points_connected(int p_id, int p_with_id) const { return astar.are_points_connected(p_id, p_with_id); } int AStar2D::get_point_count() const { return astar.get_point_count(); } int AStar2D::get_point_capacity() const { return astar.get_point_capacity(); } void AStar2D::clear() { astar.clear(); } void AStar2D::reserve_space(int p_num_nodes) { astar.reserve_space(p_num_nodes); } int AStar2D::get_closest_point(const Vector2 &p_point, bool p_include_disabled) const { return astar.get_closest_point(Vector3(p_point.x, p_point.y, 0), p_include_disabled); } Vector2 AStar2D::get_closest_position_in_segment(const Vector2 &p_point) const { Vector3 p = astar.get_closest_position_in_segment(Vector3(p_point.x, p_point.y, 0)); return Vector2(p.x, p.y); } Vector AStar2D::get_point_path(int p_from_id, int p_to_id) { PackedVector3Array pv = astar.get_point_path(p_from_id, p_to_id); int size = pv.size(); PackedVector2Array path; path.resize(size); { const Vector3 *r = pv.ptr(); Vector2 *w = path.ptrw(); for (int i = 0; i < size; i++) { Vector3 p = r[i]; w[i] = Vector2(p.x, p.y); } } return path; } Vector AStar2D::get_id_path(int p_from_id, int p_to_id) { return astar.get_id_path(p_from_id, p_to_id); } void AStar2D::_bind_methods() { ClassDB::bind_method(D_METHOD("get_available_point_id"), &AStar2D::get_available_point_id); ClassDB::bind_method(D_METHOD("add_point", "id", "position", "weight_scale"), &AStar2D::add_point, DEFVAL(1.0)); ClassDB::bind_method(D_METHOD("get_point_position", "id"), &AStar2D::get_point_position); ClassDB::bind_method(D_METHOD("set_point_position", "id", "position"), &AStar2D::set_point_position); ClassDB::bind_method(D_METHOD("get_point_weight_scale", "id"), &AStar2D::get_point_weight_scale); ClassDB::bind_method(D_METHOD("set_point_weight_scale", "id", "weight_scale"), &AStar2D::set_point_weight_scale); ClassDB::bind_method(D_METHOD("remove_point", "id"), &AStar2D::remove_point); ClassDB::bind_method(D_METHOD("has_point", "id"), &AStar2D::has_point); ClassDB::bind_method(D_METHOD("get_point_connections", "id"), &AStar2D::get_point_connections); ClassDB::bind_method(D_METHOD("get_points"), &AStar2D::get_points); ClassDB::bind_method(D_METHOD("set_point_disabled", "id", "disabled"), &AStar2D::set_point_disabled, DEFVAL(true)); ClassDB::bind_method(D_METHOD("is_point_disabled", "id"), &AStar2D::is_point_disabled); ClassDB::bind_method(D_METHOD("connect_points", "id", "to_id", "bidirectional"), &AStar2D::connect_points, DEFVAL(true)); ClassDB::bind_method(D_METHOD("disconnect_points", "id", "to_id"), &AStar2D::disconnect_points); ClassDB::bind_method(D_METHOD("are_points_connected", "id", "to_id"), &AStar2D::are_points_connected); ClassDB::bind_method(D_METHOD("get_point_count"), &AStar2D::get_point_count); ClassDB::bind_method(D_METHOD("get_point_capacity"), &AStar2D::get_point_capacity); ClassDB::bind_method(D_METHOD("reserve_space", "num_nodes"), &AStar2D::reserve_space); ClassDB::bind_method(D_METHOD("clear"), &AStar2D::clear); ClassDB::bind_method(D_METHOD("get_closest_point", "to_position", "include_disabled"), &AStar2D::get_closest_point, DEFVAL(false)); ClassDB::bind_method(D_METHOD("get_closest_position_in_segment", "to_position"), &AStar2D::get_closest_position_in_segment); ClassDB::bind_method(D_METHOD("get_point_path", "from_id", "to_id"), &AStar2D::get_point_path); ClassDB::bind_method(D_METHOD("get_id_path", "from_id", "to_id"), &AStar2D::get_id_path); } AStar2D::AStar2D() { } AStar2D::~AStar2D() { }