Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenkernel / intern / anim.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup bke
21  */
22
23 #include "MEM_guardedalloc.h"
24
25 #include <stdlib.h>
26
27 #include "BLI_listbase.h"
28 #include "BLI_math.h"
29 #include "BLI_dlrbTree.h"
30
31 #include "BLT_translation.h"
32
33 #include "DNA_anim_types.h"
34 #include "DNA_armature_types.h"
35 #include "DNA_key_types.h"
36 #include "DNA_scene_types.h"
37
38 #include "BKE_anim.h"
39 #include "BKE_animsys.h"
40 #include "BKE_action.h"
41 #include "BKE_curve.h"
42 #include "BKE_key.h"
43 #include "BKE_main.h"
44 #include "BKE_object.h"
45 #include "BKE_particle.h"
46 #include "BKE_scene.h"
47 #include "BKE_report.h"
48
49 #include "DEG_depsgraph.h"
50 #include "DEG_depsgraph_query.h"
51 #include "DEG_depsgraph_build.h"
52
53 #include "GPU_batch.h"
54
55 #include "CLG_log.h"
56
57 static CLG_LogRef LOG = {"bke.anim"};
58
59 // XXX bad level call...
60 extern short compare_ak_cfraPtr(void *node, void *data);
61 extern void agroup_to_keylist(struct AnimData *adt, struct bActionGroup *agrp, struct DLRBT_Tree *keys, int saction_flag);
62 extern void action_to_keylist(struct AnimData *adt, struct bAction *act, struct DLRBT_Tree *keys, int saction_flag);
63
64 /* --------------------- */
65 /* forward declarations */
66
67 /* ******************************************************************** */
68 /* Animation Visualization */
69
70 /* Initialize the default settings for animation visualization */
71 void animviz_settings_init(bAnimVizSettings *avs)
72 {
73         /* sanity check */
74         if (avs == NULL)
75                 return;
76
77         /* ghosting settings */
78         avs->ghost_bc = avs->ghost_ac = 10;
79
80         avs->ghost_sf = 1; /* xxx - take from scene instead? */
81         avs->ghost_ef = 250; /* xxx - take from scene instead? */
82
83         avs->ghost_step = 1;
84
85
86         /* path settings */
87         avs->path_bc = avs->path_ac = 10;
88
89         avs->path_sf = 1; /* xxx - take from scene instead? */
90         avs->path_ef = 250; /* xxx - take from scene instead? */
91
92         avs->path_viewflag = (MOTIONPATH_VIEW_KFRAS | MOTIONPATH_VIEW_KFNOS);
93
94         avs->path_step = 1;
95
96         avs->path_bakeflag |= MOTIONPATH_BAKE_HEADS;
97 }
98
99 /* ------------------- */
100
101 /* Free the given motion path's cache */
102 void animviz_free_motionpath_cache(bMotionPath *mpath)
103 {
104         /* sanity check */
105         if (mpath == NULL)
106                 return;
107
108         /* free the path if necessary */
109         if (mpath->points)
110                 MEM_freeN(mpath->points);
111
112         GPU_VERTBUF_DISCARD_SAFE(mpath->points_vbo);
113         GPU_BATCH_DISCARD_SAFE(mpath->batch_line);
114         GPU_BATCH_DISCARD_SAFE(mpath->batch_points);
115
116         /* reset the relevant parameters */
117         mpath->points = NULL;
118         mpath->length = 0;
119 }
120
121 /* Free the given motion path instance and its data
122  * NOTE: this frees the motion path given!
123  */
124 void animviz_free_motionpath(bMotionPath *mpath)
125 {
126         /* sanity check */
127         if (mpath == NULL)
128                 return;
129
130         /* free the cache first */
131         animviz_free_motionpath_cache(mpath);
132
133         /* now the instance itself */
134         MEM_freeN(mpath);
135 }
136
137 /* ------------------- */
138
139 /* Make a copy of motionpath data, so that viewing with copy on write works */
140 bMotionPath *animviz_copy_motionpath(const bMotionPath *mpath_src)
141 {
142         bMotionPath *mpath_dst;
143
144         if (mpath_src == NULL)
145                 return NULL;
146
147         mpath_dst = MEM_dupallocN(mpath_src);
148         mpath_dst->points = MEM_dupallocN(mpath_src->points);
149
150         /* should get recreated on draw... */
151         mpath_dst->points_vbo = NULL;
152         mpath_dst->batch_line = NULL;
153         mpath_dst->batch_points = NULL;
154
155         return mpath_dst;
156 }
157
158 /* ------------------- */
159
160 /**
161  * Setup motion paths for the given data.
162  * \note Only used when explicitly calculating paths on bones which may/may not be consider already
163  *
164  * \param scene: Current scene (for frame ranges, etc.)
165  * \param ob: Object to add paths for (must be provided)
166  * \param pchan: Posechannel to add paths for (optional; if not provided, object-paths are assumed)
167  */
168 bMotionPath *animviz_verify_motionpaths(ReportList *reports, Scene *scene, Object *ob, bPoseChannel *pchan)
169 {
170         bAnimVizSettings *avs;
171         bMotionPath *mpath, **dst;
172
173         /* sanity checks */
174         if (ELEM(NULL, scene, ob))
175                 return NULL;
176
177         /* get destination data */
178         if (pchan) {
179                 /* paths for posechannel - assume that posechannel belongs to the object */
180                 avs = &ob->pose->avs;
181                 dst = &pchan->mpath;
182         }
183         else {
184                 /* paths for object */
185                 avs = &ob->avs;
186                 dst = &ob->mpath;
187         }
188
189         /* avoid 0 size allocs */
190         if (avs->path_sf >= avs->path_ef) {
191                 BKE_reportf(reports, RPT_ERROR,
192                             "Motion path frame extents invalid for %s (%d to %d)%s",
193                             (pchan) ? pchan->name : ob->id.name,
194                             avs->path_sf, avs->path_ef,
195                             (avs->path_sf == avs->path_ef) ? TIP_(", cannot have single-frame paths") : "");
196                 return NULL;
197         }
198
199         /* if there is already a motionpath, just return that,
200          * provided it's settings are ok (saves extra free+alloc)
201          */
202         if (*dst != NULL) {
203                 int expected_length = avs->path_ef - avs->path_sf;
204
205                 mpath = *dst;
206
207                 /* path is "valid" if length is valid, but must also be of the same length as is being requested */
208                 if ((mpath->start_frame != mpath->end_frame) && (mpath->length > 0)) {
209                         /* outer check ensures that we have some curve data for this path */
210                         if (mpath->length == expected_length) {
211                                 /* return/use this as it is already valid length */
212                                 return mpath;
213                         }
214                         else {
215                                 /* clear the existing path (as the range has changed), and reallocate below */
216                                 animviz_free_motionpath_cache(mpath);
217                         }
218                 }
219         }
220         else {
221                 /* create a new motionpath, and assign it */
222                 mpath = MEM_callocN(sizeof(bMotionPath), "bMotionPath");
223                 *dst = mpath;
224         }
225
226         /* set settings from the viz settings */
227         mpath->start_frame = avs->path_sf;
228         mpath->end_frame = avs->path_ef;
229
230         mpath->length = mpath->end_frame - mpath->start_frame;
231
232         if (avs->path_bakeflag & MOTIONPATH_BAKE_HEADS)
233                 mpath->flag |= MOTIONPATH_FLAG_BHEAD;
234         else
235                 mpath->flag &= ~MOTIONPATH_FLAG_BHEAD;
236
237         /* set default custom values */
238         mpath->color[0] = 1.0;    /* Red */
239         mpath->color[1] = 0.0;
240         mpath->color[2] = 0.0;
241
242         mpath->line_thickness = 2;
243         mpath->flag |= MOTIONPATH_FLAG_LINES;  /* draw lines by default */
244
245         /* allocate a cache */
246         mpath->points = MEM_callocN(sizeof(bMotionPathVert) * mpath->length, "bMotionPathVerts");
247
248         /* tag viz settings as currently having some path(s) which use it */
249         avs->path_bakeflag |= MOTIONPATH_BAKE_HAS_PATHS;
250
251         /* return it */
252         return mpath;
253 }
254
255 /* ------------------- */
256
257 /* Motion path needing to be baked (mpt) */
258 typedef struct MPathTarget {
259         struct MPathTarget *next, *prev;
260
261         bMotionPath *mpath;         /* motion path in question */
262
263         DLRBT_Tree keys;         /* temp, to know where the keyframes are */
264
265         /* Original (Source Objects) */
266         Object *ob;                 /* source object */
267         bPoseChannel *pchan;        /* source posechannel (if applicable) */
268
269         /* "Evaluated" Copies (these come from the background COW copie
270          * that provide all the coordinates we want to save off)
271          */
272         Object *ob_eval;             /* evaluated object */
273 } MPathTarget;
274
275 /* ........ */
276
277 /* get list of motion paths to be baked for the given object
278  * - assumes the given list is ready to be used
279  */
280 /* TODO: it would be nice in future to be able to update objects dependent on these bones too? */
281 void animviz_get_object_motionpaths(Object *ob, ListBase *targets)
282 {
283         MPathTarget *mpt;
284
285         /* object itself first */
286         if ((ob->avs.recalc & ANIMVIZ_RECALC_PATHS) && (ob->mpath)) {
287                 /* new target for object */
288                 mpt = MEM_callocN(sizeof(MPathTarget), "MPathTarget Ob");
289                 BLI_addtail(targets, mpt);
290
291                 mpt->mpath = ob->mpath;
292                 mpt->ob = ob;
293         }
294
295         /* bones */
296         if ((ob->pose) && (ob->pose->avs.recalc & ANIMVIZ_RECALC_PATHS)) {
297                 bArmature *arm = ob->data;
298                 bPoseChannel *pchan;
299
300                 for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
301                         if ((pchan->bone) && (arm->layer & pchan->bone->layer) && (pchan->mpath)) {
302                                 /* new target for bone */
303                                 mpt = MEM_callocN(sizeof(MPathTarget), "MPathTarget PoseBone");
304                                 BLI_addtail(targets, mpt);
305
306                                 mpt->mpath = pchan->mpath;
307                                 mpt->ob = ob;
308                                 mpt->pchan = pchan;
309                         }
310                 }
311         }
312 }
313
314 /* ........ */
315
316 /* update scene for current frame */
317 static void motionpaths_calc_update_scene(Main *bmain,
318                                           struct Depsgraph *depsgraph)
319 {
320         /* Do all updates
321          *  - if this is too slow, resort to using a more efficient way
322          *    that doesn't force complete update, but for now, this is the
323          *    most accurate way!
324          *
325          * TODO(segey): Bring back partial updates, which became impossible
326          * with the new depsgraph due to unsorted nature of bases.
327          *
328          * TODO(sergey): Use evaluation context dedicated to motion paths.
329          */
330         BKE_scene_graph_update_for_newframe(depsgraph, bmain);
331 }
332
333 /* ........ */
334
335 /* perform baking for the targets on the current frame */
336 static void motionpaths_calc_bake_targets(ListBase *targets, int cframe)
337 {
338         MPathTarget *mpt;
339
340         /* for each target, check if it can be baked on the current frame */
341         for (mpt = targets->first; mpt; mpt = mpt->next) {
342                 bMotionPath *mpath = mpt->mpath;
343
344                 /* current frame must be within the range the cache works for
345                  * - is inclusive of the first frame, but not the last otherwise we get buffer overruns
346                  */
347                 if ((cframe < mpath->start_frame) || (cframe >= mpath->end_frame)) {
348                         continue;
349                 }
350
351                 /* get the relevant cache vert to write to */
352                 bMotionPathVert *mpv = mpath->points + (cframe - mpath->start_frame);
353
354                 Object *ob_eval = mpt->ob_eval;
355
356                 /* Lookup evaluated pose channel, here because the depsgraph
357                  * evaluation can change them so they are not cached in mpt. */
358                 bPoseChannel *pchan_eval = NULL;
359                 if (mpt->pchan) {
360                         pchan_eval = BKE_pose_channel_find_name(ob_eval->pose, mpt->pchan->name);
361                 }
362
363                 /* pose-channel or object path baking? */
364                 if (pchan_eval) {
365                         /* heads or tails */
366                         if (mpath->flag & MOTIONPATH_FLAG_BHEAD) {
367                                 copy_v3_v3(mpv->co, pchan_eval->pose_head);
368                         }
369                         else {
370                                 copy_v3_v3(mpv->co, pchan_eval->pose_tail);
371                         }
372
373                         /* result must be in worldspace */
374                         mul_m4_v3(ob_eval->obmat, mpv->co);
375                 }
376                 else {
377                         /* worldspace object location */
378                         copy_v3_v3(mpv->co, ob_eval->obmat[3]);
379                 }
380
381                 float mframe = (float)(cframe);
382
383                 /* Tag if it's a keyframe */
384                 if (BLI_dlrbTree_search_exact(&mpt->keys, compare_ak_cfraPtr, &mframe)) {
385                         mpv->flag |= MOTIONPATH_VERT_KEY;
386                 }
387
388                 /* Incremental update on evaluated object if possible, for fast updating
389                  * while dragging in transform. */
390                 bMotionPath *mpath_eval = NULL;
391                 if (mpt->pchan) {
392                         mpath_eval = (pchan_eval) ? pchan_eval->mpath : NULL;
393                 }
394                 else {
395                         mpath_eval = ob_eval->mpath;
396                 }
397
398                 if (mpath_eval && mpath_eval->length == mpath->length) {
399                         bMotionPathVert *mpv_eval = mpath_eval->points + (cframe - mpath_eval->start_frame);
400                         *mpv_eval = *mpv;
401
402                         GPU_VERTBUF_DISCARD_SAFE(mpath_eval->points_vbo);
403                         GPU_BATCH_DISCARD_SAFE(mpath_eval->batch_line);
404                         GPU_BATCH_DISCARD_SAFE(mpath_eval->batch_points);
405                 }
406         }
407 }
408
409 /* Perform baking of the given object's and/or its bones' transforms to motion paths
410  * - scene: current scene
411  * - ob: object whose flagged motionpaths should get calculated
412  * - recalc: whether we need to
413  */
414 /* TODO: include reports pointer? */
415 void animviz_calc_motionpaths(Depsgraph *depsgraph,
416                               Main *bmain,
417                               Scene *scene,
418                               ListBase *targets,
419                               bool restore,
420                               bool current_frame_only)
421 {
422         /* sanity check */
423         if (ELEM(NULL, targets, targets->first))
424                 return;
425
426         /* Compute frame range to bake within.
427          * TODO: this method could be improved...
428          * 1) max range for standard baking
429          * 2) minimum range for recalc baking (i.e. between keyframes, but how?) */
430         int sfra = INT_MAX;
431         int efra = INT_MIN;
432
433         for (MPathTarget *mpt = targets->first; mpt; mpt = mpt->next) {
434                 /* try to increase area to do (only as much as needed) */
435                 sfra = MIN2(sfra, mpt->mpath->start_frame);
436                 efra = MAX2(efra, mpt->mpath->end_frame);
437         }
438
439         if (efra <= sfra) {
440                 return;
441         }
442
443         /* Limit frame range if we are updating just the current frame. */
444         /* set frame values */
445         int cfra = CFRA;
446         if (current_frame_only) {
447                 if (cfra < sfra || cfra > efra) {
448                         return;
449                 }
450                 sfra = efra = cfra;
451         }
452
453         /* get copies of objects/bones to get the calculated results from
454          * (for copy-on-write evaluation), so that we actually get some results
455          */
456         // TODO: Create a copy of background depsgraph that only contain these entities, and only evaluates them..
457         for (MPathTarget *mpt = targets->first; mpt; mpt = mpt->next) {
458                 mpt->ob_eval = DEG_get_evaluated_object(depsgraph, mpt->ob);
459
460                 AnimData *adt = BKE_animdata_from_id(&mpt->ob_eval->id);
461
462                 /* build list of all keyframes in active action for object or pchan */
463                 BLI_dlrbTree_init(&mpt->keys);
464
465                 if (adt) {
466                         bAnimVizSettings *avs;
467
468                         /* get pointer to animviz settings for each target */
469                         if (mpt->pchan)
470                                 avs = &mpt->ob->pose->avs;
471                         else
472                                 avs = &mpt->ob->avs;
473
474                         /* it is assumed that keyframes for bones are all grouped in a single group
475                          * unless an option is set to always use the whole action
476                          */
477                         if ((mpt->pchan) && (avs->path_viewflag & MOTIONPATH_VIEW_KFACT) == 0) {
478                                 bActionGroup *agrp = BKE_action_group_find_name(adt->action, mpt->pchan->name);
479
480                                 if (agrp) {
481                                         agroup_to_keylist(adt, agrp, &mpt->keys, 0);
482                                 }
483                         }
484                         else {
485                                 action_to_keylist(adt, adt->action, &mpt->keys, 0);
486                         }
487                 }
488         }
489
490         /* calculate path over requested range */
491         CLOG_INFO(&LOG, 1, "Calculating MotionPaths between frames %d - %d (%d frames)", sfra, efra, efra - sfra + 1);
492         for (CFRA = sfra; CFRA <= efra; CFRA++) {
493                 if (current_frame_only) {
494                         /* For current frame, only update tagged. */
495                         BKE_scene_graph_update_tagged(depsgraph, bmain);
496                 }
497                 else {
498                         /* Update relevant data for new frame. */
499                         motionpaths_calc_update_scene(bmain, depsgraph);
500                 }
501
502                 /* perform baking for targets */
503                 motionpaths_calc_bake_targets(targets, CFRA);
504         }
505
506         /* reset original environment */
507         /* NOTE: We don't always need to reevaluate the main scene, as the depsgraph
508          * may be a temporary one that works on a subset of the data. We always have
509          * to resoture the current frame though. */
510         CFRA = cfra;
511         if (!current_frame_only && restore) {
512                 motionpaths_calc_update_scene(bmain, depsgraph);
513         }
514
515         /* clear recalc flags from targets */
516         for (MPathTarget *mpt = targets->first; mpt; mpt = mpt->next) {
517                 bAnimVizSettings *avs;
518                 bMotionPath *mpath = mpt->mpath;
519
520                 /* get pointer to animviz settings for each target */
521                 if (mpt->pchan)
522                         avs = &mpt->ob->pose->avs;
523                 else
524                         avs = &mpt->ob->avs;
525
526                 /* clear the flag requesting recalculation of targets */
527                 avs->recalc &= ~ANIMVIZ_RECALC_PATHS;
528
529                 /* Clean temp data */
530                 BLI_dlrbTree_free(&mpt->keys);
531
532                 /* Free previous batches to force update. */
533                 GPU_VERTBUF_DISCARD_SAFE(mpath->points_vbo);
534                 GPU_BATCH_DISCARD_SAFE(mpath->batch_line);
535                 GPU_BATCH_DISCARD_SAFE(mpath->batch_points);
536         }
537 }
538
539 /* ******************************************************************** */
540 /* Curve Paths - for curve deforms and/or curve following */
541
542 /* free curve path data
543  * NOTE: frees the path itself!
544  * NOTE: this is increasingly inaccurate with non-uniform BevPoint subdivisions [#24633]
545  */
546 void free_path(Path *path)
547 {
548         if (path->data) MEM_freeN(path->data);
549         MEM_freeN(path);
550 }
551
552 /* calculate a curve-deform path for a curve
553  * - only called from displist.c -> do_makeDispListCurveTypes
554  */
555 void calc_curvepath(Object *ob, ListBase *nurbs)
556 {
557         BevList *bl;
558         BevPoint *bevp, *bevpn, *bevpfirst, *bevplast;
559         PathPoint *pp;
560         Nurb *nu;
561         Path *path;
562         float *fp, *dist, *maxdist, xyz[3];
563         float fac, d = 0, fac1, fac2;
564         int a, tot, cycl = 0;
565
566         /* in a path vertices are with equal differences: path->len = number of verts */
567         /* NOW WITH BEVELCURVE!!! */
568
569         if (ob == NULL || ob->type != OB_CURVE) {
570                 return;
571         }
572
573         if (ob->runtime.curve_cache->path) free_path(ob->runtime.curve_cache->path);
574         ob->runtime.curve_cache->path = NULL;
575
576         /* weak! can only use first curve */
577         bl = ob->runtime.curve_cache->bev.first;
578         if (bl == NULL || !bl->nr) {
579                 return;
580         }
581
582         nu = nurbs->first;
583
584         ob->runtime.curve_cache->path = path = MEM_callocN(sizeof(Path), "calc_curvepath");
585
586         /* if POLY: last vertice != first vertice */
587         cycl = (bl->poly != -1);
588
589         tot = cycl ? bl->nr : bl->nr - 1;
590
591         path->len = tot + 1;
592         /* exception: vector handle paths and polygon paths should be subdivided at least a factor resolu */
593         if (path->len < nu->resolu * SEGMENTSU(nu)) {
594                 path->len = nu->resolu * SEGMENTSU(nu);
595         }
596
597         dist = (float *)MEM_mallocN(sizeof(float) * (tot + 1), "calcpathdist");
598
599         /* all lengths in *dist */
600         bevp = bevpfirst = bl->bevpoints;
601         fp = dist;
602         *fp = 0.0f;
603         for (a = 0; a < tot; a++) {
604                 fp++;
605                 if (cycl && a == tot - 1)
606                         sub_v3_v3v3(xyz, bevpfirst->vec, bevp->vec);
607                 else
608                         sub_v3_v3v3(xyz, (bevp + 1)->vec, bevp->vec);
609
610                 *fp = *(fp - 1) + len_v3(xyz);
611                 bevp++;
612         }
613
614         path->totdist = *fp;
615
616         /* the path verts  in path->data */
617         /* now also with TILT value */
618         pp = path->data = (PathPoint *)MEM_callocN(sizeof(PathPoint) * path->len, "pathdata");
619
620         bevp = bevpfirst;
621         bevpn = bevp + 1;
622         bevplast = bevpfirst + (bl->nr - 1);
623         if (UNLIKELY(bevpn > bevplast)) {
624                 bevpn = cycl ? bevpfirst : bevplast;
625         }
626         fp = dist + 1;
627         maxdist = dist + tot;
628         fac = 1.0f / ((float)path->len - 1.0f);
629         fac = fac * path->totdist;
630
631         for (a = 0; a < path->len; a++) {
632
633                 d = ((float)a) * fac;
634
635                 /* we're looking for location (distance) 'd' in the array */
636                 if (LIKELY(tot > 0)) {
637                         while ((fp < maxdist) && (d >= *fp)) {
638                                 fp++;
639                                 if (bevp < bevplast) bevp++;
640                                 bevpn = bevp + 1;
641                                 if (UNLIKELY(bevpn > bevplast)) {
642                                         bevpn = cycl ? bevpfirst : bevplast;
643                                 }
644                         }
645
646                         fac1 = (*(fp) - d) / (*(fp) - *(fp - 1));
647                         fac2 = 1.0f - fac1;
648                 }
649                 else {
650                         fac1 = 1.0f;
651                         fac2 = 0.0f;
652                 }
653
654                 interp_v3_v3v3(pp->vec, bevp->vec, bevpn->vec, fac2);
655                 pp->vec[3] = fac1 * bevp->alfa   + fac2 * bevpn->alfa;
656                 pp->radius = fac1 * bevp->radius + fac2 * bevpn->radius;
657                 pp->weight = fac1 * bevp->weight + fac2 * bevpn->weight;
658                 interp_qt_qtqt(pp->quat, bevp->quat, bevpn->quat, fac2);
659                 normalize_qt(pp->quat);
660
661                 pp++;
662         }
663
664         MEM_freeN(dist);
665 }
666
667 static int interval_test(const int min, const int max, int p1, const int cycl)
668 {
669         if (cycl) {
670                 p1 = mod_i(p1 - min, (max - min + 1)) + min;
671         }
672         else {
673                 if      (p1 < min) p1 = min;
674                 else if (p1 > max) p1 = max;
675         }
676         return p1;
677 }
678
679
680 /* calculate the deformation implied by the curve path at a given parametric position,
681  * and returns whether this operation succeeded.
682  *
683  * note: ctime is normalized range <0-1>
684  *
685  * returns OK: 1/0
686  */
687 int where_on_path(Object *ob, float ctime, float vec[4], float dir[3], float quat[4], float *radius, float *weight)
688 {
689         Curve *cu;
690         Nurb *nu;
691         BevList *bl;
692         Path *path;
693         PathPoint *pp, *p0, *p1, *p2, *p3;
694         float fac;
695         float data[4];
696         int cycl = 0, s0, s1, s2, s3;
697         ListBase *nurbs;
698
699         if (ob == NULL || ob->type != OB_CURVE) return 0;
700         cu = ob->data;
701         if (ob->runtime.curve_cache == NULL || ob->runtime.curve_cache->path == NULL || ob->runtime.curve_cache->path->data == NULL) {
702                 CLOG_WARN(&LOG, "no path!");
703                 return 0;
704         }
705         path = ob->runtime.curve_cache->path;
706         pp = path->data;
707
708         /* test for cyclic */
709         bl = ob->runtime.curve_cache->bev.first;
710         if (!bl) return 0;
711         if (!bl->nr) return 0;
712         if (bl->poly > -1) cycl = 1;
713
714         /* values below zero for non-cyclic curves give strange results */
715         BLI_assert(cycl || ctime >= 0.0f);
716
717         ctime *= (path->len - 1);
718
719         s1 = (int)floor(ctime);
720         fac = (float)(s1 + 1) - ctime;
721
722         /* path->len is corrected for cyclic */
723         s0 = interval_test(0, path->len - 1 - cycl, s1 - 1, cycl);
724         s1 = interval_test(0, path->len - 1 - cycl, s1, cycl);
725         s2 = interval_test(0, path->len - 1 - cycl, s1 + 1, cycl);
726         s3 = interval_test(0, path->len - 1 - cycl, s1 + 2, cycl);
727
728         p0 = pp + s0;
729         p1 = pp + s1;
730         p2 = pp + s2;
731         p3 = pp + s3;
732
733         /* NOTE: commented out for follow constraint
734          *
735          *       If it's ever be uncommented watch out for curve_deform_verts()
736          *       which used to temporary set CU_FOLLOW flag for the curve and no
737          *       longer does it (because of threading issues of such a thing.
738          */
739         //if (cu->flag & CU_FOLLOW) {
740
741         key_curve_tangent_weights(1.0f - fac, data, KEY_BSPLINE);
742
743         interp_v3_v3v3v3v3(dir, p0->vec, p1->vec, p2->vec, p3->vec, data);
744
745         /* make compatible with vectoquat */
746         negate_v3(dir);
747         //}
748
749         nurbs = BKE_curve_editNurbs_get(cu);
750         if (!nurbs)
751                 nurbs = &cu->nurb;
752         nu = nurbs->first;
753
754         /* make sure that first and last frame are included in the vectors here  */
755         if (nu->type == CU_POLY) key_curve_position_weights(1.0f - fac, data, KEY_LINEAR);
756         else if (nu->type == CU_BEZIER) key_curve_position_weights(1.0f - fac, data, KEY_LINEAR);
757         else if (s0 == s1 || p2 == p3) key_curve_position_weights(1.0f - fac, data, KEY_CARDINAL);
758         else key_curve_position_weights(1.0f - fac, data, KEY_BSPLINE);
759
760         vec[0] = data[0] * p0->vec[0] + data[1] * p1->vec[0] + data[2] * p2->vec[0] + data[3] * p3->vec[0]; /* X */
761         vec[1] = data[0] * p0->vec[1] + data[1] * p1->vec[1] + data[2] * p2->vec[1] + data[3] * p3->vec[1]; /* Y */
762         vec[2] = data[0] * p0->vec[2] + data[1] * p1->vec[2] + data[2] * p2->vec[2] + data[3] * p3->vec[2]; /* Z */
763         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 */
764
765         if (quat) {
766                 float totfac, q1[4], q2[4];
767
768                 totfac = data[0] + data[3];
769                 if (totfac > FLT_EPSILON) interp_qt_qtqt(q1, p0->quat, p3->quat, data[3] / totfac);
770                 else copy_qt_qt(q1, p1->quat);
771
772                 totfac = data[1] + data[2];
773                 if (totfac > FLT_EPSILON) interp_qt_qtqt(q2, p1->quat, p2->quat, data[2] / totfac);
774                 else copy_qt_qt(q2, p3->quat);
775
776                 totfac = data[0] + data[1] + data[2] + data[3];
777                 if (totfac > FLT_EPSILON) interp_qt_qtqt(quat, q1, q2, (data[1] + data[2]) / totfac);
778                 else copy_qt_qt(quat, q2);
779         }
780
781         if (radius)
782                 *radius = data[0] * p0->radius + data[1] * p1->radius + data[2] * p2->radius + data[3] * p3->radius;
783
784         if (weight)
785                 *weight = data[0] * p0->weight + data[1] * p1->weight + data[2] * p2->weight + data[3] * p3->weight;
786
787         return 1;
788 }