Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / anim.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/anim.c
29  *  \ingroup bke
30  */
31
32 #include "MEM_guardedalloc.h"
33
34 #include <stdlib.h>
35
36 #include "BLI_listbase.h"
37 #include "BLI_math.h"
38
39 #include "BLT_translation.h"
40
41 #include "DNA_anim_types.h"
42 #include "DNA_armature_types.h"
43 #include "DNA_key_types.h"
44 #include "DNA_scene_types.h"
45
46 #include "BKE_context.h"
47 #include "BKE_curve.h"
48 #include "BKE_global.h"
49 #include "BKE_key.h"
50 #include "BKE_main.h"
51 #include "BKE_object.h"
52 #include "BKE_particle.h"
53 #include "BKE_scene.h"
54 #include "BKE_anim.h"
55 #include "BKE_report.h"
56
57 #include "DEG_depsgraph.h"
58 #include "DEG_depsgraph_build.h"
59
60 // XXX bad level call...
61
62 /* --------------------- */
63 /* forward declarations */
64
65 /* ******************************************************************** */
66 /* Animation Visualization */
67
68 /* Initialize the default settings for animation visualization */
69 void animviz_settings_init(bAnimVizSettings *avs)
70 {
71         /* sanity check */
72         if (avs == NULL)
73                 return;
74
75         /* ghosting settings */
76         avs->ghost_bc = avs->ghost_ac = 10;
77
78         avs->ghost_sf = 1; /* xxx - take from scene instead? */
79         avs->ghost_ef = 250; /* xxx - take from scene instead? */
80
81         avs->ghost_step = 1;
82
83
84         /* path settings */
85         avs->path_bc = avs->path_ac = 10;
86
87         avs->path_sf = 1; /* xxx - take from scene instead? */
88         avs->path_ef = 250; /* xxx - take from scene instead? */
89
90         avs->path_viewflag = (MOTIONPATH_VIEW_KFRAS | MOTIONPATH_VIEW_KFNOS);
91
92         avs->path_step = 1;
93 }
94
95 /* ------------------- */
96
97 /* Free the given motion path's cache */
98 void animviz_free_motionpath_cache(bMotionPath *mpath) 
99 {
100         /* sanity check */
101         if (mpath == NULL) 
102                 return;
103                 
104         /* free the path if necessary */
105         if (mpath->points)
106                 MEM_freeN(mpath->points);
107         
108         /* reset the relevant parameters */
109         mpath->points = NULL;
110         mpath->length = 0;
111 }
112
113 /* Free the given motion path instance and its data 
114  * NOTE: this frees the motion path given!
115  */
116 void animviz_free_motionpath(bMotionPath *mpath)
117 {
118         /* sanity check */
119         if (mpath == NULL)
120                 return;
121         
122         /* free the cache first */
123         animviz_free_motionpath_cache(mpath);
124         
125         /* now the instance itself */
126         MEM_freeN(mpath);
127 }
128
129 /* ------------------- */
130
131 /**
132  * Setup motion paths for the given data.
133  * \note Only used when explicitly calculating paths on bones which may/may not be consider already
134  *
135  * \param scene Current scene (for frame ranges, etc.)
136  * \param ob Object to add paths for (must be provided)
137  * \param pchan Posechannel to add paths for (optional; if not provided, object-paths are assumed)
138  */
139 bMotionPath *animviz_verify_motionpaths(ReportList *reports, Scene *scene, Object *ob, bPoseChannel *pchan)
140 {
141         bAnimVizSettings *avs;
142         bMotionPath *mpath, **dst;
143         
144         /* sanity checks */
145         if (ELEM(NULL, scene, ob))
146                 return NULL;
147                 
148         /* get destination data */
149         if (pchan) {
150                 /* paths for posechannel - assume that posechannel belongs to the object */
151                 avs = &ob->pose->avs;
152                 dst = &pchan->mpath;
153         }
154         else {
155                 /* paths for object */
156                 avs = &ob->avs;
157                 dst = &ob->mpath;
158         }
159
160         /* avoid 0 size allocs */
161         if (avs->path_sf >= avs->path_ef) {
162                 BKE_reportf(reports, RPT_ERROR,
163                             "Motion path frame extents invalid for %s (%d to %d)%s",
164                             (pchan) ? pchan->name : ob->id.name,
165                             avs->path_sf, avs->path_ef,
166                             (avs->path_sf == avs->path_ef) ? TIP_(", cannot have single-frame paths") : "");
167                 return NULL;
168         }
169
170         /* if there is already a motionpath, just return that,
171          * provided it's settings are ok (saves extra free+alloc)
172          */
173         if (*dst != NULL) {
174                 int expected_length = avs->path_ef - avs->path_sf;
175                 
176                 mpath = *dst;
177                 
178                 /* path is "valid" if length is valid, but must also be of the same length as is being requested */
179                 if ((mpath->start_frame != mpath->end_frame) && (mpath->length > 0)) {
180                         /* outer check ensures that we have some curve data for this path */
181                         if (mpath->length == expected_length) {
182                                 /* return/use this as it is already valid length */
183                                 return mpath;
184                         }
185                         else {
186                                 /* clear the existing path (as the range has changed), and reallocate below */
187                                 animviz_free_motionpath_cache(mpath);
188                         }
189                 }
190         }
191         else {
192                 /* create a new motionpath, and assign it */
193                 mpath = MEM_callocN(sizeof(bMotionPath), "bMotionPath");
194                 *dst = mpath;
195         }
196         
197         /* set settings from the viz settings */
198         mpath->start_frame = avs->path_sf;
199         mpath->end_frame = avs->path_ef;
200         
201         mpath->length = mpath->end_frame - mpath->start_frame;
202         
203         if (avs->path_bakeflag & MOTIONPATH_BAKE_HEADS)
204                 mpath->flag |= MOTIONPATH_FLAG_BHEAD;
205         else
206                 mpath->flag &= ~MOTIONPATH_FLAG_BHEAD;
207
208         /* set default custom values */
209         mpath->color[0] = 1.0;    /* Red */
210         mpath->color[1] = 0.0;
211         mpath->color[2] = 0.0;
212
213         mpath->line_thickness = 1;
214         mpath->flag |= MOTIONPATH_FLAG_LINES;  /* draw lines by default */
215
216         /* allocate a cache */
217         mpath->points = MEM_callocN(sizeof(bMotionPathVert) * mpath->length, "bMotionPathVerts");
218         
219         /* tag viz settings as currently having some path(s) which use it */
220         avs->path_bakeflag |= MOTIONPATH_BAKE_HAS_PATHS;
221         
222         /* return it */
223         return mpath;
224 }
225
226 /* ------------------- */
227
228 /* Motion path needing to be baked (mpt) */
229 typedef struct MPathTarget {
230         struct MPathTarget *next, *prev;
231         
232         bMotionPath *mpath;         /* motion path in question */
233         
234         Object *ob;                 /* source object */
235         bPoseChannel *pchan;        /* source posechannel (if applicable) */
236 } MPathTarget;
237
238 /* ........ */
239
240 /* get list of motion paths to be baked for the given object
241  *  - assumes the given list is ready to be used
242  */
243 /* TODO: it would be nice in future to be able to update objects dependent on these bones too? */
244 void animviz_get_object_motionpaths(Object *ob, ListBase *targets)
245 {
246         MPathTarget *mpt;
247         
248         /* object itself first */
249         if ((ob->avs.recalc & ANIMVIZ_RECALC_PATHS) && (ob->mpath)) {
250                 /* new target for object */
251                 mpt = MEM_callocN(sizeof(MPathTarget), "MPathTarget Ob");
252                 BLI_addtail(targets, mpt);
253                 
254                 mpt->mpath = ob->mpath;
255                 mpt->ob = ob;
256         }
257         
258         /* bones */
259         if ((ob->pose) && (ob->pose->avs.recalc & ANIMVIZ_RECALC_PATHS)) {
260                 bArmature *arm = ob->data;
261                 bPoseChannel *pchan;
262                 
263                 for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
264                         if ((pchan->bone) && (arm->layer & pchan->bone->layer) && (pchan->mpath)) {
265                                 /* new target for bone */
266                                 mpt = MEM_callocN(sizeof(MPathTarget), "MPathTarget PoseBone");
267                                 BLI_addtail(targets, mpt);
268                                 
269                                 mpt->mpath = pchan->mpath;
270                                 mpt->ob = ob;
271                                 mpt->pchan = pchan;
272                         }
273                 }
274         }
275 }
276
277 /* ........ */
278
279 /* update scene for current frame */
280 static void motionpaths_calc_update_scene(Main *bmain,
281                                           Scene *scene,
282                                           SceneLayer *scene_layer,
283                                           struct Depsgraph *depsgraph)
284 {
285         /* Do all updates
286          *  - if this is too slow, resort to using a more efficient way
287          *    that doesn't force complete update, but for now, this is the
288          *    most accurate way!
289          *
290          * TODO(segey): Bring back partial updates, which became impossible
291          * with the new depsgraph due to unsorted nature of bases.
292          *
293          * TODO(sergey): Use evaluation context dedicated to motion paths.
294          */
295         BKE_scene_graph_update_for_newframe(bmain->eval_ctx, depsgraph, bmain, scene, scene_layer);
296 }
297
298 /* ........ */
299
300 /* perform baking for the targets on the current frame */
301 static void motionpaths_calc_bake_targets(Scene *scene, ListBase *targets)
302 {
303         MPathTarget *mpt;
304         
305         /* for each target, check if it can be baked on the current frame */
306         for (mpt = targets->first; mpt; mpt = mpt->next) {
307                 bMotionPath *mpath = mpt->mpath;
308                 bMotionPathVert *mpv;
309                 
310                 /* current frame must be within the range the cache works for 
311                  *      - is inclusive of the first frame, but not the last otherwise we get buffer overruns
312                  */
313                 if ((CFRA < mpath->start_frame) || (CFRA >= mpath->end_frame))
314                         continue;
315                 
316                 /* get the relevant cache vert to write to */
317                 mpv = mpath->points + (CFRA - mpath->start_frame);
318                 
319                 /* pose-channel or object path baking? */
320                 if (mpt->pchan) {
321                         /* heads or tails */
322                         if (mpath->flag & MOTIONPATH_FLAG_BHEAD) {
323                                 copy_v3_v3(mpv->co, mpt->pchan->pose_head);
324                         }
325                         else {
326                                 copy_v3_v3(mpv->co, mpt->pchan->pose_tail);
327                         }
328                         
329                         /* result must be in worldspace */
330                         mul_m4_v3(mpt->ob->obmat, mpv->co);
331                 }
332                 else {
333                         /* worldspace object location */
334                         copy_v3_v3(mpv->co, mpt->ob->obmat[3]);
335                 }
336         }
337 }
338
339 /* Perform baking of the given object's and/or its bones' transforms to motion paths 
340  *      - scene: current scene
341  *      - ob: object whose flagged motionpaths should get calculated
342  *      - recalc: whether we need to
343  */
344 /* TODO: include reports pointer? */
345  void animviz_calc_motionpaths(EvaluationContext *eval_ctx, Main *bmain, Scene *scene, ListBase *targets)
346 {
347         MPathTarget *mpt;
348         int sfra, efra;
349         int cfra;
350         
351         /* sanity check */
352         if (ELEM(NULL, targets, targets->first))
353                 return;
354         
355         /* set frame values */
356         cfra = CFRA;
357         sfra = efra = cfra;
358         
359         /* TODO: this method could be improved...
360          * 1) max range for standard baking
361          * 2) minimum range for recalc baking (i.e. between keyframes, but how?) */
362         for (mpt = targets->first; mpt; mpt = mpt->next) {
363                 /* try to increase area to do (only as much as needed) */
364                 sfra = MIN2(sfra, mpt->mpath->start_frame);
365                 efra = MAX2(efra, mpt->mpath->end_frame);
366         }
367         if (efra <= sfra) return;
368         
369         /* calculate path over requested range */
370         for (CFRA = sfra; CFRA <= efra; CFRA++) {
371                 /* update relevant data for new frame */
372                 motionpaths_calc_update_scene(bmain, scene, eval_ctx->scene_layer, eval_ctx->depsgraph);
373                 
374                 /* perform baking for targets */
375                 motionpaths_calc_bake_targets(scene, targets);
376         }
377         
378         /* reset original environment */
379         CFRA = cfra;
380         motionpaths_calc_update_scene(bmain, scene, eval_ctx->scene_layer, eval_ctx->depsgraph);
381         
382         /* clear recalc flags from targets */
383         for (mpt = targets->first; mpt; mpt = mpt->next) {
384                 bAnimVizSettings *avs;
385                 
386                 /* get pointer to animviz settings for each target */
387                 if (mpt->pchan)
388                         avs = &mpt->ob->pose->avs;
389                 else
390                         avs = &mpt->ob->avs;
391                 
392                 /* clear the flag requesting recalculation of targets */
393                 avs->recalc &= ~ANIMVIZ_RECALC_PATHS;
394         }
395 }
396
397 /* ******************************************************************** */
398 /* Curve Paths - for curve deforms and/or curve following */
399
400 /* free curve path data 
401  * NOTE: frees the path itself!
402  * NOTE: this is increasingly inaccurate with non-uniform BevPoint subdivisions [#24633]
403  */
404 void free_path(Path *path)
405 {
406         if (path->data) MEM_freeN(path->data);
407         MEM_freeN(path);
408 }
409
410 /* calculate a curve-deform path for a curve 
411  *  - only called from displist.c -> do_makeDispListCurveTypes
412  */
413 void calc_curvepath(Object *ob, ListBase *nurbs)
414 {
415         BevList *bl;
416         BevPoint *bevp, *bevpn, *bevpfirst, *bevplast;
417         PathPoint *pp;
418         Nurb *nu;
419         Path *path;
420         float *fp, *dist, *maxdist, xyz[3];
421         float fac, d = 0, fac1, fac2;
422         int a, tot, cycl = 0;
423         
424         /* in a path vertices are with equal differences: path->len = number of verts */
425         /* NOW WITH BEVELCURVE!!! */
426         
427         if (ob == NULL || ob->type != OB_CURVE) {
428                 return;
429         }
430
431         if (ob->curve_cache->path) free_path(ob->curve_cache->path);
432         ob->curve_cache->path = NULL;
433         
434         /* weak! can only use first curve */
435         bl = ob->curve_cache->bev.first;
436         if (bl == NULL || !bl->nr) {
437                 return;
438         }
439
440         nu = nurbs->first;
441
442         ob->curve_cache->path = path = MEM_callocN(sizeof(Path), "calc_curvepath");
443         
444         /* if POLY: last vertice != first vertice */
445         cycl = (bl->poly != -1);
446         
447         tot = cycl ? bl->nr : bl->nr - 1;
448         
449         path->len = tot + 1;
450         /* exception: vector handle paths and polygon paths should be subdivided at least a factor resolu */
451         if (path->len < nu->resolu * SEGMENTSU(nu)) {
452                 path->len = nu->resolu * SEGMENTSU(nu);
453         }
454         
455         dist = (float *)MEM_mallocN(sizeof(float) * (tot + 1), "calcpathdist");
456
457         /* all lengths in *dist */
458         bevp = bevpfirst = bl->bevpoints;
459         fp = dist;
460         *fp = 0.0f;
461         for (a = 0; a < tot; a++) {
462                 fp++;
463                 if (cycl && a == tot - 1)
464                         sub_v3_v3v3(xyz, bevpfirst->vec, bevp->vec);
465                 else
466                         sub_v3_v3v3(xyz, (bevp + 1)->vec, bevp->vec);
467                 
468                 *fp = *(fp - 1) + len_v3(xyz);
469                 bevp++;
470         }
471         
472         path->totdist = *fp;
473         
474         /* the path verts  in path->data */
475         /* now also with TILT value */
476         pp = path->data = (PathPoint *)MEM_callocN(sizeof(PathPoint) * path->len, "pathdata");
477
478         bevp = bevpfirst;
479         bevpn = bevp + 1;
480         bevplast = bevpfirst + (bl->nr - 1);
481         if (UNLIKELY(bevpn > bevplast)) {
482                 bevpn = cycl ? bevpfirst : bevplast;
483         }
484         fp = dist + 1;
485         maxdist = dist + tot;
486         fac = 1.0f / ((float)path->len - 1.0f);
487         fac = fac * path->totdist;
488         
489         for (a = 0; a < path->len; a++) {
490                 
491                 d = ((float)a) * fac;
492                 
493                 /* we're looking for location (distance) 'd' in the array */
494                 if (LIKELY(tot > 0)) {
495                         while ((fp < maxdist) && (d >= *fp)) {
496                                 fp++;
497                                 if (bevp < bevplast) bevp++;
498                                 bevpn = bevp + 1;
499                                 if (UNLIKELY(bevpn > bevplast)) {
500                                         bevpn = cycl ? bevpfirst : bevplast;
501                                 }
502                         }
503
504                         fac1 = (*(fp) - d) / (*(fp) - *(fp - 1));
505                         fac2 = 1.0f - fac1;
506                 }
507                 else {
508                         fac1 = 1.0f;
509                         fac2 = 0.0f;
510                 }
511
512                 interp_v3_v3v3(pp->vec, bevp->vec, bevpn->vec, fac2);
513                 pp->vec[3] = fac1 * bevp->alfa   + fac2 * bevpn->alfa;
514                 pp->radius = fac1 * bevp->radius + fac2 * bevpn->radius;
515                 pp->weight = fac1 * bevp->weight + fac2 * bevpn->weight;
516                 interp_qt_qtqt(pp->quat, bevp->quat, bevpn->quat, fac2);
517                 normalize_qt(pp->quat);
518                 
519                 pp++;
520         }
521         
522         MEM_freeN(dist);
523 }
524
525 static int interval_test(const int min, const int max, int p1, const int cycl)
526 {
527         if (cycl) {
528                 p1 = mod_i(p1 - min, (max - min + 1)) + min;
529         }
530         else {
531                 if      (p1 < min) p1 = min;
532                 else if (p1 > max) p1 = max;
533         }
534         return p1;
535 }
536
537
538 /* calculate the deformation implied by the curve path at a given parametric position,
539  * and returns whether this operation succeeded.
540  *
541  * note: ctime is normalized range <0-1>
542  *
543  * returns OK: 1/0
544  */
545 int where_on_path(Object *ob, float ctime, float vec[4], float dir[3], float quat[4], float *radius, float *weight)
546 {
547         Curve *cu;
548         Nurb *nu;
549         BevList *bl;
550         Path *path;
551         PathPoint *pp, *p0, *p1, *p2, *p3;
552         float fac;
553         float data[4];
554         int cycl = 0, s0, s1, s2, s3;
555         ListBase *nurbs;
556
557         if (ob == NULL || ob->type != OB_CURVE) return 0;
558         cu = ob->data;
559         if (ob->curve_cache == NULL || ob->curve_cache->path == NULL || ob->curve_cache->path->data == NULL) {
560                 printf("no path!\n");
561                 return 0;
562         }
563         path = ob->curve_cache->path;
564         pp = path->data;
565         
566         /* test for cyclic */
567         bl = ob->curve_cache->bev.first;
568         if (!bl) return 0;
569         if (!bl->nr) return 0;
570         if (bl->poly > -1) cycl = 1;
571
572         /* values below zero for non-cyclic curves give strange results */
573         BLI_assert(cycl || ctime >= 0.0f);
574
575         ctime *= (path->len - 1);
576         
577         s1 = (int)floor(ctime);
578         fac = (float)(s1 + 1) - ctime;
579
580         /* path->len is corected for cyclic */
581         s0 = interval_test(0, path->len - 1 - cycl, s1 - 1, cycl);
582         s1 = interval_test(0, path->len - 1 - cycl, s1, cycl);
583         s2 = interval_test(0, path->len - 1 - cycl, s1 + 1, cycl);
584         s3 = interval_test(0, path->len - 1 - cycl, s1 + 2, cycl);
585
586         p0 = pp + s0;
587         p1 = pp + s1;
588         p2 = pp + s2;
589         p3 = pp + s3;
590
591         /* NOTE: commented out for follow constraint
592          *
593          *       If it's ever be uncommented watch out for curve_deform_verts()
594          *       which used to temporary set CU_FOLLOW flag for the curve and no
595          *       longer does it (because of threading issues of such a thing.
596          */
597         //if (cu->flag & CU_FOLLOW) {
598
599         key_curve_tangent_weights(1.0f - fac, data, KEY_BSPLINE);
600
601         interp_v3_v3v3v3v3(dir, p0->vec, p1->vec, p2->vec, p3->vec, data);
602
603         /* make compatible with vectoquat */
604         negate_v3(dir);
605         //}
606
607         nurbs = BKE_curve_editNurbs_get(cu);
608         if (!nurbs)
609                 nurbs = &cu->nurb;
610         nu = nurbs->first;
611
612         /* make sure that first and last frame are included in the vectors here  */
613         if (nu->type == CU_POLY) key_curve_position_weights(1.0f - fac, data, KEY_LINEAR);
614         else if (nu->type == CU_BEZIER) key_curve_position_weights(1.0f - fac, data, KEY_LINEAR);
615         else if (s0 == s1 || p2 == p3) key_curve_position_weights(1.0f - fac, data, KEY_CARDINAL);
616         else key_curve_position_weights(1.0f - fac, data, KEY_BSPLINE);
617
618         vec[0] = data[0] * p0->vec[0] + data[1] * p1->vec[0] + data[2] * p2->vec[0] + data[3] * p3->vec[0]; /* X */
619         vec[1] = data[0] * p0->vec[1] + data[1] * p1->vec[1] + data[2] * p2->vec[1] + data[3] * p3->vec[1]; /* Y */
620         vec[2] = data[0] * p0->vec[2] + data[1] * p1->vec[2] + data[2] * p2->vec[2] + data[3] * p3->vec[2]; /* Z */
621         vec[3] = data[0] * p0->vec[3] + data[1] * p1->vec[3] + data[2] * p2->vec[3] + data[3] * p3->vec[3]; /* Tilt, should not be needed since we have quat still used */
622
623         if (quat) {
624                 float totfac, q1[4], q2[4];
625
626                 totfac = data[0] + data[3];
627                 if (totfac > FLT_EPSILON) interp_qt_qtqt(q1, p0->quat, p3->quat, data[3] / totfac);
628                 else copy_qt_qt(q1, p1->quat);
629
630                 totfac = data[1] + data[2];
631                 if (totfac > FLT_EPSILON) interp_qt_qtqt(q2, p1->quat, p2->quat, data[2] / totfac);
632                 else copy_qt_qt(q2, p3->quat);
633
634                 totfac = data[0] + data[1] + data[2] + data[3];
635                 if (totfac > FLT_EPSILON) interp_qt_qtqt(quat, q1, q2, (data[1] + data[2]) / totfac);
636                 else copy_qt_qt(quat, q2);
637         }
638
639         if (radius)
640                 *radius = data[0] * p0->radius + data[1] * p1->radius + data[2] * p2->radius + data[3] * p3->radius;
641
642         if (weight)
643                 *weight = data[0] * p0->weight + data[1] * p1->weight + data[2] * p2->weight + data[3] * p3->weight;
644
645         return 1;
646 }