FIX docstrings optional parameters.

Author: petrasvestartas

docs/examples/example_mapping_patterns.py

@@ -27,19 +27,19 @@
 # ==============================================================================
 
 aabb = mesh.aabb()
-fixed_points = []
+fixed_vertices = []
 
 
 for vertex in mesh.vertices():
     x, y, z = mesh.vertex_attributes(vertex, "xyz")  # type: ignore
     if abs(z-aabb.zmin) < 1e-3 or abs(z-aabb.zmax) < 1e-3:
-        fixed_points.append(vertex)
+        fixed_vertices.append(vertex)
 
 # ==============================================================================
 # Mapping: 3D Mesh, 2D Pattern, UV
 # ==============================================================================
 
-mesh_mapped0 = map_pattern_to_mesh("ZigZag", mesh, clip_boundaries=True, tolerance=1e-6, pattern_u=16, pattern_v=16, simplify_borders=True, fixed_points=fixed_points)
+mesh_mapped0 = map_pattern_to_mesh("ZigZag", mesh, clip_boundaries=True, tolerance=1e-6, pattern_u=16, pattern_v=16, simplify_borders=True, fixed_vertices=fixed_vertices)
 mesh_mapped1 = map_pattern_to_mesh("ZigZag", mesh, clip_boundaries=True, tolerance=1e-6, pattern_u=16, pattern_v=16, simplify_borders=False)
 # ==============================================================================
 # Viewer
@@ -55,7 +55,7 @@
 viewer.scene.add(mesh_mapped0, name="mesh_mapped0", facecolor=Color.red(), show_points=True)
 # viewer.scene.add(mesh_mapped1, name="mesh_mapped1", facecolor=Color.blue(), show_points=True, show_faces=False)
 
-for p in fixed_points:
+for p in fixed_vertices:
     viewer.scene.add(mesh.vertex_point(p), pointcolor=Color.red(), pointsize=10)
 
 viewer.show()

src/compas_libigl/mapping.py

@@ -26,7 +26,7 @@
 from compas_libigl._types_std import VectorVectorInt  # noqa: F401
 
 
-def map_mesh(target_mesh, pattern_mesh, clip_boundaries=True, simplify_borders=True, fixed_points=None, tolerance=1e-6):
+def map_mesh(target_mesh, pattern_mesh, clip_boundaries=True, simplify_borders=True, fixed_vertices=None, tolerance=1e-6):
     """
     Map a 2D pattern mesh onto a 3D target.
 
@@ -36,14 +36,18 @@ def map_mesh(target_mesh, pattern_mesh, clip_boundaries=True, simplify_borders=T
         A tuple of (vertices, faces) representing the target mesh.
     pattern_mesh : tuple[list[list[float]], list[list[int]]]
         A tuple of (vertices, faces) representing the pattern mesh.
-    clip_boundaries : bool
+    clip_boundaries : bool, optional
         Whether to clip the pattern mesh to the boundaries of the target mesh.
-    simplify_borders : bool
+        Default is True.
+    simplify_borders : bool, optional
         Whether to simplify the border of the pattern mesh.
-    fixed_points : list[list[float]]
+        Default is True.
+    fixed_vertices : list[list[float]], optional
         A list of fixed points on the target mesh.
-    tolerance : float
+        Default is None.
+    tolerance : float, optional
         The tolerance for point comparison, to remove duplicates.
+        Default is 1e-6.
 
     Returns
     -------
@@ -65,13 +69,13 @@ def map_mesh(target_mesh, pattern_mesh, clip_boundaries=True, simplify_borders=T
     f_numpy = np.array(f, dtype=np.int32)
     pattern_v_numpy = np.array(pv, dtype=np.float64)
 
-    # Handle fixed_points - provide empty array if None
+    # Handle fixed_vertices - provide empty array if None
 
-    fixed_points_vectorint = VectorInt()
-    if fixed_points is None:
-        fixed_points_vectorint = VectorInt()
+    fixed_vertices_vectorint = VectorInt()
+    if fixed_vertices is None:
+        fixed_vertices_vectorint = VectorInt()
     else:
-        fixed_points_vectorint = VectorInt(fixed_points)
+        fixed_vertices_vectorint = VectorInt(fixed_vertices)
 
     # Convert pattern_f from Python list to VectorVectorInt which is expected by C++ code
 
@@ -81,14 +85,14 @@ def map_mesh(target_mesh, pattern_mesh, clip_boundaries=True, simplify_borders=T
 
     # Perform the mapping
     pv_numpy_copy, pf_numpy_cleaned, p_normals, pattern_is_boundary, pattern_groups = _mapping.map_mesh_with_automatic_parameterization(
-        v_numpy, f_numpy, pattern_v_numpy, pattern_f_vec, clip_boundaries, simplify_borders, fixed_points_vectorint, tolerance
+        v_numpy, f_numpy, pattern_v_numpy, pattern_f_vec, clip_boundaries, simplify_borders, fixed_vertices_vectorint, tolerance
     )
 
     # Return the result as a tuple
     return pv_numpy_copy, pf_numpy_cleaned, p_normals, pattern_is_boundary, pattern_groups
 
 
-def map_pattern_to_mesh(name, mesh, clip_boundaries=True, tolerance=1e-6, pattern_u=16, pattern_v=16, simplify_borders=True, fixed_points=None):
+def map_pattern_to_mesh(name, mesh, clip_boundaries=True, tolerance=1e-6, pattern_u=16, pattern_v=16, simplify_borders=True, fixed_vertices=None):
     """
     Map a 2D pattern mesh onto a 3D target.
 
