Minor cleanup in comments.
authorBastien Montagne <montagne29@wanadoo.fr>
Tue, 28 Apr 2015 12:15:27 +0000 (14:15 +0200)
committerBastien Montagne <montagne29@wanadoo.fr>
Tue, 28 Apr 2015 14:01:43 +0000 (16:01 +0200)
source/blender/blenkernel/intern/mesh_mapping.c

index cc5006efacb631a009c58bd5d31cc08c78a43985..37b4c5fcf8f3392966015e31100388622f4f6316 100644 (file)
@@ -180,8 +180,6 @@ void BKE_mesh_uv_vert_map_free(UvVertMap *vmap)
 }
 
 /**
-
-
  * Generates a map where the key is the vertex and the value is a list
  * of polys or loops that use that vertex as a corner. The lists are allocated
  * from one memory pool.
@@ -254,9 +252,10 @@ void BKE_mesh_vert_loop_map_create(MeshElemMap **r_map, int **r_mem,
        mesh_vert_poly_or_loop_map_create(r_map, r_mem, mpoly, mloop, totvert, totpoly, totloop, true);
 }
 
-/* Generates a map where the key is the vertex and the value is a list
- * of edges that use that vertex as an endpoint. The lists are allocated
- * from one memory pool. */
+/**
+ * Generates a map where the key is the vertex and the value is a list of edges that use that vertex as an endpoint.
+ * The lists are allocated from one memory pool.
+ */
 void BKE_mesh_vert_edge_map_create(MeshElemMap **r_map, int **r_mem,
                                    const MEdge *medge, int totvert, int totedge)
 {
@@ -296,6 +295,10 @@ void BKE_mesh_vert_edge_map_create(MeshElemMap **r_map, int **r_mem,
        *r_mem = indices;
 }
 
+/**
+ * Generates a map where the key is the edge and the value is a list of polygons that use that edge.
+ * The lists are allocated from one memory pool.
+ */
 void BKE_mesh_edge_poly_map_create(MeshElemMap **r_map, int **r_mem,
                                    const MEdge *UNUSED(medge), const int totedge,
                                    const MPoly *mpoly, const int totpoly,
@@ -403,7 +406,8 @@ void BKE_mesh_origindex_map_create(MeshElemMap **r_map, int **r_mem,
  * Used currently for UVs and 'smooth groups'.
  * \{ */
 
-/** Callback deciding whether the given poly/loop/edge define an island boundary or not.
+/**
+ * Callback deciding whether the given poly/loop/edge define an island boundary or not.
  */
 typedef bool (*MeshRemap_CheckIslandBoundary)(
         const struct MPoly *mpoly, const struct MLoop *mloop, const struct MEdge *medge,
@@ -586,8 +590,7 @@ static void poly_edge_loop_islands_calc(
 }
 
 static bool poly_is_island_boundary_smooth_cb(
-        const MPoly *mp, const MLoop *UNUSED(ml), const MEdge *me,
-        const int nbr_egde_users)
+        const MPoly *mp, const MLoop *UNUSED(ml), const MEdge *me, const int nbr_egde_users)
 {
        /* Edge is sharp if its poly is sharp, or edge itself is sharp, or edge is not used by exactly two polygons. */
        return (!(mp->flag & ME_SMOOTH) || (me->flag & ME_SHARP) || (nbr_egde_users != 2));
@@ -719,17 +722,21 @@ void BKE_mesh_loop_islands_add(
  *       not sure we want that at all!
  */
 static bool mesh_check_island_boundary_uv(
-        const MPoly *UNUSED(mp), const MLoop *UNUSED(ml), const MEdge *me,
-        const int UNUSED(nbr_egde_users))
+        const MPoly *UNUSED(mp), const MLoop *UNUSED(ml), const MEdge *me, const int UNUSED(nbr_egde_users))
 {
        /* Edge is UV boundary if tagged as seam. */
        return (me->flag & ME_SEAM) != 0;
 }
 
 /**
- * \note all this could be optimized...
- * Not sure it would be worth the more complex code, though, those loops
- * are supposed to be really quick to do...
+ * Calculate UV islands.
+ *
+ * \note Currently we only consider edges tagges as seams as UV boundaries. This has the advantages of simplicity,
+ *     and being valid/common to all UV maps. However, it means actual UV islands whithout matching UV seams
+ *     will not be handled correctly...
+ *
+ * \note All this could be optimized...
+ *     Not sure it would be worth the more complex code, though, those loops are supposed to be really quick to do...
  */
 bool BKE_mesh_calc_islands_loop_poly_uv(
         MVert *UNUSED(verts), const int UNUSED(totvert),