[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [55673] trunk/blender/source/blender/bmesh /operators: code comments: bmesh operator doxy header descriptions.

Campbell Barton ideasman42 at gmail.com
Sat Mar 30 09:54:51 CET 2013


Revision: 55673
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=55673
Author:   campbellbarton
Date:     2013-03-30 08:54:50 +0000 (Sat, 30 Mar 2013)
Log Message:
-----------
code comments: bmesh operator doxy header descriptions.

Modified Paths:
--------------
    trunk/blender/source/blender/bmesh/operators/bmo_beautify.c
    trunk/blender/source/blender/bmesh/operators/bmo_bevel.c
    trunk/blender/source/blender/bmesh/operators/bmo_connect.c
    trunk/blender/source/blender/bmesh/operators/bmo_create.c
    trunk/blender/source/blender/bmesh/operators/bmo_dissolve.c
    trunk/blender/source/blender/bmesh/operators/bmo_dupe.c
    trunk/blender/source/blender/bmesh/operators/bmo_edgeloop_fill.c
    trunk/blender/source/blender/bmesh/operators/bmo_edgenet.c
    trunk/blender/source/blender/bmesh/operators/bmo_extrude.c
    trunk/blender/source/blender/bmesh/operators/bmo_hull.c
    trunk/blender/source/blender/bmesh/operators/bmo_inset.c
    trunk/blender/source/blender/bmesh/operators/bmo_join_triangles.c
    trunk/blender/source/blender/bmesh/operators/bmo_mirror.c
    trunk/blender/source/blender/bmesh/operators/bmo_primitive.c
    trunk/blender/source/blender/bmesh/operators/bmo_removedoubles.c
    trunk/blender/source/blender/bmesh/operators/bmo_smooth_laplacian.c
    trunk/blender/source/blender/bmesh/operators/bmo_subdivide.c
    trunk/blender/source/blender/bmesh/operators/bmo_symmetrize.c
    trunk/blender/source/blender/bmesh/operators/bmo_triangulate.c
    trunk/blender/source/blender/bmesh/operators/bmo_unsubdivide.c
    trunk/blender/source/blender/bmesh/operators/bmo_wireframe.c

Modified: trunk/blender/source/blender/bmesh/operators/bmo_beautify.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_beautify.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_beautify.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,19 @@
 
 /** \file blender/bmesh/operators/bmo_beautify.c
  *  \ingroup bmesh
+ *
+ * Beautify the mesh by rotating edes between triangles
+ * to more attractive positions until no more rotations can be made.
+ *
+ * In princible this is very simple however there is the possability of
+ * going into an eternal loop where edges keep rotating.
+ * To avoid this - each edge stores a hash of it previous
+ * states so as not to rotate back.
+ *
+ * TODO
+ * - Take face normals into account.
+ * - Use a stack of rotations to perform the best onces first
+ *   similar to edge-collapse-decimate.
  */
 
 #include "BLI_math.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_bevel.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_bevel.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_bevel.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_bevel.c
  *  \ingroup bmesh
+ *
+ * Bevel wrapper around #BM_mesh_bevel
  */
 
 #include "BLI_utildefines.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_connect.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_connect.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_connect.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_connect.c
  *  \ingroup bmesh
+ *
+ * Connect verts across faces (splits faces) and bridge tool.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_create.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_create.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_create.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -15,13 +15,15 @@
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
- * Contributor(s): Joseph Eagar.
+ * Contributor(s): Joseph Eagar, Campbell Barton.
  *
  * ***** END GPL LICENSE BLOCK *****
  */
 
 /** \file blender/bmesh/operators/bmo_create.c
- *  \ingroup bmesh
+ *  \ingroup bmesh 
+ *
+ * Create faces or edges (Fkey by default).
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_dissolve.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_dissolve.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_dissolve.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_dissolve.c
  *  \ingroup bmesh
+ *
+ * Removes isolated geometry regions without creating holes in the mesh.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_dupe.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_dupe.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_dupe.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_dupe.c
  *  \ingroup bmesh
+ *
+ * Duplicate, Split, Spint operators.
  */
 
 #include "MEM_guardedalloc.h"
@@ -124,7 +126,6 @@
  *
  * Copy an existing face from one bmesh to another.
  */
-
 static BMFace *copy_face(BMOperator *op,
                          BMOpSlot *slot_facemap_out,
                          BMesh *source_mesh,
@@ -183,7 +184,6 @@
  *
  * Internal Copy function.
  */
-
 static void bmo_mesh_copy(BMOperator *op, BMesh *bm_src, BMesh *bm_dst)
 {
 
@@ -320,7 +320,6 @@
  * BMOP_DUPE_ENEW: Buffer containing pointers to the new mesh edges
  * BMOP_DUPE_FNEW: Buffer containing pointers to the new mesh faces
  */
-
 void bmo_duplicate_exec(BMesh *bm, BMOperator *op)
 {
 	BMOperator *dupeop = op;
@@ -378,11 +377,10 @@
  * BMOP_DUPE_EOUTPUT: Buffer containing pointers to the split mesh edges
  * BMOP_DUPE_FOUTPUT: Buffer containing pointers to the split mesh faces
  */
-
-#define SPLIT_INPUT 1
-
 void bmo_split_exec(BMesh *bm, BMOperator *op)
 {
+#define SPLIT_INPUT 1
+
 	BMOperator *splitop = op;
 	BMOperator dupeop;
 	BMOperator delop;
@@ -455,6 +453,8 @@
 	/* cleanup */
 	BMO_op_finish(bm, &delop);
 	BMO_op_finish(bm, &dupeop);
+
+#undef SPLIT_INPUT
 }
 
 
@@ -478,7 +478,6 @@
  * Extrude or duplicate geometry a number of times,
  * rotating and possibly translating after each step
  */
-
 void bmo_spin_exec(BMesh *bm, BMOperator *op)
 {
 	BMOperator dupop, extop;

Modified: trunk/blender/source/blender/bmesh/operators/bmo_edgeloop_fill.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_edgeloop_fill.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_edgeloop_fill.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_edgeloop_fill.c
  *  \ingroup bmesh
+ *
+ * Fill discreet edge loop(s) with faces.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_edgenet.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_edgenet.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_edgenet.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_edgenet.c
  *  \ingroup bmesh
+ *
+ * Edge-Net for filling in open edge-loops.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_extrude.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_extrude.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_extrude.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_extrude.c
  *  \ingroup bmesh
+ *
+ * Extrude faces and solidify.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_hull.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_hull.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_hull.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_hull.c
  *  \ingroup bmesh
+ *
+ * Create a convex hull using bullet physics library.
  */
 
 #ifdef WITH_BULLET

Modified: trunk/blender/source/blender/bmesh/operators/bmo_inset.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_inset.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_inset.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,11 @@
 
 /** \file blender/bmesh/operators/bmo_inset.c
  *  \ingroup bmesh
+ *
+ * Inset face regions.
+ *
+ * TODO
+ * - Inset indervidual faces.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_join_triangles.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_join_triangles.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_join_triangles.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,11 @@
 
 /** \file blender/bmesh/operators/bmo_join_triangles.c
  *  \ingroup bmesh
+ *
+ * Convert triangle to quads.
+ *
+ * TODO
+ * - convert triangles to any sided faces, not just quads.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_mirror.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_mirror.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_mirror.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_mirror.c
  *  \ingroup bmesh
+ *
+ * Basic mirror, optionally with UVs's.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_primitive.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_primitive.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_primitive.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_primitive.c
  *  \ingroup bmesh
+ *
+ * Primitive shapes.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_removedoubles.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_removedoubles.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_removedoubles.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_removedoubles.c
  *  \ingroup bmesh
+ *
+ * Welding and merging functionality.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_smooth_laplacian.c
===================================================================
--- trunk/blender/source/blender/bmesh/operators/bmo_smooth_laplacian.c	2013-03-29 16:17:22 UTC (rev 55672)
+++ trunk/blender/source/blender/bmesh/operators/bmo_smooth_laplacian.c	2013-03-30 08:54:50 UTC (rev 55673)
@@ -22,6 +22,8 @@
 
 /** \file blender/bmesh/operators/bmo_smooth_laplacian.c
  *  \ingroup bmesh
+ *
+ * Advanced smoothing.
  */
 
 #include "MEM_guardedalloc.h"

Modified: trunk/blender/source/blender/bmesh/operators/bmo_subdivide.c
===================================================================

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list