merge with 2.5 at r18865
[blender.git] / source / blender / bmesh / bmesh_operators.h
1 #ifndef BM_OPERATORS_H
2 #define BM_OPERATORS_H
3
4 #include "BLI_memarena.h"
5
6 #define BMOP_OPSLOT_INT                 0
7 #define BMOP_OPSLOT_FLT                 1
8 #define BMOP_OPSLOT_PNT                 2
9 #define BMOP_OPSLOT_VEC                 6
10
11 /*after BMOP_OPSLOT_VEC, everything is 
12   dynamically allocated arrays.  we
13   leave a space in the identifiers
14   for future growth.*/
15 #define BMOP_OPSLOT_INT_BUF             7
16 #define BMOP_OPSLOT_FLT_BUF             8               
17 #define BMOP_OPSLOT_PNT_BUF             9
18 #define BMOP_OPSLOT_TYPES               10
19
20 typedef struct BMOpSlot{
21         int slottype;
22         int len;
23         int index; /*index within slot array*/
24         union {
25                 int i;
26                 float f;                                        
27                 void *p;                                        
28                 float vec[3];                           /*vector*/
29                 void *buf;                              /*buffer*/
30         } data;
31 }BMOpSlot;
32
33 /*operators represent logical, executable mesh modules.*/
34 #define BMOP_MAX_SLOTS                  16              /*way more than probably needed*/
35
36 typedef struct BMOperator{
37         int type;
38         int slottype;
39         int needflag;
40         struct BMOpSlot slots[BMOP_MAX_SLOTS];
41         void (*exec)(struct BMesh *bm, struct BMOperator *op);
42         MemArena *arena;
43 }BMOperator;
44
45 /*need to refactor code to use this*/
46 typedef struct BMOpDefine {
47         int slottypes[BMOP_MAX_SLOTS];
48         void (*exec)(BMesh *bm, BMOperator *op);
49         int totslot;
50         int flag;
51 } BMOpDefine;
52
53 /*BMOpDefine->flag*/
54 //doesn't do anything at the moment.
55
56 /*API for operators*/
57 void BMO_Init_Op(struct BMOperator *op, int opcode);
58 void BMO_Exec_Op(struct BMesh *bm, struct BMOperator *op);
59 void BMO_Finish_Op(struct BMesh *bm, struct BMOperator *op);
60 BMOpSlot *BMO_GetSlot(struct BMOperator *op, int slotcode);
61 void BMO_CopySlot(struct BMOperator *source_op, struct BMOperator *dest_op, int src, int dst);
62 void BMO_Set_Float(struct BMOperator *op, int slotcode, float f);
63 void BMO_Set_Int(struct BMOperator *op, int slotcode, int i);
64 void BMO_Set_PntBuf(struct BMOperator *op, int slotcode, void *p, int len);
65 void BMO_Set_Pnt(struct BMOperator *op, int slotcode, void *p);
66 void BMO_Set_Vec(struct BMOperator *op, int slotcode, float *vec);
67 void BMO_SetFlag(struct BMesh *bm, void *element, int flag);
68 void BMO_ClearFlag(struct BMesh *bm, void *element, int flag);
69 int BMO_TestFlag(struct BMesh *bm, void *element, int flag);
70 int BMO_CountFlag(struct BMesh *bm, int flag, int type);
71 void BMO_Flag_To_Slot(struct BMesh *bm, struct BMOperator *op, int slotcode, int flag, int type);
72 void BMO_Flag_Buffer(struct BMesh *bm, struct BMOperator *op, int slotcode, int flag);
73 void BMO_HeaderFlag_To_Slot(struct BMesh *bm, struct BMOperator *op, int slotcode, int flag, int type);
74
75 /*if msg is null, then the default message for the errorcode is used*/
76 void BMOP_RaiseError(BMesh *bm, int errcode, char *msg);
77 /*returns error code or 0 if no error*/
78 int BMOP_GetError(BMesh *bm, char **msg);
79 /*returns 1 if there was an error*/
80 int BMOP_CheckError(BMesh *bm);
81 int BMOP_PopError(BMesh *bm, char **msg);
82
83 /*------ error code defines -------*/
84
85 /*error messages*/
86 #define BMERR_SELF_INTERSECTING        1
87
88 static char *bmop_error_messages[] = {
89        0,
90        "Self intersection error",
91 };
92
93 /*------------begin operator defines (see bmesh_opdefines.c too)------------*/
94 /*split op*/
95 #define BMOP_SPLIT                              0
96
97 enum {
98         BMOP_SPLIT_MULTIN,
99         BMOP_SPLIT_MULTOUT,
100         BMOP_SPLIT_TOTSLOT,
101 };
102
103 /*dupe op*/
104 #define BMOP_DUPE       1
105
106 enum {
107         BMOP_DUPE_MULTIN,
108         BMOP_DUPE_ORIG,
109         BMOP_DUPE_NEW,
110         BMOP_DUPE_TOTSLOT
111 };
112
113 /*delete op*/
114 #define BMOP_DEL        2
115
116 enum {
117         BMOP_DEL_MULTIN,
118         BMOP_DEL_CONTEXT,
119         BMOP_DEL_TOTSLOT,
120 };
121
122 #define DEL_VERTS               1
123 #define DEL_EDGES               2
124 #define DEL_ONLYFACES   3
125 #define DEL_EDGESFACES  4
126 #define DEL_FACES               5
127 #define DEL_ALL                 6
128
129 /*BMOP_DEL_CONTEXT*/
130 enum {
131         BMOP_DEL_VERTS = 1,
132         BMOP_DEL_EDGESFACES,
133         BMOP_DEL_ONLYFACES,
134         BMOP_DEL_FACES,
135         BMOP_DEL_ALL,
136 };
137
138 /*editmesh->bmesh op*/
139 #define BMOP_FROM_EDITMESH              3
140 enum {
141         BMOP_FROM_EDITMESH_EM,
142         BMOP_FROM_EDITMESH_TOTSLOT,
143 };
144
145 #define BMOP_TO_EDITMESH                4
146 /*bmesh->editmesh op*/
147 enum {
148         BMOP_TO_EDITMESH_EMOUT,
149         BMOP_TO_EDITMESH_TOTSLOT,
150 };
151
152 /*edge subdivide op*/
153 #define BMOP_ESUBDIVIDE                 5
154 enum {
155         BMOP_ESUBDIVIDE_EDGES,
156         BMOP_ESUBDIVIDE_NUMCUTS,
157         BMOP_ESUBDIVIDE_FLAG, //beauty flag in esubdivide
158         BMOP_ESUBDIVIDE_RADIUS,
159         BMOP_ESUBDIVIDE_SELACTION,
160
161         BMOP_ESUBDIVIDE_CUSTOMFILL_FACES,
162         BMOP_ESUBDIVIDE_CUSTOMFILL_PATTERNS,
163
164         BMOP_ESUBDIVIDE_PERCENT_VERTS,
165         BMOP_ESUBDIVIDE_PERCENT_VALUES,
166
167         BMOP_ESUBDIVIDE_TOTSLOT,
168 };
169 /*
170 SUBDIV_SELECT_INNER
171 SUBDIV_SELECT_ORIG
172 SUBDIV_SELECT_INNER_SEL
173 SUBDIV_SELECT_LOOPCUT
174 DOUBLEOPFILL
175 */
176
177 /*triangulate*/
178 #define BMOP_TRIANGULATE                6
179
180 enum {
181         BMOP_TRIANG_FACEIN,
182         BMOP_TRIANG_NEW_EDGES,
183         BMOP_TRIANG_NEW_FACES,
184         BMOP_TRIANG_TOTSLOT,
185 };
186
187 /*dissolve faces*/
188 #define BMOP_DISSOLVE_FACES             7
189
190 #define BMOP_DISFACES_FACEIN    0
191 #define BMOP_DISFACES_TOTSLOT   1
192
193 /*dissolve verts*/
194 #define BMOP_DISSOLVE_VERTS             8
195
196 #define BMOP_DISVERTS_VERTIN    0
197 #define BMOP_DISVERTS_TOTSLOT   1
198
199 #define BMOP_MAKE_FGONS                 9
200 #define BMOP_MAKE_FGONS_TOTSLOT 0
201
202 /*keep this updated!*/
203 #define BMOP_TOTAL_OPS                  10
204 /*-------------------------------end operator defines-------------------------------*/
205
206 extern BMOpDefine *opdefines[];
207 extern int bmesh_total_ops;
208
209 /*------specific operator helper functions-------*/
210
211 /*executes the duplicate operation, feeding elements of 
212   type flag etypeflag and header flag flag to it.  note,
213   to get more useful information (such as the mapping from
214   original to new elements) you should run the dupe op manually.*/
215 struct Object;
216
217 void BMOP_DupeFromFlag(struct BMesh *bm, int etypeflag, int flag);
218 void BM_esubdivideflag(struct Object *obedit, struct BMesh *bm, int selflag, float rad, 
219                        int flag, int numcuts, int seltype);
220 #endif