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