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