Fix mixup w/ wmOperator/BMOperator flag
[blender-staging.git] / source / blender / editors / mesh / editmesh_bisect.c
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  * The Original Code is Copyright (C) 2013 by Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Campbell Barton
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/editors/mesh/editmesh_bisect.c
27  *  \ingroup edmesh
28  */
29
30 #include "MEM_guardedalloc.h"
31
32 #include "DNA_object_types.h"
33
34 #include "BLI_math.h"
35
36 #include "BLT_translation.h"
37
38 #include "BKE_global.h"
39 #include "BKE_context.h"
40 #include "BKE_editmesh.h"
41 #include "BKE_report.h"
42
43 #include "RNA_define.h"
44 #include "RNA_access.h"
45
46 #include "WM_api.h"
47 #include "WM_types.h"
48
49 #include "ED_mesh.h"
50 #include "ED_screen.h"
51 #include "ED_view3d.h"
52
53
54 #include "mesh_intern.h"  /* own include */
55
56 static int mesh_bisect_exec(bContext *C, wmOperator *op);
57
58 /* -------------------------------------------------------------------- */
59 /* Model Helpers */
60
61 typedef struct {
62         /* modal only */
63         BMBackup mesh_backup;
64         bool is_first;
65         short twtype;
66 } BisectData;
67
68 static bool mesh_bisect_interactive_calc(
69         bContext *C, wmOperator *op,
70         BMEditMesh *em,
71         float plane_co[3], float plane_no[3])
72 {
73         wmGesture *gesture = op->customdata;
74         BisectData *opdata;
75
76         ARegion *ar = CTX_wm_region(C);
77         RegionView3D *rv3d = ar->regiondata;
78
79         int x_start = RNA_int_get(op->ptr, "xstart");
80         int y_start = RNA_int_get(op->ptr, "ystart");
81         int x_end = RNA_int_get(op->ptr, "xend");
82         int y_end = RNA_int_get(op->ptr, "yend");
83
84         /* reference location (some point in front of the view) for finding a point on a plane */
85         const float *co_ref = rv3d->ofs;
86         float co_a_ss[2] = {x_start, y_start}, co_b_ss[2] = {x_end, y_end}, co_delta_ss[2];
87         float co_a[3], co_b[3];
88         const float zfac = ED_view3d_calc_zfac(rv3d, co_ref, NULL);
89
90         opdata = gesture->userdata;
91
92         /* view vector */
93         ED_view3d_win_to_vector(ar, co_a_ss, co_a);
94
95         /* view delta */
96         sub_v2_v2v2(co_delta_ss, co_a_ss, co_b_ss);
97         ED_view3d_win_to_delta(ar, co_delta_ss, co_b, zfac);
98
99         /* cross both to get a normal */
100         cross_v3_v3v3(plane_no, co_a, co_b);
101         normalize_v3(plane_no);  /* not needed but nicer for user */
102
103         /* point on plane, can use either start or endpoint */
104         ED_view3d_win_to_3d(ar, co_ref, co_a_ss, plane_co);
105
106         if (opdata->is_first == false)
107                 EDBM_redo_state_restore(opdata->mesh_backup, em, false);
108
109         opdata->is_first = false;
110
111         return true;
112 }
113
114 static int mesh_bisect_invoke(bContext *C, wmOperator *op, const wmEvent *event)
115 {
116         Object *obedit = CTX_data_edit_object(C);
117         BMEditMesh *em = BKE_editmesh_from_object(obedit);
118         int ret;
119
120         if (em->bm->totedgesel == 0) {
121                 BKE_report(op->reports, RPT_ERROR, "Selected edges/faces required");
122                 return OPERATOR_CANCELLED;
123         }
124
125         /* if the properties are set or there is no rv3d,
126          * skip model and exec immediately */
127
128         if ((CTX_wm_region_view3d(C) == NULL) ||
129             (RNA_struct_property_is_set(op->ptr, "plane_co") &&
130              RNA_struct_property_is_set(op->ptr, "plane_no")))
131         {
132                 return mesh_bisect_exec(C, op);
133         }
134
135         ret = WM_gesture_straightline_invoke(C, op, event);
136         if (ret & OPERATOR_RUNNING_MODAL) {
137                 View3D *v3d = CTX_wm_view3d(C);
138
139                 wmGesture *gesture = op->customdata;
140                 BisectData *opdata;
141
142
143                 opdata = MEM_mallocN(sizeof(BisectData), "inset_operator_data");
144                 opdata->mesh_backup = EDBM_redo_state_store(em);
145                 opdata->is_first = true;
146                 gesture->userdata = opdata;
147
148                 /* misc other vars */
149                 G.moving = G_TRANSFORM_EDIT;
150                 opdata->twtype = v3d->twtype;
151                 v3d->twtype = 0;
152
153                 /* initialize modal callout */
154                 ED_area_headerprint(CTX_wm_area(C), IFACE_("LMB: Click and drag to draw cut line"));
155         }
156         return ret;
157 }
158
159 static void edbm_bisect_exit(bContext *C, BisectData *opdata)
160 {
161         View3D *v3d = CTX_wm_view3d(C);
162         EDBM_redo_state_free(&opdata->mesh_backup, NULL, false);
163         v3d->twtype = opdata->twtype;
164         G.moving = 0;
165 }
166
167 static int mesh_bisect_modal(bContext *C, wmOperator *op, const wmEvent *event)
168 {
169         wmGesture *gesture = op->customdata;
170         BisectData *opdata = gesture->userdata;
171         BisectData opdata_back = *opdata;  /* annoyance, WM_gesture_straightline_modal, frees */
172         int ret;
173
174         ret = WM_gesture_straightline_modal(C, op, event);
175
176         /* update or clear modal callout */
177         if (event->type == EVT_MODAL_MAP) {
178                 if (event->val == GESTURE_MODAL_BEGIN) {
179                         ED_area_headerprint(CTX_wm_area(C), IFACE_("LMB: Release to confirm cut line"));
180                 }
181                 else {
182                         ED_area_headerprint(CTX_wm_area(C), NULL);
183                 }
184         }
185
186         if (ret & (OPERATOR_FINISHED | OPERATOR_CANCELLED)) {
187                 edbm_bisect_exit(C, &opdata_back);
188         }
189
190         return ret;
191 }
192
193 /* End Model Helpers */
194 /* -------------------------------------------------------------------- */
195
196
197
198 static int mesh_bisect_exec(bContext *C, wmOperator *op)
199 {
200         Scene *scene = CTX_data_scene(C);
201
202         /* both can be NULL, fallbacks values are used */
203         View3D *v3d = CTX_wm_view3d(C);
204         RegionView3D *rv3d = ED_view3d_context_rv3d(C);
205
206         Object *obedit = CTX_data_edit_object(C);
207         BMEditMesh *em = BKE_editmesh_from_object(obedit);
208         BMesh *bm;
209         BMOperator bmop;
210         float plane_co[3];
211         float plane_no[3];
212         float imat[4][4];
213
214         const float thresh = RNA_float_get(op->ptr, "threshold");
215         const bool use_fill = RNA_boolean_get(op->ptr, "use_fill");
216         const bool clear_inner = RNA_boolean_get(op->ptr, "clear_inner");
217         const bool clear_outer = RNA_boolean_get(op->ptr, "clear_outer");
218
219         PropertyRNA *prop_plane_co;
220         PropertyRNA *prop_plane_no;
221
222         prop_plane_co = RNA_struct_find_property(op->ptr, "plane_co");
223         if (RNA_property_is_set(op->ptr, prop_plane_co)) {
224                 RNA_property_float_get_array(op->ptr, prop_plane_co, plane_co);
225         }
226         else {
227                 copy_v3_v3(plane_co, ED_view3d_cursor3d_get(scene, v3d));
228                 RNA_property_float_set_array(op->ptr, prop_plane_co, plane_co);
229         }
230
231         prop_plane_no = RNA_struct_find_property(op->ptr, "plane_no");
232         if (RNA_property_is_set(op->ptr, prop_plane_no)) {
233                 RNA_property_float_get_array(op->ptr, prop_plane_no, plane_no);
234         }
235         else {
236                 if (rv3d) {
237                         copy_v3_v3(plane_no, rv3d->viewinv[1]);
238                 }
239                 else {
240                         /* fallback... */
241                         plane_no[0] = plane_no[1] = 0.0f; plane_no[2] = 1.0f;
242                 }
243                 RNA_property_float_set_array(op->ptr, prop_plane_no, plane_no);
244         }
245
246
247
248         /* -------------------------------------------------------------------- */
249         /* Modal support */
250         /* Note: keep this isolated, exec can work wihout this */
251         if ((op->customdata != NULL) &&
252             mesh_bisect_interactive_calc(C, op, em, plane_co, plane_no))
253         {
254                 /* write back to the props */
255                 RNA_property_float_set_array(op->ptr, prop_plane_no, plane_no);
256                 RNA_property_float_set_array(op->ptr, prop_plane_co, plane_co);
257         }
258         /* End Modal */
259         /* -------------------------------------------------------------------- */
260
261
262
263         bm = em->bm;
264
265         invert_m4_m4(imat, obedit->obmat);
266         mul_m4_v3(imat, plane_co);
267         mul_transposed_mat3_m4_v3(obedit->obmat, plane_no);
268
269         EDBM_op_init(em, &bmop, op,
270                      "bisect_plane geom=%hvef plane_co=%v plane_no=%v dist=%f clear_inner=%b clear_outer=%b",
271                      BM_ELEM_SELECT, plane_co, plane_no, thresh, clear_inner, clear_outer);
272         BMO_op_exec(bm, &bmop);
273
274         EDBM_flag_disable_all(em, BM_ELEM_SELECT);
275
276         if (use_fill) {
277                 float normal_fill[3];
278                 BMOperator bmop_fill;
279                 BMOperator bmop_attr;
280
281                 normalize_v3_v3(normal_fill, plane_no);
282                 if (clear_outer == true && clear_inner == false) {
283                         negate_v3(normal_fill);
284                 }
285
286                 /* Fill */
287                 BMO_op_initf(
288                         bm, &bmop_fill, 0,
289                         "triangle_fill edges=%S normal=%v use_dissolve=%b",
290                         &bmop, "geom_cut.out", normal_fill, true);
291                 BMO_op_exec(bm, &bmop_fill);
292
293                 /* Copy Attributes */
294                 BMO_op_initf(bm, &bmop_attr, 0,
295                              "face_attribute_fill faces=%S use_normals=%b use_data=%b",
296                              &bmop_fill, "geom.out", false, true);
297                 BMO_op_exec(bm, &bmop_attr);
298
299                 BMO_slot_buffer_hflag_enable(bm, bmop_fill.slots_out, "geom.out", BM_FACE, BM_ELEM_SELECT, true);
300
301                 BMO_op_finish(bm, &bmop_attr);
302                 BMO_op_finish(bm, &bmop_fill);
303         }
304
305         BMO_slot_buffer_hflag_enable(bm, bmop.slots_out, "geom_cut.out", BM_VERT | BM_EDGE, BM_ELEM_SELECT, true);
306
307         if (!EDBM_op_finish(em, &bmop, op, true)) {
308                 return OPERATOR_CANCELLED;
309         }
310         else {
311                 EDBM_update_generic(em, true, true);
312                 EDBM_selectmode_flush(em);
313                 return OPERATOR_FINISHED;
314         }
315 }
316
317
318 void MESH_OT_bisect(struct wmOperatorType *ot)
319 {
320         PropertyRNA *prop;
321
322         /* identifiers */
323         ot->name = "Bisect";
324         ot->description = "Cut geometry along a plane (click-drag to define plane)";
325         ot->idname = "MESH_OT_bisect";
326
327         /* api callbacks */
328         ot->exec = mesh_bisect_exec;
329         ot->invoke = mesh_bisect_invoke;
330         ot->modal = mesh_bisect_modal;
331         ot->cancel = WM_gesture_straightline_cancel;
332         ot->poll = ED_operator_editmesh;
333
334         /* flags */
335         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
336
337
338         prop = RNA_def_float_vector(ot->srna, "plane_co", 3, NULL, -1e12f, 1e12f,
339                                     "Plane Point", "A point on the plane", -1e4f, 1e4f);
340         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
341         prop = RNA_def_float_vector(ot->srna, "plane_no", 3, NULL, -1.0f, 1.0f,
342                                     "Plane Normal", "The direction the plane points", -1.0f, 1.0f);
343         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
344
345         RNA_def_boolean(ot->srna, "use_fill", false, "Fill", "Fill in the cut");
346         RNA_def_boolean(ot->srna, "clear_inner", false, "Clear Inner", "Remove geometry behind the plane");
347         RNA_def_boolean(ot->srna, "clear_outer", false, "Clear Outer", "Remove geometry in front of the plane");
348
349         RNA_def_float(ot->srna, "threshold", 0.0001, 0.0, 10.0, "Axis Threshold", "", 0.00001, 0.1);
350
351         WM_operator_properties_gesture_straightline(ot, CURSOR_EDIT);
352 }