Merge pull request #1 from Geode-solutions/dev

feat(criterion): Add inspector criterion for degeneration on SurfaceMesh and SolidMesh

Author: MelchiorSchuh

.github/workflows/CD.yml

@@ -30,13 +30,13 @@ jobs:
         cd build
         version="${GITHUB_REF##*/*/}"
         echo ::set-output name=version::$version
-        cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH:PATH=${{ steps.opengeode.outputs.path }} -DMYMODULE_WITH_TESTS:BOOL=OFF -DCPACK_PACKAGE_VERSION:STRING=$version -DCPACK_SYSTEM_NAME:STRING=${{ matrix.config.system }} ..
+        cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH:PATH=${{ steps.opengeode.outputs.path }} -DOPENGEODE_INSPECTOR_WITH_TESTS:BOOL=OFF -DCPACK_PACKAGE_VERSION:STRING=$version -DCPACK_SYSTEM_NAME:STRING=${{ matrix.config.system }} ..
         cmake --build . -- -j2
         cmake --build . --target package
     - name: Upload
       uses: softprops/action-gh-release@v1
       with:
-        files: "build/MyModule-${{ steps.package.outputs.version }}-${{ matrix.config.system }}.tar.gz"
+        files: "build/OpenGeode-Inspector-${{ steps.package.outputs.version }}-${{ matrix.config.system }}.tar.gz"
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - name: Doc
@@ -63,13 +63,13 @@ jobs:
         cd build
         version="${GITHUB_REF##*/*/}"
         echo ::set-output name=version::$version
-        cmake -G "Xcode" -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH:PATH=${{ steps.opengeode.outputs.path }} -DMYMODULE_WITH_TESTS:BOOL=OFF -DCPACK_PACKAGE_VERSION:STRING=$version -DCPACK_SYSTEM_NAME:STRING=darwin ..
+        cmake -G "Xcode" -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH:PATH=${{ steps.opengeode.outputs.path }} -DOPENGEODE_INSPECTOR_WITH_TESTS:BOOL=OFF -DCPACK_PACKAGE_VERSION:STRING=$version -DCPACK_SYSTEM_NAME:STRING=darwin ..
         cmake --build . --config Release
         cmake --build . --target package --config Release
     - name: Upload
       uses: softprops/action-gh-release@v1
       with:
-        files: "build/MyModule-${{ steps.package.outputs.version }}-darwin.tar.gz"
+        files: "build/OpenGeode-Inspector-${{ steps.package.outputs.version }}-darwin.tar.gz"
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -91,13 +91,13 @@ jobs:
         cd build
         version="${GITHUB_REF##*/*/}"
         echo ::set-output name=version::$version
-        cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_PREFIX_PATH:PATH=${{ steps.opengeode.outputs.path }} -DMYMODULE_WITH_TESTS:BOOL=OFF -DCPACK_PACKAGE_VERSION:STRING=$version -DCPACK_SYSTEM_NAME:STRING=win64 ..
+        cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_PREFIX_PATH:PATH=${{ steps.opengeode.outputs.path }} -DOPENGEODE_INSPECTOR_WITH_TESTS:BOOL=OFF -DCPACK_PACKAGE_VERSION:STRING=$version -DCPACK_SYSTEM_NAME:STRING=win64 ..
         cmake --build . --config Release
         cmake --build . --target PACKAGE --config Release
       shell: bash
     - name: Upload
       uses: softprops/action-gh-release@v1
       with:
-        files: "build/MyModule-${{ steps.package.outputs.version }}-win64.zip"
+        files: "build/OpenGeode-Inspector-${{ steps.package.outputs.version }}-win64.zip"
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}        

CMakeLists.txt

@@ -21,33 +21,23 @@
 cmake_minimum_required(VERSION 3.11)
 
 # Define the project
-project(MyModule CXX)
+project(OpenGeode-Inspector CXX)
 
-option(MYMODULE_WITH_TESTS "Compile test projects" ON)
+option(OPENGEODE_INSPECTOR_WITH_TESTS "Compile test projects" ON)
 
-# Get MyModule dependencies
+# Get OpenGeode-inspector dependencies
 find_package(OpenGeode REQUIRED)
 
 #------------------------------------------------------------------------------------------------
