Merge pull request #462 from OpenVicProject/add/pointmap-signals

Add invalidation signals to pathfinding classes

Author: Spartan322

src/openvic-simulation/pathfinding/AStarPathing.hpp

@@ -25,8 +25,6 @@ namespace OpenVic {
 	};
 
 	/** A* Pathfinding implementation
-
-		Requires that any pointer invalidation in PointMap must call reset_search()
 	 */
 	struct AStarPathing : public PathingBase<AStarPathingNode> {
 		using PathingBase::PathingBase;

src/openvic-simulation/pathfinding/FringePathing.hpp

@@ -20,8 +20,6 @@ namespace OpenVic {
 	};
 
 	/** Fringe Pathfinding implementation
-
-		Requires that any pointer invalidation in PointMap must call reset_search()
 	 */
 	struct FringePathing : public PathingBase<FringePathingNode> {
 		using PathingBase::PathingBase;

src/openvic-simulation/pathfinding/PathingBase.hpp

@@ -5,6 +5,7 @@
 #include <fmt/core.h>
 
 #include "openvic-simulation/pathfinding/PointMap.hpp"
+#include "openvic-simulation/types/Signal.hpp"
 #include "openvic-simulation/types/fixed_point/FixedPoint.hpp"
 #include "openvic-simulation/utility/ErrorMacros.hpp"
 
@@ -34,7 +35,7 @@ namespace OpenVic {
 	};
 
 	template<typename ValueT, typename KeyT = PointMap::points_key_type>
-	struct PathingBase {
+	struct PathingBase : observer {
 		using search_node_type = PathingNodeBase<ValueT, KeyT>;
 		using search_key_type = search_node_type::search_key_type;
 		using search_value_type = search_node_type::search_value_type;
@@ -69,13 +70,31 @@ namespace OpenVic {
 			search_iterator begin_point, search_iterator end_point, uint64_t pass, bool allow_partial_path
 		) = 0;
 
+		void _on_point_invalidated(search_key_type id) {
+			search_const_iterator it = search.find(id);
+			if (it != search.end()) {
+				search.unordered_erase(it);
+			}
+		}
+
+		void _on_point_map_destroyed() {
+			point_map = nullptr;
+		}
+
 	public:
 		PathingBase(PointMap const* map) : point_map(map) {
 			reserve_space(point_map->get_point_count());
+			point_map->point_invalidated.connect(&PathingBase::_on_point_invalidated, this);
+			point_map->points_pointers_invalidated.connect(&PathingBase::reset_search, this);
+			point_map->destroyed.connect(&PathingBase::_on_point_map_destroyed, this);
 		}
 
 		PathingBase(PointMap const& map) : PathingBase(&map) {}
 
+		virtual ~PathingBase() {
+			this->disconnect_all();
+		}
+
 		PointMap const& get_point_map() const {
 			return *point_map;
 		}
@@ -145,6 +164,8 @@ namespace OpenVic {
 		std::vector<ivec2_t> get_point_path( //
 			PointMap::points_key_type from_id, PointMap::points_key_type to_id, bool allow_partial_path = false
 		) {
+			OV_ERR_FAIL_COND_V(point_map == nullptr, std::vector<ivec2_t>());
+
 			search_iterator from_it = get_iterator_by_id(from_id);
 			OV_ERR_FAIL_COND_V(from_it == search.end(), std::vector<ivec2_t>());
 
@@ -177,6 +198,8 @@ namespace OpenVic {
 		std::vector<PointMap::points_key_type> get_id_path( //
 			PointMap::points_key_type from_id, PointMap::points_key_type to_id, bool allow_partial_path = false
 		) {
+			OV_ERR_FAIL_COND_V(point_map == nullptr, std::vector<PointMap::points_key_type>());
+
 			search_iterator from_it = get_iterator_by_id(from_id);
 			OV_ERR_FAIL_COND_V(from_it == search.end(), std::vector<PointMap::points_key_type>());
 

src/openvic-simulation/pathfinding/PointMap.cpp

@@ -18,6 +18,10 @@
 
 using namespace OpenVic;
 
+PointMap::~PointMap() {
+	destroyed();
+}
+
 int64_t PointMap::get_available_points() const {
 	if (points.contains(last_free_id)) {
 		int64_t cur_new_id = last_free_id + 1;
@@ -44,7 +48,11 @@ bool PointMap::try_add_point(
 		return false;
 	}
 
+	size_t prev_capacity = get_point_capacity();
 	points[id] = Point { .position = position, .weight_scale = weight_scale, .enabled = true };
+	if (OV_unlikely(prev_capacity != get_point_capacity())) {
+		points_pointers_invalidated();
+	}
 
 	for (points_key_type const& adj_id : adjacent_points) {
 		connect_points(id, adj_id);
@@ -66,7 +74,11 @@ void PointMap::add_point(
 	points_iterator found_pt = points.find(id);
 
 	if (found_pt == points.end()) {
+		size_t prev_capacity = get_point_capacity();
 		points[id] = Point { .position = position, .weight_scale = weight_scale, .enabled = true };
+		if (OV_unlikely(get_point_capacity() != prev_capacity)) {
+			points_pointers_invalidated();
+		}
 	} else {
 		found_pt.value().position = position;
 		found_pt.value().weight_scale = weight_scale;
@@ -156,6 +168,7 @@ void PointMap::remove_point(points_key_type id) {
 
 	points.unordered_erase(it);
 	last_free_id = id;
+	point_invalidated(id);
 }
 
 bool PointMap::has_point(points_key_type id) const {
@@ -295,20 +308,23 @@ size_t PointMap::get_point_capacity() const {
 void PointMap::reserve_space(size_t num_nodes) {
 	OV_ERR_FAIL_COND_MSG(num_nodes <= 0, fmt::format("New capacity must be greater than 0, new was: {}.", num_nodes));
 	OV_ERR_FAIL_COND_MSG(
-		num_nodes < points.capacity(),
+		num_nodes <= points.capacity(),
 		fmt::format("New capacity must be greater than current capacity: {}, new was: {}.", points.capacity(), num_nodes)
 	);
 	points.reserve(num_nodes);
+	points_pointers_invalidated();
 }
 
 void PointMap::shrink_to_fit() {
 	points.shrink_to_fit();
+	points_pointers_invalidated();
 }
 
 void PointMap::clear() {
 	last_free_id = 0;
 	segments.clear();
 	points.clear();
+	points_pointers_invalidated();
 }
 
 PointMap::points_key_type PointMap::get_closest_point(ivec2_t const& point, bool include_disabled) const {

src/openvic-simulation/pathfinding/PointMap.hpp

@@ -9,6 +9,7 @@
 #include <tsl/ordered_set.h>
 
 #include "openvic-simulation/types/EnumBitfield.hpp"
+#include "openvic-simulation/types/Signal.hpp"
 #include "openvic-simulation/types/Vector.hpp"
 #include "openvic-simulation/types/fixed_point/FixedPoint.hpp"
 #include "openvic-simulation/utility/Utility.hpp"
@@ -132,6 +133,12 @@ namespace OpenVic {
 		mutable points_key_type last_free_id = 0;
 
 	public:
+		mutable signal_property<PointMap, points_key_type> point_invalidated;
+		mutable signal_property<PointMap> points_pointers_invalidated;
+		mutable signal_property<PointMap> destroyed;
+
+		~PointMap();
+
 		int64_t get_available_points() const;
 
 		bool try_add_point(