@@ -118,18 +122,24 @@ def map_pattern_to_mesh(name, mesh, clip_boundaries=True, tolerance=1e-6, patter
 
     mesh : compas.datastructures.Mesh
         The target mesh.
-    clip_boundaries : bool
+    clip_boundaries : bool, optional
         Whether to clip the pattern mesh to the boundaries of the target mesh.
-    tolerance : float
+        Default is True.
+    tolerance : float, optional
         The tolerance for point comparison, to remove duplicates.
-    pattern_u : int
+        Default is 1e-6.
+    pattern_u : int, optional
         The number of pattern vertices in the u direction.
-    pattern_v : int
+        Default is 16.
+    pattern_v : int, optional
         The number of pattern vertices in the v direction.
-    simplify_borders : bool
+        Default is 16.
+    simplify_borders : bool, optional
         Whether to simplify the border of the pattern mesh.
-    fixed_points : list[list[float]]
+        Default is True.
+    fixed_vertices : list[list[float]], optional
         A list of fixed points on the target mesh.
+        Default is None.
 
     Returns
     -------
@@ -188,7 +198,7 @@ def map_pattern_to_mesh(name, mesh, clip_boundaries=True, tolerance=1e-6, patter
 
     v, f = mesh.to_vertices_and_faces()
     mapped_vertices, mapped_faces, mapped_normals, mapped_is_boundary, mapped_groups = map_mesh(
-        (v, f), (pv, pf), clip_boundaries=clip_boundaries, simplify_borders=simplify_borders, fixed_points=fixed_points, tolerance=tolerance
+        (v, f), (pv, pf), clip_boundaries=clip_boundaries, simplify_borders=simplify_borders, fixed_vertices=fixed_vertices, tolerance=tolerance
     )
 
     return Mesh.from_vertices_and_faces(mapped_vertices, mapped_faces)

src/mapping.cpp

@@ -172,7 +172,7 @@ std::tuple<compas::RowMatrixXd, std::vector<std::vector<int>>, std::vector<bool>
     const std::vector<std::vector<int>>& pattern_f,
     bool clip_boundaries,
     bool simplify_borders,
-    std::vector<int>& fixed_points,
+    std::vector<int>& fixed_vertices,
     double tolerance
 )   
 {
@@ -181,7 +181,7 @@ std::tuple<compas::RowMatrixXd, std::vector<std::vector<int>>, std::vector<bool>
     // Fixed points
     ////////////////////////////////////////////////////////////////////////////////////////
     Clipper2Lib::PathD fixed;
-    for (const auto &point_id : fixed_points){
+    for (const auto &point_id : fixed_vertices){
         fixed.emplace_back(Clipper2Lib::PointD(flattned_target_uv(point_id, 0), flattned_target_uv(point_id, 1)));
     }
 
@@ -449,7 +449,7 @@ std::tuple<compas::RowMatrixXd, std::vector<std::vector<int>>, compas::RowMatrix
     const std::vector<std::vector<int>>& pattern_f,
     bool clip_boundaries,
     bool simplify_borders,
-    std::vector<int>& fixed_points,
+    std::vector<int>& fixed_vertices,
     double tolerance)
 {
 
@@ -486,7 +486,7 @@ std::tuple<compas::RowMatrixXd, std::vector<std::vector<int>>, compas::RowMatrix
 
 
     // Clip the pattern
-    auto [clipped_pattern_v, clipped_pattern_f, clipped_pattern_is_boundary, clipped_pattern_groups] = eigen_to_clipper(target_uv, target_f, pattern_v, pattern_f, clip_boundaries, simplify_borders, fixed_points, tolerance);
+    auto [clipped_pattern_v, clipped_pattern_f, clipped_pattern_is_boundary, clipped_pattern_groups] = eigen_to_clipper(target_uv, target_f, pattern_v, pattern_f, clip_boundaries, simplify_borders, fixed_vertices, tolerance);
 
     Eigen::MatrixXd clipped_pattern_uv;
     clipped_pattern_uv.setZero();
@@ -523,7 +523,7 @@ NB_MODULE(_mapping, m)
         "pattern_f"_a,
         "clip_boundaries"_a,
         "simplify_borders"_a,
-        "fixed_points"_a,
+        "fixed_vertices"_a,
         "tolerance"_a
     );
 }

src/mapping.hpp

@@ -74,7 +74,7 @@ bool paths_intersect(const Clipper2Lib::PathsD& paths1, const Clipper2Lib::Paths
  * @param pattern_f The pattern mesh face indices.
  * @param clip_boundaries Whether to clip the pattern mesh to the boundaries of the target mesh.
  * @param simplify_borders Whether to simplify the border of the pattern mesh.
- * @param fixed_points fixed points on the target mesh
+ * @param fixed_vertices fixed points on the target mesh
  * @param tolerance The tolerance for point comparison, to remove duplicates.
  * @return A tuple of the clipped pattern mesh vertex coordinates and face indices.
  */
@@ -86,7 +86,7 @@ std::tuple<compas::RowMatrixXd, std::vector<std::vector<int>>, std::vector<bool>
     const std::vector<std::vector<int>>& pattern_f,
     bool clip_boundaries,
     bool simplify_borders,
-    std::vector<int>& fixed_points,
+    std::vector<int>& fixed_vertices,
     double tolerance = 1e-6
 )  ;    
 
@@ -101,7 +101,7 @@ std::tuple<compas::RowMatrixXd, std::vector<std::vector<int>>, std::vector<bool>
  * @param pattern_f vector of vectors of int of pattern mesh triangle indices
  * @param clip_boundaries whether to clip the pattern mesh to the boundaries of the target mesh
  * @param simplify_borders whether to simplify the border of the pattern mesh
- * @param fixed_points fixed points on the target mesh
+ * @param fixed_vertices fixed points on the target mesh
  * @param tolerance tolerance for point comparison, to remove duplicates
  * @return A tuple containing the mapped pattern vertices, faces, and vertex normal vectors.
  */
@@ -112,6 +112,6 @@ std::tuple<compas::RowMatrixXd, std::vector<std::vector<int>>, compas::RowMatrix
     const std::vector<std::vector<int>>& pattern_f,
     bool clip_boundaries,
     bool simplify_borders,
-    std::vector<int>& fixed_points,
+    std::vector<int>& fixed_vertices,
     double tolerance = 1e-6
 );