Browse Source

better doc

Former-commit-id: f6ae49676720631896091208281ae25de45fe08a
Alec Jacobson 9 years ago
parent
commit
4d40f7cb01
1 changed files with 11 additions and 15 deletions
  1. 11 15
      include/igl/extract_manifold_patches.h

+ 11 - 15
include/igl/extract_manifold_patches.h

@@ -6,13 +6,9 @@
 #include <vector>
 #include <vector>
 
 
 namespace igl {
 namespace igl {
-    // Extract a set of maximal manifold patches from a given mesh.
-    // A maximal manifold patch is a subset of the input faces that is
-    // connected and manifold, and it cannot be expanded further by
-    // including more faces.
-    //
-    // Assumes the input mesh have all self-intersection resolved.  See
-    // ``igl::cgal::remesh_self_intersection`` for more details.
+    // Extract a set of maximal patches from a given mesh.
+    // A maximal patch is a subset of the input faces that are connected via
+    // manifold edges; a patch is as large as possible.
     //
     //
     // Inputs:
     // Inputs:
     //   F  #F by 3 list representing triangles.
     //   F  #F by 3 list representing triangles.
@@ -25,15 +21,15 @@ namespace igl {
     // Returns:
     // Returns:
     //   number of manifold patches.
     //   number of manifold patches.
     template <
     template <
-        typename DerivedF,
-        typename DerivedEMAP,
-        typename uE2EType,
-        typename DerivedP>
+      typename DerivedF,
+      typename DerivedEMAP,
+      typename uE2EType,
+      typename DerivedP>
     IGL_INLINE size_t extract_manifold_patches(
     IGL_INLINE size_t extract_manifold_patches(
-            const Eigen::PlainObjectBase<DerivedF>& F,
-            const Eigen::PlainObjectBase<DerivedEMAP>& EMAP,
-            const std::vector<std::vector<uE2EType> >& uE2E,
-            Eigen::PlainObjectBase<DerivedP>& P);
+      const Eigen::PlainObjectBase<DerivedF>& F,
+      const Eigen::PlainObjectBase<DerivedEMAP>& EMAP,
+      const std::vector<std::vector<uE2EType> >& uE2E,
+      Eigen::PlainObjectBase<DerivedP>& P);
 }
 }
 #ifndef IGL_STATIC_LIBRARY
 #ifndef IGL_STATIC_LIBRARY
 #  include "extract_manifold_patches.cpp"
 #  include "extract_manifold_patches.cpp"