code comments: bmesh operator doxy header descriptions.

This commit is contained in:
Campbell Barton 2013-03-30 08:54:50 +00:00
parent 96c2647676
commit b1f4e2b4db
21 changed files with 71 additions and 9 deletions

View File

@ -22,6 +22,19 @@
/** \file blender/bmesh/operators/bmo_beautify.c /** \file blender/bmesh/operators/bmo_beautify.c
* \ingroup bmesh * \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" #include "BLI_math.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_bevel.c /** \file blender/bmesh/operators/bmo_bevel.c
* \ingroup bmesh * \ingroup bmesh
*
* Bevel wrapper around #BM_mesh_bevel
*/ */
#include "BLI_utildefines.h" #include "BLI_utildefines.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_connect.c /** \file blender/bmesh/operators/bmo_connect.c
* \ingroup bmesh * \ingroup bmesh
*
* Connect verts across faces (splits faces) and bridge tool.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -15,13 +15,15 @@
* along with this program; if not, write to the Free Software Foundation, * along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * 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 ***** * ***** END GPL LICENSE BLOCK *****
*/ */
/** \file blender/bmesh/operators/bmo_create.c /** \file blender/bmesh/operators/bmo_create.c
* \ingroup bmesh * \ingroup bmesh
*
* Create faces or edges (Fkey by default).
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_dissolve.c /** \file blender/bmesh/operators/bmo_dissolve.c
* \ingroup bmesh * \ingroup bmesh
*
* Removes isolated geometry regions without creating holes in the mesh.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

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

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_edgeloop_fill.c /** \file blender/bmesh/operators/bmo_edgeloop_fill.c
* \ingroup bmesh * \ingroup bmesh
*
* Fill discreet edge loop(s) with faces.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_edgenet.c /** \file blender/bmesh/operators/bmo_edgenet.c
* \ingroup bmesh * \ingroup bmesh
*
* Edge-Net for filling in open edge-loops.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_extrude.c /** \file blender/bmesh/operators/bmo_extrude.c
* \ingroup bmesh * \ingroup bmesh
*
* Extrude faces and solidify.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_hull.c /** \file blender/bmesh/operators/bmo_hull.c
* \ingroup bmesh * \ingroup bmesh
*
* Create a convex hull using bullet physics library.
*/ */
#ifdef WITH_BULLET #ifdef WITH_BULLET

View File

@ -22,6 +22,11 @@
/** \file blender/bmesh/operators/bmo_inset.c /** \file blender/bmesh/operators/bmo_inset.c
* \ingroup bmesh * \ingroup bmesh
*
* Inset face regions.
*
* TODO
* - Inset indervidual faces.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,11 @@
/** \file blender/bmesh/operators/bmo_join_triangles.c /** \file blender/bmesh/operators/bmo_join_triangles.c
* \ingroup bmesh * \ingroup bmesh
*
* Convert triangle to quads.
*
* TODO
* - convert triangles to any sided faces, not just quads.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_mirror.c /** \file blender/bmesh/operators/bmo_mirror.c
* \ingroup bmesh * \ingroup bmesh
*
* Basic mirror, optionally with UVs's.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_primitive.c /** \file blender/bmesh/operators/bmo_primitive.c
* \ingroup bmesh * \ingroup bmesh
*
* Primitive shapes.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_removedoubles.c /** \file blender/bmesh/operators/bmo_removedoubles.c
* \ingroup bmesh * \ingroup bmesh
*
* Welding and merging functionality.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_smooth_laplacian.c /** \file blender/bmesh/operators/bmo_smooth_laplacian.c
* \ingroup bmesh * \ingroup bmesh
*
* Advanced smoothing.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_subdivide.c /** \file blender/bmesh/operators/bmo_subdivide.c
* \ingroup bmesh * \ingroup bmesh
*
* Edge based subdivision with various subdivision patterns.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -20,6 +20,13 @@
* ***** END GPL LICENSE BLOCK ***** * ***** END GPL LICENSE BLOCK *****
*/ */
/** \file blender/bmesh/operators/bmo_symmetrize.c
* \ingroup bmesh
*
* Makes the mesh symmetrical by splitting along an axis and duplicating the geometry.
*/
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"
#include "BLI_array.h" #include "BLI_array.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_triangulate.c /** \file blender/bmesh/operators/bmo_triangulate.c
* \ingroup bmesh * \ingroup bmesh
*
* Triangulate faces, also defines triangle fill.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

View File

@ -22,6 +22,9 @@
/** \file blender/bmesh/operators/bmo_unsubdivide.c /** \file blender/bmesh/operators/bmo_unsubdivide.c
* \ingroup bmesh * \ingroup bmesh
*
* Pattern based geometry reduction which has the result similar to undoing
* a subdivide operation.
*/ */
#include "BLI_math.h" #include "BLI_math.h"

View File

@ -22,6 +22,8 @@
/** \file blender/bmesh/operators/bmo_wireframe.c /** \file blender/bmesh/operators/bmo_wireframe.c
* \ingroup bmesh * \ingroup bmesh
*
* Creates a solid wireframe from conected faces.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"