renderer: Add RenderEntity base class for common methods.

Author: heinezen

libopenage/renderer/stages/CMakeLists.txt

@@ -1,3 +1,7 @@
+add_sources(libopenage
+	render_entity.cpp
+)
+
 add_subdirectory(camera/)
 add_subdirectory(hud/)
 add_subdirectory(screen/)

libopenage/renderer/stages/hud/render_entity.cpp

@@ -1,4 +1,4 @@
-// Copyright 2023-2023 the openage authors. See copying.md for legal info.
+// Copyright 2023-2024 the openage authors. See copying.md for legal info.
 
 #include "render_entity.h"
 
@@ -8,8 +8,7 @@
 namespace openage::renderer::hud {
 
 HudDragRenderEntity::HudDragRenderEntity(const coord::input drag_start) :
-	changed{false},
-	last_update{0.0},
+	RenderEntity{},
 	drag_pos{nullptr, 0, "", nullptr, drag_start},
 	drag_start{drag_start} {
 }
@@ -24,12 +23,6 @@ void HudDragRenderEntity::update(const coord::input drag_pos,
 	this->changed = true;
 }
 
-time::time_t HudDragRenderEntity::get_update_time() {
-	std::shared_lock lock{this->mutex};
-
-	return this->last_update;
-}
-
 const curve::Continuous<coord::input> &HudDragRenderEntity::get_drag_pos() {
 	return this->drag_pos;
 }
@@ -38,16 +31,4 @@ const coord::input &HudDragRenderEntity::get_drag_start() {
 	return this->drag_start;
 }
 
-bool HudDragRenderEntity::is_changed() {
-	std::shared_lock lock{this->mutex};
-
-	return this->changed;
-}
-
-void HudDragRenderEntity::clear_changed_flag() {
-	std::unique_lock lock{this->mutex};
-
-	this->changed = false;
-}
-
 } // namespace openage::renderer::hud

libopenage/renderer/stages/hud/render_entity.h

@@ -3,20 +3,18 @@
 #pragma once
 
 #include <cstdint>
-#include <shared_mutex>
-#include <string>
 
 #include "coord/pixel.h"
 #include "curve/continuous.h"
