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