2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[blender.git] / source / blender / blenkernel / intern / booleanops.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) Blender Foundation
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * CSG operations. 
29  */
30
31 #include <string.h>
32 #include <math.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "BLI_arithb.h"
37 #include "BLI_blenlib.h"
38 #include "BLI_ghash.h"
39
40 #include "DNA_material_types.h"
41 #include "DNA_mesh_types.h"
42 #include "DNA_meshdata_types.h"
43 #include "DNA_object_types.h"
44 #include "DNA_scene_types.h"
45
46 #include "CSG_BooleanOps.h"
47
48 #include "BKE_booleanops.h"
49 #include "BKE_cdderivedmesh.h"
50 #include "BKE_customdata.h"
51 #include "BKE_depsgraph.h"
52 #include "BKE_DerivedMesh.h"
53 #include "BKE_global.h"
54 #include "BKE_library.h"
55 #include "BKE_material.h"
56 #include "BKE_mesh.h"
57 #include "BKE_object.h"
58 #include "BKE_utildefines.h"
59
60
61
62 /**
63  * Here's the vertex iterator structure used to walk through
64  * the blender vertex structure.
65  */
66
67 typedef struct {
68         DerivedMesh *dm;
69         Object *ob;
70         int pos;
71 } VertexIt;
72
73 /**
74  * Implementations of local vertex iterator functions.
75  * These describe a blender mesh to the CSG module.
76  */
77
78 static void VertexIt_Destruct(CSG_VertexIteratorDescriptor * iterator)
79 {
80         if (iterator->it) {
81                 // deallocate memory for iterator
82                 MEM_freeN(iterator->it);
83                 iterator->it = 0;
84         }
85         iterator->Done = NULL;
86         iterator->Fill = NULL;
87         iterator->Reset = NULL;
88         iterator->Step = NULL;
89         iterator->num_elements = 0;
90
91 }               
92
93 static int VertexIt_Done(CSG_IteratorPtr it)
94 {
95         VertexIt * iterator = (VertexIt *)it;
96         return(iterator->pos >= iterator->dm->getNumVerts(iterator->dm));
97 }
98
99 static void VertexIt_Fill(CSG_IteratorPtr it, CSG_IVertex *vert)
100 {
101         VertexIt * iterator = (VertexIt *)it;
102         MVert *verts = iterator->dm->getVertArray(iterator->dm);
103
104         float global_pos[3];
105
106         /* boolean happens in global space, transform both with obmat */
107         VecMat4MulVecfl(
108                 global_pos,
109                 iterator->ob->obmat, 
110                 verts[iterator->pos].co
111         );
112
113         vert->position[0] = global_pos[0];
114         vert->position[1] = global_pos[1];
115         vert->position[2] = global_pos[2];
116 }
117
118 static void VertexIt_Step(CSG_IteratorPtr it)
119 {
120         VertexIt * iterator = (VertexIt *)it;
121         iterator->pos ++;
122
123  
124 static void VertexIt_Reset(CSG_IteratorPtr it)
125 {
126         VertexIt * iterator = (VertexIt *)it;
127         iterator->pos = 0;
128 }
129
130 static void VertexIt_Construct(CSG_VertexIteratorDescriptor *output, DerivedMesh *dm, Object *ob)
131 {
132
133         VertexIt *it;
134         if (output == 0) return;
135
136         // allocate some memory for blender iterator
137         it = (VertexIt *)(MEM_mallocN(sizeof(VertexIt),"Boolean_VIt"));
138         if (it == 0) {
139                 return;
140         }
141         // assign blender specific variables
142         it->dm = dm;
143         it->ob = ob; // needed for obmat transformations 
144         
145         it->pos = 0;
146
147         // assign iterator function pointers.
148         output->Step = VertexIt_Step;
149         output->Fill = VertexIt_Fill;
150         output->Done = VertexIt_Done;
151         output->Reset = VertexIt_Reset;
152         output->num_elements = it->dm->getNumVerts(it->dm);
153         output->it = it;
154 }
155
156 /**
157  * Blender Face iterator
158  */
159
160 typedef struct {
161         DerivedMesh *dm;
162         int pos;
163         int offset;
164 } FaceIt;
165
166 static void FaceIt_Destruct(CSG_FaceIteratorDescriptor * iterator)
167 {
168         MEM_freeN(iterator->it);
169         iterator->Done = NULL;
170         iterator->Fill = NULL;
171         iterator->Reset = NULL;
172         iterator->Step = NULL;
173         iterator->num_elements = 0;
174 }
175
176 static int FaceIt_Done(CSG_IteratorPtr it)
177 {
178         // assume CSG_IteratorPtr is of the correct type.
179         FaceIt * iterator = (FaceIt *)it;
180         return(iterator->pos >= iterator->dm->getNumFaces(iterator->dm));
181 }
182
183 static void FaceIt_Fill(CSG_IteratorPtr it, CSG_IFace *face)
184 {
185         // assume CSG_IteratorPtr is of the correct type.
186         FaceIt *face_it = (FaceIt *)it;
187         MFace *mfaces = face_it->dm->getFaceArray(face_it->dm);
188         MFace *mface = &mfaces[face_it->pos];
189
190         face->vertex_index[0] = mface->v1;
191         face->vertex_index[1] = mface->v2;
192         face->vertex_index[2] = mface->v3;
193         if (mface->v4) {
194                 face->vertex_index[3] = mface->v4;
195                 face->vertex_number = 4;
196         } else {
197                 face->vertex_number = 3;
198         }
199
200         face->orig_face = face_it->offset + face_it->pos;
201 }
202
203 static void FaceIt_Step(CSG_IteratorPtr it)
204 {
205         FaceIt * face_it = (FaceIt *)it;                
206         face_it->pos ++;
207 }
208
209 static void FaceIt_Reset(CSG_IteratorPtr it)
210 {
211         FaceIt * face_it = (FaceIt *)it;                
212         face_it->pos = 0;
213 }       
214
215 static void FaceIt_Construct(
216         CSG_FaceIteratorDescriptor *output, DerivedMesh *dm, int offset)
217 {
218         FaceIt *it;
219         if (output == 0) return;
220
221         // allocate some memory for blender iterator
222         it = (FaceIt *)(MEM_mallocN(sizeof(FaceIt),"Boolean_FIt"));
223         if (it == 0) {
224                 return ;
225         }
226         // assign blender specific variables
227         it->dm = dm;
228         it->offset = offset;
229         it->pos = 0;
230
231         // assign iterator function pointers.
232         output->Step = FaceIt_Step;
233         output->Fill = FaceIt_Fill;
234         output->Done = FaceIt_Done;
235         output->Reset = FaceIt_Reset;
236         output->num_elements = it->dm->getNumFaces(it->dm);
237         output->it = it;
238 }
239
240 static Object *AddNewBlenderMesh(Scene *scene, Base *base)
241 {
242         // This little function adds a new mesh object to the blender object list
243         // It uses ob to duplicate data as this seems to be easier than creating
244         // a new one. This new oject contains no faces nor vertices.
245         Mesh *old_me;
246         Base *basen;
247         Object *ob_new;
248
249         // now create a new blender object.
250         // duplicating all the settings from the previous object
251         // to the new one.
252         ob_new= copy_object(base->object);
253
254         // Ok we don't want to use the actual data from the
255         // last object, the above function incremented the 
256         // number of users, so decrement it here.
257         old_me= ob_new->data;
258         old_me->id.us--;
259
260         // Now create a new base to add into the linked list of 
261         // vase objects.
262         
263         basen= MEM_mallocN(sizeof(Base), "duplibase");
264         *basen= *base;
265         BLI_addhead(&scene->base, basen);       /* addhead: anders oneindige lus */
266         basen->object= ob_new;
267         basen->flag &= ~SELECT;
268                                 
269         // Initialize the mesh data associated with this object.                                                
270         ob_new->data= add_mesh("Mesh");
271
272         // Finally assign the object type.
273         ob_new->type= OB_MESH;
274
275         return ob_new;
276 }
277
278 static void InterpCSGFace(
279         DerivedMesh *dm, DerivedMesh *orig_dm, int index, int orig_index, int nr,
280         float mapmat[][4])
281 {
282         float obco[3], *co[4], *orig_co[4], w[4][4];
283         MFace *mface, *orig_mface;
284         int j;
285
286         mface = CDDM_get_face(dm, index);
287         orig_mface = orig_dm->getFaceArray(orig_dm) + orig_index;
288
289         // get the vertex coordinates from the original mesh
290         orig_co[0] = (orig_dm->getVertArray(orig_dm) + orig_mface->v1)->co;
291         orig_co[1] = (orig_dm->getVertArray(orig_dm) + orig_mface->v2)->co;
292         orig_co[2] = (orig_dm->getVertArray(orig_dm) + orig_mface->v3)->co;
293         orig_co[3] = (orig_mface->v4)? (orig_dm->getVertArray(orig_dm) + orig_mface->v4)->co: NULL;
294
295         // get the vertex coordinates from the new derivedmesh
296         co[0] = CDDM_get_vert(dm, mface->v1)->co;
297         co[1] = CDDM_get_vert(dm, mface->v2)->co;
298         co[2] = CDDM_get_vert(dm, mface->v3)->co;
299         co[3] = (nr == 4)? CDDM_get_vert(dm, mface->v4)->co: NULL;
300
301         for (j = 0; j < nr; j++) {
302                 // get coordinate into the space of the original mesh
303                 if (mapmat)
304                         VecMat4MulVecfl(obco, mapmat, co[j]);
305                 else
306                         VecCopyf(obco, co[j]);
307
308                 InterpWeightsQ3Dfl(orig_co[0], orig_co[1], orig_co[2], orig_co[3], obco, w[j]);
309         }
310
311         CustomData_interp(&orig_dm->faceData, &dm->faceData, &orig_index, NULL, (float*)w, 1, index);
312 }
313
314 /* Iterate over the CSG Output Descriptors and create a new DerivedMesh
315    from them */
316 static DerivedMesh *ConvertCSGDescriptorsToDerivedMesh(
317         CSG_FaceIteratorDescriptor *face_it,
318         CSG_VertexIteratorDescriptor *vertex_it,
319         float parinv[][4],
320         float mapmat[][4],
321         Material **mat,
322         int *totmat,
323         DerivedMesh *dm1,
324         Object *ob1,
325         DerivedMesh *dm2,
326         Object *ob2)
327 {
328         DerivedMesh *result, *orig_dm;
329         GHash *material_hash = NULL;
330         Mesh *me1= (Mesh*)ob1->data;
331         Mesh *me2= (Mesh*)ob2->data;
332         int i;
333
334         // create a new DerivedMesh
335         result = CDDM_new(vertex_it->num_elements, 0, face_it->num_elements);
336         CustomData_merge(&dm1->faceData, &result->faceData, CD_MASK_DERIVEDMESH,
337                           CD_DEFAULT, face_it->num_elements); 
338         CustomData_merge(&dm2->faceData, &result->faceData, CD_MASK_DERIVEDMESH,
339                           CD_DEFAULT, face_it->num_elements); 
340
341         // step through the vertex iterators:
342         for (i = 0; !vertex_it->Done(vertex_it->it); i++) {
343                 CSG_IVertex csgvert;
344                 MVert *mvert = CDDM_get_vert(result, i);
345
346                 // retrieve a csg vertex from the boolean module
347                 vertex_it->Fill(vertex_it->it, &csgvert);
348                 vertex_it->Step(vertex_it->it);
349
350                 // we have to map the vertex coordinates back in the coordinate frame
351                 // of the resulting object, since it was computed in world space
352                 VecMat4MulVecfl(mvert->co, parinv, csgvert.position);
353         }
354
355         // a hash table to remap materials to indices
356         if (mat) {
357                 material_hash = BLI_ghash_new(BLI_ghashutil_ptrhash, BLI_ghashutil_ptrcmp);
358                 *totmat = 0;
359         }
360
361         // step through the face iterators
362         for(i = 0; !face_it->Done(face_it->it); i++) {
363                 Mesh *orig_me;
364                 Object *orig_ob;
365                 Material *orig_mat;
366                 CSG_IFace csgface;
367                 MFace *mface;
368                 int orig_index, mat_nr;
369
370                 // retrieve a csg face from the boolean module
371                 face_it->Fill(face_it->it, &csgface);
372                 face_it->Step(face_it->it);
373
374                 // find the original mesh and data
375                 orig_ob = (csgface.orig_face < dm1->getNumFaces(dm1))? ob1: ob2;
376                 orig_dm = (csgface.orig_face < dm1->getNumFaces(dm1))? dm1: dm2;
377                 orig_me = (orig_ob == ob1)? me1: me2;
378                 orig_index = (orig_ob == ob1)? csgface.orig_face: csgface.orig_face - dm1->getNumFaces(dm1);
379
380                 // copy all face layers, including mface
381                 CustomData_copy_data(&orig_dm->faceData, &result->faceData, orig_index, i, 1);
382
383                 // set mface
384                 mface = CDDM_get_face(result, i);
385                 mface->v1 = csgface.vertex_index[0];
386                 mface->v2 = csgface.vertex_index[1];
387                 mface->v3 = csgface.vertex_index[2];
388                 mface->v4 = (csgface.vertex_number == 4)? csgface.vertex_index[3]: 0;
389
390                 // set material, based on lookup in hash table
391                 orig_mat= give_current_material(orig_ob, mface->mat_nr+1);
392
393                 if (mat && orig_mat) {
394                         if (!BLI_ghash_haskey(material_hash, orig_mat)) {
395                                 mat[*totmat] = orig_mat;
396                                 mat_nr = mface->mat_nr = (*totmat)++;
397                                 BLI_ghash_insert(material_hash, orig_mat, SET_INT_IN_POINTER(mat_nr));
398                         }
399                         else
400                                 mface->mat_nr = GET_INT_FROM_POINTER(BLI_ghash_lookup(material_hash, orig_mat));
401                 }
402                 else
403                         mface->mat_nr = 0;
404
405                 InterpCSGFace(result, orig_dm, i, orig_index, csgface.vertex_number,
406                               (orig_me == me2)? mapmat: NULL);
407
408                 test_index_face(mface, &result->faceData, i, csgface.vertex_number);
409         }
410
411         if (material_hash)
412                 BLI_ghash_free(material_hash, NULL, NULL);
413
414         CDDM_calc_edges(result);
415         CDDM_calc_normals(result);
416
417         return result;
418 }
419         
420 static void BuildMeshDescriptors(
421         struct DerivedMesh *dm,
422         struct Object *ob,
423         int face_offset,
424         struct CSG_FaceIteratorDescriptor * face_it,
425         struct CSG_VertexIteratorDescriptor * vertex_it)
426 {
427         VertexIt_Construct(vertex_it,dm, ob);
428         FaceIt_Construct(face_it,dm,face_offset);
429 }
430         
431 static void FreeMeshDescriptors(
432         struct CSG_FaceIteratorDescriptor *face_it,
433         struct CSG_VertexIteratorDescriptor *vertex_it)
434 {
435         VertexIt_Destruct(vertex_it);
436         FaceIt_Destruct(face_it);
437 }
438
439 DerivedMesh *NewBooleanDerivedMesh_intern(
440         DerivedMesh *dm, struct Object *ob, DerivedMesh *dm_select, struct Object *ob_select,
441         int int_op_type, Material **mat, int *totmat)
442 {
443
444         float inv_mat[4][4];
445         float map_mat[4][4];
446
447         DerivedMesh *result = NULL;
448
449         if (dm == NULL || dm_select == NULL) return 0;
450         if (!dm->getNumFaces(dm) || !dm_select->getNumFaces(dm_select)) return 0;
451
452         // we map the final object back into ob's local coordinate space. For this
453         // we need to compute the inverse transform from global to ob (inv_mat),
454         // and the transform from ob to ob_select for use in interpolation (map_mat)
455         Mat4Invert(inv_mat, ob->obmat);
456         Mat4MulMat4(map_mat, ob_select->obmat, inv_mat);
457         Mat4Invert(inv_mat, ob_select->obmat);
458
459         {
460                 // interface with the boolean module:
461                 //
462                 // the idea is, we pass the boolean module verts and faces using the
463                 // provided descriptors. once the boolean operation is performed, we
464                 // get back output descriptors, from which we then build a DerivedMesh
465
466                 CSG_VertexIteratorDescriptor vd_1, vd_2;
467                 CSG_FaceIteratorDescriptor fd_1, fd_2;
468                 CSG_OperationType op_type;
469                 CSG_BooleanOperation *bool_op;
470
471                 // work out the operation they chose and pick the appropriate 
472                 // enum from the csg module.
473                 switch (int_op_type) {
474                         case 1 : op_type = e_csg_intersection; break;
475                         case 2 : op_type = e_csg_union; break;
476                         case 3 : op_type = e_csg_difference; break;
477                         case 4 : op_type = e_csg_classify; break;
478                         default : op_type = e_csg_intersection;
479                 }
480                 
481                 BuildMeshDescriptors(dm_select, ob_select, 0, &fd_1, &vd_1);
482                 BuildMeshDescriptors(dm, ob, dm_select->getNumFaces(dm_select) , &fd_2, &vd_2);
483
484                 bool_op = CSG_NewBooleanFunction();
485
486                 // perform the operation
487                 if (CSG_PerformBooleanOperation(bool_op, op_type, fd_1, vd_1, fd_2, vd_2)) {
488                         CSG_VertexIteratorDescriptor vd_o;
489                         CSG_FaceIteratorDescriptor fd_o;
490
491                         CSG_OutputFaceDescriptor(bool_op, &fd_o);
492                         CSG_OutputVertexDescriptor(bool_op, &vd_o);
493
494                         // iterate through results of operation and insert
495                         // into new object
496                         result = ConvertCSGDescriptorsToDerivedMesh(
497                                 &fd_o, &vd_o, inv_mat, map_mat, mat, totmat, dm_select, ob_select, dm, ob);
498
499                         // free up the memory
500                         CSG_FreeVertexDescriptor(&vd_o);
501                         CSG_FreeFaceDescriptor(&fd_o);
502                 }
503 //              else
504 // XXX                  error("Unknown internal error in boolean");
505
506                 CSG_FreeBooleanOperation(bool_op);
507
508                 FreeMeshDescriptors(&fd_1, &vd_1);
509                 FreeMeshDescriptors(&fd_2, &vd_2);
510         }
511
512         return result;
513 }
514
515 int NewBooleanMesh(Scene *scene, Base *base, Base *base_select, int int_op_type)
516 {
517         Mesh *me_new;
518         int a, maxmat, totmat= 0;
519         Object *ob_new, *ob, *ob_select;
520         Material **mat;
521         DerivedMesh *result;
522         DerivedMesh *dm_select;
523         DerivedMesh *dm;
524
525         ob= base->object;
526         ob_select= base_select->object;
527
528         dm = mesh_get_derived_final(scene, ob, CD_MASK_BAREMESH);
529         dm_select = mesh_create_derived_view(scene, ob_select, 0); // no modifiers in editmode ??
530
531         maxmat= ob->totcol + ob_select->totcol;
532         mat= (Material**)MEM_mallocN(sizeof(Material*)*maxmat, "NewBooleanMeshMat");
533         
534         /* put some checks in for nice user feedback */
535         if (dm == NULL || dm_select == NULL) return 0;
536         if (!dm->getNumFaces(dm) || !dm_select->getNumFaces(dm_select))
537         {
538                 MEM_freeN(mat);
539                 return -1;
540         }
541         
542         result= NewBooleanDerivedMesh_intern(dm, ob, dm_select, ob_select, int_op_type, mat, &totmat);
543
544         if (result == NULL) {
545                 MEM_freeN(mat);
546                 return 0;
547         }
548
549         /* create a new blender mesh object - using 'base' as  a template */
550         ob_new= AddNewBlenderMesh(scene, base_select);
551         me_new= ob_new->data;
552
553         DM_to_mesh(result, me_new);
554         result->release(result);
555
556         dm->release(dm);
557         dm_select->release(dm_select);
558
559         /* add materials to object */
560         for (a = 0; a < totmat; a++)
561                 assign_material(ob_new, mat[a], a+1);
562
563         MEM_freeN(mat);
564
565         /* update dag */
566         DAG_object_flush_update(scene, ob_new, OB_RECALC_DATA);
567
568         return 1;
569 }
570
571 DerivedMesh *NewBooleanDerivedMesh(DerivedMesh *dm, struct Object *ob, DerivedMesh *dm_select, struct Object *ob_select,
572                                    int int_op_type)
573 {
574         return NewBooleanDerivedMesh_intern(dm, ob, dm_select, ob_select, int_op_type, NULL, NULL);
575 }
576