Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / mball.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): Jiri Hnidek <jiri.hnidek@vslib.cz>.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  *
25  * MetaBalls are created from a single Object (with a name without number in it),
26  * here the DispList and BoundBox also is located.
27  * All objects with the same name (but with a number in it) are added to this.
28  *
29  * texture coordinates are patched within the displist
30  */
31
32 /** \file blender/blenkernel/intern/mball.c
33  *  \ingroup bke
34  */
35
36 #include <stdio.h>
37 #include <string.h>
38 #include <math.h>
39 #include <stdlib.h>
40 #include <ctype.h>
41 #include <float.h>
42
43 #include "MEM_guardedalloc.h"
44
45 #include "DNA_material_types.h"
46 #include "DNA_object_types.h"
47 #include "DNA_meta_types.h"
48 #include "DNA_scene_types.h"
49
50 #include "BLI_blenlib.h"
51 #include "BLI_math.h"
52 #include "BLI_string_utils.h"
53 #include "BLI_utildefines.h"
54
55 #include "BKE_global.h"
56 #include "BKE_main.h"
57
58 #include "BKE_animsys.h"
59 #include "BKE_curve.h"
60 #include "BKE_scene.h"
61 #include "BKE_library.h"
62 #include "BKE_library_query.h"
63 #include "BKE_library_remap.h"
64 #include "BKE_displist.h"
65 #include "BKE_mball.h"
66 #include "BKE_object.h"
67 #include "BKE_material.h"
68
69 //#include "DEG_depsgraph.h"
70
71 /* Functions */
72
73 /** Free (or release) any data used by this mball (does not free the mball itself). */
74 void BKE_mball_free(MetaBall *mb)
75 {
76         BKE_animdata_free((ID *)mb, false);
77
78         BKE_mball_batch_cache_free(mb);
79
80         MEM_SAFE_FREE(mb->mat);
81
82         BLI_freelistN(&mb->elems);
83         if (mb->disp.first) BKE_displist_free(&mb->disp);
84 }
85
86 void BKE_mball_init(MetaBall *mb)
87 {
88         BLI_assert(MEMCMP_STRUCT_OFS_IS_ZERO(mb, id));
89
90         mb->size[0] = mb->size[1] = mb->size[2] = 1.0;
91         mb->texflag = MB_AUTOSPACE;
92         
93         mb->wiresize = 0.4f;
94         mb->rendersize = 0.2f;
95         mb->thresh = 0.6f;
96 }
97
98 MetaBall *BKE_mball_add(Main *bmain, const char *name)
99 {
100         MetaBall *mb;
101
102         mb = BKE_libblock_alloc(bmain, ID_MB, name, 0);
103
104         BKE_mball_init(mb);
105
106         return mb;
107 }
108
109 /**
110  * Only copy internal data of MetaBall ID from source to already allocated/initialized destination.
111  * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
112  *
113  * WARNING! This function will not handle ID user count!
114  *
115  * \param flag  Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
116  */
117 void BKE_mball_copy_data(Main *UNUSED(bmain), MetaBall *mb_dst, const MetaBall *mb_src, const int UNUSED(flag))
118 {
119         BLI_duplicatelist(&mb_dst->elems, &mb_src->elems);
120
121         mb_dst->mat = MEM_dupallocN(mb_src->mat);
122
123         mb_dst->editelems = NULL;
124         mb_dst->lastelem = NULL;
125         mb_dst->batch_cache = NULL;
126 }
127
128 MetaBall *BKE_mball_copy(Main *bmain, const MetaBall *mb)
129 {
130         MetaBall *mb_copy;
131         BKE_id_copy_ex(bmain, &mb->id, (ID **)&mb_copy, 0, false);
132         return mb_copy;
133 }
134
135 void BKE_mball_make_local(Main *bmain, MetaBall *mb, const bool lib_local)
136 {
137         BKE_id_make_local_generic(bmain, &mb->id, true, lib_local);
138 }
139
140 /* most simple meta-element adding function
141  * don't do context manipulation here (rna uses) */
142 MetaElem *BKE_mball_element_add(MetaBall *mb, const int type)
143 {
144         MetaElem *ml = MEM_callocN(sizeof(MetaElem), "metaelem");
145
146         unit_qt(ml->quat);
147
148         ml->rad = 2.0;
149         ml->s = 2.0;
150         ml->flag = MB_SCALE_RAD;
151
152         switch (type) {
153                 case MB_BALL:
154                         ml->type = MB_BALL;
155                         ml->expx = ml->expy = ml->expz = 1.0;
156
157                         break;
158                 case MB_TUBE:
159                         ml->type = MB_TUBE;
160                         ml->expx = ml->expy = ml->expz = 1.0;
161
162                         break;
163                 case MB_PLANE:
164                         ml->type = MB_PLANE;
165                         ml->expx = ml->expy = ml->expz = 1.0;
166
167                         break;
168                 case MB_ELIPSOID:
169                         ml->type = MB_ELIPSOID;
170                         ml->expx = 1.2f;
171                         ml->expy = 0.8f;
172                         ml->expz = 1.0;
173
174                         break;
175                 case MB_CUBE:
176                         ml->type = MB_CUBE;
177                         ml->expx = ml->expy = ml->expz = 1.0;
178
179                         break;
180                 default:
181                         break;
182         }
183
184         BLI_addtail(&mb->elems, ml);
185
186         return ml;
187 }
188 /** Compute bounding box of all MetaElems/MetaBalls.
189  *
190  * Bounding box is computed from polygonized surface. Object *ob is
191  * basic MetaBall (usually with name Meta). All other MetaBalls (with
192  * names Meta.001, Meta.002, etc) are included in this Bounding Box.
193  */
194 void BKE_mball_texspace_calc(Object *ob)
195 {
196         DispList *dl;
197         BoundBox *bb;
198         float *data, min[3], max[3] /*, loc[3], size[3] */;
199         int tot;
200         bool do_it = false;
201
202         if (ob->bb == NULL) ob->bb = MEM_callocN(sizeof(BoundBox), "mb boundbox");
203         bb = ob->bb;
204         
205         /* Weird one, this. */
206 /*      INIT_MINMAX(min, max); */
207         (min)[0] = (min)[1] = (min)[2] = 1.0e30f;
208         (max)[0] = (max)[1] = (max)[2] = -1.0e30f;
209
210         dl = ob->curve_cache->disp.first;
211         while (dl) {
212                 tot = dl->nr;
213                 if (tot) do_it = true;
214                 data = dl->verts;
215                 while (tot--) {
216                         /* Also weird... but longer. From utildefines. */
217                         minmax_v3v3_v3(min, max, data);
218                         data += 3;
219                 }
220                 dl = dl->next;
221         }
222
223         if (!do_it) {
224                 min[0] = min[1] = min[2] = -1.0f;
225                 max[0] = max[1] = max[2] = 1.0f;
226         }
227 #if 0
228         loc[0] = (min[0] + max[0]) / 2.0f;
229         loc[1] = (min[1] + max[1]) / 2.0f;
230         loc[2] = (min[2] + max[2]) / 2.0f;
231
232         size[0] = (max[0] - min[0]) / 2.0f;
233         size[1] = (max[1] - min[1]) / 2.0f;
234         size[2] = (max[2] - min[2]) / 2.0f;
235 #endif
236         BKE_boundbox_init_from_minmax(bb, min, max);
237
238         bb->flag &= ~BOUNDBOX_DIRTY;
239 }
240
241 float *BKE_mball_make_orco(Object *ob, ListBase *dispbase)
242 {
243         BoundBox *bb;
244         DispList *dl;
245         float *data, *orco, *orcodata;
246         float loc[3], size[3];
247         int a;
248
249         /* restore size and loc */
250         bb = ob->bb;
251         loc[0] = (bb->vec[0][0] + bb->vec[4][0]) / 2.0f;
252         size[0] = bb->vec[4][0] - loc[0];
253         loc[1] = (bb->vec[0][1] + bb->vec[2][1]) / 2.0f;
254         size[1] = bb->vec[2][1] - loc[1];
255         loc[2] = (bb->vec[0][2] + bb->vec[1][2]) / 2.0f;
256         size[2] = bb->vec[1][2] - loc[2];
257
258         dl = dispbase->first;
259         orcodata = MEM_mallocN(sizeof(float) * 3 * dl->nr, "MballOrco");
260
261         data = dl->verts;
262         orco = orcodata;
263         a = dl->nr;
264         while (a--) {
265                 orco[0] = (data[0] - loc[0]) / size[0];
266                 orco[1] = (data[1] - loc[1]) / size[1];
267                 orco[2] = (data[2] - loc[2]) / size[2];
268
269                 data += 3;
270                 orco += 3;
271         }
272
273         return orcodata;
274 }
275
276 /* Note on mball basis stuff 2.5x (this is a can of worms)
277  * This really needs a rewrite/refactor its totally broken in anything other then basic cases
278  * Multiple Scenes + Set Scenes & mixing mball basis SHOULD work but fails to update the depsgraph on rename
279  * and linking into scenes or removal of basis mball. so take care when changing this code.
280  *
281  * Main idiot thing here is that the system returns find_basis_mball() objects which fail a is_basis_mball() test.
282  *
283  * Not only that but the depsgraph and their areas depend on this behavior!, so making small fixes here isn't worth it.
284  * - Campbell
285  */
286
287
288 /** \brief Test, if Object *ob is basic MetaBall.
289  *
290  * It test last character of Object ID name. If last character
291  * is digit it return 0, else it return 1.
292  */
293 bool BKE_mball_is_basis(Object *ob)
294 {
295         /* just a quick test */
296         const int len = strlen(ob->id.name);
297         return (!isdigit(ob->id.name[len - 1]));
298 }
299
300 /* return nonzero if ob1 is a basis mball for ob */
301 bool BKE_mball_is_basis_for(Object *ob1, Object *ob2)
302 {
303         int basis1nr, basis2nr;
304         char basis1name[MAX_ID_NAME], basis2name[MAX_ID_NAME];
305
306         BLI_split_name_num(basis1name, &basis1nr, ob1->id.name + 2, '.');
307         BLI_split_name_num(basis2name, &basis2nr, ob2->id.name + 2, '.');
308
309         if (STREQ(basis1name, basis2name)) {
310                 return BKE_mball_is_basis(ob1);
311         }
312         else {
313                 return false;
314         }
315 }
316
317 bool BKE_mball_is_any_selected(const MetaBall *mb)
318 {
319         for (const MetaElem *ml = mb->editelems->first; ml != NULL; ml = ml->next) {
320                 if (ml->flag & SELECT) {
321                         return true;
322                 }
323         }
324         return false;
325 }
326
327 bool BKE_mball_is_any_unselected(const MetaBall *mb)
328 {
329         for (const MetaElem *ml = mb->editelems->first; ml != NULL; ml = ml->next) {
330                 if ((ml->flag & SELECT) == 0) {
331                         return true;
332                 }
333         }
334         return false;
335 }
336
337 /* \brief copy some properties from object to other metaball object with same base name
338  *
339  * When some properties (wiresize, threshold, update flags) of metaball are changed, then this properties
340  * are copied to all metaballs in same "group" (metaballs with same base name: MBall,
341  * MBall.001, MBall.002, etc). The most important is to copy properties to the base metaball,
342  * because this metaball influence polygonisation of metaballs. */
343 void BKE_mball_properties_copy(Scene *scene, Object *active_object)
344 {
345         Scene *sce_iter = scene;
346         Base *base;
347         Object *ob;
348         MetaBall *active_mball = (MetaBall *)active_object->data;
349         int basisnr, obnr;
350         char basisname[MAX_ID_NAME], obname[MAX_ID_NAME];
351         SceneBaseIter iter;
352
353         BLI_split_name_num(basisname, &basisnr, active_object->id.name + 2, '.');
354
355         /* Pass depsgraph as NULL, which means we will not expand into
356          * duplis unlike when we generate the mball. Expanding duplis
357          * would not be compatible when editing multiple view layers. */
358         BKE_scene_base_iter_next(NULL, &iter, &sce_iter, 0, NULL, NULL);
359         while (BKE_scene_base_iter_next(NULL, &iter, &sce_iter, 1, &base, &ob)) {
360                 if (ob->type == OB_MBALL) {
361                         if (ob != active_object) {
362                                 BLI_split_name_num(obname, &obnr, ob->id.name + 2, '.');
363
364                                 /* Object ob has to be in same "group" ... it means, that it has to have
365                                  * same base of its name */
366                                 if (STREQ(obname, basisname)) {
367                                         MetaBall *mb = ob->data;
368
369                                         /* Copy properties from selected/edited metaball */
370                                         mb->wiresize = active_mball->wiresize;
371                                         mb->rendersize = active_mball->rendersize;
372                                         mb->thresh = active_mball->thresh;
373                                         mb->flag = active_mball->flag;
374                                 }
375                         }
376                 }
377         }
378 }
379
380 /** \brief This function finds basic MetaBall.
381  *
382  * Basic MetaBall doesn't include any number at the end of
383  * its name. All MetaBalls with same base of name can be
384  * blended. MetaBalls with different basic name can't be
385  * blended.
386  *
387  * warning!, is_basis_mball() can fail on returned object, see long note above.
388  */
389 Object *BKE_mball_basis_find(Scene *scene, Object *basis)
390 {
391         Object *bob = basis;
392         int basisnr, obnr;
393         char basisname[MAX_ID_NAME], obname[MAX_ID_NAME];
394
395         BLI_split_name_num(basisname, &basisnr, basis->id.name + 2, '.');
396
397         for (ViewLayer *view_layer = scene->view_layers.first; view_layer; view_layer = view_layer->next) {
398                 for (Base *base = view_layer->object_bases.first; base; base = base->next) {
399                         Object *ob = base->object;
400                         if ((ob->type == OB_MBALL) && !(base->flag & OB_FROMDUPLI)) {
401                                 if (ob != bob) {
402                                         BLI_split_name_num(obname, &obnr, ob->id.name + 2, '.');
403
404                                         /* object ob has to be in same "group" ... it means, that it has to have same base of its name */
405                                         if (STREQ(obname, basisname)) {
406                                                 if (obnr < basisnr) {
407                                                         basis = ob;
408                                                         basisnr = obnr;
409                                                 }
410                                         }
411                                 }
412                         }
413                 }
414         }
415
416         return basis;
417 }
418
419 bool BKE_mball_minmax_ex(MetaBall *mb, float min[3], float max[3],
420                          float obmat[4][4], const short flag)
421 {
422         const float scale = obmat ? mat4_to_scale(obmat) : 1.0f;
423         MetaElem *ml;
424         bool changed = false;
425         float centroid[3], vec[3];
426
427         INIT_MINMAX(min, max);
428
429         for (ml = mb->elems.first; ml; ml = ml->next) {
430                 if ((ml->flag & flag) == flag) {
431                         const float scale_mb = (ml->rad * 0.5f) * scale;
432                         int i;
433
434                         if (obmat) {
435                                 mul_v3_m4v3(centroid, obmat, &ml->x);
436                         }
437                         else {
438                                 copy_v3_v3(centroid, &ml->x);
439                         }
440
441                         /* TODO, non circle shapes cubes etc, probably nobody notices - campbell */
442                         for (i = -1; i != 3; i += 2) {
443                                 copy_v3_v3(vec, centroid);
444                                 add_v3_fl(vec, scale_mb * i);
445                                 minmax_v3v3_v3(min, max, vec);
446                         }
447                         changed = true;
448                 }
449         }
450
451         return changed;
452 }
453
454
455 /* basic vertex data functions */
456 bool BKE_mball_minmax(MetaBall *mb, float min[3], float max[3])
457 {
458         MetaElem *ml;
459
460         INIT_MINMAX(min, max);
461
462         for (ml = mb->elems.first; ml; ml = ml->next) {
463                 minmax_v3v3_v3(min, max, &ml->x);
464         }
465
466         return (BLI_listbase_is_empty(&mb->elems) == false);
467 }
468
469 bool BKE_mball_center_median(MetaBall *mb, float r_cent[3])
470 {
471         MetaElem *ml;
472         int total = 0;
473
474         zero_v3(r_cent);
475
476         for (ml = mb->elems.first; ml; ml = ml->next) {
477                 add_v3_v3(r_cent, &ml->x);
478                 total++;
479         }
480
481         if (total) {
482                 mul_v3_fl(r_cent, 1.0f / (float)total);
483         }
484
485         return (total != 0);
486 }
487
488 bool BKE_mball_center_bounds(MetaBall *mb, float r_cent[3])
489 {
490         float min[3], max[3];
491
492         if (BKE_mball_minmax(mb, min, max)) {
493                 mid_v3_v3v3(r_cent, min, max);
494                 return true;
495         }
496
497         return false;
498 }
499
500 void BKE_mball_transform(MetaBall *mb, float mat[4][4], const bool do_props)
501 {
502         MetaElem *me;
503         float quat[4];
504         const float scale = mat4_to_scale(mat);
505         const float scale_sqrt = sqrtf(scale);
506
507         mat4_to_quat(quat, mat);
508
509         for (me = mb->elems.first; me; me = me->next) {
510                 mul_m4_v3(mat, &me->x);
511                 mul_qt_qtqt(me->quat, quat, me->quat);
512
513                 if (do_props) {
514                         me->rad *= scale;
515                         /* hrmf, probably elems shouldn't be
516                          * treating scale differently - campbell */
517                         if (!MB_TYPE_SIZE_SQUARED(me->type)) {
518                                 mul_v3_fl(&me->expx, scale);
519                         }
520                         else {
521                                 mul_v3_fl(&me->expx, scale_sqrt);
522                         }
523                 }
524         }
525 }
526
527 void BKE_mball_translate(MetaBall *mb, const float offset[3])
528 {
529         MetaElem *ml;
530
531         for (ml = mb->elems.first; ml; ml = ml->next) {
532                 add_v3_v3(&ml->x, offset);
533         }
534 }
535
536 /* *** select funcs *** */
537 void BKE_mball_select_all(struct MetaBall *mb)
538 {
539         MetaElem *ml;
540
541         for (ml = mb->editelems->first; ml; ml = ml->next) {
542                 ml->flag |= SELECT;
543         }
544 }
545
546 void BKE_mball_deselect_all(MetaBall *mb)
547 {
548         MetaElem *ml;
549
550         for (ml = mb->editelems->first; ml; ml = ml->next) {
551                 ml->flag &= ~SELECT;
552         }
553 }
554
555 void BKE_mball_select_swap(struct MetaBall *mb)
556 {
557         MetaElem *ml;
558
559         for (ml = mb->editelems->first; ml; ml = ml->next) {
560                 ml->flag ^= SELECT;
561         }
562 }
563
564 /* **** Depsgraph evaluation **** */
565
566 /* Draw Engine */
567
568 void (*BKE_mball_batch_cache_dirty_cb)(MetaBall *mb, int mode) = NULL;
569 void (*BKE_mball_batch_cache_free_cb)(MetaBall *mb) = NULL;
570
571 void BKE_mball_batch_cache_dirty(MetaBall *mb, int mode)
572 {
573         if (mb->batch_cache) {
574                 BKE_mball_batch_cache_dirty_cb(mb, mode);
575         }
576 }
577 void BKE_mball_batch_cache_free(MetaBall *mb)
578 {
579         if (mb->batch_cache) {
580                 BKE_mball_batch_cache_free_cb(mb);
581         }
582 }