PR comments and documentation.

Author: pv

docs/_images/example_mapping.png

@@ -2,31 +2,99 @@
 compas_libigl
 ********************************************************************************
 
-.. currentmodule:: compas_libigl
-
-Functions
-=========
-
-.. autosummary::
-    :toctree: generated/
-    :nosignatures:
-
-    add
-    get
-    get_beetle
-    get_armadillo
-    intersection_ray_mesh
-    intersection_rays_mesh
-    trimesh_boundaries
-    trimesh_gaussian_curvature
-    trimesh_principal_curvature
-    trimesh_geodistance
-    trimesh_geodistance_multiple
-    trimesh_isolines
-    groupsort_isolines
-    trimesh_massmatrix
-    trimesh_harmonic_mapping
-    trimesh_lsc_mapping
-    quadmesh_planarize
-    trimesh_remesh_along_isoline
-    trimesh_remesh_along_isolines
+Boundaries
+----------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.boundaries.trimesh_boundaries
+
+Curvature
+---------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.curvature.trimesh_gaussian_curvature
+    compas_libigl.curvature.trimesh_principal_curvature
+
+Geodesic Distance
+-----------------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.geodistance.trimesh_geodistance
+    compas_libigl.geodistance.trimesh_geodistance_multiple
+
+Intersections
+-------------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.intersections.intersection_ray_mesh
+    compas_libigl.intersections.intersection_rays_mesh
+
+Isolines
+--------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.isolines.trimesh_isolines
+    compas_libigl.isolines.groupsort_isolines
+
+Mapping
+-------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.mapping.map_mesh
+    compas_libigl.mapping.map_pattern_to_mesh
+
+Mass Matrix
+-----------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.massmatrix.trimesh_massmatrix
+
+Meshing
+-------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.meshing.trimesh_remesh_along_isoline
+    compas_libigl.meshing.trimesh_remesh_along_isolines
+
+Parametrisation
+---------------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.parametrisation.trimesh_harmonic_mapping
+    compas_libigl.parametrisation.trimesh_lsc_mapping
+
+Planarization
+-------------
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    compas_libigl.planarize.quadmesh_planarize

docs/_images/example_mapping_boundaries.png

@@ -57,7 +57,6 @@
 mv, mf, mn, mb, mg = map_mesh((v, f), (pv, pf))
 mesh_mapped = Mesh.from_vertices_and_faces(mv, mf)
 
-
 # ==============================================================================
 # Offset mesh by normals, normals are interpolated from the original mesh.
 # ==============================================================================

docs/api/compas_libigl.rst

@@ -2,6 +2,10 @@
 compas_libigl
 ********************************************************************************
 
+.. figure:: /_images/example_mapping_boundaries.png
+     :figclass: figure
+     :class: figure-img img-fluid
+
 .. rst-class:: lead
 
 COMPAS Libigl provides a Python binding for `Libigl <https://libigl.github.io/>`_,

docs/examples/example_mapping.py

@@ -32,27 +32,25 @@ def map_mesh(target_mesh, pattern_mesh, clip_boundaries=True, tolerance=1e-6):
 
     Parameters
     ----------
-    target_mesh : tuple
+    target_mesh : tuple[list[list[float]], list[list[int]]]
         A tuple of (vertices, faces) representing the target mesh.
-        vertices : list[list[float]]
-            The vertices of the target mesh.
-        faces : list[list[int]]
-            The triangle faces of the target mesh.
-        clip_boundaries : bool
-            Whether to clip the pattern mesh to the boundaries of the target mesh.
-        tolerance : float
-            The tolerance for point comparison, to remove duplicates.
-    pattern_mesh : tuple
+    pattern_mesh : tuple[list[list[float]], list[list[int]]]
         A tuple of (vertices, faces) representing the pattern mesh.
-        vertices : list[list[float]]
-            The vertices of the pattern mesh.
-        faces : list[list[int]]
-            The polygonal faces of the pattern mesh.
+    clip_boundaries : bool
+        Whether to clip the pattern mesh to the boundaries of the target mesh.
+    tolerance : float
+        The tolerance for point comparison, to remove duplicates.
 
     Returns
     -------
-    tuple
-        A tuple containing: mesh vertices, normals, grouping of polygons (to form holes), boundary flags.
+    tuple[ndarray, VectorVectorInt, ndarray, VectorBool, VectorInt]
+        A tuple containing:
+
+        * vertices: ndarray - The 3D coordinates of the mapped mesh vertices
+        * faces: VectorVectorInt - The faces of the mapped mesh
+        * normals: ndarray - The normal vectors at each vertex
+        * boundary_flags: VectorBool - Boolean flags indicating if vertices are on the boundary
+        * polygon_groups: VectorInt - Grouping indices for polygons (to form holes)
     """
     # Unpack mesh tuples
     v, f = target_mesh
@@ -80,24 +78,26 @@ def map_pattern_to_mesh(name, mesh, clip_boundaries=True, tolerance=1e-6, patter
     ----------
     name : str
         The name of the pattern to be created. Options are:
-        "Hex",
-        "Tri",
-        "Octo",
-        "Square",
-        "Rhombus",
-        "HexTri",
-        "DissectedSquare",
-        "DissectedTriangle",
-        "DissectedHexQuad",
-        "DissectedHexTri",
-        "Floret",
-        "Pythagorean",
-        "Brick",
-        "Weave",
-        "ZigZag",
-        "HexBigTri",
-        "Dodeca",
-        "SquareTri"
+
+        * "Hex"
+        * "Tri"
+        * "Octo"
+        * "Square"
+        * "Rhombus"
+        * "HexTri"
+        * "DissectedSquare"
+        * "DissectedTriangle"
+        * "DissectedHexQuad"
+        * "DissectedHexTri"
+        * "Floret"
+        * "Pythagorean"
+        * "Brick"
+        * "Weave"
+        * "ZigZag"
+        * "HexBigTri"
+        * "Dodeca"
+        * "SquareTri"
+
     mesh : compas.datastructures.Mesh
         The target mesh.
     clip_boundaries : bool
@@ -113,6 +113,11 @@ def map_pattern_to_mesh(name, mesh, clip_boundaries=True, tolerance=1e-6, patter
     -------
     compas.datastructures.Mesh
         The mapped pattern mesh.
+
+    Raises
+    ------
+    ValueError
+        If the specified pattern name is not supported.
     """
 
     TESSAGON_TYPES = {
@@ -136,6 +141,11 @@ def map_pattern_to_mesh(name, mesh, clip_boundaries=True, tolerance=1e-6, patter
         "SquareTri": SquareTriTessagon,
     }
 
+    # Check if the provided pattern name is supported
+    if name not in TESSAGON_TYPES:
+        supported_names = list(TESSAGON_TYPES.keys())
+        raise ValueError(f"Pattern name '{name}' is not supported. Choose from: {', '.join(supported_names)}")
+
     options = {
         "function": lambda u, v: [u * 1, v * 1, 0],
         "u_range": [-0.255, 1.33],