Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / lattice.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  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/lattice.c
29  *  \ingroup bke
30  */
31
32 #include <stdio.h>
33 #include <string.h>
34 #include <math.h>
35 #include <stdlib.h>
36
37 #include "MEM_guardedalloc.h"
38
39 #include "BLI_utildefines.h"
40 #include "BLI_listbase.h"
41 #include "BLI_bitmap.h"
42 #include "BLI_math.h"
43
44 #include "DNA_mesh_types.h"
45 #include "DNA_meshdata_types.h"
46 #include "DNA_scene_types.h"
47 #include "DNA_object_types.h"
48 #include "DNA_lattice_types.h"
49 #include "DNA_curve_types.h"
50 #include "DNA_key_types.h"
51
52 #include "BKE_animsys.h"
53 #include "BKE_anim.h"
54 #include "BKE_cdderivedmesh.h"
55 #include "BKE_curve.h"
56 #include "BKE_displist.h"
57 #include "BKE_key.h"
58 #include "BKE_lattice.h"
59 #include "BKE_library.h"
60 #include "BKE_library_query.h"
61 #include "BKE_library_remap.h"
62 #include "BKE_main.h"
63 #include "BKE_modifier.h"
64 #include "BKE_object.h"
65
66 #include "BKE_deform.h"
67
68 #include "DEG_depsgraph_query.h"
69
70 int BKE_lattice_index_from_uvw(Lattice *lt,
71                                const int u, const int v, const int w)
72 {
73         const int totu = lt->pntsu;
74         const int totv = lt->pntsv;
75
76         return (w * (totu * totv) + (v * totu) + u);
77 }
78
79 void BKE_lattice_index_to_uvw(Lattice *lt, const int index,
80                               int *r_u, int *r_v, int *r_w)
81 {
82         const int totu = lt->pntsu;
83         const int totv = lt->pntsv;
84
85         *r_u = (index % totu);
86         *r_v = (index / totu) % totv;
87         *r_w = (index / (totu * totv));
88 }
89
90 int BKE_lattice_index_flip(Lattice *lt, const int index,
91                            const bool flip_u, const bool flip_v, const bool flip_w)
92 {
93         int u, v, w;
94
95         BKE_lattice_index_to_uvw(lt, index, &u, &v, &w);
96
97         if (flip_u) {
98                 u = (lt->pntsu - 1) - u;
99         }
100
101         if (flip_v) {
102                 v = (lt->pntsv - 1) - v;
103         }
104
105         if (flip_w) {
106                 w = (lt->pntsw - 1) - w;
107         }
108
109         return BKE_lattice_index_from_uvw(lt, u, v, w);
110 }
111
112 void BKE_lattice_bitmap_from_flag(Lattice *lt, BLI_bitmap *bitmap, const short flag,
113                                   const bool clear, const bool respecthide)
114 {
115         const unsigned int tot = lt->pntsu * lt->pntsv * lt->pntsw;
116         unsigned int i;
117         BPoint *bp;
118
119         bp = lt->def;
120         for (i = 0; i < tot; i++, bp++) {
121                 if ((bp->f1 & flag) && (!respecthide || !bp->hide)) {
122                         BLI_BITMAP_ENABLE(bitmap, i);
123                 }
124                 else {
125                         if (clear) {
126                                 BLI_BITMAP_DISABLE(bitmap, i);
127                         }
128                 }
129         }
130
131 }
132
133 void calc_lat_fudu(int flag, int res, float *r_fu, float *r_du)
134 {
135         if (res == 1) {
136                 *r_fu = 0.0;
137                 *r_du = 0.0;
138         }
139         else if (flag & LT_GRID) {
140                 *r_fu = -0.5f * (res - 1);
141                 *r_du = 1.0f;
142         }
143         else {
144                 *r_fu = -1.0f;
145                 *r_du = 2.0f / (res - 1);
146         }
147 }
148
149 void BKE_lattice_resize(Lattice *lt, int uNew, int vNew, int wNew, Object *ltOb)
150 {
151         BPoint *bp;
152         int i, u, v, w;
153         float fu, fv, fw, uc, vc, wc, du = 0.0, dv = 0.0, dw = 0.0;
154         float *co, (*vertexCos)[3] = NULL;
155         
156         /* vertex weight groups are just freed all for now */
157         if (lt->dvert) {
158                 BKE_defvert_array_free(lt->dvert, lt->pntsu * lt->pntsv * lt->pntsw);
159                 lt->dvert = NULL;
160         }
161         
162         while (uNew * vNew * wNew > 32000) {
163                 if (uNew >= vNew && uNew >= wNew) uNew--;
164                 else if (vNew >= uNew && vNew >= wNew) vNew--;
165                 else wNew--;
166         }
167
168         vertexCos = MEM_mallocN(sizeof(*vertexCos) * uNew * vNew * wNew, "tmp_vcos");
169
170         calc_lat_fudu(lt->flag, uNew, &fu, &du);
171         calc_lat_fudu(lt->flag, vNew, &fv, &dv);
172         calc_lat_fudu(lt->flag, wNew, &fw, &dw);
173
174         /* If old size is different then resolution changed in interface,
175          * try to do clever reinit of points. Pretty simply idea, we just
176          * deform new verts by old lattice, but scaling them to match old
177          * size first.
178          */
179         if (ltOb) {
180                 if (uNew != 1 && lt->pntsu != 1) {
181                         fu = lt->fu;
182                         du = (lt->pntsu - 1) * lt->du / (uNew - 1);
183                 }
184
185                 if (vNew != 1 && lt->pntsv != 1) {
186                         fv = lt->fv;
187                         dv = (lt->pntsv - 1) * lt->dv / (vNew - 1);
188                 }
189
190                 if (wNew != 1 && lt->pntsw != 1) {
191                         fw = lt->fw;
192                         dw = (lt->pntsw - 1) * lt->dw / (wNew - 1);
193                 }
194         }
195
196         co = vertexCos[0];
197         for (w = 0, wc = fw; w < wNew; w++, wc += dw) {
198                 for (v = 0, vc = fv; v < vNew; v++, vc += dv) {
199                         for (u = 0, uc = fu; u < uNew; u++, co += 3, uc += du) {
200                                 co[0] = uc;
201                                 co[1] = vc;
202                                 co[2] = wc;
203                         }
204                 }
205         }
206         
207         if (ltOb) {
208                 float mat[4][4];
209                 int typeu = lt->typeu, typev = lt->typev, typew = lt->typew;
210
211                 /* works best if we force to linear type (endpoints match) */
212                 lt->typeu = lt->typev = lt->typew = KEY_LINEAR;
213
214                 if (ltOb->curve_cache) {
215                         /* prevent using deformed locations */
216                         BKE_displist_free(&ltOb->curve_cache->disp);
217                 }
218
219                 copy_m4_m4(mat, ltOb->obmat);
220                 unit_m4(ltOb->obmat);
221                 lattice_deform_verts(ltOb, NULL, NULL, vertexCos, uNew * vNew * wNew, NULL, 1.0f);
222                 copy_m4_m4(ltOb->obmat, mat);
223
224                 lt->typeu = typeu;
225                 lt->typev = typev;
226                 lt->typew = typew;
227         }
228
229         lt->fu = fu;
230         lt->fv = fv;
231         lt->fw = fw;
232         lt->du = du;
233         lt->dv = dv;
234         lt->dw = dw;
235
236         lt->pntsu = uNew;
237         lt->pntsv = vNew;
238         lt->pntsw = wNew;
239
240         lt->actbp = LT_ACTBP_NONE;
241         MEM_freeN(lt->def);
242         lt->def = MEM_callocN(lt->pntsu * lt->pntsv * lt->pntsw * sizeof(BPoint), "lattice bp");
243         
244         bp = lt->def;
245         
246         for (i = 0; i < lt->pntsu * lt->pntsv * lt->pntsw; i++, bp++) {
247                 copy_v3_v3(bp->vec, vertexCos[i]);
248         }
249
250         MEM_freeN(vertexCos);
251 }
252
253 void BKE_lattice_init(Lattice *lt)
254 {
255         BLI_assert(MEMCMP_STRUCT_OFS_IS_ZERO(lt, id));
256
257         lt->flag = LT_GRID;
258         
259         lt->typeu = lt->typev = lt->typew = KEY_BSPLINE;
260         
261         lt->def = MEM_callocN(sizeof(BPoint), "lattvert"); /* temporary */
262         BKE_lattice_resize(lt, 2, 2, 2, NULL);  /* creates a uniform lattice */
263         lt->actbp = LT_ACTBP_NONE;
264 }
265
266 Lattice *BKE_lattice_add(Main *bmain, const char *name)
267 {
268         Lattice *lt;
269
270         lt = BKE_libblock_alloc(bmain, ID_LT, name, 0);
271
272         BKE_lattice_init(lt);
273
274         return lt;
275 }
276
277 /**
278  * Only copy internal data of Lattice ID from source to already allocated/initialized destination.
279  * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
280  *
281  * WARNING! This function will not handle ID user count!
282  *
283  * \param flag  Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
284  */
285 void BKE_lattice_copy_data(Main *bmain, Lattice *lt_dst, const Lattice *lt_src, const int flag)
286 {
287         lt_dst->def = MEM_dupallocN(lt_src->def);
288
289         if (lt_src->key && (flag & LIB_ID_COPY_SHAPEKEY)) {
290                 BKE_id_copy_ex(bmain, &lt_src->key->id, (ID **)&lt_dst->key, flag, false);
291         }
292
293         if (lt_src->dvert) {
294                 int tot = lt_src->pntsu * lt_src->pntsv * lt_src->pntsw;
295                 lt_dst->dvert = MEM_mallocN(sizeof(MDeformVert) * tot, "Lattice MDeformVert");
296                 BKE_defvert_array_copy(lt_dst->dvert, lt_src->dvert, tot);
297         }
298
299         lt_dst->editlatt = NULL;
300 }
301
302 Lattice *BKE_lattice_copy(Main *bmain, const Lattice *lt)
303 {
304         Lattice *lt_copy;
305         BKE_id_copy_ex(bmain, &lt->id, (ID **)&lt_copy, LIB_ID_COPY_SHAPEKEY, false);
306         return lt_copy;
307 }
308
309         /** Free (or release) any data used by this lattice (does not free the lattice itself). */
310 void BKE_lattice_free(Lattice *lt)
311 {
312         BKE_animdata_free(&lt->id, false);
313
314         BKE_lattice_batch_cache_free(lt);
315
316         MEM_SAFE_FREE(lt->def);
317         if (lt->dvert) {
318                 BKE_defvert_array_free(lt->dvert, lt->pntsu * lt->pntsv * lt->pntsw);
319                 lt->dvert = NULL;
320         }
321         if (lt->editlatt) {
322                 Lattice *editlt = lt->editlatt->latt;
323
324                 if (editlt->def)
325                         MEM_freeN(editlt->def);
326                 if (editlt->dvert)
327                         BKE_defvert_array_free(editlt->dvert, lt->pntsu * lt->pntsv * lt->pntsw);
328
329                 MEM_freeN(editlt);
330                 MEM_freeN(lt->editlatt);
331                 lt->editlatt = NULL;
332         }
333 }
334
335
336 void BKE_lattice_make_local(Main *bmain, Lattice *lt, const bool lib_local)
337 {
338         BKE_id_make_local_generic(bmain, &lt->id, true, lib_local);
339 }
340
341 typedef struct LatticeDeformData {
342         Object *object;
343         float *latticedata;
344         float latmat[4][4];
345 } LatticeDeformData;
346
347 LatticeDeformData *init_latt_deform(Object *oblatt, Object *ob)
348 {
349         /* we make an array with all differences */
350         Lattice *lt = oblatt->data;
351         BPoint *bp;
352         DispList *dl = oblatt->curve_cache ? BKE_displist_find(&oblatt->curve_cache->disp, DL_VERTS) : NULL;
353         const float *co = dl ? dl->verts : NULL;
354         float *fp, imat[4][4];
355         float fu, fv, fw;
356         int u, v, w;
357         float *latticedata;
358         float latmat[4][4];
359         LatticeDeformData *lattice_deform_data;
360
361         if (lt->editlatt) lt = lt->editlatt->latt;
362         bp = lt->def;
363         
364         fp = latticedata = MEM_mallocN(sizeof(float) * 3 * lt->pntsu * lt->pntsv * lt->pntsw, "latticedata");
365         
366         /* for example with a particle system: (ob == NULL) */
367         if (ob == NULL) {
368                 /* in deformspace, calc matrix  */
369                 invert_m4_m4(latmat, oblatt->obmat);
370         
371                 /* back: put in deform array */
372                 invert_m4_m4(imat, latmat);
373         }
374         else {
375                 /* in deformspace, calc matrix */
376                 invert_m4_m4(imat, oblatt->obmat);
377                 mul_m4_m4m4(latmat, imat, ob->obmat);
378         
379                 /* back: put in deform array */
380                 invert_m4_m4(imat, latmat);
381         }
382         
383         for (w = 0, fw = lt->fw; w < lt->pntsw; w++, fw += lt->dw) {
384                 for (v = 0, fv = lt->fv; v < lt->pntsv; v++, fv += lt->dv) {
385                         for (u = 0, fu = lt->fu; u < lt->pntsu; u++, bp++, co += 3, fp += 3, fu += lt->du) {
386                                 if (dl) {
387                                         fp[0] = co[0] - fu;
388                                         fp[1] = co[1] - fv;
389                                         fp[2] = co[2] - fw;
390                                 }
391                                 else {
392                                         fp[0] = bp->vec[0] - fu;
393                                         fp[1] = bp->vec[1] - fv;
394                                         fp[2] = bp->vec[2] - fw;
395                                 }
396
397                                 mul_mat3_m4_v3(imat, fp);
398                         }
399                 }
400         }
401
402         lattice_deform_data = MEM_mallocN(sizeof(LatticeDeformData), "Lattice Deform Data");
403         lattice_deform_data->latticedata = latticedata;
404         lattice_deform_data->object = oblatt;
405         copy_m4_m4(lattice_deform_data->latmat, latmat);
406
407         return lattice_deform_data;
408 }
409
410 void calc_latt_deform(LatticeDeformData *lattice_deform_data, float co[3], float weight)
411 {
412         Object *ob = lattice_deform_data->object;
413         Lattice *lt = ob->data;
414         float u, v, w, tu[4], tv[4], tw[4];
415         float vec[3];
416         int idx_w, idx_v, idx_u;
417         int ui, vi, wi, uu, vv, ww;
418
419         /* vgroup influence */
420         int defgrp_index = -1;
421         float co_prev[3], weight_blend = 0.0f;
422         MDeformVert *dvert = BKE_lattice_deform_verts_get(ob);
423         float *__restrict latticedata = lattice_deform_data->latticedata;
424
425
426         if (lt->editlatt) lt = lt->editlatt->latt;
427         if (latticedata == NULL) return;
428
429         if (lt->vgroup[0] && dvert) {
430                 defgrp_index = defgroup_name_index(ob, lt->vgroup);
431                 copy_v3_v3(co_prev, co);
432         }
433
434         /* co is in local coords, treat with latmat */
435         mul_v3_m4v3(vec, lattice_deform_data->latmat, co);
436
437         /* u v w coords */
438
439         if (lt->pntsu > 1) {
440                 u = (vec[0] - lt->fu) / lt->du;
441                 ui = (int)floor(u);
442                 u -= ui;
443                 key_curve_position_weights(u, tu, lt->typeu);
444         }
445         else {
446                 tu[0] = tu[2] = tu[3] = 0.0; tu[1] = 1.0;
447                 ui = 0;
448         }
449
450         if (lt->pntsv > 1) {
451                 v = (vec[1] - lt->fv) / lt->dv;
452                 vi = (int)floor(v);
453                 v -= vi;
454                 key_curve_position_weights(v, tv, lt->typev);
455         }
456         else {
457                 tv[0] = tv[2] = tv[3] = 0.0; tv[1] = 1.0;
458                 vi = 0;
459         }
460
461         if (lt->pntsw > 1) {
462                 w = (vec[2] - lt->fw) / lt->dw;
463                 wi = (int)floor(w);
464                 w -= wi;
465                 key_curve_position_weights(w, tw, lt->typew);
466         }
467         else {
468                 tw[0] = tw[2] = tw[3] = 0.0; tw[1] = 1.0;
469                 wi = 0;
470         }
471
472         for (ww = wi - 1; ww <= wi + 2; ww++) {
473                 w = tw[ww - wi + 1];
474
475                 if (w != 0.0f) {
476                         if (ww > 0) {
477                                 if (ww < lt->pntsw) idx_w = ww * lt->pntsu * lt->pntsv;
478                                 else                idx_w = (lt->pntsw - 1) * lt->pntsu * lt->pntsv;
479                         }
480                         else {
481                                 idx_w = 0;
482                         }
483
484                         for (vv = vi - 1; vv <= vi + 2; vv++) {
485                                 v = w * tv[vv - vi + 1];
486
487                                 if (v != 0.0f) {
488                                         if (vv > 0) {
489                                                 if (vv < lt->pntsv) idx_v = idx_w + vv * lt->pntsu;
490                                                 else                idx_v = idx_w + (lt->pntsv - 1) * lt->pntsu;
491                                         }
492                                         else {
493                                                 idx_v = idx_w;
494                                         }
495
496                                         for (uu = ui - 1; uu <= ui + 2; uu++) {
497                                                 u = weight * v * tu[uu - ui + 1];
498
499                                                 if (u != 0.0f) {
500                                                         if (uu > 0) {
501                                                                 if (uu < lt->pntsu) idx_u = idx_v + uu;
502                                                                 else                idx_u = idx_v + (lt->pntsu - 1);
503                                                         }
504                                                         else {
505                                                                 idx_u = idx_v;
506                                                         }
507
508                                                         madd_v3_v3fl(co, &latticedata[idx_u * 3], u);
509
510                                                         if (defgrp_index != -1)
511                                                                 weight_blend += (u * defvert_find_weight(dvert + idx_u, defgrp_index));
512                                                 }
513                                         }
514                                 }
515                         }
516                 }
517         }
518
519         if (defgrp_index != -1)
520                 interp_v3_v3v3(co, co_prev, co, weight_blend);
521
522 }
523
524 void end_latt_deform(LatticeDeformData *lattice_deform_data)
525 {
526         if (lattice_deform_data->latticedata)
527                 MEM_freeN(lattice_deform_data->latticedata);
528
529         MEM_freeN(lattice_deform_data);
530 }
531
532 /* calculations is in local space of deformed object
533  * so we store in latmat transform from path coord inside object
534  */
535 typedef struct {
536         float dmin[3], dmax[3];
537         float curvespace[4][4], objectspace[4][4], objectspace3[3][3];
538         int no_rot_axis;
539 } CurveDeform;
540
541 static void init_curve_deform(Object *par, Object *ob, CurveDeform *cd)
542 {
543         invert_m4_m4(ob->imat, ob->obmat);
544         mul_m4_m4m4(cd->objectspace, ob->imat, par->obmat);
545         invert_m4_m4(cd->curvespace, cd->objectspace);
546         copy_m3_m4(cd->objectspace3, cd->objectspace);
547         cd->no_rot_axis = 0;
548 }
549
550 /* this makes sure we can extend for non-cyclic.
551  *
552  * returns OK: 1/0
553  */
554 static bool where_on_path_deform(Object *ob, float ctime, float vec[4], float dir[3], float quat[4], float *radius)
555 {
556         BevList *bl;
557         float ctime1;
558         int cycl = 0;
559         
560         /* test for cyclic */
561         bl = ob->curve_cache->bev.first;
562         if (!bl->nr) return false;
563         if (bl->poly > -1) cycl = 1;
564
565         if (cycl == 0) {
566                 ctime1 = CLAMPIS(ctime, 0.0f, 1.0f);
567         }
568         else {
569                 ctime1 = ctime;
570         }
571         
572         /* vec needs 4 items */
573         if (where_on_path(ob, ctime1, vec, dir, quat, radius, NULL)) {
574                 
575                 if (cycl == 0) {
576                         Path *path = ob->curve_cache->path;
577                         float dvec[3];
578                         
579                         if (ctime < 0.0f) {
580                                 sub_v3_v3v3(dvec, path->data[1].vec, path->data[0].vec);
581                                 mul_v3_fl(dvec, ctime * (float)path->len);
582                                 add_v3_v3(vec, dvec);
583                                 if (quat) copy_qt_qt(quat, path->data[0].quat);
584                                 if (radius) *radius = path->data[0].radius;
585                         }
586                         else if (ctime > 1.0f) {
587                                 sub_v3_v3v3(dvec, path->data[path->len - 1].vec, path->data[path->len - 2].vec);
588                                 mul_v3_fl(dvec, (ctime - 1.0f) * (float)path->len);
589                                 add_v3_v3(vec, dvec);
590                                 if (quat) copy_qt_qt(quat, path->data[path->len - 1].quat);
591                                 if (radius) *radius = path->data[path->len - 1].radius;
592                                 /* weight - not used but could be added */
593                         }
594                 }
595                 return true;
596         }
597         return false;
598 }
599
600 /* for each point, rotate & translate to curve */
601 /* use path, since it has constant distances */
602 /* co: local coord, result local too */
603 /* returns quaternion for rotation, using cd->no_rot_axis */
604 /* axis is using another define!!! */
605 static bool calc_curve_deform(Object *par, float co[3],
606                               const short axis, CurveDeform *cd, float r_quat[4])
607 {
608         Curve *cu = par->data;
609         float fac, loc[4], dir[3], new_quat[4], radius;
610         short index;
611         const bool is_neg_axis = (axis > 2);
612
613         if (par->curve_cache == NULL) {
614                 /* Happens with a cyclic dependencies. */
615                 return false;
616         }
617
618         if (par->curve_cache->path == NULL) {
619                 return false;  /* happens on append, cyclic dependencies and empty curves */
620         }
621
622         /* options */
623         if (is_neg_axis) {
624                 index = axis - 3;
625                 if (cu->flag & CU_STRETCH)
626                         fac = (-co[index] - cd->dmax[index]) / (cd->dmax[index] - cd->dmin[index]);
627                 else
628                         fac = -(co[index] - cd->dmax[index]) / (par->curve_cache->path->totdist);
629         }
630         else {
631                 index = axis;
632                 if (cu->flag & CU_STRETCH) {
633                         fac = (co[index] - cd->dmin[index]) / (cd->dmax[index] - cd->dmin[index]);
634                 }
635                 else {
636                         if (LIKELY(par->curve_cache->path->totdist > FLT_EPSILON)) {
637                                 fac = +(co[index] - cd->dmin[index]) / (par->curve_cache->path->totdist);
638                         }
639                         else {
640                                 fac = 0.0f;
641                         }
642                 }
643         }
644         
645         if (where_on_path_deform(par, fac, loc, dir, new_quat, &radius)) {  /* returns OK */
646                 float quat[4], cent[3];
647
648                 if (cd->no_rot_axis) {  /* set by caller */
649
650                         /* this is not exactly the same as 2.4x, since the axis is having rotation removed rather than
651                          * changing the axis before calculating the tilt but serves much the same purpose */
652                         float dir_flat[3] = {0, 0, 0}, q[4];
653                         copy_v3_v3(dir_flat, dir);
654                         dir_flat[cd->no_rot_axis - 1] = 0.0f;
655
656                         normalize_v3(dir);
657                         normalize_v3(dir_flat);
658
659                         rotation_between_vecs_to_quat(q, dir, dir_flat); /* Could this be done faster? */
660
661                         mul_qt_qtqt(new_quat, q, new_quat);
662                 }
663
664
665                 /* Logic for 'cent' orientation *
666                  *
667                  * The way 'co' is copied to 'cent' may seem to have no meaning, but it does.
668                  *
669                  * Use a curve modifier to stretch a cube out, color each side RGB, positive side light, negative dark.
670                  * view with X up (default), from the angle that you can see 3 faces RGB colors (light), anti-clockwise
671                  * Notice X,Y,Z Up all have light colors and each ordered CCW.
672                  *
673                  * Now for Neg Up XYZ, the colors are all dark, and ordered clockwise - Campbell
674                  *
675                  * note: moved functions into quat_apply_track/vec_apply_track
676                  * */
677                 copy_qt_qt(quat, new_quat);
678                 copy_v3_v3(cent, co);
679
680                 /* zero the axis which is not used,
681                  * the big block of text above now applies to these 3 lines */
682                 quat_apply_track(quat, axis, (axis == 0 || axis == 2) ? 1 : 0); /* up flag is a dummy, set so no rotation is done */
683                 vec_apply_track(cent, axis);
684                 cent[index] = 0.0f;
685
686
687                 /* scale if enabled */
688                 if (cu->flag & CU_PATH_RADIUS)
689                         mul_v3_fl(cent, radius);
690                 
691                 /* local rotation */
692                 normalize_qt(quat);
693                 mul_qt_v3(quat, cent);
694
695                 /* translation */
696                 add_v3_v3v3(co, cent, loc);
697
698                 if (r_quat)
699                         copy_qt_qt(r_quat, quat);
700
701                 return true;
702         }
703         return false;
704 }
705
706 void curve_deform_verts(
707         Object *cuOb, Object *target, Mesh *mesh, float (*vertexCos)[3],
708         int numVerts, const char *vgroup, short defaxis)
709 {
710         Curve *cu;
711         int a;
712         CurveDeform cd;
713         MDeformVert *dvert = NULL;
714         int defgrp_index = -1;
715         const bool is_neg_axis = (defaxis > 2);
716
717         if (cuOb->type != OB_CURVE)
718                 return;
719
720         cu = cuOb->data;
721
722         init_curve_deform(cuOb, target, &cd);
723
724         /* dummy bounds, keep if CU_DEFORM_BOUNDS_OFF is set */
725         if (is_neg_axis == false) {
726                 cd.dmin[0] = cd.dmin[1] = cd.dmin[2] = 0.0f;
727                 cd.dmax[0] = cd.dmax[1] = cd.dmax[2] = 1.0f;
728         }
729         else {
730                 /* negative, these bounds give a good rest position */
731                 cd.dmin[0] = cd.dmin[1] = cd.dmin[2] = -1.0f;
732                 cd.dmax[0] = cd.dmax[1] = cd.dmax[2] =  0.0f;
733         }
734         
735         /* Check whether to use vertex groups (only possible if target is a Mesh or Lattice).
736          * We want either a Mesh/Lattice with no derived data, or derived data with deformverts.
737          */
738         if (vgroup && vgroup[0] && ELEM(target->type, OB_MESH, OB_LATTICE)) {
739                 defgrp_index = defgroup_name_index(target, vgroup);
740
741                 if (defgrp_index != -1) {
742                         /* if there's derived data without deformverts, don't use vgroups */
743                         if (mesh) {
744                                 dvert = CustomData_get_layer(&mesh->vdata, CD_MDEFORMVERT);
745                         }
746                         else if (target->type == OB_LATTICE) {
747                                 dvert = ((Lattice *)target->data)->dvert;
748                         }
749                         else {
750                                 dvert = ((Mesh *)target->data)->dvert;
751                         }
752                 }
753         }
754
755         if (dvert) {
756                 MDeformVert *dvert_iter;
757                 float vec[3];
758
759                 if (cu->flag & CU_DEFORM_BOUNDS_OFF) {
760                         for (a = 0, dvert_iter = dvert; a < numVerts; a++, dvert_iter++) {
761                                 const float weight = defvert_find_weight(dvert_iter, defgrp_index);
762
763                                 if (weight > 0.0f) {
764                                         mul_m4_v3(cd.curvespace, vertexCos[a]);
765                                         copy_v3_v3(vec, vertexCos[a]);
766                                         calc_curve_deform(cuOb, vec, defaxis, &cd, NULL);
767                                         interp_v3_v3v3(vertexCos[a], vertexCos[a], vec, weight);
768                                         mul_m4_v3(cd.objectspace, vertexCos[a]);
769                                 }
770                         }
771                 }
772                 else {
773                         /* set mesh min/max bounds */
774                         INIT_MINMAX(cd.dmin, cd.dmax);
775
776                         for (a = 0, dvert_iter = dvert; a < numVerts; a++, dvert_iter++) {
777                                 if (defvert_find_weight(dvert_iter, defgrp_index) > 0.0f) {
778                                         mul_m4_v3(cd.curvespace, vertexCos[a]);
779                                         minmax_v3v3_v3(cd.dmin, cd.dmax, vertexCos[a]);
780                                 }
781                         }
782
783                         for (a = 0, dvert_iter = dvert; a < numVerts; a++, dvert_iter++) {
784                                 const float weight = defvert_find_weight(dvert_iter, defgrp_index);
785
786                                 if (weight > 0.0f) {
787                                         /* already in 'cd.curvespace', prev for loop */
788                                         copy_v3_v3(vec, vertexCos[a]);
789                                         calc_curve_deform(cuOb, vec, defaxis, &cd, NULL);
790                                         interp_v3_v3v3(vertexCos[a], vertexCos[a], vec, weight);
791                                         mul_m4_v3(cd.objectspace, vertexCos[a]);
792                                 }
793                         }
794                 }
795         }
796         else {
797                 if (cu->flag & CU_DEFORM_BOUNDS_OFF) {
798                         for (a = 0; a < numVerts; a++) {
799                                 mul_m4_v3(cd.curvespace, vertexCos[a]);
800                                 calc_curve_deform(cuOb, vertexCos[a], defaxis, &cd, NULL);
801                                 mul_m4_v3(cd.objectspace, vertexCos[a]);
802                         }
803                 }
804                 else {
805                         /* set mesh min max bounds */
806                         INIT_MINMAX(cd.dmin, cd.dmax);
807                                 
808                         for (a = 0; a < numVerts; a++) {
809                                 mul_m4_v3(cd.curvespace, vertexCos[a]);
810                                 minmax_v3v3_v3(cd.dmin, cd.dmax, vertexCos[a]);
811                         }
812         
813                         for (a = 0; a < numVerts; a++) {
814                                 /* already in 'cd.curvespace', prev for loop */
815                                 calc_curve_deform(cuOb, vertexCos[a], defaxis, &cd, NULL);
816                                 mul_m4_v3(cd.objectspace, vertexCos[a]);
817                         }
818                 }
819         }
820 }
821
822 /* input vec and orco = local coord in armature space */
823 /* orco is original not-animated or deformed reference point */
824 /* result written in vec and mat */
825 void curve_deform_vector(Object *cuOb, Object *target,
826                          float orco[3], float vec[3], float mat[3][3], int no_rot_axis)
827 {
828         CurveDeform cd;
829         float quat[4];
830         
831         if (cuOb->type != OB_CURVE) {
832                 unit_m3(mat);
833                 return;
834         }
835
836         init_curve_deform(cuOb, target, &cd);
837         cd.no_rot_axis = no_rot_axis;                /* option to only rotate for XY, for example */
838         
839         copy_v3_v3(cd.dmin, orco);
840         copy_v3_v3(cd.dmax, orco);
841
842         mul_m4_v3(cd.curvespace, vec);
843         
844         if (calc_curve_deform(cuOb, vec, target->trackflag, &cd, quat)) {
845                 float qmat[3][3];
846                 
847                 quat_to_mat3(qmat, quat);
848                 mul_m3_m3m3(mat, qmat, cd.objectspace3);
849         }
850         else
851                 unit_m3(mat);
852         
853         mul_m4_v3(cd.objectspace, vec);
854
855 }
856
857 void lattice_deform_verts(Object *laOb, Object *target, Mesh *mesh,
858                           float (*vertexCos)[3], int numVerts, const char *vgroup, float fac)
859 {
860         LatticeDeformData *lattice_deform_data;
861         MDeformVert *dvert = NULL;
862         int defgrp_index = -1;
863         int a;
864
865         if (laOb->type != OB_LATTICE)
866                 return;
867
868         lattice_deform_data = init_latt_deform(laOb, target);
869
870         /* Check whether to use vertex groups (only possible if target is a Mesh or Lattice).
871          * We want either a Mesh/Lattice with no derived data, or derived data with deformverts.
872          */
873         if (vgroup && vgroup[0] && target && ELEM(target->type, OB_MESH, OB_LATTICE)) {
874                 defgrp_index = defgroup_name_index(target, vgroup);
875
876                 if (defgrp_index != -1) {
877                         /* if there's derived data without deformverts, don't use vgroups */
878                         if (mesh) {
879                                 dvert = CustomData_get_layer(&mesh->vdata, CD_MDEFORMVERT);
880                         }
881                         else if (target->type == OB_LATTICE) {
882                                 dvert = ((Lattice *)target->data)->dvert;
883                         }
884                         else {
885                                 dvert = ((Mesh *)target->data)->dvert;
886                         }
887                 }
888         }
889         if (dvert) {
890                 MDeformVert *dvert_iter;
891                 for (a = 0, dvert_iter = dvert; a < numVerts; a++, dvert_iter++) {
892                         const float weight = defvert_find_weight(dvert_iter, defgrp_index);
893                         if (weight > 0.0f) {
894                                 calc_latt_deform(lattice_deform_data, vertexCos[a], weight * fac);
895                         }
896                 }
897         }
898         else {
899                 for (a = 0; a < numVerts; a++) {
900                         calc_latt_deform(lattice_deform_data, vertexCos[a], fac);
901                 }
902         }
903         end_latt_deform(lattice_deform_data);
904 }
905
906 bool object_deform_mball(Object *ob, ListBase *dispbase)
907 {
908         if (ob->parent && ob->parent->type == OB_LATTICE && ob->partype == PARSKEL) {
909                 DispList *dl;
910
911                 for (dl = dispbase->first; dl; dl = dl->next) {
912                         lattice_deform_verts(ob->parent, ob, NULL,
913                                              (float(*)[3])dl->verts, dl->nr, NULL, 1.0f);
914                 }
915
916                 return true;
917         }
918         else {
919                 return false;
920         }
921 }
922
923 static BPoint *latt_bp(Lattice *lt, int u, int v, int w)
924 {
925         return &lt->def[BKE_lattice_index_from_uvw(lt, u, v, w)];
926 }
927
928 void outside_lattice(Lattice *lt)
929 {
930         BPoint *bp, *bp1, *bp2;
931         int u, v, w;
932         float fac1, du = 0.0, dv = 0.0, dw = 0.0;
933
934         if (lt->flag & LT_OUTSIDE) {
935                 bp = lt->def;
936
937                 if (lt->pntsu > 1) du = 1.0f / ((float)lt->pntsu - 1);
938                 if (lt->pntsv > 1) dv = 1.0f / ((float)lt->pntsv - 1);
939                 if (lt->pntsw > 1) dw = 1.0f / ((float)lt->pntsw - 1);
940                         
941                 for (w = 0; w < lt->pntsw; w++) {
942                         
943                         for (v = 0; v < lt->pntsv; v++) {
944                         
945                                 for (u = 0; u < lt->pntsu; u++, bp++) {
946                                         if (u == 0 || v == 0 || w == 0 || u == lt->pntsu - 1 || v == lt->pntsv - 1 || w == lt->pntsw - 1) {
947                                                 /* pass */
948                                         }
949                                         else {
950                                                 bp->hide = 1;
951                                                 bp->f1 &= ~SELECT;
952                                                 
953                                                 /* u extrema */
954                                                 bp1 = latt_bp(lt, 0, v, w);
955                                                 bp2 = latt_bp(lt, lt->pntsu - 1, v, w);
956                                                 
957                                                 fac1 = du * u;
958                                                 bp->vec[0] = (1.0f - fac1) * bp1->vec[0] + fac1 * bp2->vec[0];
959                                                 bp->vec[1] = (1.0f - fac1) * bp1->vec[1] + fac1 * bp2->vec[1];
960                                                 bp->vec[2] = (1.0f - fac1) * bp1->vec[2] + fac1 * bp2->vec[2];
961                                                 
962                                                 /* v extrema */
963                                                 bp1 = latt_bp(lt, u, 0, w);
964                                                 bp2 = latt_bp(lt, u, lt->pntsv - 1, w);
965                                                 
966                                                 fac1 = dv * v;
967                                                 bp->vec[0] += (1.0f - fac1) * bp1->vec[0] + fac1 * bp2->vec[0];
968                                                 bp->vec[1] += (1.0f - fac1) * bp1->vec[1] + fac1 * bp2->vec[1];
969                                                 bp->vec[2] += (1.0f - fac1) * bp1->vec[2] + fac1 * bp2->vec[2];
970                                                 
971                                                 /* w extrema */
972                                                 bp1 = latt_bp(lt, u, v, 0);
973                                                 bp2 = latt_bp(lt, u, v, lt->pntsw - 1);
974                                                 
975                                                 fac1 = dw * w;
976                                                 bp->vec[0] += (1.0f - fac1) * bp1->vec[0] + fac1 * bp2->vec[0];
977                                                 bp->vec[1] += (1.0f - fac1) * bp1->vec[1] + fac1 * bp2->vec[1];
978                                                 bp->vec[2] += (1.0f - fac1) * bp1->vec[2] + fac1 * bp2->vec[2];
979                                                 
980                                                 mul_v3_fl(bp->vec, 1.0f / 3.0f);
981                                                 
982                                         }
983                                 }
984                                 
985                         }
986                         
987                 }
988         }
989         else {
990                 bp = lt->def;
991
992                 for (w = 0; w < lt->pntsw; w++)
993                         for (v = 0; v < lt->pntsv; v++)
994                                 for (u = 0; u < lt->pntsu; u++, bp++)
995                                         bp->hide = 0;
996         }
997 }
998
999 float (*BKE_lattice_vertexcos_get(struct Object *ob, int *r_numVerts))[3]
1000 {
1001         Lattice *lt = ob->data;
1002         int i, numVerts;
1003         float (*vertexCos)[3];
1004
1005         if (lt->editlatt) lt = lt->editlatt->latt;
1006         numVerts = *r_numVerts = lt->pntsu * lt->pntsv * lt->pntsw;
1007         
1008         vertexCos = MEM_mallocN(sizeof(*vertexCos) * numVerts, "lt_vcos");
1009         
1010         for (i = 0; i < numVerts; i++) {
1011                 copy_v3_v3(vertexCos[i], lt->def[i].vec);
1012         }
1013
1014         return vertexCos;
1015 }
1016
1017 void BKE_lattice_vertexcos_apply(struct Object *ob, float (*vertexCos)[3])
1018 {
1019         Lattice *lt = ob->data;
1020         int i, numVerts = lt->pntsu * lt->pntsv * lt->pntsw;
1021
1022         for (i = 0; i < numVerts; i++) {
1023                 copy_v3_v3(lt->def[i].vec, vertexCos[i]);
1024         }
1025 }
1026
1027 void BKE_lattice_modifiers_calc(struct Depsgraph *depsgraph, Scene *scene, Object *ob)
1028 {
1029         Lattice *lt = ob->data;
1030         /* Get vertex coordinates from the original copy; otherwise we get already-modified coordinates. */
1031         Object *ob_orig = DEG_get_original_object(ob);
1032         VirtualModifierData virtualModifierData;
1033         ModifierData *md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
1034         float (*vertexCos)[3] = NULL;
1035         int numVerts, editmode = (lt->editlatt != NULL);
1036         const ModifierEvalContext mectx = {depsgraph, ob, 0};
1037
1038         if (ob->curve_cache) {
1039                 BKE_displist_free(&ob->curve_cache->disp);
1040         }
1041         else {
1042                 ob->curve_cache = MEM_callocN(sizeof(CurveCache), "CurveCache for lattice");
1043         }
1044
1045         for (; md; md = md->next) {
1046                 const ModifierTypeInfo *mti = modifierType_getInfo(md->type);
1047
1048                 md->scene = scene;
1049                 
1050                 if (!(mti->flags & eModifierTypeFlag_AcceptsLattice)) continue;
1051                 if (!(md->mode & eModifierMode_Realtime)) continue;
1052                 if (editmode && !(md->mode & eModifierMode_Editmode)) continue;
1053                 if (mti->isDisabled && mti->isDisabled(md, 0)) continue;
1054                 if (mti->type != eModifierTypeType_OnlyDeform) continue;
1055
1056                 if (!vertexCos) vertexCos = BKE_lattice_vertexcos_get(ob_orig, &numVerts);
1057                 modifier_deformVerts_DM_deprecated(md, &mectx, NULL, vertexCos, numVerts);
1058         }
1059
1060         if (ob->id.tag & LIB_TAG_COPIED_ON_WRITE) {
1061                 if (vertexCos) {
1062                         BKE_lattice_vertexcos_apply(ob, vertexCos);
1063                         MEM_freeN(vertexCos);
1064                 }
1065         }
1066         else {
1067                 /* Displist won't do anything; this is just for posterity's sake until we remove it. */
1068                 if (!vertexCos) vertexCos = BKE_lattice_vertexcos_get(ob_orig, &numVerts);
1069
1070                 DispList *dl = MEM_callocN(sizeof(*dl), "lt_dl");
1071                 dl->type = DL_VERTS;
1072                 dl->parts = 1;
1073                 dl->nr = numVerts;
1074                 dl->verts = (float *) vertexCos;
1075                 
1076                 BLI_addtail(&ob->curve_cache->disp, dl);
1077         }
1078 }
1079
1080 struct MDeformVert *BKE_lattice_deform_verts_get(struct Object *oblatt)
1081 {
1082         Lattice *lt = (Lattice *)oblatt->data;
1083         BLI_assert(oblatt->type == OB_LATTICE);
1084         if (lt->editlatt) lt = lt->editlatt->latt;
1085         return lt->dvert;
1086 }
1087
1088 struct BPoint *BKE_lattice_active_point_get(Lattice *lt)
1089 {
1090         BLI_assert(GS(lt->id.name) == ID_LT);
1091
1092         if (lt->editlatt) {
1093                 lt = lt->editlatt->latt;
1094         }
1095
1096         BLI_assert(lt->actbp < lt->pntsu * lt->pntsv * lt->pntsw);
1097
1098         if ((lt->actbp != LT_ACTBP_NONE) && (lt->actbp < lt->pntsu * lt->pntsv * lt->pntsw)) {
1099                 return &lt->def[lt->actbp];
1100         }
1101         else {
1102                 return NULL;
1103         }
1104 }
1105
1106 void BKE_lattice_center_median(Lattice *lt, float cent[3])
1107 {
1108         int i, numVerts;
1109
1110         if (lt->editlatt) lt = lt->editlatt->latt;
1111         numVerts = lt->pntsu * lt->pntsv * lt->pntsw;
1112
1113         zero_v3(cent);
1114
1115         for (i = 0; i < numVerts; i++)
1116                 add_v3_v3(cent, lt->def[i].vec);
1117
1118         mul_v3_fl(cent, 1.0f / (float)numVerts);
1119 }
1120
1121 static void boundbox_lattice(Object *ob)
1122 {
1123         BoundBox *bb;
1124         Lattice *lt;
1125         float min[3], max[3];
1126
1127         if (ob->bb == NULL) {
1128                 ob->bb = MEM_callocN(sizeof(BoundBox), "Lattice boundbox");
1129         }
1130
1131         bb = ob->bb;
1132         lt = ob->data;
1133
1134         INIT_MINMAX(min, max);
1135         BKE_lattice_minmax_dl(ob, lt, min, max);
1136         BKE_boundbox_init_from_minmax(bb, min, max);
1137
1138         bb->flag &= ~BOUNDBOX_DIRTY;
1139 }
1140
1141 BoundBox *BKE_lattice_boundbox_get(Object *ob)
1142 {
1143         boundbox_lattice(ob);
1144
1145         return ob->bb;
1146 }
1147
1148 void BKE_lattice_minmax_dl(Object *ob, Lattice *lt, float min[3], float max[3])
1149 {
1150         DispList *dl = ob->curve_cache ? BKE_displist_find(&ob->curve_cache->disp, DL_VERTS) : NULL;
1151
1152         if (!dl) {
1153                 BKE_lattice_minmax(lt, min, max);
1154         }
1155         else {
1156                 int i, numVerts;
1157                 
1158                 if (lt->editlatt) lt = lt->editlatt->latt;
1159                 numVerts = lt->pntsu * lt->pntsv * lt->pntsw;
1160
1161                 for (i = 0; i < numVerts; i++)
1162                         minmax_v3v3_v3(min, max, &dl->verts[i * 3]);
1163         }
1164 }
1165
1166 void BKE_lattice_minmax(Lattice *lt, float min[3], float max[3])
1167 {
1168         int i, numVerts;
1169
1170         if (lt->editlatt) lt = lt->editlatt->latt;
1171         numVerts = lt->pntsu * lt->pntsv * lt->pntsw;
1172
1173         for (i = 0; i < numVerts; i++)
1174                 minmax_v3v3_v3(min, max, lt->def[i].vec);
1175 }
1176
1177 void BKE_lattice_center_bounds(Lattice *lt, float cent[3])
1178 {
1179         float min[3], max[3];
1180
1181         INIT_MINMAX(min, max);
1182
1183         BKE_lattice_minmax(lt, min, max);
1184         mid_v3_v3v3(cent, min, max);
1185 }
1186
1187 void BKE_lattice_transform(Lattice *lt, float mat[4][4], bool do_keys)
1188 {
1189         BPoint *bp = lt->def;
1190         int i = lt->pntsu * lt->pntsv * lt->pntsw;
1191
1192         while (i--) {
1193                 mul_m4_v3(mat, bp->vec);
1194                 bp++;
1195         }
1196
1197         if (do_keys && lt->key) {
1198                 KeyBlock *kb;
1199
1200                 for (kb = lt->key->block.first; kb; kb = kb->next) {
1201                         float *fp = kb->data;
1202                         for (i = kb->totelem; i--; fp += 3) {
1203                                 mul_m4_v3(mat, fp);
1204                         }
1205                 }
1206         }
1207 }
1208
1209 void BKE_lattice_translate(Lattice *lt, float offset[3], bool do_keys)
1210 {
1211         int i, numVerts;
1212
1213         numVerts = lt->pntsu * lt->pntsv * lt->pntsw;
1214
1215         if (lt->def)
1216                 for (i = 0; i < numVerts; i++)
1217                         add_v3_v3(lt->def[i].vec, offset);
1218
1219         if (lt->editlatt)
1220                 for (i = 0; i < numVerts; i++)
1221                         add_v3_v3(lt->editlatt->latt->def[i].vec, offset);
1222
1223         if (do_keys && lt->key) {
1224                 KeyBlock *kb;
1225
1226                 for (kb = lt->key->block.first; kb; kb = kb->next) {
1227                         float *fp = kb->data;
1228                         for (i = kb->totelem; i--; fp += 3) {
1229                                 add_v3_v3(fp, offset);
1230                         }
1231                 }
1232         }
1233 }
1234
1235 bool BKE_lattice_is_any_selected(const Lattice *lt)
1236 {
1237         /* Intentionally don't handle 'lt->editlatt' (caller must do this). */
1238         const BPoint *bp = lt->def;
1239         int a = lt->pntsu * lt->pntsv * lt->pntsw;
1240         while (a--) {
1241                 if (bp->hide == 0) {
1242                         if (bp->f1 & SELECT) {
1243                                 return true;
1244                         }
1245                 }
1246                 bp++;
1247         }
1248         return false;
1249 }
1250
1251 /* **** Depsgraph evaluation **** */
1252
1253 void BKE_lattice_eval_geometry(struct Depsgraph *UNUSED(depsgraph),
1254                                Lattice *UNUSED(latt))
1255 {
1256 }
1257
1258 /* Draw Engine */
1259 void (*BKE_lattice_batch_cache_dirty_cb)(Lattice *lt, int mode) = NULL;
1260 void (*BKE_lattice_batch_cache_free_cb)(Lattice *lt) = NULL;
1261
1262 void BKE_lattice_batch_cache_dirty(Lattice *lt, int mode)
1263 {
1264         if (lt->batch_cache) {
1265                 BKE_lattice_batch_cache_dirty_cb(lt, mode);
1266         }
1267 }
1268 void BKE_lattice_batch_cache_free(Lattice *lt)
1269 {
1270         if (lt->batch_cache) {
1271                 BKE_lattice_batch_cache_free_cb(lt);
1272         }
1273 }