-# Configure the MyModule libraries
-add_geode_library(
-    NAME mylib
-    FOLDER "mylib"
-    SOURCES
-        "common.cpp"
-        "hello_world.cpp"
-    PUBLIC_HEADERS
-        "hello_world.h"
-    PRIVATE_DEPENDENCIES
-        OpenGeode::basic
-)
+# Configure the OpenGeode-inspector libraries
+add_subdirectory(src/geode)
 
 #------------------------------------------------------------------------------------------------
 # Optional modules configuration
-if(MYMODULE_WITH_TESTS)
+if(OPENGEODE_INSPECTOR_WITH_TESTS)
     # Enable testing with CTest
     enable_testing()
-    message(STATUS "Configuring MyModule with tests")
+    message(STATUS "Configuring OpenGeode-inspector with tests")
     add_subdirectory(tests)
 endif()
 

README.md

@@ -1,5 +1,5 @@
-<h1 align="center">OpenGeode-ModuleTemplate<sup><i>by Geode-solutions</i></sup></h1>
-<h3 align="center">Template for creating your own OpenGeode modules</h3>
+<h1 align="center">OpenGeode-Inspector<sup><i>by Geode-solutions</i></sup></h1>
+<h3 align="center">OpenGeode module for inspecting meshes and models</h3>
 
 
 <p align="center">
@@ -31,18 +31,22 @@
 
 ## Introduction
 
-OpenGeode-ModuleTemplate provides a template for creating an [OpenGeode] module.
+OpenGeode-Inspector is a module of [OpenGeode] providing ways of inspecting your meshes and models and verifying their validity.
 
 [OpenGeode]: https://github.com/Geode-solutions/OpenGeode
 
 ## Documentation
 
-To know how to use this template, please have a look at this page: https://help.github.com/en/articles/creating-a-repository-from-a-template
+Go check out the online documentation at [docs.geode-solutions.com].
 
-Have also a look at this [OpenGeode] documentation: https://docs.geode-solutions.com/opengeode then click on "How to create your own OpenGeode module"
+[docs.geode-solutions.com] https://docs.geode-solutions.com
+
+Installing OpenGeode-Inspector is done:
+
+ * by compiling the C++ source.
 
 ## Questions
-For questions and support please use the official [slack](https://slackin-opengeode.herokuapp.com) and go to the channel #module_template. The issue list of this repo is exclusively for bug reports and feature requests. 
+For questions and support please use the official [slack](https://slackin-opengeode.herokuapp.com) and go to the channel #inspector. The issue list of this repo is exclusively for bug reports and feature requests. 
 
 
 ## License

cmake/MyModuleConfig.cmake.in renamed to cmake/OpenGeode-InspectorConfig.cmake.in

@@ -24,4 +24,4 @@ include(CMakeFindDependencyMacro)
 find_dependency(OpenGeode)
 
 # Load information for each target
-include(${CMAKE_CURRENT_LIST_DIR}/@PROJECT_NAME@_mylib_target.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/@PROJECT_NAME@_inspector_target.cmake)

include/mylib/hello_world.h renamed to include/geode/inspector/common.h

@@ -23,9 +23,6 @@
 
 #pragma once
 
-#include <mylib/mymodule_mylib_export.h>
+#include <geode/basic/common.h>
 
-namespace mymodule
-{
-    bool mymodule_mylib_api hello_world();
-} // namespace mymodule
+#include <geode/inspector/opengeode_inspector_inspector_export.h>

tests/mylib/test-hello-world.cpp renamed to include/geode/inspector/criterion/degeneration/solid_degeneration.h

@@ -21,23 +21,38 @@
  *
  */
 
-#include <geode/basic/assert.h>
-#include <geode/basic/logger.h>
+#pragma once
 
-#include <mylib/hello_world.h>
+#include <geode/basic/pimpl.h>
 
-int main()
+#include <geode/inspector/common.h>
+
+namespace geode
 {
-    try
-    {
-        OPENGEODE_EXCEPTION(
-            mymodule::hello_world(), "[Test] Hello World is not correct" );
+    FORWARD_DECLARATION_DIMENSION_CLASS( SolidMesh );
+    ALIAS_3D( SolidMesh );
+} // namespace geode
 
-        geode::Logger::info( "TEST SUCCESS" );
-        return 0;
-    }
-    catch( ... )
+namespace geode
+{
+    /*!
+     * Class for inspecting the degeneration of a SolidMesh
+     */
+    class opengeode_inspector_inspector_api SolidMeshDegeneration
     {
-        return geode::geode_lippincott();
-    }
-}
+        OPENGEODE_DISABLE_COPY( SolidMeshDegeneration );
+
+    public:
+        SolidMeshDegeneration( const SolidMesh3D& mesh );
+        ~SolidMeshDegeneration();
+
+        bool is_mesh_degenerated() const;
+
+        index_t nb_degenerated_edges() const;
+
+        std::vector< index_t > degenerated_edges() const;
+
+    private:
+        IMPLEMENTATION_MEMBER( impl_ );
+    };
+} // namespace geode

