fix: cleaner function signature serializeStl -> serialize

Innoptech · Mar 17, 2024 · 7fd394c · 7fd394c
1 parent 3efc935
commit 7fd394c
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -89,7 +89,7 @@ if (!file.is_open()) {
 }
 
 std::vector<openstl::Triangle> originalTriangles{}; // User triangles
-openstl::serializeStl(originalTriangles, file, openstl::StlFormat::Binary); // Or StlFormat::ASCII
+openstl::serialize(originalTriangles, file, openstl::StlFormat::Binary); // Or StlFormat::ASCII
 
 if (file.fail()) {
     std::cerr << "Error: Failed to write to file " << filename << std::endl;
@@ -104,7 +104,7 @@ file.close();
 std::stringstream ss;
 
 std::vector<openstl::Triangle> originalTriangles{}; // User triangles
-openstl::serializeStl(originalTriangles, ss, openstl::StlFormat::Binary); // Or StlFormat::ASCII
+openstl::serialize(originalTriangles, ss, openstl::StlFormat::Binary); // Or StlFormat::ASCII
 ```
 
 # Integrate to your codebase

diff --git a/modules/core/include/openstl/core/stl.h b/modules/core/include/openstl/core/stl.h
@@ -112,7 +112,7 @@ namespace openstl
      * @param format The format of the STL file (ASCII or binary).
      */
     template <typename Stream, typename Container>
-    inline void serializeStl(const Container& triangles, Stream& stream, StlFormat format) {
+    inline void serialize(const Container& triangles, Stream& stream, StlFormat format) {
         switch (format) {
             case StlFormat::ASCII:
                 serializeAsciiStl(triangles, stream);

diff --git a/python/core/src/stl.cpp b/python/core/src/stl.cpp
@@ -129,7 +129,7 @@ void serialize(py::module_ &m) {
             return false;
 
         StridedTriangleSpan stridedIter{buf.data(), (size_t)buf.shape(0)};
-        openstl::serializeStl(stridedIter, file, format); // Or StlFormat::ASCII
+        openstl::serialize(stridedIter, file, format);
 
         if (file.fail()) {
             std::cerr << "Error: Failed to write to file " << filename << std::endl;

diff --git a/tests/core/src/serialize.test.cpp b/tests/core/src/serialize.test.cpp
@@ -41,7 +41,7 @@ TEST_CASE("Serialize STL triangles", "[openstl]") {
         REQUIRE(stream.is_open());
 
         // Serialize the triangles in binary format
-        serializeStl(originalTriangles, stream, StlFormat::Binary);
+        serialize(originalTriangles, stream, StlFormat::Binary);
         REQUIRE_FALSE(stream.fail());
         stream.close();
 
@@ -58,7 +58,7 @@ TEST_CASE("Serialize STL triangles", "[openstl]") {
         std::stringstream ss;
 
         // Serialize the triangles in binary format
-        serializeStl(originalTriangles, ss, StlFormat::Binary);
+        serialize(originalTriangles, ss, StlFormat::Binary);
 
         // Deserialize the serialized triangles
         ss.seekg(0);
@@ -78,7 +78,7 @@ TEST_CASE("Serialize STL triangles", "[openstl]") {
         REQUIRE(stream.is_open());
 
         // Serialize the triangles in ASCII format
-        serializeStl(originalTriangles, stream, StlFormat::ASCII);
+        serialize(originalTriangles, stream, StlFormat::ASCII);
         REQUIRE_FALSE(stream.fail());
         stream.close();