CAP: basic working diffCheck to start prototyping

Author: 9and3

CMakeLists.txt

@@ -22,9 +22,8 @@ endif()
 set(SHARED_LIB_NAME diffCheck)
 
 file(GLOB_RECURSE SOURCES_LIB 
-    src/diffCheck.cc src/diffCheck.hh        # diffCheck interface
+    src/diffCheck.hh                         # diffCheck interface
     src/diffCheck/*.cc src/diffCheck/*.hh    # diffCheck src
-    src/diffcheckpch.cc src/diffcheckpch.hh  # precompiled headers
     )
 
 add_library(${SHARED_LIB_NAME} SHARED ${SOURCES_LIB})

CONTRIBUTING.md

@@ -146,7 +146,7 @@ gdb "path-to-executable"
 > use `break` to set a breakpoint and `continue` to continue the execution of the program.
 > use `bt` to see the backtrace of the program when a segfault occurs.
 
-### Doxygen
+<!-- ### Doxygen
 For documentation we use the [*JavaDoc" convention](https://doxygen.nl/manual/docblocks.html).
 Follow [this guide for documenting the code](https://developer.lsst.io/cpp/api-docs.html).
 ```c++
@@ -155,9 +155,9 @@ Follow [this guide for documenting the code](https://developer.lsst.io/cpp/api-d
  * @param filename path to the map.yaml file
  * @param planes vector of TSPlane objects
  */
-```
+``` -->
 
-### Logging (TO BE UPDATED)
+<!-- ### Logging (TO BE UPDATED)
 To log use the following MACROS. All the code is contained in `Log.hpp` and `Log.cpp`. 
 ```c++
 AIAC_INFO("test_core_info");
@@ -173,8 +173,42 @@ The output is like so:
 The logging can be silenced by setting OFF the option in the main `CMakeLists.txt` and do clean reconfiguration.
 ```cmake
 option(SILENT_LOGGING "Do not log messages in the terminal of on." ON)
+``` -->
+
+### I/O and basic datatypes
+Here's how you can import point cloud from file:
+```c++
+#include "diffCheck/geometry/DFPointCloud.hh"
+#include "diffCheck/geometry/DFMesh.hh"
+
+// clouds
+std::shared_ptr<diffCheck::geometry::DFPointCloud> dfPointCloudPtr = std::make_shared<diffCheck::geometry::DFPointCloud>();
+std::string pathMesh = R"(C:\Users\yourfilecloudpath.ply)";
+dfPointCloudPtr->LoadFromPLY(pathCloud);
+
+// mesh
+std::shared_ptr<diffCheck::geometry::DFMesh> dfMeshPtr = std::make_shared<diffCheck::geometry::DFMesh>();
+std::string pathCloud = R"(C:\Users\yourfilemeshpath.ply)";
+dfMeshPtr->LoadFromPLY(pathMesh);
 ```
 
+### Visualizer
+Clouds and mesh can be visualized like this:
+```c++
+#include "diffCheck/visualizer/DFVisualizer.hh"
+
+// clouds
+std::shared_ptr<diffCheck::visualizer::DFVisualizer> dfVisualizerPtr = std::make_shared<diffCheck::visualizer::DFVisualizer>();
+dfVisualizerPtr->LoadPointCloud(dfPointCloudPtr);
+dfVisualizerPtr->Run();
+
+// mesh
+std::shared_ptr<diffCheck::visualizer::DFVisualizer> dfVisualizerPtr = std::make_shared<diffCheck::visualizer::DFVisualizer>();
+dfVisualizerPtr->LoadMesh(dfMeshPtr);
+dfVisualizerPtr->Run();
+```
+
+
 ### CTesting (TO BE UPDATED)
 When necessary, c++ testing is done by using CTest. Important/critical features (e.g., correcting functioning of graphics with OpenGL and Glfw) needs testing to be written (this is usefull for e.g., GitHub Actions). Such tests can be extracted from the main source code and integrated in a seperate section: cmake testing.
 

README.md

@@ -55,5 +55,18 @@ To build and test the project, follow the following steps:
 ```terminal
 cmake -S . -B build
 cmake --build build
-./build/bin/diffCheck.exe
-```
+./build/bin/diffCheckApp.exe <-- for prototyping
+```
+
+## Prototype diffCheck in C++
+To prototype:
+1) add a header/source file in `src/diffCheck` and include the header in `diffCheck.hh` interface
+1) test it in `diffCheckApp` (the cmake will output an executable in bin)
+
+See the [CONTRIBUTING.md](https://github.com/diffCheckOrg/diffCheck/blob/main/CONTRIBUTING.md) for more information on how to prototype with diffCheck (code guidelines, visualizer, utilities, etc).
+
+
+## TODO:
+- [ ] @Andrea: add writing functions for mesh and point cloud
+- [ ] @Andrea: refactor `IOManager.hh` with a class `IOManager` and static methods
+- [ ] @Andrea: test Rhino exporeted `.ply` files

assets/img/gif_meshvisual.gif

@@ -6,22 +6,7 @@
 #include <open3d/Open3D.h>
 
 // diffCheck includes
-#include "diffCheck/libHeaderTemplate.hh"  // This is a dummy include to test the include path
 #include "diffCheck/geometry/DFPointCloud.hh"
+#include "diffCheck/geometry/DFMesh.hh"
 #include "diffCheck/IOManager.hh"
-#include "diffCheck/visualizer.hh"
-
-
-namespace diffCheck {
-    /// @brief Function 1 of the library
-    int func1();
-
-    /// @brief Function 2 of the library
-    int func2();
-
-    /// @brief Function 3 of the library
-    int func3();
-
-    /// @brief Testing open3d import
-    void testOpen3d();
-}  // namespace diffCheck
+#include "diffCheck/visualizer.hh"

deps/fmt

@@ -6,14 +6,6 @@
 
 namespace diffCheck::io
 {
-    // TODO: return a dggeometry::Mesh object
-    void ReadPLYMeshFromFile(const std::string &filename)
-    {
-        Eigen::MatrixXd V;
-        Eigen::MatrixXi F;
-        igl::readPLY(filename, V, F);
-    }
-
     std::shared_ptr<diffCheck::geometry::DFPointCloud> ReadPLYPointCloud(const std::string &filename)
     {
         std::shared_ptr<diffCheck::geometry::DFPointCloud> pointCloud = std::make_shared<diffCheck::geometry::DFPointCloud>();
@@ -41,4 +33,39 @@ namespace diffCheck::io
         }
         return pointCloud;
     }
+
+    std::shared_ptr<diffCheck::geometry::DFMesh> ReadPLYMeshFromFile(const std::string &filename)
+    {
+        std::shared_ptr<diffCheck::geometry::DFMesh> mesh = std::make_shared<diffCheck::geometry::DFMesh>();
+        Eigen::MatrixXd V;
+        Eigen::MatrixXd C;
+        Eigen::MatrixXd N;
+        Eigen::MatrixXi F;
+
+        // read the ply file
+        igl::readPLY(filename, V, F, C, N);
+
+        mesh->Vertices.resize(V.rows());
+        for (int i = 0; i < V.rows(); i++)
+        {
+            mesh->Vertices[i] = V.row(i);
+        }
+        mesh->Faces.resize(F.rows());
+        for (int i = 0; i < F.rows(); i++)
+        {
+            mesh->Faces[i] = F.row(i);
+        }
+        mesh->ColorsVertex.resize(C.rows());
+        for (int i = 0; i < C.rows(); i++)
+        {
+            mesh->ColorsFace[i] = C.row(i);
+        }
+        mesh->NormalsVertex.resize(N.rows());
+        for (int i = 0; i < N.rows(); i++)
+        {
+            mesh->NormalsFace[i] = N.row(i);
+        }
+
+        return mesh;
+    }
 } // namespace diffCheck::io

src/diffCheck.cc

@@ -6,21 +6,24 @@
 #include <igl/readPLY.h>
 
 #include "diffCheck/geometry/DFPointCloud.hh"
+#include "diffCheck/geometry/DFMesh.hh"
 
 namespace diffCheck::io
 {
+    // TODO: here we should  add a class IOManager and the functions should be static
     /**
      * @brief Read a point cloud from a file
      * 
      * @param filename the path to the file with the extension
+     * @return std::shared_ptr<diffCheck::geometry::DFPointCloud> the point cloud
      */
     std::shared_ptr<diffCheck::geometry::DFPointCloud> ReadPLYPointCloud(const std::string &filename);
 
-    // TODO: return a dggeometry::Mesh object
     /**
-     * @brief Read mesh of format file
+     * @brief Read mesh from ply format
      * 
      * @param filename the path to the file with the extension
+     * @return std::shared_ptr<diffCheck::geometry::DFMesh> the mesh
      */
-    void ReadPLYMeshFromFile(const std::string &filename);
+    std::shared_ptr<diffCheck::geometry::DFMesh> ReadPLYMeshFromFile(const std::string &filename);
 } // namespace diffCheck::io