0cf4f6a008fd9a91907442ead9f03954ca4d46eb
[blender.git] / source / blender / modifiers / intern / MOD_boolean_util.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) Blender Foundation
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * CSG operations. 
27  */
28
29 /** \file blender/modifiers/intern/MOD_boolean_util.c
30  *  \ingroup modifiers
31  */
32
33
34 #include "DNA_material_types.h"
35 #include "DNA_mesh_types.h"
36 #include "DNA_meshdata_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_scene_types.h"
39
40 #include "MEM_guardedalloc.h"
41
42 #include "BLI_math.h"
43 #include "BLI_utildefines.h"
44 #include "BLI_listbase.h"
45 #include "BLI_ghash.h"
46
47 #include "BKE_cdderivedmesh.h"
48 #include "BKE_depsgraph.h"
49 #include "BKE_material.h"
50 #include "BKE_mesh.h"
51 #include "BKE_object.h"
52
53 #include "CSG_BooleanOps.h"
54
55 #include "MOD_boolean_util.h"
56
57 /**
58  * Here's the vertex iterator structure used to walk through
59  * the blender vertex structure.
60  */
61
62 typedef struct {
63         DerivedMesh *dm;
64         Object *ob;
65         int pos;
66 } VertexIt;
67
68 /**
69  * Implementations of local vertex iterator functions.
70  * These describe a blender mesh to the CSG module.
71  */
72
73 static void VertexIt_Destruct(CSG_VertexIteratorDescriptor *iterator)
74 {
75         if (iterator->it) {
76                 /* deallocate memory for iterator */
77                 MEM_freeN(iterator->it);
78                 iterator->it = 0;
79         }
80         iterator->Done = NULL;
81         iterator->Fill = NULL;
82         iterator->Reset = NULL;
83         iterator->Step = NULL;
84         iterator->num_elements = 0;
85
86 }               
87
88 static int VertexIt_Done(CSG_IteratorPtr it)
89 {
90         VertexIt *iterator = (VertexIt *)it;
91         return(iterator->pos >= iterator->dm->getNumVerts(iterator->dm));
92 }
93
94 static void VertexIt_Fill(CSG_IteratorPtr it, CSG_IVertex *vert)
95 {
96         VertexIt *iterator = (VertexIt *)it;
97         MVert *verts = iterator->dm->getVertArray(iterator->dm);
98
99         float global_pos[3];
100
101         /* boolean happens in global space, transform both with obmat */
102         mul_v3_m4v3(
103             global_pos,
104             iterator->ob->obmat,
105             verts[iterator->pos].co
106             );
107
108         vert->position[0] = global_pos[0];
109         vert->position[1] = global_pos[1];
110         vert->position[2] = global_pos[2];
111 }
112
113 static void VertexIt_Step(CSG_IteratorPtr it)
114 {
115         VertexIt *iterator = (VertexIt *)it;
116         iterator->pos++;
117
118  
119 static void VertexIt_Reset(CSG_IteratorPtr it)
120 {
121         VertexIt *iterator = (VertexIt *)it;
122         iterator->pos = 0;
123 }
124
125 static void VertexIt_Construct(CSG_VertexIteratorDescriptor *output, DerivedMesh *dm, Object *ob)
126 {
127
128         VertexIt *it;
129         if (output == 0) return;
130
131         /* allocate some memory for blender iterator */
132         it = (VertexIt *)(MEM_mallocN(sizeof(VertexIt), "Boolean_VIt"));
133         if (it == 0) {
134                 return;
135         }
136         /* assign blender specific variables */
137         it->dm = dm;
138         it->ob = ob; /* needed for obmat transformations */
139
140         it->pos = 0;
141
142         /* assign iterator function pointers. */
143         output->Step = VertexIt_Step;
144         output->Fill = VertexIt_Fill;
145         output->Done = VertexIt_Done;
146         output->Reset = VertexIt_Reset;
147         output->num_elements = it->dm->getNumVerts(it->dm);
148         output->it = it;
149 }
150
151 /**
152  * Blender Face iterator
153  */
154
155 typedef struct {
156         DerivedMesh *dm;
157         int pos;
158         int offset;
159         int flip;
160 } FaceIt;
161
162 static void FaceIt_Destruct(CSG_FaceIteratorDescriptor *iterator)
163 {
164         MEM_freeN(iterator->it);
165         iterator->Done = NULL;
166         iterator->Fill = NULL;
167         iterator->Reset = NULL;
168         iterator->Step = NULL;
169         iterator->num_elements = 0;
170 }
171
172 static int FaceIt_Done(CSG_IteratorPtr it)
173 {
174         /* assume CSG_IteratorPtr is of the correct type. */
175         FaceIt *iterator = (FaceIt *)it;
176         return(iterator->pos >= iterator->dm->getNumTessFaces(iterator->dm));
177 }
178
179 static void FaceIt_Fill(CSG_IteratorPtr it, CSG_IFace *face)
180 {
181         /* assume CSG_IteratorPtr is of the correct type. */
182         FaceIt *face_it = (FaceIt *)it;
183         MFace *mfaces = face_it->dm->getTessFaceArray(face_it->dm);
184         MFace *mface = &mfaces[face_it->pos];
185
186         /* reverse face vertices if necessary */
187         face->vertex_index[1] = mface->v2;
188         if (face_it->flip == 0) {
189                 face->vertex_index[0] = mface->v1;
190                 face->vertex_index[2] = mface->v3;
191         }
192         else {
193                 face->vertex_index[2] = mface->v1;
194                 face->vertex_index[0] = mface->v3;
195         }
196         if (mface->v4) {
197                 face->vertex_index[3] = mface->v4;
198                 face->vertex_number = 4;
199         }
200         else {
201                 face->vertex_number = 3;
202         }
203
204         face->orig_face = face_it->offset + face_it->pos;
205 }
206
207 static void FaceIt_Step(CSG_IteratorPtr it)
208 {
209         FaceIt *face_it = (FaceIt *)it;
210         face_it->pos++;
211 }
212
213 static void FaceIt_Reset(CSG_IteratorPtr it)
214 {
215         FaceIt *face_it = (FaceIt *)it;
216         face_it->pos = 0;
217 }       
218
219 static void FaceIt_Construct(
220         CSG_FaceIteratorDescriptor *output, DerivedMesh *dm, int offset, Object *ob)
221 {
222         FaceIt *it;
223         if (output == 0) return;
224
225         /* allocate some memory for blender iterator */
226         it = (FaceIt *)(MEM_mallocN(sizeof(FaceIt), "Boolean_FIt"));
227         if (it == 0) {
228                 return;
229         }
230         /* assign blender specific variables */
231         it->dm = dm;
232         it->offset = offset;
233         it->pos = 0;
234
235         /* determine if we will need to reverse order of face vertices */
236         if (ob->size[0] < 0.0f) {
237                 if (ob->size[1] < 0.0f && ob->size[2] < 0.0f) {
238                         it->flip = 1;
239                 }
240                 else if (ob->size[1] >= 0.0f && ob->size[2] >= 0.0f) {
241                         it->flip = 1;
242                 }
243                 else {
244                         it->flip = 0;
245                 }
246         }
247         else {
248                 if (ob->size[1] < 0.0f && ob->size[2] < 0.0f) {
249                         it->flip = 0;
250                 }
251                 else if (ob->size[1] >= 0.0f && ob->size[2] >= 0.0f) {
252                         it->flip = 0;
253                 }
254                 else {
255                         it->flip = 1;
256                 }
257         }
258
259         /* assign iterator function pointers. */
260         output->Step = FaceIt_Step;
261         output->Fill = FaceIt_Fill;
262         output->Done = FaceIt_Done;
263         output->Reset = FaceIt_Reset;
264         output->num_elements = it->dm->getNumTessFaces(it->dm);
265         output->it = it;
266 }
267
268 static Object *AddNewBlenderMesh(Scene *scene, Base *base)
269 {
270         /* This little function adds a new mesh object to the blender object list
271          * It uses ob to duplicate data as this seems to be easier than creating
272          * a new one. This new oject contains no faces nor vertices. */
273         Mesh *old_me;
274         Base *basen;
275         Object *ob_new;
276
277         /* now create a new blender object.
278          * duplicating all the settings from the previous object
279          * to the new one. */
280         ob_new = BKE_object_copy(base->object);
281
282         /* Ok we don't want to use the actual data from the
283          * last object, the above function incremented the
284          * number of users, so decrement it here. */
285         old_me = ob_new->data;
286         old_me->id.us--;
287
288         /* Now create a new base to add into the linked list of
289          * vase objects. */
290
291         basen = MEM_mallocN(sizeof(Base), "duplibase");
292         *basen = *base;
293         BLI_addhead(&scene->base, basen);   /* addhead: anders oneindige lus */
294         basen->object = ob_new;
295         basen->flag &= ~SELECT;
296                                 
297         /* Initialize the mesh data associated with this object. */
298         ob_new->data = BKE_mesh_add("Mesh");
299
300         /* Finally assign the object type. */
301         ob_new->type = OB_MESH;
302
303         return ob_new;
304 }
305
306 static void InterpCSGFace(
307         DerivedMesh *dm, DerivedMesh *orig_dm, int index, int orig_index, int nr,
308         float mapmat[4][4])
309 {
310         float obco[3], *co[4], *orig_co[4], w[4][4];
311         MFace *mface, *orig_mface;
312         int j;
313
314         mface = CDDM_get_tessface(dm, index);
315         orig_mface = orig_dm->getTessFaceArray(orig_dm) + orig_index;
316
317         /* get the vertex coordinates from the original mesh */
318         orig_co[0] = (orig_dm->getVertArray(orig_dm) + orig_mface->v1)->co;
319         orig_co[1] = (orig_dm->getVertArray(orig_dm) + orig_mface->v2)->co;
320         orig_co[2] = (orig_dm->getVertArray(orig_dm) + orig_mface->v3)->co;
321         orig_co[3] = (orig_mface->v4) ? (orig_dm->getVertArray(orig_dm) + orig_mface->v4)->co : NULL;
322
323         /* get the vertex coordinates from the new derivedmesh */
324         co[0] = CDDM_get_vert(dm, mface->v1)->co;
325         co[1] = CDDM_get_vert(dm, mface->v2)->co;
326         co[2] = CDDM_get_vert(dm, mface->v3)->co;
327         co[3] = (nr == 4) ? CDDM_get_vert(dm, mface->v4)->co : NULL;
328
329         for (j = 0; j < nr; j++) {
330                 /* get coordinate into the space of the original mesh */
331                 if (mapmat)
332                         mul_v3_m4v3(obco, mapmat, co[j]);
333                 else
334                         copy_v3_v3(obco, co[j]);
335
336                 interp_weights_face_v3(w[j], orig_co[0], orig_co[1], orig_co[2], orig_co[3], obco);
337         }
338
339         CustomData_interp(&orig_dm->faceData, &dm->faceData, &orig_index, NULL, (float *)w, 1, index);
340 }
341
342 /* Iterate over the CSG Output Descriptors and create a new DerivedMesh
343  * from them */
344 static DerivedMesh *ConvertCSGDescriptorsToDerivedMesh(
345         CSG_FaceIteratorDescriptor *face_it,
346         CSG_VertexIteratorDescriptor *vertex_it,
347         float parinv[4][4],
348         float mapmat[4][4],
349         Material **mat,
350         int *totmat,
351         DerivedMesh *dm1,
352         Object *ob1,
353         DerivedMesh *dm2,
354         Object *ob2)
355 {
356         DerivedMesh *result, *orig_dm;
357         GHash *material_hash = NULL;
358         Mesh *me1 = (Mesh *)ob1->data;
359         Mesh *me2 = (Mesh *)ob2->data;
360         int i, *origindex_layer;
361
362         /* create a new DerivedMesh */
363         result = CDDM_new(vertex_it->num_elements, 0, face_it->num_elements, 0, 0);
364         CustomData_merge(&dm1->faceData, &result->faceData, CD_MASK_DERIVEDMESH & ~(CD_MASK_NORMAL | CD_MASK_ORIGINDEX),
365                          CD_DEFAULT, face_it->num_elements);
366         CustomData_merge(&dm2->faceData, &result->faceData, CD_MASK_DERIVEDMESH & ~(CD_MASK_NORMAL | CD_MASK_ORIGINDEX),
367                          CD_DEFAULT, face_it->num_elements);
368
369         /* step through the vertex iterators: */
370         for (i = 0; !vertex_it->Done(vertex_it->it); i++) {
371                 CSG_IVertex csgvert;
372                 MVert *mvert = CDDM_get_vert(result, i);
373
374                 /* retrieve a csg vertex from the boolean module */
375                 vertex_it->Fill(vertex_it->it, &csgvert);
376                 vertex_it->Step(vertex_it->it);
377
378                 /* we have to map the vertex coordinates back in the coordinate frame
379                  * of the resulting object, since it was computed in world space */
380                 mul_v3_m4v3(mvert->co, parinv, csgvert.position);
381         }
382
383         /* a hash table to remap materials to indices */
384         material_hash = BLI_ghash_ptr_new("CSG_mat gh");
385
386         if (mat)
387                 *totmat = 0;
388
389         origindex_layer = result->getTessFaceDataArray(result, CD_ORIGINDEX);
390
391         /* step through the face iterators */
392         for (i = 0; !face_it->Done(face_it->it); i++) {
393                 Mesh *orig_me;
394                 Object *orig_ob;
395                 Material *orig_mat;
396                 CSG_IFace csgface;
397                 MFace *mface;
398                 int orig_index, mat_nr;
399
400                 /* retrieve a csg face from the boolean module */
401                 face_it->Fill(face_it->it, &csgface);
402                 face_it->Step(face_it->it);
403
404                 /* find the original mesh and data */
405                 orig_ob = (csgface.orig_face < dm1->getNumTessFaces(dm1)) ? ob1 : ob2;
406                 orig_dm = (csgface.orig_face < dm1->getNumTessFaces(dm1)) ? dm1 : dm2;
407                 orig_me = (orig_ob == ob1) ? me1 : me2;
408                 orig_index = (orig_ob == ob1) ? csgface.orig_face : csgface.orig_face - dm1->getNumTessFaces(dm1);
409
410                 /* copy all face layers, including mface */
411                 CustomData_copy_data(&orig_dm->faceData, &result->faceData, orig_index, i, 1);
412
413                 /* set mface */
414                 mface = CDDM_get_tessface(result, i);
415                 mface->v1 = csgface.vertex_index[0];
416                 mface->v2 = csgface.vertex_index[1];
417                 mface->v3 = csgface.vertex_index[2];
418                 mface->v4 = (csgface.vertex_number == 4) ? csgface.vertex_index[3] : 0;
419
420                 /* set material, based on lookup in hash table */
421                 orig_mat = give_current_material(orig_ob, mface->mat_nr + 1);
422
423                 if (mat && orig_mat) {
424                         if (!BLI_ghash_haskey(material_hash, orig_mat)) {
425                                 mat[*totmat] = orig_mat;
426                                 mat_nr = mface->mat_nr = (*totmat)++;
427                                 BLI_ghash_insert(material_hash, orig_mat, SET_INT_IN_POINTER(mat_nr));
428                         }
429                         else
430                                 mface->mat_nr = GET_INT_FROM_POINTER(BLI_ghash_lookup(material_hash, orig_mat));
431                 }
432                 else if (orig_mat) {
433                         if (orig_ob == ob1) {
434                                 /* No need to change materian index for faces from left operand */
435                         }
436                         else {
437                                 /* for faces from right operand checn if there's needed material in left operand and if it is,
438                                  * use index of that material, otherwise fallback to first material (material with index=0) */
439                                 if (!BLI_ghash_haskey(material_hash, orig_mat)) {
440                                         int a;
441
442                                         mat_nr = 0;
443                                         for (a = 0; a < ob1->totcol; a++) {
444                                                 if (give_current_material(ob1, a + 1) == orig_mat) {
445                                                         mat_nr = a;
446                                                         break;
447                                                 }
448                                         }
449
450                                         BLI_ghash_insert(material_hash, orig_mat, SET_INT_IN_POINTER(mat_nr));
451
452                                         mface->mat_nr = mat_nr;
453                                 }
454                                 else
455                                         mface->mat_nr = GET_INT_FROM_POINTER(BLI_ghash_lookup(material_hash, orig_mat));
456                         }
457                 }
458                 else
459                         mface->mat_nr = 0;
460
461                 InterpCSGFace(result, orig_dm, i, orig_index, csgface.vertex_number,
462                               (orig_me == me2) ? mapmat : NULL);
463
464                 test_index_face(mface, &result->faceData, i, csgface.vertex_number);
465
466                 if (origindex_layer && orig_ob == ob2)
467                         origindex_layer[i] = ORIGINDEX_NONE;
468         }
469
470         if (material_hash)
471                 BLI_ghash_free(material_hash, NULL, NULL);
472
473         CDDM_calc_edges_tessface(result);
474
475         CDDM_tessfaces_to_faces(result); /*builds ngon faces from tess (mface) faces*/
476
477         /* this fixes shading issues but SHOULD NOT.
478          * TODO, find out why face normals are wrong & flicker - campbell */
479 #if 0
480         DM_debug_print(result);
481
482         CustomData_free(&result->faceData, result->numTessFaceData);
483         result->numTessFaceData = 0;
484         DM_ensure_tessface(result);
485 #endif
486
487         CDDM_calc_normals(result);
488
489         return result;
490 }
491         
492 static void BuildMeshDescriptors(
493         struct DerivedMesh *dm,
494         struct Object *ob,
495         int face_offset,
496         struct CSG_FaceIteratorDescriptor *face_it,
497         struct CSG_VertexIteratorDescriptor *vertex_it)
498 {
499         VertexIt_Construct(vertex_it, dm, ob);
500         FaceIt_Construct(face_it, dm, face_offset, ob);
501 }
502         
503 static void FreeMeshDescriptors(
504         struct CSG_FaceIteratorDescriptor *face_it,
505         struct CSG_VertexIteratorDescriptor *vertex_it)
506 {
507         VertexIt_Destruct(vertex_it);
508         FaceIt_Destruct(face_it);
509 }
510
511 static DerivedMesh *NewBooleanDerivedMesh_intern(
512         DerivedMesh *dm, struct Object *ob, DerivedMesh *dm_select, struct Object *ob_select,
513         int int_op_type, Material **mat, int *totmat)
514 {
515
516         float inv_mat[4][4];
517         float map_mat[4][4];
518
519         DerivedMesh *result = NULL;
520
521         if (dm == NULL || dm_select == NULL) return 0;
522         if (!dm->getNumTessFaces(dm) || !dm_select->getNumTessFaces(dm_select)) return 0;
523
524         /* we map the final object back into ob's local coordinate space. For this
525          * we need to compute the inverse transform from global to ob (inv_mat),
526          * and the transform from ob to ob_select for use in interpolation (map_mat) */
527         invert_m4_m4(inv_mat, ob->obmat);
528         mult_m4_m4m4(map_mat, inv_mat, ob_select->obmat);
529         invert_m4_m4(inv_mat, ob_select->obmat);
530
531         {
532                 /* interface with the boolean module:
533                  *
534                  * the idea is, we pass the boolean module verts and faces using the
535                  * provided descriptors. once the boolean operation is performed, we
536                  * get back output descriptors, from which we then build a DerivedMesh */
537
538                 CSG_VertexIteratorDescriptor vd_1, vd_2;
539                 CSG_FaceIteratorDescriptor fd_1, fd_2;
540                 CSG_OperationType op_type;
541                 CSG_BooleanOperation *bool_op;
542
543                 /* work out the operation they chose and pick the appropriate
544                  * enum from the csg module. */
545                 switch (int_op_type) {
546                         case 1: op_type = e_csg_intersection; break;
547                         case 2: op_type = e_csg_union; break;
548                         case 3: op_type = e_csg_difference; break;
549                         case 4: op_type = e_csg_classify; break;
550                         default: op_type = e_csg_intersection;
551                 }
552
553                 BuildMeshDescriptors(dm_select, ob_select, 0, &fd_1, &vd_1);
554                 BuildMeshDescriptors(dm, ob, dm_select->getNumTessFaces(dm_select), &fd_2, &vd_2);
555
556                 bool_op = CSG_NewBooleanFunction();
557
558                 /* perform the operation */
559                 if (CSG_PerformBooleanOperation(bool_op, op_type, fd_1, vd_1, fd_2, vd_2)) {
560                         CSG_VertexIteratorDescriptor vd_o;
561                         CSG_FaceIteratorDescriptor fd_o;
562
563                         CSG_OutputFaceDescriptor(bool_op, &fd_o);
564                         CSG_OutputVertexDescriptor(bool_op, &vd_o);
565
566                         /* iterate through results of operation and insert
567                          * into new object */
568                         result = ConvertCSGDescriptorsToDerivedMesh(
569                             &fd_o, &vd_o, inv_mat, map_mat, mat, totmat, dm_select, ob_select, dm, ob);
570
571                         /* free up the memory */
572                         CSG_FreeVertexDescriptor(&vd_o);
573                         CSG_FreeFaceDescriptor(&fd_o);
574                 }
575                 else
576                         printf("Unknown internal error in boolean\n");
577
578                 CSG_FreeBooleanOperation(bool_op);
579
580                 FreeMeshDescriptors(&fd_1, &vd_1);
581                 FreeMeshDescriptors(&fd_2, &vd_2);
582         }
583
584         return result;
585 }
586
587 int NewBooleanMesh(Scene *scene, Base *base, Base *base_select, int int_op_type)
588 {
589         Mesh *me_new;
590         int a, maxmat, totmat = 0;
591         Object *ob_new, *ob, *ob_select;
592         Material **mat;
593         DerivedMesh *result;
594         DerivedMesh *dm_select;
595         DerivedMesh *dm;
596
597         ob = base->object;
598         ob_select = base_select->object;
599
600         dm = mesh_get_derived_final(scene, ob, CD_MASK_BAREMESH);
601         dm_select = mesh_create_derived_view(scene, ob_select, 0); // no modifiers in editmode ??
602
603         maxmat = ob->totcol + ob_select->totcol;
604         mat = (Material **)MEM_mallocN(sizeof(Material *) * maxmat, "NewBooleanMeshMat");
605         
606         /* put some checks in for nice user feedback */
607         if (dm == NULL || dm_select == NULL) {
608                 return 0;
609         }
610
611         if (!dm->getNumTessFaces(dm) || !dm_select->getNumTessFaces(dm_select)) {
612                 MEM_freeN(mat);
613                 return -1;
614         }
615         
616         result = NewBooleanDerivedMesh_intern(dm, ob, dm_select, ob_select, int_op_type, mat, &totmat);
617
618         if (result == NULL) {
619                 MEM_freeN(mat);
620                 return 0;
621         }
622
623         /* create a new blender mesh object - using 'base' as  a template */
624         ob_new = AddNewBlenderMesh(scene, base_select);
625         me_new = ob_new->data;
626
627         DM_to_mesh(result, me_new, ob_new);
628         result->release(result);
629
630         dm->release(dm);
631         dm_select->release(dm_select);
632
633         /* add materials to object */
634         for (a = 0; a < totmat; a++)
635                 assign_material(ob_new, mat[a], a + 1, BKE_MAT_ASSIGN_USERPREF);
636
637         MEM_freeN(mat);
638
639         /* update dag */
640         DAG_id_tag_update(&ob_new->id, OB_RECALC_DATA);
641
642         return 1;
643 }
644
645 DerivedMesh *NewBooleanDerivedMesh(DerivedMesh *dm, struct Object *ob, DerivedMesh *dm_select, struct Object *ob_select,
646                                    int int_op_type)
647 {
648         return NewBooleanDerivedMesh_intern(dm, ob, dm_select, ob_select, int_op_type, NULL, NULL);
649 }