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