Cleanup: comments
[blender.git] / source / blender / bmesh / intern / bmesh_operator_api.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_OPERATOR_API_H__
18 #define __BMESH_OPERATOR_API_H__
19
20 /** \file \ingroup bmesh
21  */
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 #include "BLI_ghash.h"
28
29 #include <stdarg.h>
30
31 /**
32  * operators represent logical, executable mesh modules.  all topological
33  * operations involving a bmesh has to go through them.
34  *
35  * operators are nested, as are tool flags, which are private to an operator
36  * when it's executed.  tool flags are allocated in layers, one per operator
37  * execution, and are used for all internal flagging a tool needs to do.
38  *
39  * each operator has a series of "slots" which can be of the following types:
40  * - simple numerical types
41  * - arrays of elements (e.g. arrays of faces).
42  * - hash mappings.
43  *
44  * each slot is identified by a slot code, as are each operator.
45  * operators, and their slots, are defined in bmesh_opdefines.c (with their
46  * execution functions prototyped in bmesh_operators_private.h), with all their
47  * operator code and slot codes defined in bmesh_operators.h.  see
48  * bmesh_opdefines.c and the BMOpDefine struct for how to define new operators.
49  *
50  * in general, operators are fed arrays of elements, created using either
51  * #BMO_slot_buffer_from_hflag or #BMO_slot_buffer_from_flag
52  * (or through one of the format specifiers in #BMO_op_callf or #BMO_op_initf).
53  *
54  * \note multiple element types (e.g. faces and edges)
55  * can be fed to the same slot array.  Operators act on this data,
56  * and possibly spit out data into output slots.
57  *
58  * \note operators should never read from header flags (e.g. element->head.flag).
59  * For example, if you want an operator to only operate on selected faces, you
60  * should use #BMO_slot_buffer_from_hflag to put the selected elements into a slot.
61  *
62  * \note when you read from an element slot array or mapping, you can either tool-flag
63  * all the elements in it, or read them using an iterator API (which is semantically
64  * similar to the iterator api in bmesh_iterators.h).
65  *
66  * \note only #BMLoop items can't be put into slots as with verts, edges & faces.
67  */
68
69 struct GHashIterator;
70
71 BLI_INLINE BMFlagLayer *BMO_elem_flag_from_header(BMHeader *ele_head)
72 {
73         switch (ele_head->htype) {
74                 case BM_VERT: return ((BMVert_OFlag *)ele_head)->oflags;
75                 case BM_EDGE: return ((BMEdge_OFlag *)ele_head)->oflags;
76                 default:      return ((BMFace_OFlag *)ele_head)->oflags;
77         }
78 }
79
80 #define BMO_elem_flag_test(bm, ele, oflag) \
81         _bmo_elem_flag_test(bm, BMO_elem_flag_from_header(&(ele)->head), oflag)
82 #define BMO_elem_flag_test_bool(bm, ele, oflag) \
83         _bmo_elem_flag_test_bool(bm, BMO_elem_flag_from_header(&(ele)->head), oflag)
84 #define BMO_elem_flag_enable(bm, ele, oflag) \
85         _bmo_elem_flag_enable(bm, (BM_CHECK_TYPE_ELEM_NONCONST(ele), BMO_elem_flag_from_header(&(ele)->head)), oflag)
86 #define BMO_elem_flag_disable(bm, ele, oflag) \
87         _bmo_elem_flag_disable(bm, (BM_CHECK_TYPE_ELEM_NONCONST(ele), BMO_elem_flag_from_header(&(ele)->head)), oflag)
88 #define BMO_elem_flag_set(bm, ele, oflag, val) \
89         _bmo_elem_flag_set(bm, (BM_CHECK_TYPE_ELEM_NONCONST(ele), BMO_elem_flag_from_header(&(ele)->head)), oflag, val)
90 #define BMO_elem_flag_toggle(bm, ele, oflag) \
91         _bmo_elem_flag_toggle(bm, (BM_CHECK_TYPE_ELEM_NONCONST(ele), BMO_elem_flag_from_header(&(ele)->head)), oflag)
92
93 /* take care not to instansiate args multiple times */
94 #ifdef __GNUC___
95 #define _BMO_CAST_V_CONST(e) ({ typeof(e) _e = e; \
96         (BM_CHECK_TYPE_VERT(_e), BLI_assert(((const BMHeader *)_e)->htype == BM_VERT), (const BMVert_OFlag *)_e); })
97 #define _BMO_CAST_E_CONST(e) ({ typeof(e) _e = e; \
98         (BM_CHECK_TYPE_EDGE(_e), BLI_assert(((const BMHeader *)_e)->htype == BM_EDGE), (const BMEdge_OFlag *)_e); })
99 #define _BMO_CAST_F_CONST(e) ({ typeof(e) _e = e; \
100         (BM_CHECK_TYPE_FACE(_e), BLI_assert(((const BMHeader *)_e)->htype == BM_FACE), (const BMFace_OFlag *)_e); })
101 #define _BMO_CAST_V(e) ({ typeof(e) _e = e; \
102         (BM_CHECK_TYPE_VERT_NONCONST(_e), BLI_assert(((BMHeader *)_e)->htype == BM_VERT), (BMVert_OFlag *)_e); })
103 #define _BMO_CAST_E(e) ({ typeof(e) _e = e; \
104         (BM_CHECK_TYPE_EDGE_NONCONST(_e), BLI_assert(((BMHeader *)_e)->htype == BM_EDGE), (BMEdge_OFlag *)_e); })
105 #define _BMO_CAST_F(e) ({ typeof(e) _e = e; \
106         (BM_CHECK_TYPE_FACE_NONCONST(_e), BLI_assert(((BMHeader *)_e)->htype == BM_FACE), (BMFace_OFlag *)_e); })
107 #else
108 #define _BMO_CAST_V_CONST(e) (BM_CHECK_TYPE_VERT(e), (const BMVert_OFlag *)e)
109 #define _BMO_CAST_E_CONST(e) (BM_CHECK_TYPE_EDGE(e), (const BMEdge_OFlag *)e)
110 #define _BMO_CAST_F_CONST(e) (BM_CHECK_TYPE_FACE(e), (const BMFace_OFlag *)e)
111 #define _BMO_CAST_V(e) (BM_CHECK_TYPE_VERT_NONCONST(e), (BMVert_OFlag *)e)
112 #define _BMO_CAST_E(e) (BM_CHECK_TYPE_EDGE_NONCONST(e), (BMEdge_OFlag *)e)
113 #define _BMO_CAST_F(e) (BM_CHECK_TYPE_FACE_NONCONST(e), (BMFace_OFlag *)e)
114 #endif
115
116 #define BMO_vert_flag_test(     bm, e, oflag)      _bmo_elem_flag_test     (bm, _BMO_CAST_V_CONST(e)->oflags, oflag)
117 #define BMO_vert_flag_test_bool(bm, e, oflag)      _bmo_elem_flag_test_bool(bm, _BMO_CAST_V_CONST(e)->oflags, oflag)
118 #define BMO_vert_flag_enable(   bm, e, oflag)      _bmo_elem_flag_enable   (bm, _BMO_CAST_V(e)->oflags, oflag)
119 #define BMO_vert_flag_disable(  bm, e, oflag)      _bmo_elem_flag_disable  (bm, _BMO_CAST_V(e)->oflags, oflag)
120 #define BMO_vert_flag_set(      bm, e, oflag, val) _bmo_elem_flag_set      (bm, _BMO_CAST_V(e)->oflags, oflag, val)
121 #define BMO_vert_flag_toggle(   bm, e, oflag)      _bmo_elem_flag_toggle   (bm, _BMO_CAST_V(e)->oflags, oflag)
122
123 #define BMO_edge_flag_test(     bm, e, oflag)      _bmo_elem_flag_test     (bm, _BMO_CAST_E_CONST(e)->oflags, oflag)
124 #define BMO_edge_flag_test_bool(bm, e, oflag)      _bmo_elem_flag_test_bool(bm, _BMO_CAST_E_CONST(e)->oflags, oflag)
125 #define BMO_edge_flag_enable(   bm, e, oflag)      _bmo_elem_flag_enable   (bm, _BMO_CAST_E(e)->oflags, oflag)
126 #define BMO_edge_flag_disable(  bm, e, oflag)      _bmo_elem_flag_disable  (bm, _BMO_CAST_E(e)->oflags, oflag)
127 #define BMO_edge_flag_set(      bm, e, oflag, val) _bmo_elem_flag_set      (bm, _BMO_CAST_E(e)->oflags, oflag, val)
128 #define BMO_edge_flag_toggle(   bm, e, oflag)      _bmo_elem_flag_toggle   (bm, _BMO_CAST_E(e)->oflags, oflag)
129
130 #define BMO_face_flag_test(     bm, e, oflag)      _bmo_elem_flag_test     (bm, _BMO_CAST_F_CONST(e)->oflags, oflag)
131 #define BMO_face_flag_test_bool(bm, e, oflag)      _bmo_elem_flag_test_bool(bm, _BMO_CAST_F_CONST(e)->oflags, oflag)
132 #define BMO_face_flag_enable(   bm, e, oflag)      _bmo_elem_flag_enable   (bm, _BMO_CAST_F(e)->oflags, oflag)
133 #define BMO_face_flag_disable(  bm, e, oflag)      _bmo_elem_flag_disable  (bm, _BMO_CAST_F(e)->oflags, oflag)
134 #define BMO_face_flag_set(      bm, e, oflag, val) _bmo_elem_flag_set      (bm, _BMO_CAST_F(e)->oflags, oflag, val)
135 #define BMO_face_flag_toggle(   bm, e, oflag)      _bmo_elem_flag_toggle   (bm, _BMO_CAST_F(e)->oflags, oflag)
136
137 BLI_INLINE short _bmo_elem_flag_test(     BMesh *bm, const BMFlagLayer *oflags, const short oflag);
138 BLI_INLINE bool  _bmo_elem_flag_test_bool(BMesh *bm, const BMFlagLayer *oflags, const short oflag);
139 BLI_INLINE void  _bmo_elem_flag_enable(   BMesh *bm, BMFlagLayer *oflags, const short oflag);
140 BLI_INLINE void  _bmo_elem_flag_disable(  BMesh *bm, BMFlagLayer *oflags, const short oflag);
141 BLI_INLINE void  _bmo_elem_flag_set(      BMesh *bm, BMFlagLayer *oflags, const short oflag, int val);
142 BLI_INLINE void  _bmo_elem_flag_toggle(   BMesh *bm, BMFlagLayer *oflags, const short oflag);
143
144 /* slot type arrays are terminated by the last member
145  * having a slot type of 0 */
146 typedef enum eBMOpSlotType {
147         /* BMO_OP_SLOT_SENTINEL = 0, */
148         BMO_OP_SLOT_BOOL = 1,
149         BMO_OP_SLOT_INT = 2,
150         BMO_OP_SLOT_FLT = 3,
151
152         /* normally store pointers to object, scene,
153          * _never_ store arrays corresponding to mesh elements with this */
154         BMO_OP_SLOT_PTR = 4,  /* requres subtype BMO_OP_SLOT_SUBTYPE_PTR_xxx */
155         BMO_OP_SLOT_MAT = 5,
156         BMO_OP_SLOT_VEC = 8,
157
158         /* after BMO_OP_SLOT_VEC, everything is dynamically allocated arrays.
159          * We leave a space in the identifiers for future growth.
160          *
161          * it's very important this remain a power of two */
162         BMO_OP_SLOT_ELEMENT_BUF = 9, /* list of verts/edges/faces */
163         BMO_OP_SLOT_MAPPING = 10 /* simple hash map, requres subtype BMO_OP_SLOT_SUBTYPE_MAP_xxx */
164 } eBMOpSlotType;
165 #define BMO_OP_SLOT_TOTAL_TYPES 11
166
167 /* don't overlap values to avoid confusion */
168 typedef enum eBMOpSlotSubType_Elem {
169         /* use as flags */
170         BMO_OP_SLOT_SUBTYPE_ELEM_VERT = BM_VERT,
171         BMO_OP_SLOT_SUBTYPE_ELEM_EDGE = BM_EDGE,
172         BMO_OP_SLOT_SUBTYPE_ELEM_FACE = BM_FACE,
173         BMO_OP_SLOT_SUBTYPE_ELEM_IS_SINGLE = (BM_FACE << 1),
174 } eBMOpSlotSubType_Elem;
175 typedef enum eBMOpSlotSubType_Map {
176         BMO_OP_SLOT_SUBTYPE_MAP_EMPTY    = 64,  /* use as a set(), unused value */
177         BMO_OP_SLOT_SUBTYPE_MAP_ELEM     = 65,
178         BMO_OP_SLOT_SUBTYPE_MAP_FLT      = 66,
179         BMO_OP_SLOT_SUBTYPE_MAP_INT      = 67,
180         BMO_OP_SLOT_SUBTYPE_MAP_BOOL     = 68,
181         BMO_OP_SLOT_SUBTYPE_MAP_INTERNAL = 69,  /* python can't convert these */
182 } eBMOpSlotSubType_Map;
183 typedef enum eBMOpSlotSubType_Ptr {
184         BMO_OP_SLOT_SUBTYPE_PTR_BMESH  = 100,
185         BMO_OP_SLOT_SUBTYPE_PTR_SCENE  = 101,
186         BMO_OP_SLOT_SUBTYPE_PTR_OBJECT = 102,
187         BMO_OP_SLOT_SUBTYPE_PTR_MESH   = 103,
188 } eBMOpSlotSubType_Ptr;
189 typedef enum eBMOpSlotSubType_Int {
190         BMO_OP_SLOT_SUBTYPE_INT_ENUM = 200,
191         BMO_OP_SLOT_SUBTYPE_INT_FLAG = 201,
192 } eBMOpSlotSubType_Int;
193
194 typedef union eBMOpSlotSubType_Union {
195         eBMOpSlotSubType_Elem elem;
196         eBMOpSlotSubType_Ptr ptr;
197         eBMOpSlotSubType_Map map;
198         eBMOpSlotSubType_Int intg;
199 } eBMOpSlotSubType_Union;
200
201 typedef struct BMO_FlagSet {
202         int value;
203         const char *identifier;
204 } BMO_FlagSet;
205
206 /* please ignore all these structures, don't touch them in tool code, except
207  * for when your defining an operator with BMOpDefine.*/
208
209 typedef struct BMOpSlot {
210         const char *slot_name;  /* pointer to BMOpDefine.slot_args */
211         eBMOpSlotType          slot_type;
212         eBMOpSlotSubType_Union slot_subtype;
213
214         int len;
215 //      int flag;  /* UNUSED */
216 //      int index; /* index within slot array */  /* UNUSED */
217         union {
218                 int i;
219                 float f;
220                 void *p;
221                 float vec[3];
222                 void **buf;
223                 GHash *ghash;
224                 struct {
225                         /** Don't clobber (i) when assigning flags, see #eBMOpSlotSubType_Int. */
226                         int _i;
227                         BMO_FlagSet *flags;
228                 } enum_data;
229         } data;
230 } BMOpSlot;
231
232 /* mainly for use outside bmesh internal code */
233 #define BMO_SLOT_AS_BOOL(slot)         ((slot)->data.i)
234 #define BMO_SLOT_AS_INT(slot)          ((slot)->data.i)
235 #define BMO_SLOT_AS_FLOAT(slot)        ((slot)->data.f)
236 #define BMO_SLOT_AS_VECTOR(slot)       ((slot)->data.vec)
237 #define BMO_SLOT_AS_MATRIX(slot )      ((float (*)[4])((slot)->data.p))
238 #define BMO_SLOT_AS_BUFFER(slot )      ((slot)->data.buf)
239 #define BMO_SLOT_AS_GHASH(slot )       ((slot)->data.ghash)
240
241 #define BMO_ASSERT_SLOT_IN_OP(slot, op) \
242         BLI_assert(((slot >= (op)->slots_in)  && (slot < &(op)->slots_in[BMO_OP_MAX_SLOTS])) || \
243                    ((slot >= (op)->slots_out) && (slot < &(op)->slots_out[BMO_OP_MAX_SLOTS])))
244
245 /* way more than probably needed, compiler complains if limit hit */
246 #define BMO_OP_MAX_SLOTS 20
247
248 /* BMOpDefine->type_flag */
249 typedef enum {
250         BMO_OPTYPE_FLAG_NOP                 = 0,
251         BMO_OPTYPE_FLAG_UNTAN_MULTIRES      = (1 << 0),  /* switch from multires tangent space to absolute coordinates */
252         BMO_OPTYPE_FLAG_NORMALS_CALC        = (1 << 1),
253         BMO_OPTYPE_FLAG_SELECT_FLUSH        = (1 << 2),
254         BMO_OPTYPE_FLAG_SELECT_VALIDATE     = (1 << 3),
255         BMO_OPTYPE_FLAG_INVALIDATE_CLNOR_ALL = (1 << 4),
256 } BMOpTypeFlag;
257
258 typedef struct BMOperator {
259         struct BMOpSlot slots_in[BMO_OP_MAX_SLOTS];
260         struct BMOpSlot slots_out[BMO_OP_MAX_SLOTS];
261         void (*exec)(BMesh *bm, struct BMOperator *op);
262         struct MemArena *arena;
263         int type;
264         BMOpTypeFlag type_flag;
265         int flag;  /* runtime options */
266 } BMOperator;
267
268 enum {
269         BMO_FLAG_RESPECT_HIDE = 1,
270 };
271
272 #define BMO_FLAG_DEFAULTS  BMO_FLAG_RESPECT_HIDE
273
274 #define MAX_SLOTNAME    32
275
276 typedef struct BMOSlotType {
277         char name[MAX_SLOTNAME];
278         eBMOpSlotType          type;
279         eBMOpSlotSubType_Union subtype;
280         BMO_FlagSet            *enum_flags;
281 } BMOSlotType;
282
283 typedef struct BMOpDefine {
284         const char *opname;
285         BMOSlotType slot_types_in[BMO_OP_MAX_SLOTS];
286         BMOSlotType slot_types_out[BMO_OP_MAX_SLOTS];
287         void (*exec)(BMesh *bm, BMOperator *op);
288         BMOpTypeFlag type_flag;
289 } BMOpDefine;
290
291 /*------------- Operator API --------------*/
292
293 /* data types that use pointers (arrays, etc) should never
294  * have it set directly.  and never use BMO_slot_ptr_set to
295  * pass in a list of edges or any arrays, really.*/
296
297 void BMO_op_init(BMesh *bm, BMOperator *op, const int flag, const char *opname);
298
299 /* executes an operator, pushing and popping a new tool flag
300  * layer as appropriate.*/
301 void BMO_op_exec(BMesh *bm, BMOperator *op);
302
303 /* finishes an operator (though note the operator's tool flag is removed
304  * after it finishes executing in BMO_op_exec).*/
305 void BMO_op_finish(BMesh *bm, BMOperator *op);
306
307 /* count the number of elements with the specified flag enabled.
308  * type can be a bitmask of BM_FACE, BM_EDGE, or BM_FACE. */
309 int BMO_mesh_enabled_flag_count(BMesh *bm, const char htype, const short oflag);
310
311 /* count the number of elements with the specified flag disabled.
312  * type can be a bitmask of BM_FACE, BM_EDGE, or BM_FACE. */
313 int BMO_mesh_disabled_flag_count(BMesh *bm, const char htype, const short oflag);
314
315 /*---------formatted operator initialization/execution-----------*/
316 void BMO_push(BMesh *bm, BMOperator *op);
317 void BMO_pop(BMesh *bm);
318
319 /*executes an operator*/
320 bool BMO_op_callf(BMesh *bm, const int flag, const char *fmt, ...);
321
322 /* initializes, but doesn't execute an operator.  this is so you can
323  * gain access to the outputs of the operator.  note that you have
324  * to execute/finish (BMO_op_exec and BMO_op_finish) yourself. */
325 bool BMO_op_initf(BMesh *bm, BMOperator *op, const int flag, const char *fmt, ...);
326
327 /* va_list version, used to implement the above two functions,
328  * plus EDBM_op_callf in editmesh_utils.c. */
329 bool BMO_op_vinitf(BMesh *bm, BMOperator *op, const int flag, const char *fmt, va_list vlist);
330
331 /* test whether a named slot exists */
332 bool BMO_slot_exists(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *identifier);
333
334 /* get a pointer to a slot.  this may be removed layer on from the public API. */
335 BMOpSlot *BMO_slot_get(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *identifier);
336
337 /* copies the data of a slot from one operator to another.  src and dst are the
338  * source/destination slot codes, respectively. */
339 #define BMO_slot_copy(op_src, slots_src, slot_name_src,                       \
340                       op_dst, slots_dst, slot_name_dst)                       \
341         _bmo_slot_copy((op_src)->slots_src, slot_name_src,                        \
342                        (op_dst)->slots_dst, slot_name_dst,                        \
343                        (op_dst)->arena)
344
345 void _bmo_slot_copy(
346         BMOpSlot slot_args_src[BMO_OP_MAX_SLOTS], const char *slot_name_src,
347         BMOpSlot slot_args_dst[BMO_OP_MAX_SLOTS], const char *slot_name_dst,
348         struct MemArena *arena_dst);
349
350 /* del "context" slot values, used for operator too */
351 enum {
352         DEL_VERTS = 1,
353         DEL_EDGES,
354         DEL_ONLYFACES,
355         DEL_EDGESFACES,
356         DEL_FACES,
357         /* A version of 'DEL_FACES' that keeps edges on face boundaries,
358          * allowing the surrounding edge-loop to be kept from removed face regions. */
359         DEL_FACES_KEEP_BOUNDARY,
360         DEL_ONLYTAGGED,
361 };
362
363 typedef enum {
364         BMO_SYMMETRIZE_NEGATIVE_X,
365         BMO_SYMMETRIZE_NEGATIVE_Y,
366         BMO_SYMMETRIZE_NEGATIVE_Z,
367
368         BMO_SYMMETRIZE_POSITIVE_X,
369         BMO_SYMMETRIZE_POSITIVE_Y,
370         BMO_SYMMETRIZE_POSITIVE_Z,
371 } BMO_SymmDirection;
372
373 typedef enum {
374         BMO_DELIM_NORMAL = 1 << 0,
375         BMO_DELIM_MATERIAL = 1 << 1,
376         BMO_DELIM_SEAM = 1 << 2,
377         BMO_DELIM_SHARP = 1 << 3,
378         BMO_DELIM_UV = 1 << 4,
379 } BMO_Delimit;
380
381 void BMO_op_flag_enable(BMesh *bm, BMOperator *op, const int op_flag);
382 void BMO_op_flag_disable(BMesh *bm, BMOperator *op, const int op_flag);
383
384 void  BMO_slot_float_set(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const float f);
385 float BMO_slot_float_get(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name);
386 void  BMO_slot_int_set(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const int i);
387 int   BMO_slot_int_get(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name);
388 void  BMO_slot_bool_set(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const bool i);
389 bool  BMO_slot_bool_get(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name);
390 void *BMO_slot_as_arrayN(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, int *len);
391
392
393 /* don't pass in arrays that are supposed to map to elements this way.
394  *
395  * so, e.g. passing in list of floats per element in another slot is bad.
396  * passing in, e.g. pointer to an editmesh for the conversion operator is fine
397  * though. */
398 void  BMO_slot_ptr_set(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, void *p);
399 void *BMO_slot_ptr_get(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name);
400 void  BMO_slot_vec_set(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, const float vec[3]);
401 void  BMO_slot_vec_get(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, float r_vec[3]);
402
403 /* only supports square mats */
404 /* size must be 3 or 4; this api is meant only for transformation matrices.
405  * note that internally the matrix is stored in 4x4 form, and it's safe to
406  * call whichever BMO_Get_MatXXX function you want. */
407 void BMO_slot_mat_set(BMOperator *op, BMOpSlot slot_args[BMO_OP_MAX_SLOTS],  const char *slot_name, const float *mat, int size);
408 void BMO_slot_mat4_get(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, float r_mat[4][4]);
409 void BMO_slot_mat3_get(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name, float r_mat[3][3]);
410
411 void BMO_mesh_flag_disable_all(BMesh *bm, BMOperator *op, const char htype, const short oflag);
412
413 void BMO_mesh_selected_remap(
414         BMesh *bm,
415         BMOpSlot *slot_vert_map,
416         BMOpSlot *slot_edge_map,
417         BMOpSlot *slot_face_map,
418         const bool check_select);
419
420 /* copies the values from another slot to the end of the output slot */
421 #define BMO_slot_buffer_append(op_src, slots_src, slot_name_src,              \
422                                op_dst, slots_dst, slot_name_dst)              \
423         _bmo_slot_buffer_append((op_src)->slots_src, slot_name_src,               \
424                                 (op_dst)->slots_dst, slot_name_dst,               \
425                                 (op_dst)->arena)
426 void _bmo_slot_buffer_append(
427         BMOpSlot slot_args_dst[BMO_OP_MAX_SLOTS], const char *slot_name_dst,
428         BMOpSlot slot_args_src[BMO_OP_MAX_SLOTS], const char *slot_name_src,
429         struct MemArena *arena_dst);
430
431 /* puts every element of type 'type' (which is a bitmask) with tool
432  * flag 'flag', into a slot. */
433 void BMO_slot_buffer_from_enabled_flag(
434         BMesh *bm, BMOperator *op,
435         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name,
436         const char htype, const short oflag);
437
438 /* puts every element of type 'type' (which is a bitmask) without tool
439  * flag 'flag', into a slot. */
440 void BMO_slot_buffer_from_disabled_flag(
441         BMesh *bm, BMOperator *op,
442         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name,
443         const char htype, const short oflag);
444
445 /* tool-flags all elements inside an element slot array with flag flag. */
446 void BMO_slot_buffer_flag_enable(
447         BMesh *bm,
448         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name,
449         const char htype, const short oflag);
450 /* clears tool-flag flag from all elements inside a slot array. */
451 void BMO_slot_buffer_flag_disable(
452         BMesh *bm,
453         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name,
454         const char htype, const short oflag);
455
456 /* tool-flags all elements inside an element slot array with flag flag. */
457 void BMO_slot_buffer_hflag_enable(
458         BMesh *bm,
459         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name,
460         const char htype, const char hflag, const bool do_flush);
461 /* clears tool-flag flag from all elements inside a slot array. */
462 void BMO_slot_buffer_hflag_disable(
463         BMesh *bm,
464         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name,
465         const char htype, const char hflag, const bool do_flush);
466
467 /* puts every element of type 'type' (which is a bitmask) with header
468  * flag 'flag', into a slot.  note: ignores hidden elements
469  * (e.g. elements with header flag BM_ELEM_HIDDEN set).*/
470 void BMO_slot_buffer_from_enabled_hflag(
471         BMesh *bm, BMOperator *op,
472         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name,
473         const char htype, const char hflag);
474
475 /* puts every element of type 'type' (which is a bitmask) without
476  * header flag 'flag', into a slot.  note: ignores hidden elements
477  * (e.g. elements with header flag BM_ELEM_HIDDEN set).*/
478 void BMO_slot_buffer_from_disabled_hflag(
479         BMesh *bm, BMOperator *op,
480         BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name,
481         const char htype, const char hflag);
482
483 void  BMO_slot_buffer_from_array(BMOperator *op, BMOpSlot *slot, BMHeader **ele_buffer, int ele_buffer_len);
484
485 void  BMO_slot_buffer_from_single(BMOperator *op, BMOpSlot *slot, BMHeader *ele);
486 void *BMO_slot_buffer_get_single(BMOpSlot *slot);
487
488
489 /* counts number of elements inside a slot array. */
490 int BMO_slot_buffer_count(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name);
491 int BMO_slot_map_count(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name);
492
493 void BMO_slot_map_insert(
494         BMOperator *op, BMOpSlot *slot,
495         const void *element, const void *data);
496
497 /* flags all elements in a mapping.  note that the mapping must only have
498  * bmesh elements in it.*/
499 void BMO_slot_map_to_flag(
500         BMesh *bm, BMOpSlot slot_args[BMO_OP_MAX_SLOTS],
501         const char *slot_name, const char hflag, const short oflag);
502
503 void *BMO_slot_buffer_alloc(
504         BMOperator *op, BMOpSlot slot_args[BMO_OP_MAX_SLOTS],
505         const char *slot_name, const int len);
506
507 void BMO_slot_buffer_from_all(
508         BMesh *bm, BMOperator *op, BMOpSlot slot_args[BMO_OP_MAX_SLOTS],
509         const char *slot_name, const char htype);
510
511 /**
512  * This part of the API is used to iterate over element buffer or
513  * mapping slots.
514  *
515  * for example, iterating over the faces in a slot is:
516  *
517  * \code{.c}
518  *
519  *    BMOIter oiter;
520  *    BMFace *f;
521  *
522  *    f = BMO_iter_new(&oiter, some_operator, "slot_name", BM_FACE);
523  *    for (; f; f = BMO_iter_step(&oiter)) {
524  *        // do something with the face
525  *    }
526  *
527  * another example, iterating over a mapping:
528  *    BMOIter oiter;
529  *    void *key;
530  *    void *val;
531  *
532  *    key = BMO_iter_new(&oiter, bm, some_operator, "slot_name", 0);
533  *    for (; key; key = BMO_iter_step(&oiter)) {
534  *        val = BMO_iter_map_value(&oiter);
535  *        //do something with the key/val pair
536  *        //note that val is a pointer to the val data,
537  *        //whether it's a float, pointer, whatever.
538  *        //
539  *        // so to get a pointer, for example, use:
540  *        //  *((void **)BMO_iter_map_value(&oiter));
541  *        //or something like that.
542  *    }
543  * \endcode
544  */
545
546 /* contents of this structure are private,
547  * don't directly access. */
548 typedef struct BMOIter {
549         BMOpSlot *slot;
550         int cur; //for arrays
551         GHashIterator giter;
552         void **val;
553         char restrictmask; /* bitwise '&' with BMHeader.htype */
554 } BMOIter;
555
556 void *BMO_slot_buffer_get_first(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char *slot_name);
557
558 void *BMO_iter_new(
559         BMOIter *iter,
560         BMOpSlot slot_args[BMO_OP_MAX_SLOTS],  const char *slot_name,
561         const char restrictmask);
562 void *BMO_iter_step(BMOIter *iter);
563
564 void **BMO_iter_map_value_p(BMOIter *iter);
565 void  *BMO_iter_map_value_ptr(BMOIter *iter);
566
567 float BMO_iter_map_value_float(BMOIter *iter);
568 int   BMO_iter_map_value_int(BMOIter *iter);
569 bool  BMO_iter_map_value_bool(BMOIter *iter);
570
571 #define BMO_ITER(ele, iter, slot_args, slot_name, restrict_flag)   \
572         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BMO_iter_new(iter, slot_args, slot_name, restrict_flag); \
573              ele; \
574              BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BMO_iter_step(iter))
575
576 #define BMO_ITER_INDEX(ele, iter, slot_args, slot_name, restrict_flag, i_)   \
577         for (BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BMO_iter_new(iter, slot_args, slot_name, restrict_flag), i_ = 0; \
578              ele; \
579              BM_CHECK_TYPE_ELEM_ASSIGN(ele) = BMO_iter_step(iter), i_++)
580
581 extern const int BMO_OPSLOT_TYPEINFO[BMO_OP_SLOT_TOTAL_TYPES];
582
583 int BMO_opcode_from_opname(const char *opname);
584
585 #ifdef __cplusplus
586 }
587 #endif
588
589 #endif /* __BMESH_OPERATOR_API_H__ */