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