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

MelchiorSchuh · MelchiorSchuh · commit bca8875f5f27 · 2021-11-08T14:07:52.000+01:00
diff --git a/.github/workflows/CD.yml b/.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 }}        
diff --git a/include/geode/inspector/criterion/degeneration/solid_degeneration.h b/include/geode/inspector/criterion/degeneration/solid_degeneration.h
@@ -0,0 +1,62 @@
+/*
+ * 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( SolidMesh );
+    ALIAS_3D( SolidMesh );
+} // namespace geode
+
+namespace geode
+{
+    namespace inspector
+    {
+        /*!
+         * Class for inspecting the degeneration of a SolidMesh
+         */
+        class SolidMeshDegeneration
+        {
+        public:
+            SolidMeshDegeneration();
+            ~SolidMeshDegeneration();
+
+            bool is_mesh_degenerated( const SolidMesh3D& mesh ) const;
+
+            index_t nb_degenerated_edges( const SolidMesh3D& mesh ) const;
+
+            const std::vector< index_t > degenerated_edges(
+                const SolidMesh3D& mesh ) const;
+
+        private:
+            // SolidMeshDegeneration( SolidMeshDegeneration&& other );
+
+            IMPLEMENTATION_MEMBER( impl_ );
+        };
+    } // namespace inspector
+} // namespace geode
diff --git a/include/geode/inspector/criterion/degeneration/surface_degeneration.h b/include/geode/inspector/criterion/degeneration/surface_degeneration.h
@@ -30,7 +30,6 @@
 namespace geode
 {
     FORWARD_DECLARATION_DIMENSION_CLASS( SurfaceMesh );
-    FORWARD_DECLARATION_DIMENSION_CLASS( SolidMesh );
 } // namespace geode
 
 namespace geode
@@ -44,8 +43,7 @@ namespace geode
         class opengeode_inspector_inspector_api SurfaceMeshDegeneration
         {
         public:
-            SurfaceMeshDegeneration() = default;
-            SurfaceMeshDegeneration( SurfaceMeshDegeneration&& other );
+            SurfaceMeshDegeneration();
             ~SurfaceMeshDegeneration();
 
             bool is_mesh_degenerated(
@@ -58,30 +56,10 @@ namespace geode
                 const SurfaceMesh< dimension >& mesh ) const;
 
         private:
+            // SurfaceMeshDegeneration( SurfaceMeshDegeneration&& other );
+
             IMPLEMENTATION_MEMBER( impl_ );
         };
         ALIAS_2D_AND_3D( SurfaceMeshDegeneration );
-
-        // template < index_t dimension >
-        // class SolidMeshDegeneration
-        // {
-        // public:
-        //     SolidMeshDegeneration();
-        //     SolidMeshDegeneration( SolidMeshDegeneration&& other );
-        //     ~SolidMeshDegeneration();
-
-        //     bool is_mesh_degenerated(
-        //         const SolidMesh< dimension >& mesh ) const;
-
-        //     index_t nb_degenerated_edges(
-        //         const SolidMesh< dimension >& mesh ) const;
-
-        //     const std::vector< index_t > degenerated_edges(
-        //         const SolidMesh< dimension >& mesh ) const;
-
-        // private:
-        //     IMPLEMENTATION_MEMBER( impl_ );
-        // };
-        // ALIAS_2D_AND_3D( SolidMeshDegeneration );
     } // namespace inspector
 } // namespace geode
