Add is_valid functions to entity, mesh and texture in public API (#262)

* Add is_valid functions to entity, mesh and texture in public API

* Update src/api/apiCore.cpp with suggested change

Co-authored-by: Piotr Rybicki <[email protected]>

* Add is_alive naming convention and check input argument

* Add an is_alive function for node

---------

Co-authored-by: Josef <[email protected]>
Co-authored-by: Piotr Rybicki <[email protected]>

Author: AlgoryxJosef

include/rgl/api/core.h

@@ -474,6 +474,14 @@ RGL_API rgl_status_t rgl_mesh_destroy(rgl_mesh_t mesh);
  */
 RGL_API rgl_status_t rgl_mesh_update_vertices(rgl_mesh_t mesh, const rgl_vec3f* vertices, int32_t vertex_count);
 
+/**
+ * Assigns value true to out_alive if the given mesh is known and has not been destroyed,
+ * assigns value false otherwise.
+ * @param mesh Mesh to check if alive
+ * @param out_alive Boolean set to indicate if alive
+ */
+RGL_API rgl_status_t rgl_mesh_is_alive(rgl_mesh_t mesh, bool* out_alive);
+
 /******************************** ENTITY ********************************/
 
 /**
@@ -510,10 +518,18 @@ RGL_API rgl_status_t rgl_entity_set_id(rgl_entity_t entity, int32_t id);
 /**
  * Assign intensity texture to the given Entity. The assumption is that the Entity can hold only one intensity texture.
  * @param entity Entity to modify.
- * @apram texture Texture to assign.
+ * @param texture Texture to assign.
  */
 RGL_API rgl_status_t rgl_entity_set_intensity_texture(rgl_entity_t entity, rgl_texture_t texture);
 
+/**
+ * Assigns value true to out_alive if the given entity is known and has not been destroyed,
+ * assigns value false otherwise.
+ * @param entity Entity to check if alive
+ * @param out_alive Boolean set to indicate if alive
+ */
+RGL_API rgl_status_t rgl_entity_is_alive(rgl_entity_t entity, bool* out_alive);
+
 /******************************* TEXTURE *******************************/
 
 /**
@@ -529,10 +545,18 @@ RGL_API rgl_status_t rgl_texture_create(rgl_texture_t* out_texture, const void*
 /**
  * Informs that the given texture will be no longer used.
  * The texture will be destroyed after all referring Entities are destroyed.
- * @param mesh Texture to be marked as no longer needed
+ * @param texture Texture to be marked as no longer needed
  */
 RGL_API rgl_status_t rgl_texture_destroy(rgl_texture_t texture);
 
+/**
+ * Assigns value true to out_alive if the given texture is known and has not been destroyed,
+ * assigns value false otherwise.
+ * @param texture Texture to check if alive
+ * @param out_alive Boolean set to indicate if alive
+ */
+RGL_API rgl_status_t rgl_texture_is_alive(rgl_texture_t texture, bool* out_alive);
+
 /******************************** SCENE ********************************/
 
 /**
@@ -851,6 +875,14 @@ RGL_API rgl_status_t rgl_node_gaussian_noise_angular_hitpoint(rgl_node_t* node,
 RGL_API rgl_status_t rgl_node_gaussian_noise_distance(rgl_node_t* node, float mean, float st_dev_base,
                                                       float st_dev_rise_per_meter);
 
+/**
+ * Assigns value true to out_alive if the given node is known and has not been destroyed,
+ * assigns value false otherwise.
+ * @param node Node to check if alive
+ * @param out_alive Boolean set to indicate if alive
+ */
+RGL_API rgl_status_t rgl_node_is_alive(rgl_node_t node, bool* out_alive);
+
 /******************************** GRAPH ********************************/
 
 /**

src/api/apiCore.cpp

@@ -256,6 +256,16 @@ void TapeCore::tape_mesh_update_vertices(const YAML::Node& yamlNode, PlaybackSta
 	                         yamlNode[2].as<int32_t>());
 }
 
+rgl_status_t rgl_mesh_is_alive(rgl_mesh_t mesh, bool* out_alive)
+{
+	auto status = rglSafeCall([&]() {
+		CHECK_ARG(out_alive != nullptr);
+		*out_alive = Mesh::instances.contains(mesh);
+	});
+	TAPE_HOOK(mesh, out_alive);
+	return status;
+}
+
 RGL_API rgl_status_t rgl_entity_create(rgl_entity_t* out_entity, rgl_scene_t scene, rgl_mesh_t mesh)
 {
 	auto status = rglSafeCall([&]() {
@@ -355,6 +365,16 @@ void TapeCore::tape_entity_set_intensity_texture(const YAML::Node& yamlNode, Pla
 	                                 state.textures.at(yamlNode[1].as<TapeAPIObjectID>()));
 }
 
+rgl_status_t rgl_entity_is_alive(rgl_entity_t entity, bool* out_alive)
+{
+	auto status = rglSafeCall([&]() {
+		CHECK_ARG(out_alive != nullptr);
+		*out_alive = Entity::instances.contains(entity);
+	});
+	TAPE_HOOK(entity, out_alive);
+	return status;
+}
+
 RGL_API rgl_status_t rgl_texture_create(rgl_texture_t* out_texture, const void* texels, int32_t width, int32_t height)
 {
 	auto status = rglSafeCall([&]() {
@@ -398,6 +418,16 @@ void TapeCore::tape_texture_destroy(const YAML::Node& yamlNode, PlaybackState& s
 	state.textures.erase(textureId);
 }
 
+rgl_status_t rgl_texture_is_alive(rgl_texture_t texture, bool* out_alive)
+{
+	auto status = rglSafeCall([&]() {
+		CHECK_ARG(out_alive != nullptr);
+		*out_alive = Texture::instances.contains(texture);
+	});
+	TAPE_HOOK(texture, out_alive);
+	return status;
+}
+
 RGL_API rgl_status_t rgl_scene_set_time(rgl_scene_t scene, uint64_t nanoseconds)
 {
 	auto status = rglSafeCall([&]() {
@@ -1200,6 +1230,16 @@ void TapeCore::tape_node_gaussian_noise_distance(const YAML::Node& yamlNode, Pla
 	state.nodes.insert({nodeId, node});
 }
 
+rgl_status_t rgl_node_is_alive(rgl_node_t node, bool* out_alive)
+{
+	auto status = rglSafeCall([&]() {
+		CHECK_ARG(out_alive != nullptr);
+		*out_alive = Node::instances.contains(node);
+	});
+	TAPE_HOOK(node, out_alive);
+	return status;
+}
+
 RGL_API rgl_status_t rgl_tape_record_begin(const char* path)
 {
 /**