-#include "time/time.h"
+#include "renderer/stages/render_entity.h"
 
 
 namespace openage::renderer::hud {
 
 /**
  * Render entity for pushing drag selection updates to the HUD renderer.
  */
-class HudDragRenderEntity {
+class HudDragRenderEntity final : public renderer::RenderEntity {
 public:
 	/**
 	 * Create a new render entity for drag selection in the HUD.
@@ -36,13 +34,6 @@ class HudDragRenderEntity {
 	void update(const coord::input drag_pos,
 	            const time::time_t time = 0.0);
 
-	/**
-	 * Get the time of the last update.
-	 *
-	 * @return Time of last update.
-	 */
-	time::time_t get_update_time();
-
 	/**
 	 * Get the position of the dragged corner.
 	 *
@@ -57,31 +48,7 @@ class HudDragRenderEntity {
 	 */
 	const coord::input &get_drag_start();
 
-	/**
-	 * Check whether the render entity has received new updates.
-	 *
-	 * @return true if updates have been received, else false.
-	 */
-	bool is_changed();
-
-	/**
-	 * Clear the update flag by setting it to false.
-	 */
-	void clear_changed_flag();
-
 private:
-	/**
-	 * Flag for determining if the render entity has been updated by the
-	 * corresponding gamestate entity. Set to true every time \p update()
-	 * is called.
-	 */
-	bool changed;
-
-	/**
-	 * Time of the last update call.
-	 */
-	time::time_t last_update;
-
 	/**
 	 * Position of the dragged corner.
 	 */
@@ -91,10 +58,5 @@ class HudDragRenderEntity {
 	 * Position of the start corner.
 	 */
 	coord::input drag_start;
-
-	/**
-	 * Mutex for protecting threaded access.
-	 */
-	std::shared_mutex mutex;
 };
 } // namespace openage::renderer::hud

libopenage/renderer/stages/render_entity.cpp

@@ -0,0 +1,37 @@
+// Copyright 2024-2024 the openage authors. See copying.md for legal info.
+
+#include "render_entity.h"
+
+#include <mutex>
+
+
+namespace openage::renderer {
+
+RenderEntity::RenderEntity() :
+	changed{false},
+	last_update{time::time_t::zero()} {
+}
+
+time::time_t RenderEntity::get_update_time() {
+	std::shared_lock lock{this->mutex};
+
+	return this->last_update;
+}
+
+bool RenderEntity::is_changed() {
+	std::shared_lock lock{this->mutex};
+
+	return this->changed;
+}
+
+void RenderEntity::clear_changed_flag() {
+	std::unique_lock lock{this->mutex};
+
+	this->changed = false;
+}
+
+std::shared_lock<std::shared_mutex> RenderEntity::get_read_lock() {
+	return std::shared_lock{this->mutex};
+}
+
+} // namespace openage::renderer

libopenage/renderer/stages/render_entity.h

@@ -0,0 +1,83 @@
+// Copyright 2024-2024 the openage authors. See copying.md for legal info.
+
+#pragma once
+
+#include <mutex>
+#include <shared_mutex>
+
+#include <eigen3/Eigen/Dense>
+
+#include "time/time.h"
+
+
+namespace openage::renderer {
+
+/**
+ * Interface for render entities that allow pushing updates from game simulation
+ * to renderer.
+ */
+class RenderEntity {
+public:
+	~RenderEntity() = default;
+
+	/**
+	 * Get the time of the last update.
+	 *
+	 * Accessing the update time is thread-safe.
+	 *
+	 * @return Time of last update.
+	 */
+	time::time_t get_update_time();
+
+	/**
+	 * Check whether the render entity has received new updates from the
+	 * gamestate.
+	 *
+	 * @return true if updates have been received, else false.
+	 */
+	bool is_changed();
+
+	/**
+	 * Clear the update flag by setting it to false.
+	 */
+	void clear_changed_flag();
+
+	/**
+	 * Get a shared lock for thread-safe reading from the render entity.
+	 *
+	 * The caller is responsible for unlocking the mutex after reading.
+	 *
+	 * @return Lock for the render entity.
+	 */
+	std::shared_lock<std::shared_mutex> get_read_lock();
+
+protected:
+	/**
+	 * Create a new render entity.
+	 *
+	 * Members are initialized to these values by default:
+	 * - \p changed: false
+	 * - \p last_update: time::time_t::zero()
+	 *
+	 * Declared as protected to prevent direct instantiation of this class.
+	 */
+	RenderEntity();
+
+	/**
+	 * Flag for determining if the render entity has been updated by the
+	 * corresponding gamestate entity. Set to true every time \p update()
+	 * is called.
+	 */
+	bool changed;
+
+	/**
+	 * Time of the last update call.
+	 */
+	time::time_t last_update;
+
+	/**
+	 * Mutex for protecting threaded access.
+	 */
+	std::shared_mutex mutex;
+};
+} // namespace openage::renderer

libopenage/renderer/stages/terrain/render_entity.cpp

@@ -10,10 +10,9 @@
 namespace openage::renderer::terrain {
 
 TerrainRenderEntity::TerrainRenderEntity() :
-	changed{false},
+	RenderEntity{},
 	size{0, 0},
 	tiles{},
-	last_update{0.0},
 	terrain_paths{},
 	vertices{}
 // terrain_path{nullptr, 0},
@@ -132,16 +131,4 @@ const util::Vector2s &TerrainRenderEntity::get_size() {
 	return this->size;
 }
 
-bool TerrainRenderEntity::is_changed() {
-	std::shared_lock lock{this->mutex};
-
-	return this->changed;
-}
-
-void TerrainRenderEntity::clear_changed_flag() {
-	std::unique_lock lock{this->mutex};
-
-	this->changed = false;
-}
-
 } // namespace openage::renderer::terrain

libopenage/renderer/stages/terrain/render_entity.h

@@ -2,16 +2,14 @@
 
 #pragma once
 
-#include <memory>
-#include <shared_mutex>
 #include <string>
 #include <unordered_set>
 #include <vector>
 
 #include "coord/scene.h"
 #include "coord/tile.h"
 #include "curve/discrete.h"
-#include "time/time.h"
+#include "renderer/stages/render_entity.h"
 #include "util/vector.h"
 
 
@@ -20,7 +18,7 @@ namespace openage::renderer::terrain {
 /**
  * Render entity for pushing updates to the Terrain renderer.
  */
-class TerrainRenderEntity {
+class TerrainRenderEntity final : public renderer::RenderEntity {
 public:
 	TerrainRenderEntity();
 	~TerrainRenderEntity() = default;
@@ -84,27 +82,7 @@ class TerrainRenderEntity {
 	 */
 	const util::Vector2s &get_size();
 
-	/**
-	 * Check whether the render entity has received new updates from the
-	 * gamestate.
-	 *
-	 * @return true if updates have been received, else false.
-	 */
-	bool is_changed();
-
-	/**
-	 * Clear the update flag by setting it to false.
-	 */
-	void clear_changed_flag();
-
 private:
-	/**
-	 * Flag for determining if the render entity has been updated by the
-	 * corresponding gamestate entity. Set to true every time \p update()
-	 * is called.
-	 */
-	bool changed;
-
 	/**
 	 * Chunk dimensions (width x height).
 	 */
@@ -115,11 +93,6 @@ class TerrainRenderEntity {
 	 */
 	tiles_t tiles;
 
-	/**
-	 * Time of the last update call.
-	 */
-	time::time_t last_update;
-
 	/**
 	 * Terrain texture paths used in \p tiles .
 	 */
@@ -129,10 +102,5 @@ class TerrainRenderEntity {
 	 * Terrain vertices (ingame coordinates).
 	 */
 	std::vector<coord::scene3> vertices;
-
-	/**
-	 * Mutex for protecting threaded access.
-	 */
-	std::shared_mutex mutex;
 };
 } // namespace openage::renderer::terrain