include/geode/inspector/criterion/degeneration/surface_degeneration.h

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2019 - 2021 Geode-solutions
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+#pragma once
+
+#include <geode/basic/pimpl.h>
+
+#include <geode/inspector/common.h>
+
+namespace geode
+{
+    FORWARD_DECLARATION_DIMENSION_CLASS( SurfaceMesh );
+} // namespace geode
+
+namespace geode
+{
+    /*!
+     * Class for inspecting the degeneration of a SurfaceMesh
+     */
+    template < index_t dimension >
+    class opengeode_inspector_inspector_api SurfaceMeshDegeneration
+    {
+        OPENGEODE_DISABLE_COPY( SurfaceMeshDegeneration );
+
+    public:
+        SurfaceMeshDegeneration( const SurfaceMesh< dimension >& mesh );
+        ~SurfaceMeshDegeneration();
+
+        bool is_mesh_degenerated() const;
+
+        index_t nb_degenerated_edges() const;
+
+        std::vector< index_t > degenerated_edges() const;
+
+    private:
+        IMPLEMENTATION_MEMBER( impl_ );
+    };
+    ALIAS_2D_AND_3D( SurfaceMeshDegeneration );
+} // namespace geode

src/mylib/hello_world.cpp renamed to include/geode/inspector/criterion/private/degeneration_impl.h

@@ -21,15 +21,36 @@
  *
  */
 
-#include <mylib/hello_world.h>
+#pragma once
 
-#include <geode/basic/logger.h>
+#include <geode/inspector/common.h>
 
-namespace mymodule
+namespace geode
 {
-    bool hello_world()
+    namespace detail
     {
-        geode::Logger::info( "Hello Geode World!" );
-        return true;
-    }
-} // namespace mymodule
+        /*!
+         * Implementation of the inspection of the degeneration of a Mesh
+         */
+        template < class MeshType >
+        class opengeode_inspector_inspector_api DegenerationImpl
+        {
+            OPENGEODE_DISABLE_COPY( DegenerationImpl );
+
+        public:
+            DegenerationImpl( const MeshType& mesh );
+
+            bool is_mesh_degenerated() const;
+
+            index_t nb_degenerated_edges() const;
+
+            std::vector< index_t > degenerated_edges() const;
+
+        private:
+            bool edge_is_degenerated( index_t edge_index ) const;
+
+        private:
+            const MeshType& mesh_;
+        };
+    } // namespace detail
+} // namespace geode

tests/mylib/CMakeLists.txt renamed to src/geode/CMakeLists.txt

@@ -18,9 +18,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-add_geode_test(
-    SOURCE "test-hello-world.cpp"
-    DEPENDENCIES
-        OpenGeode::basic
-        ${PROJECT_NAME}::mylib
-)
+add_subdirectory(inspector)

src/geode/inspector/CMakeLists.txt

@@ -0,0 +1,41 @@
+# Copyright (c) 2019 - 2021 Geode-solutions
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+add_geode_library(
+    NAME inspector
+    FOLDER "geode/inspector"
+    SOURCES
+        "common.cpp"
+        "criterion/degeneration/surface_degeneration.cpp"
+        "criterion/degeneration/solid_degeneration.cpp"
+        "criterion/private/degeneration_impl.cpp"
+    PUBLIC_HEADERS
+        "common.h"
+        "criterion/degeneration/surface_degeneration.h"
+        "criterion/degeneration/solid_degeneration.h"
+    PRIVATE_HEADERS
+        "criterion/private/degeneration_impl.h"
+    PUBLIC_DEPENDENCIES
+        OpenGeode::basic
+    PRIVATE_DEPENDENCIES
+        OpenGeode::geometry
+        OpenGeode::mesh
+)
+