diff --git a/src/geode/inspector/CMakeLists.txt b/src/geode/inspector/CMakeLists.txt
@@ -23,10 +23,12 @@ add_geode_library(
     FOLDER "geode/inspector"
     SOURCES
         "common.cpp"
-        "criterion/degeneration.cpp"
+        "criterion/degeneration/surface_degeneration.cpp"
+        "criterion/degeneration/solid_degeneration.cpp"
     PUBLIC_HEADERS
         "common.h"
-        "criterion/degeneration.h"
+        "criterion/degeneration/surface_degeneration.h"
+        "criterion/degeneration/solid_degeneration.h"
     ADVANCED_HEADERS
         # "mixin/core/detail/components_storage.h"
     PRIVATE_HEADERS
diff --git a/src/geode/inspector/criterion/degeneration/solid_degeneration.cpp b/src/geode/inspector/criterion/degeneration/solid_degeneration.cpp
@@ -0,0 +1,128 @@
+/*
+ * 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.
+ *
+ */
+
+#include <geode/inspector/criterion/degeneration/solid_degeneration.h>
+
+#include <geode/basic/pimpl_impl.h>
+
+#include <geode/mesh/core/solid_edges.h>
+#include <geode/mesh/core/solid_mesh.h>
+
+#include <geode/geometry/distance.h>
+#include <geode/geometry/point.h>
+
+namespace geode
+{
+    namespace inspector
+    {
+        class SolidMeshDegeneration::Impl
+        {
+        public:
+            Impl() = default;
+
+            bool is_mesh_degenerated( const SolidMesh3D& mesh ) const
+            {
+                bool is_degenerated = false;
+
+                mesh.enable_edges();
+                for( auto edge_index : Range( mesh.edges().nb_edges() ) )
+                {
+                    const auto edge_vertices =
+                        mesh.edges().edge_vertices( edge_index );
+                    const Point3D &p1 = mesh.point( edge_vertices[0] ),
+                                  p2 = mesh.point( edge_vertices[1] );
+                    if( geode::point_point_distance( p1, p2 ) < global_epsilon )
+                    {
+                        is_degenerated = true;
+                        break;
+                    }
+                }
+
+                return is_degenerated;
+            }
+
+            index_t nb_degenerated_edges( const SolidMesh3D& mesh ) const
+            {
+                index_t nb_degeneration = 0;
+
+                mesh.enable_edges();
+                for( auto edge_index : Range( mesh.edges().nb_edges() ) )
+                {
+                    const auto edge_vertices =
+                        mesh.edges().edge_vertices( edge_index );
+                    const Point3D &p1 = mesh.point( edge_vertices[0] ),
+                                  p2 = mesh.point( edge_vertices[1] );
+                    if( geode::point_point_distance( p1, p2 ) < global_epsilon )
+                    {
+                        nb_degeneration++;
+                    }
+                }
+
+                return nb_degeneration;
+            }
+
+            std::vector< index_t > degenerated_edges(
+                const SolidMesh3D& mesh ) const
+            {
+                std::vector< index_t > degenerated_edges_index;
+
+                mesh.enable_edges();
+                for( auto edge_index : Range( mesh.edges().nb_edges() ) )
+                {
+                    const auto edge_vertices =
+                        mesh.edges().edge_vertices( edge_index );
+                    const Point3D &p1 = mesh.point( edge_vertices[0] ),
+                                  p2 = mesh.point( edge_vertices[1] );
+                    if( geode::point_point_distance( p1, p2 ) < global_epsilon )
+                    {
+                        degenerated_edges_index.push_back( edge_index );
+                    }
+                }
+
+                return degenerated_edges_index;
+            }
+        };
+
+        SolidMeshDegeneration::SolidMeshDegeneration() {}
+
+        SolidMeshDegeneration::~SolidMeshDegeneration() {}
+
+        bool SolidMeshDegeneration::is_mesh_degenerated(
+            const SolidMesh3D& mesh ) const
+        {
+            return impl_->is_mesh_degenerated( mesh );
+        }
+
+        index_t SolidMeshDegeneration::nb_degenerated_edges(
+            const SolidMesh3D& mesh ) const
+        {
+            return impl_->nb_degenerated_edges( mesh );
+        }
+
+        const std::vector< index_t > SolidMeshDegeneration::degenerated_edges(
+            const SolidMesh3D& mesh ) const
+        {
+            return impl_->degenerated_edges( mesh );
+        }
+    } // namespace inspector
+} // namespace geode
diff --git a/src/geode/inspector/criterion/degeneration/surface_degeneration.cpp b/src/geode/inspector/criterion/degeneration/surface_degeneration.cpp
@@ -21,7 +21,7 @@
  *
  */
 
-#include <geode/inspector/criterion/degeneration.h>
+#include <geode/inspector/criterion/degeneration/surface_degeneration.h>
 
 #include <geode/basic/pimpl_impl.h>
 
@@ -67,7 +67,7 @@ namespace geode
             index_t nb_degenerated_edges(
                 const SurfaceMesh< dimension >& mesh ) const
             {
-                index_t nb_degeneration;
+                index_t nb_degeneration = 0;
 
                 mesh.enable_edges();
                 for( auto edge_index : Range( mesh.edges().nb_edges() ) )
@@ -89,7 +89,7 @@ namespace geode
             std::vector< index_t > degenerated_edges(
                 const SurfaceMesh< dimension >& mesh ) const
             {
-                std::vector< index_t > degenerated_edge_points;
+                std::vector< index_t > degenerated_edges_index;
 
                 mesh.enable_edges();
                 for( auto edge_index : Range( mesh.edges().nb_edges() ) )
@@ -101,14 +101,19 @@ namespace geode
                                            p2 = mesh.point( edge_vertices[1] );
                     if( geode::point_point_distance( p1, p2 ) < global_epsilon )
                     {
-                        degenerated_edge_points.push_back( edge_index );
+                        degenerated_edges_index.push_back( edge_index );
                     }
                 }
 
-                return degenerated_edge_points;
+                return degenerated_edges_index;
             }
         };
 
