diff options
Diffstat (limited to 'source/blender/bmesh/bmesh.h')
| -rw-r--r-- | source/blender/bmesh/bmesh.h | 38 |
1 files changed, 0 insertions, 38 deletions
diff --git a/source/blender/bmesh/bmesh.h b/source/blender/bmesh/bmesh.h index 138b8b7c51f..f07320df0a8 100644 --- a/source/blender/bmesh/bmesh.h +++ b/source/blender/bmesh/bmesh.h @@ -1,6 +1,4 @@ /* - * ***** BEGIN GPL LICENSE BLOCK ***** - * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 @@ -14,10 +12,6 @@ * You should have received a copy of the GNU General Public License * 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): Geoffrey Bantle, Levi Schooley. - * - * ***** END GPL LICENSE BLOCK ***** */ #ifndef __BMESH_H__ @@ -29,8 +23,6 @@ * \addtogroup bmesh BMesh * * \brief BMesh is a non-manifold boundary representation designed to support advanced editing operations. - * - * * \section bm_structure The Structure * * BMesh stores topology in four main element structures: @@ -39,22 +31,16 @@ * - Loops - BMLoop, (stores per-face-vertex data, UV's, vertex-colors, etc) * - Edges - BMEdge * - Verts - BMVert - * - * * \subsection bm_header_flags Header Flags * Each element (vertex/edge/face/loop) in a mesh has an associated bit-field called "header flags". * * BMHeader flags should **never** be read or written to by bmesh operators (see Operators below). * * Access to header flags is done with ``BM_elem_flag_*()`` functions. - * - * * \subsection bm_faces Faces * * Faces in BMesh are stored as a circular linked list of loops. Loops store per-face-vertex data * (amongst other things outlined later in this document), and define the face boundary. - * - * * \subsection bm_loop The Loop * * Loops can be thought of as a *face-corner*, since faces don't reference verts or edges directly. @@ -70,15 +56,11 @@ * - BMLoop#e - pointer to the edge associated with this loop, * between verts ``(loop->v, loop->next->v)`` * - BMLoop#f - pointer to the face associated with this loop. - * - * * \subsection bm_two_side_face 2-Sided Faces * * There are some situations where you need 2-sided faces (e.g. a face of two vertices). * This is supported by BMesh, but note that such faces should only be used as intermediary steps, * and should not end up in the final mesh. - * - * * \subsection bm_edges_and_verts Edges and Vertices * * Edges and Vertices in BMesh are primitive structures. @@ -86,8 +68,6 @@ * \note There can be more than one edge between two vertices in BMesh, * though the rest of Blender (i.e. DNA and evaluated Mesh) does not support this. * So it should only occur temporarily during editing operations. - * - * * \subsection bm_queries Queries * * The following topological queries are available: @@ -99,21 +79,15 @@ * These are accessible through the iterator api, which is covered later in this document * * See source/blender/bmesh/bmesh_query.h for more misc. queries. - * - * * \section bm_api The BMesh API * * One of the goals of the BMesh API is to make it easy and natural to produce highly maintainable code. * Code duplication, etc are avoided where possible. - * - * * \subsection bm_iter_api Iterator API * * Most topological queries in BMesh go through an iterator API (see Queries above). * These are defined in bmesh_iterators.h. * If you can, please use the #BM_ITER_MESH, #BM_ITER_ELEM macros in bmesh_iterators.h - * - * * \subsection bm_walker_api Walker API * * Topological queries that require a stack (e.g. recursive queries) go through the Walker API, @@ -124,8 +98,6 @@ * there are additional functions you can use for topological iteration, but their meant for internal bmesh code. * * Note that the walker API supports delimiter flags, to allow the caller to flag elements not to walk past. - * - * * \subsection bm_ops Operators * * Operators are an integral part of BMesh. Unlike regular blender operators, @@ -137,8 +109,6 @@ * These slots are identified by name, using strings. * * Access to slots is done with ``BMO_slot_***()`` functions. - * - * * \subsection bm_tool_flags Tool Flags * * The BMesh API provides a set of flags for faces, edges and vertices, which are private to an operator. @@ -156,8 +126,6 @@ * They act entirely on the data inside their input slots. * For example an operator should not check the selected state of an element, * there are some exceptions to this - some operators check of a face is smooth. - * - * * \subsection bm_slot_types Slot Types * * The following slot types are available: @@ -170,14 +138,10 @@ * - vector - #BMO_OP_SLOT_VEC * - buffer - #BMO_OP_SLOT_ELEMENT_BUF - a list of verts/edges/faces. * - map - BMO_OP_SLOT_MAPPING - simple hash map. - * - * * \subsection bm_slot_iter Slot Iterators * * Access to element buffers or maps must go through the slot iterator api, defined in bmesh_operators.h. * Use #BMO_ITER where ever possible. - * - * * \subsection bm_elem_buf Element Buffers * * The element buffer slot type is used to feed elements (verts/edges/faces) to operators. @@ -186,8 +150,6 @@ * then spit out a new one; this allows operators to be chained together. * * \note Element buffers may have elements of different types within the same buffer (this is supported by the API. - * - * * \section bm_fname Function Naming Conventions * * These conventions should be used throughout the bmesh module. |