Cleanup: Remove more #if 0 blocks
[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->runtime.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
228         BKE_boundbox_init_from_minmax(bb, min, max);
229
230         bb->flag &= ~BOUNDBOX_DIRTY;
231 }
232
233 /** Return or compute bbox for given metaball object. */
234 BoundBox *BKE_mball_boundbox_get(Object *ob)
235 {
236         BLI_assert(ob->type == OB_MBALL);
237
238         if (ob->bb != NULL && (ob->bb->flag & BOUNDBOX_DIRTY) == 0) {
239                 return ob->bb;
240         }
241
242         /* This should always only be called with evaluated objects, but currently RNA is a problem here... */
243         if (ob->runtime.curve_cache != NULL) {
244                 BKE_mball_texspace_calc(ob);
245         }
246
247         return ob->bb;
248 }
249
250 float *BKE_mball_make_orco(Object *ob, ListBase *dispbase)
251 {
252         BoundBox *bb;
253         DispList *dl;
254         float *data, *orco, *orcodata;
255         float loc[3], size[3];
256         int a;
257
258         /* restore size and loc */
259         bb = ob->bb;
260         loc[0] = (bb->vec[0][0] + bb->vec[4][0]) / 2.0f;
261         size[0] = bb->vec[4][0] - loc[0];
262         loc[1] = (bb->vec[0][1] + bb->vec[2][1]) / 2.0f;
263         size[1] = bb->vec[2][1] - loc[1];
264         loc[2] = (bb->vec[0][2] + bb->vec[1][2]) / 2.0f;
265         size[2] = bb->vec[1][2] - loc[2];
266
267         dl = dispbase->first;
268         orcodata = MEM_mallocN(sizeof(float) * 3 * dl->nr, "MballOrco");
269
270         data = dl->verts;
271         orco = orcodata;
272         a = dl->nr;
273         while (a--) {
274                 orco[0] = (data[0] - loc[0]) / size[0];
275                 orco[1] = (data[1] - loc[1]) / size[1];
276                 orco[2] = (data[2] - loc[2]) / size[2];
277
278                 data += 3;
279                 orco += 3;
280         }
281
282         return orcodata;
283 }
284
285 /* Note on mball basis stuff 2.5x (this is a can of worms)
286  * This really needs a rewrite/refactor its totally broken in anything other then basic cases
287  * Multiple Scenes + Set Scenes & mixing mball basis SHOULD work but fails to update the depsgraph on rename
288  * and linking into scenes or removal of basis mball. so take care when changing this code.
289  *
290  * Main idiot thing here is that the system returns find_basis_mball() objects which fail a is_basis_mball() test.
291  *
292  * Not only that but the depsgraph and their areas depend on this behavior!, so making small fixes here isn't worth it.
293  * - Campbell
294  */
295
296
297 /** \brief Test, if Object *ob is basic MetaBall.
298  *
299  * It test last character of Object ID name. If last character
300  * is digit it return 0, else it return 1.
301  */
302 bool BKE_mball_is_basis(Object *ob)
303 {
304         /* just a quick test */
305         const int len = strlen(ob->id.name);
306         return (!isdigit(ob->id.name[len - 1]));
307 }
308
309 /* return nonzero if ob1 is a basis mball for ob */
310 bool BKE_mball_is_basis_for(Object *ob1, Object *ob2)
311 {
312         int basis1nr, basis2nr;
313         char basis1name[MAX_ID_NAME], basis2name[MAX_ID_NAME];
314
315         BLI_split_name_num(basis1name, &basis1nr, ob1->id.name + 2, '.');
316         BLI_split_name_num(basis2name, &basis2nr, ob2->id.name + 2, '.');
317
318         if (STREQ(basis1name, basis2name)) {
319                 return BKE_mball_is_basis(ob1);
320         }
321         else {
322                 return false;
323         }
324 }
325
326 bool BKE_mball_is_any_selected(const MetaBall *mb)
327 {
328         for (const MetaElem *ml = mb->editelems->first; ml != NULL; ml = ml->next) {
329                 if (ml->flag & SELECT) {
330                         return true;
331                 }
332         }
333         return false;
334 }
335
336 bool BKE_mball_is_any_unselected(const MetaBall *mb)
337 {
338         for (const MetaElem *ml = mb->editelems->first; ml != NULL; ml = ml->next) {
339                 if ((ml->flag & SELECT) == 0) {
340                         return true;
341                 }
342         }
343         return false;
344 }
345
346 /* \brief copy some properties from object to other metaball object with same base name
347  *
348  * When some properties (wiresize, threshold, update flags) of metaball are changed, then this properties
349  * are copied to all metaballs in same "group" (metaballs with same base name: MBall,
350  * MBall.001, MBall.002, etc). The most important is to copy properties to the base metaball,
351  * because this metaball influence polygonisation of metaballs. */
352 void BKE_mball_properties_copy(Scene *scene, Object *active_object)
353 {
354         Scene *sce_iter = scene;
355         Base *base;
356         Object *ob;
357         MetaBall *active_mball = (MetaBall *)active_object->data;
358         int basisnr, obnr;
359         char basisname[MAX_ID_NAME], obname[MAX_ID_NAME];
360         SceneBaseIter iter;
361
362         BLI_split_name_num(basisname, &basisnr, active_object->id.name + 2, '.');
363
364         /* Pass depsgraph as NULL, which means we will not expand into
365          * duplis unlike when we generate the mball. Expanding duplis
366          * would not be compatible when editing multiple view layers. */
367         BKE_scene_base_iter_next(NULL, &iter, &sce_iter, 0, NULL, NULL);
368         while (BKE_scene_base_iter_next(NULL, &iter, &sce_iter, 1, &base, &ob)) {
369                 if (ob->type == OB_MBALL) {
370                         if (ob != active_object) {
371                                 BLI_split_name_num(obname, &obnr, ob->id.name + 2, '.');
372
373                                 /* Object ob has to be in same "group" ... it means, that it has to have
374                                  * same base of its name */
375                                 if (STREQ(obname, basisname)) {
376                                         MetaBall *mb = ob->data;
377
378                                         /* Copy properties from selected/edited metaball */
379                                         mb->wiresize = active_mball->wiresize;
380                                         mb->rendersize = active_mball->rendersize;
381                                         mb->thresh = active_mball->thresh;
382                                         mb->flag = active_mball->flag;
383                                 }
384                         }
385                 }
386         }
387 }
388
389 /** \brief This function finds basic MetaBall.
390  *
391  * Basic MetaBall doesn't include any number at the end of
392  * its name. All MetaBalls with same base of name can be
393  * blended. MetaBalls with different basic name can't be
394  * blended.
395  *
396  * warning!, is_basis_mball() can fail on returned object, see long note above.
397  */
398 Object *BKE_mball_basis_find(Scene *scene, Object *basis)
399 {
400         Object *bob = basis;
401         int basisnr, obnr;
402         char basisname[MAX_ID_NAME], obname[MAX_ID_NAME];
403
404         BLI_split_name_num(basisname, &basisnr, basis->id.name + 2, '.');
405
406         for (ViewLayer *view_layer = scene->view_layers.first; view_layer; view_layer = view_layer->next) {
407                 for (Base *base = view_layer->object_bases.first; base; base = base->next) {
408                         Object *ob = base->object;
409                         if ((ob->type == OB_MBALL) && !(base->flag & OB_FROMDUPLI)) {
410                                 if (ob != bob) {
411                                         BLI_split_name_num(obname, &obnr, ob->id.name + 2, '.');
412
413                                         /* object ob has to be in same "group" ... it means, that it has to have same base of its name */
414                                         if (STREQ(obname, basisname)) {
415                                                 if (obnr < basisnr) {
416                                                         basis = ob;
417                                                         basisnr = obnr;
418                                                 }
419                                         }
420                                 }
421                         }
422                 }
423         }
424
425         return basis;
426 }
427
428 bool BKE_mball_minmax_ex(MetaBall *mb, float min[3], float max[3],
429                          float obmat[4][4], const short flag)
430 {
431         const float scale = obmat ? mat4_to_scale(obmat) : 1.0f;
432         MetaElem *ml;
433         bool changed = false;
434         float centroid[3], vec[3];
435
436         INIT_MINMAX(min, max);
437
438         for (ml = mb->elems.first; ml; ml = ml->next) {
439                 if ((ml->flag & flag) == flag) {
440                         const float scale_mb = (ml->rad * 0.5f) * scale;
441                         int i;
442
443                         if (obmat) {
444                                 mul_v3_m4v3(centroid, obmat, &ml->x);
445                         }
446                         else {
447                                 copy_v3_v3(centroid, &ml->x);
448                         }
449
450                         /* TODO, non circle shapes cubes etc, probably nobody notices - campbell */
451                         for (i = -1; i != 3; i += 2) {
452                                 copy_v3_v3(vec, centroid);
453                                 add_v3_fl(vec, scale_mb * i);
454                                 minmax_v3v3_v3(min, max, vec);
455                         }
456                         changed = true;
457                 }
458         }
459
460         return changed;
461 }
462
463
464 /* basic vertex data functions */
465 bool BKE_mball_minmax(MetaBall *mb, float min[3], float max[3])
466 {
467         MetaElem *ml;
468
469         INIT_MINMAX(min, max);
470
471         for (ml = mb->elems.first; ml; ml = ml->next) {
472                 minmax_v3v3_v3(min, max, &ml->x);
473         }
474
475         return (BLI_listbase_is_empty(&mb->elems) == false);
476 }
477
478 bool BKE_mball_center_median(MetaBall *mb, float r_cent[3])
479 {
480         MetaElem *ml;
481         int total = 0;
482
483         zero_v3(r_cent);
484
485         for (ml = mb->elems.first; ml; ml = ml->next) {
486                 add_v3_v3(r_cent, &ml->x);
487                 total++;
488         }
489
490         if (total) {
491                 mul_v3_fl(r_cent, 1.0f / (float)total);
492         }
493
494         return (total != 0);
495 }
496
497 bool BKE_mball_center_bounds(MetaBall *mb, float r_cent[3])
498 {
499         float min[3], max[3];
500
501         if (BKE_mball_minmax(mb, min, max)) {
502                 mid_v3_v3v3(r_cent, min, max);
503                 return true;
504         }
505
506         return false;
507 }
508
509 void BKE_mball_transform(MetaBall *mb, float mat[4][4], const bool do_props)
510 {
511         MetaElem *me;
512         float quat[4];
513         const float scale = mat4_to_scale(mat);
514         const float scale_sqrt = sqrtf(scale);
515
516         mat4_to_quat(quat, mat);
517
518         for (me = mb->elems.first; me; me = me->next) {
519                 mul_m4_v3(mat, &me->x);
520                 mul_qt_qtqt(me->quat, quat, me->quat);
521
522                 if (do_props) {
523                         me->rad *= scale;
524                         /* hrmf, probably elems shouldn't be
525                          * treating scale differently - campbell */
526                         if (!MB_TYPE_SIZE_SQUARED(me->type)) {
527                                 mul_v3_fl(&me->expx, scale);
528                         }
529                         else {
530                                 mul_v3_fl(&me->expx, scale_sqrt);
531                         }
532                 }
533         }
534 }
535
536 void BKE_mball_translate(MetaBall *mb, const float offset[3])
537 {
538         MetaElem *ml;
539
540         for (ml = mb->elems.first; ml; ml = ml->next) {
541                 add_v3_v3(&ml->x, offset);
542         }
543 }
544
545 /* *** select funcs *** */
546 void BKE_mball_select_all(struct 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_deselect_all(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 void BKE_mball_select_swap(struct MetaBall *mb)
565 {
566         MetaElem *ml;
567
568         for (ml = mb->editelems->first; ml; ml = ml->next) {
569                 ml->flag ^= SELECT;
570         }
571 }
572
573 /* **** Depsgraph evaluation **** */
574
575 /* Draw Engine */
576
577 void (*BKE_mball_batch_cache_dirty_tag_cb)(MetaBall *mb, int mode) = NULL;
578 void (*BKE_mball_batch_cache_free_cb)(MetaBall *mb) = NULL;
579
580 void BKE_mball_batch_cache_dirty_tag(MetaBall *mb, int mode)
581 {
582         if (mb->batch_cache) {
583                 BKE_mball_batch_cache_dirty_tag_cb(mb, mode);
584         }
585 }
586 void BKE_mball_batch_cache_free(MetaBall *mb)
587 {
588         if (mb->batch_cache) {
589                 BKE_mball_batch_cache_free_cb(mb);
590         }
591 }