+        template < index_t dimension >
+        SurfaceMeshDegeneration< dimension >::SurfaceMeshDegeneration()
+        {
+        }
+
         template < index_t dimension >
         SurfaceMeshDegeneration< dimension >::~SurfaceMeshDegeneration()
         {
diff --git a/tests/inspector/CMakeLists.txt b/tests/inspector/CMakeLists.txt
@@ -19,10 +19,19 @@
 # SOFTWARE.
 
 add_geode_test(
-    SOURCE "test-degeneration.cpp"
+    SOURCE "test-surface-degeneration.cpp"
     DEPENDENCIES
         OpenGeode::basic
         OpenGeode::geometry
         OpenGeode::mesh
         ${PROJECT_NAME}::inspector
 )
+
+add_geode_test(
+    SOURCE "test-solid-degeneration.cpp"
+    DEPENDENCIES
+        OpenGeode::basic
+        OpenGeode::geometry
+        OpenGeode::mesh
+        ${PROJECT_NAME}::inspector
+)
diff --git a/tests/inspector/test-degeneration.cpp b/tests/inspector/test-degeneration.cpp
diff --git a/tests/inspector/test-solid-degeneration.cpp b/tests/inspector/test-solid-degeneration.cpp
diff --git a/tests/inspector/test-surface-degeneration.cpp b/tests/inspector/test-surface-degeneration.cpp

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`*`
`22`	`22`	`*/`
`23`	`23`
`24`		`-#include <geode/inspector/criterion/degeneration.h>`
	`24`	`+#include <geode/inspector/criterion/degeneration/surface_degeneration.h>`
`25`	`25`
`26`	`26`	`#include <geode/basic/pimpl_impl.h>`
`27`	`27`
`@@ -67,7 +67,7 @@ namespace geode`
`67`	`67`	`index_t nb_degenerated_edges(`
`68`	`68`	`const SurfaceMesh< dimension >& mesh ) const`
`69`	`69`	`{`
`70`		`- index_t nb_degeneration;`
	`70`	`+ index_t nb_degeneration = 0;`
`71`	`71`
`72`	`72`	`mesh.enable_edges();`
`73`	`73`	`for( auto edge_index : Range( mesh.edges().nb_edges() ) )`
`@@ -89,7 +89,7 @@ namespace geode`
`89`	`89`	`std::vector< index_t > degenerated_edges(`
`90`	`90`	`const SurfaceMesh< dimension >& mesh ) const`
`91`	`91`	`{`
`92`		`- std::vector< index_t > degenerated_edge_points;`
	`92`	`+ std::vector< index_t > degenerated_edges_index;`
`93`	`93`
`94`	`94`	`mesh.enable_edges();`
`95`	`95`	`for( auto edge_index : Range( mesh.edges().nb_edges() ) )`
`@@ -101,14 +101,19 @@ namespace geode`
`101`	`101`	`p2 = mesh.point( edge_vertices[1] );`
`102`	`102`	`if( geode::point_point_distance( p1, p2 ) < global_epsilon )`
`103`	`103`	`{`
`104`		`- degenerated_edge_points.push_back( edge_index );`
	`104`	`+ degenerated_edges_index.push_back( edge_index );`
`105`	`105`	`}`
`106`	`106`	`}`
`107`	`107`
`108`		`- return degenerated_edge_points;`
	`108`	`+ return degenerated_edges_index;`
`109`	`109`	`}`
`110`	`110`	`};`
`111`	`111`
	`112`	`+ template < index_t dimension >`
	`113`	`+ SurfaceMeshDegeneration< dimension >::SurfaceMeshDegeneration()`
	`114`	`+ {`
	`115`	`+ }`
	`116`	`+`
`112`	`117`	`template < index_t dimension >`
`113`	`118`	`SurfaceMeshDegeneration< dimension >::~SurfaceMeshDegeneration()`
`114`	`119`	`{`