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