Merge branch 'blender2.7'
[blender.git] / source / blender / bmesh / bmesh.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BMESH_H__
18 #define __BMESH_H__
19
20 /** \file \ingroup bmesh
21  *
22  * \addtogroup bmesh BMesh
23  *
24  * \brief BMesh is a non-manifold boundary representation designed to support advanced editing operations.
25  * \section bm_structure The Structure
26  *
27  * BMesh stores topology in four main element structures:
28  *
29  * - Faces - BMFace
30  * - Loops - BMLoop, (stores per-face-vertex data, UV's, vertex-colors, etc)
31  * - Edges - BMEdge
32  * - Verts - BMVert
33  * \subsection bm_header_flags Header Flags
34  * Each element (vertex/edge/face/loop) in a mesh has an associated bit-field called "header flags".
35  *
36  * BMHeader flags should **never** be read or written to by bmesh operators (see Operators below).
37  *
38  * Access to header flags is done with ``BM_elem_flag_*()`` functions.
39  * \subsection bm_faces Faces
40  *
41  * Faces in BMesh are stored as a circular linked list of loops. Loops store per-face-vertex data
42  * (amongst other things outlined later in this document), and define the face boundary.
43  * \subsection bm_loop The Loop
44  *
45  * Loops can be thought of as a *face-corner*, since faces don't reference verts or edges directly.
46  * Each loop connects the face to one of its corner vertices,
47  * and also references an edge which connects this loop's vertex to the next loop's vertex.
48  *
49  * Loops allow faces to access their verts and edges,
50  * while edges and faces store their loops, allowing access in the opposite direction too.
51  *
52  * Loop pointers:
53  *
54  * - BMLoop#v - pointer to the vertex associated with this loop.
55  * - BMLoop#e - pointer to the edge associated with this loop,
56  *   between verts ``(loop->v, loop->next->v)``
57  * - BMLoop#f - pointer to the face associated with this loop.
58  * \subsection bm_two_side_face 2-Sided Faces
59  *
60  * There are some situations where you need 2-sided faces (e.g. a face of two vertices).
61  * This is supported by BMesh, but note that such faces should only be used as intermediary steps,
62  * and should not end up in the final mesh.
63  * \subsection bm_edges_and_verts Edges and Vertices
64  *
65  * Edges and Vertices in BMesh are primitive structures.
66  *
67  * \note There can be more than one edge between two vertices in BMesh,
68  * though the rest of Blender (i.e. DNA and evaluated Mesh) does not support this.
69  * So it should only occur temporarily during editing operations.
70  * \subsection bm_queries Queries
71  *
72  * The following topological queries are available:
73  *
74  * - Edges/Faces/Loops around a vertex.
75  * - Faces around an edge.
76  * - Loops around an edge.
77  *
78  * These are accessible through the iterator api, which is covered later in this document
79  *
80  * See source/blender/bmesh/bmesh_query.h for more misc. queries.
81  * \section bm_api The BMesh API
82  *
83  * One of the goals of the BMesh API is to make it easy and natural to produce highly maintainable code.
84  * Code duplication, etc are avoided where possible.
85  * \subsection bm_iter_api Iterator API
86  *
87  * Most topological queries in BMesh go through an iterator API (see Queries above).
88  * These are defined in bmesh_iterators.h.
89  * If you can, please use the #BM_ITER_MESH, #BM_ITER_ELEM macros in bmesh_iterators.h
90  * \subsection bm_walker_api Walker API
91  *
92  * Topological queries that require a stack (e.g. recursive queries) go through the Walker API,
93  * which is defined in bmesh_walkers.h. Currently the "walkers" are hard-coded into the API,
94  * though a mechanism for plugging in new walkers needs to be added at some point.
95  *
96  * Most topological queries should go through these two APIs;
97  * there are additional functions you can use for topological iteration, but their meant for internal bmesh code.
98  *
99  * Note that the walker API supports delimiter flags, to allow the caller to flag elements not to walk past.
100  * \subsection bm_ops Operators
101  *
102  * Operators are an integral part of BMesh. Unlike regular blender operators,
103  * BMesh operators **bmo's** are designed to be nested (e.g. call other operators).
104  *
105  * Each operator has a number of input/output "slots" which are used to pass settings & data into/out of the operator
106  * (and allows for chaining operators together).
107  *
108  * These slots are identified by name, using strings.
109  *
110  * Access to slots is done with ``BMO_slot_***()`` functions.
111  * \subsection bm_tool_flags Tool Flags
112  *
113  * The BMesh API provides a set of flags for faces, edges and vertices, which are private to an operator.
114  * These flags may be used by the client operator code as needed
115  * (a common example is flagging elements for use in another operator).
116  * Each call to an operator allocates it's own set of tool flags when it's executed,
117  * avoiding flag conflicts between operators.
118  *
119  * These flags should not be confused with header flags, which are used to store persistent flags
120  * (e.g. selection, hide status, etc).
121  *
122  * Access to tool flags is done with ``BMO_elem_flag_***()`` functions.
123  *
124  * \warning Operators are **never** allowed to read or write to header flags.
125  * They act entirely on the data inside their input slots.
126  * For example an operator should not check the selected state of an element,
127  * there are some exceptions to this - some operators check of a face is smooth.
128  * \subsection bm_slot_types Slot Types
129  *
130  * The following slot types are available:
131  *
132  * - integer - #BMO_OP_SLOT_INT
133  * - boolean - #BMO_OP_SLOT_BOOL
134  * - float   - #BMO_OP_SLOT_FLT
135  * - pointer - #BMO_OP_SLOT_PTR
136  * - matrix  - #BMO_OP_SLOT_MAT
137  * - vector  - #BMO_OP_SLOT_VEC
138  * - buffer  - #BMO_OP_SLOT_ELEMENT_BUF - a list of verts/edges/faces.
139  * - map     - BMO_OP_SLOT_MAPPING - simple hash map.
140  * \subsection bm_slot_iter Slot Iterators
141  *
142  * Access to element buffers or maps must go through the slot iterator api, defined in bmesh_operators.h.
143  * Use #BMO_ITER where ever possible.
144  * \subsection bm_elem_buf Element Buffers
145  *
146  * The element buffer slot type is used to feed elements (verts/edges/faces) to operators.
147  * Internally they are stored as pointer arrays (which happily has not caused any problems so far).
148  * Many operators take in a buffer of elements, process it,
149  * then spit out a new one; this allows operators to be chained together.
150  *
151  * \note Element buffers may have elements of different types within the same buffer (this is supported by the API.
152  * \section bm_fname Function Naming Conventions
153  *
154  * These conventions should be used throughout the bmesh module.
155  *
156  * - ``bmesh_kernel_*()`` - Low level API, for primitive functions that others are built ontop of.
157  * - ``bmesh_***()`` - Low level API function.
158  * - ``bm_***()`` -     'static' functions, not apart of the API at all, but use prefix since they operate on BMesh data.
159  * - ``BM_***()`` -     High level BMesh API function for use anywhere.
160  * - ``BMO_***()`` -    High level operator API function for use anywhere.
161  * - ``bmo_***()`` -    Low level / internal operator API functions.
162  * - ``_bm_***()`` -    Functions which are called via macros only.
163  *
164  * \section bm_todo BMesh TODO's
165  *
166  * There may be a better place for this section, but adding here for now.
167  *
168  * \subsection bm_todo_optimize Optimizations
169  *
170  * - skip normal calc when its not needed (when calling chain of operators & for modifiers, flag as dirty)
171  * - skip BMO flag allocation, its not needed in many cases, this is fairly redundant to calc by default.
172  * - ability to call BMO's with option not to create return data (will save some time)
173  * - binary diff UNDO, currently this uses huge amount of ram when all shapes are stored for each undo step for eg.
174  * - use two different iterator types for BMO map/buffer types.
175  */
176
177 #ifdef __cplusplus
178 extern "C" {
179 #endif
180
181 #include "DNA_listBase.h" /* selection history uses */
182 #include "DNA_customdata_types.h" /* BMesh struct in bmesh_class.h uses */
183
184 #include <stdlib.h>
185 #include <stdio.h>
186 #include <assert.h>
187
188 #include "bmesh_class.h"
189
190 /* include the rest of the API */
191 #include "intern/bmesh_operator_api.h"
192 #include "intern/bmesh_error.h"
193
194 #include "intern/bmesh_core.h"
195 #include "intern/bmesh_callback_generic.h"
196 #include "intern/bmesh_construct.h"
197 #include "intern/bmesh_delete.h"
198 #include "intern/bmesh_edgeloop.h"
199 #include "intern/bmesh_interp.h"
200 #include "intern/bmesh_iterators.h"
201 #include "intern/bmesh_log.h"
202 #include "intern/bmesh_marking.h"
203 #include "intern/bmesh_mesh.h"
204 #include "intern/bmesh_mesh_conv.h"
205 #include "intern/bmesh_mesh_validate.h"
206 #include "intern/bmesh_mods.h"
207 #include "intern/bmesh_operators.h"
208 #include "intern/bmesh_polygon.h"
209 #include "intern/bmesh_polygon_edgenet.h"
210 #include "intern/bmesh_query.h"
211 #include "intern/bmesh_walkers.h"
212
213 #include "intern/bmesh_inline.h"
214
215 #ifdef __cplusplus
216 }
217 #endif
218
219 #endif /* __BMESH_H__ */