Merging r39199 through r39485 from trunk into vgroup_modifiers.
[blender-staging.git] / source / blender / editors / armature / poseSlide.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009, Blender Foundation, Joshua Leung
21  * This is a new part of Blender
22  *
23  * Contributor(s): Joshua Leung
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/armature/poseSlide.c
29  *  \ingroup edarmature
30  */
31
32  
33 #include <stdlib.h>
34 #include <stdio.h>
35 #include <stddef.h>
36 #include <string.h>
37 #include <math.h>
38 #include <float.h>
39
40 #include "MEM_guardedalloc.h"
41
42 #include "BLI_math.h"
43 #include "BLI_blenlib.h"
44 #include "BLI_dynstr.h"
45 #include "BLI_dlrbTree.h"
46 #include "BLI_utildefines.h"
47
48 #include "DNA_anim_types.h"
49 #include "DNA_armature_types.h"
50 #include "DNA_object_types.h"
51 #include "DNA_scene_types.h"
52
53 #include "BKE_fcurve.h"
54
55 #include "BKE_context.h"
56 #include "BKE_report.h"
57
58 #include "RNA_access.h"
59 #include "RNA_define.h"
60
61 #include "WM_api.h"
62 #include "WM_types.h"
63
64 #include "ED_armature.h"
65 #include "ED_keyframes_draw.h"
66 #include "ED_markers.h"
67 #include "ED_screen.h"
68
69 #include "armature_intern.h"
70
71 /* **************************************************** */
72 /* == POSE 'SLIDING' TOOLS == 
73  *
74  * A) Push & Relax, Breakdowner
75  * These tools provide the animator with various capabilities
76  * for interactively controlling the spacing of poses, but also
77  * for 'pushing' and/or 'relaxing' extremes as they see fit.
78  *
79  * B) Propagate
80  * This tool copies elements of the selected pose to successive
81  * keyframes, allowing the animator to go back and modify the poses
82  * for some "static" pose controls, without having to repeatedly
83  * doing a "next paste" dance.
84  *
85  * C) Pose Sculpting
86  * This is yet to be implemented, but the idea here is to use
87  * sculpting techniques to make it easier to pose rigs by allowing
88  * rigs to be manipulated using a familiar paint-based interface. 
89  */
90 /* **************************************************** */
91 /* A) Push & Relax, Breakdowner */
92
93 /* Temporary data shared between these operators */
94 typedef struct tPoseSlideOp {
95         Scene *scene;           /* current scene */
96         ARegion *ar;            /* region that we're operating in (needed for  */
97         Object *ob;                     /* active object that Pose Info comes from */
98         bArmature *arm;         /* armature for pose */
99         
100         ListBase pfLinks;       /* links between posechannels and f-curves  */
101         DLRBT_Tree keys;        /* binary tree for quicker searching for keyframes (when applicable) */
102         
103         int cframe;                     /* current frame number */
104         int prevFrame;          /* frame before current frame (blend-from) */
105         int nextFrame;          /* frame after current frame (blend-to) */
106         
107         int mode;                       /* sliding mode (ePoseSlide_Modes) */
108         int flag;                       // unused for now, but can later get used for storing runtime settings....
109         
110         float percentage;       /* 0-1 value for determining the influence of whatever is relevant */
111 } tPoseSlideOp;
112
113 /* Pose Sliding Modes */
114 typedef enum ePoseSlide_Modes {
115         POSESLIDE_PUSH  = 0,            /* exaggerate the pose... */
116         POSESLIDE_RELAX,                        /* soften the pose... */
117         POSESLIDE_BREAKDOWN,            /* slide between the endpoint poses, finding a 'soft' spot */
118 } ePoseSlide_Modes;
119
120 /* ------------------------------------ */
121
122 /* operator init */
123 static int pose_slide_init (bContext *C, wmOperator *op, short mode)
124 {
125         tPoseSlideOp *pso;
126         bAction *act= NULL;
127         
128         /* init slide-op data */
129         pso= op->customdata= MEM_callocN(sizeof(tPoseSlideOp), "tPoseSlideOp");
130         
131         /* get info from context */
132         pso->scene= CTX_data_scene(C);
133         pso->ob= ED_object_pose_armature(CTX_data_active_object(C));
134         pso->arm= (pso->ob)? pso->ob->data : NULL;
135         pso->ar= CTX_wm_region(C); /* only really needed when doing modal() */
136         
137         pso->cframe= pso->scene->r.cfra;
138         pso->mode= mode;
139         
140         /* set range info from property values - these may get overridden for the invoke() */
141         pso->percentage= RNA_float_get(op->ptr, "percentage");
142         pso->prevFrame= RNA_int_get(op->ptr, "prev_frame");
143         pso->nextFrame= RNA_int_get(op->ptr, "next_frame");
144         
145         /* check the settings from the context */
146         if (ELEM4(NULL, pso->ob, pso->arm, pso->ob->adt, pso->ob->adt->action))
147                 return 0;
148         else
149                 act= pso->ob->adt->action;
150         
151         /* for each Pose-Channel which gets affected, get the F-Curves for that channel 
152          * and set the relevant transform flags...
153          */
154         poseAnim_mapping_get(C, &pso->pfLinks, pso->ob, act);
155         
156         /* set depsgraph flags */
157                 /* make sure the lock is set OK, unlock can be accidentally saved? */
158         pso->ob->pose->flag |= POSE_LOCKED;
159         pso->ob->pose->flag &= ~POSE_DO_UNLOCK;
160         
161         /* do basic initialise of RB-BST used for finding keyframes, but leave the filling of it up 
162          * to the caller of this (usually only invoke() will do it, to make things more efficient).
163          */
164         BLI_dlrbTree_init(&pso->keys);
165         
166         /* return status is whether we've got all the data we were requested to get */
167         return 1;
168 }
169
170 /* exiting the operator - free data */
171 static void pose_slide_exit(wmOperator *op)
172 {
173         tPoseSlideOp *pso= op->customdata;
174         
175         /* if data exists, clear its data and exit */
176         if (pso) {
177                 /* free the temp pchan links and their data */
178                 poseAnim_mapping_free(&pso->pfLinks);
179                 
180                 /* free RB-BST for keyframes (if it contained data) */
181                 BLI_dlrbTree_free(&pso->keys);
182                 
183                 /* free data itself */
184                 MEM_freeN(pso);
185         }
186         
187         /* cleanup */
188         op->customdata= NULL;
189 }
190
191 /* ------------------------------------ */
192
193 /* helper for apply() / reset() - refresh the data */
194 static void pose_slide_refresh (bContext *C, tPoseSlideOp *pso)
195 {
196         /* wrapper around the generic version, allowing us to add some custom stuff later still */
197         poseAnim_mapping_refresh(C, pso->scene, pso->ob);
198 }
199
200 /* helper for apply() - perform sliding for some value */
201 static void pose_slide_apply_val (tPoseSlideOp *pso, FCurve *fcu, float *val)
202 {
203         float cframe = (float)pso->cframe;
204         float sVal, eVal;
205         float w1, w2;
206         
207         /* get keyframe values for endpoint poses to blend with */
208                 /* previous/start */
209         sVal= evaluate_fcurve(fcu, (float)pso->prevFrame);
210                 /* next/end */
211         eVal= evaluate_fcurve(fcu, (float)pso->nextFrame);
212         
213         /* calculate the relative weights of the endpoints */
214         if (pso->mode == POSESLIDE_BREAKDOWN) {
215                 /* get weights from the percentage control */
216                 w1= pso->percentage;    /* this must come second */
217                 w2= 1.0f - w1;                  /* this must come first */
218         }
219         else {
220                 /*      - these weights are derived from the relative distance of these 
221                  *        poses from the current frame
222                  *      - they then get normalised so that they only sum up to 1
223                  */
224                 float wtot; 
225                 
226                 w1 = cframe - (float)pso->prevFrame;
227                 w2 = (float)pso->nextFrame - cframe;
228                 
229                 wtot = w1 + w2;
230                 w1 = (w1/wtot);
231                 w2 = (w2/wtot);
232         }
233         
234         /* depending on the mode, calculate the new value
235          *      - in all of these, the start+end values are multiplied by w2 and w1 (respectively),
236          *        since multiplication in another order would decrease the value the current frame is closer to
237          */
238         switch (pso->mode) {
239                 case POSESLIDE_PUSH: /* make the current pose more pronounced */
240                 {
241                         /* perform a weighted average here, favouring the middle pose 
242                          *      - numerator should be larger than denominator to 'expand' the result
243                          *      - perform this weighting a number of times given by the percentage...
244                          */
245                         int iters= (int)ceil(10.0f*pso->percentage); // TODO: maybe a sensitivity ctrl on top of this is needed
246                         
247                         while (iters-- > 0) {
248                                 (*val)= ( -((sVal * w2) + (eVal * w1)) + ((*val) * 6.0f) ) / 5.0f; 
249                         }
250                 }
251                         break;
252                         
253                 case POSESLIDE_RELAX: /* make the current pose more like its surrounding ones */
254                 {
255                         /* perform a weighted average here, favouring the middle pose 
256                          *      - numerator should be smaller than denominator to 'relax' the result
257                          *      - perform this weighting a number of times given by the percentage...
258                          */
259                         int iters= (int)ceil(10.0f*pso->percentage); // TODO: maybe a sensitivity ctrl on top of this is needed
260                         
261                         while (iters-- > 0) {
262                                 (*val)= ( ((sVal * w2) + (eVal * w1)) + ((*val) * 5.0f) ) / 6.0f;
263                         }
264                 }
265                         break;
266                         
267                 case POSESLIDE_BREAKDOWN: /* make the current pose slide around between the endpoints */
268                 {
269                         /* perform simple linear interpolation - coefficient for start must come from pso->percentage... */
270                         // TODO: make this use some kind of spline interpolation instead?
271                         (*val)= ((sVal * w2) + (eVal * w1));
272                 }
273                         break;
274         }
275 }
276
277 /* helper for apply() - perform sliding for some 3-element vector */
278 static void pose_slide_apply_vec3 (tPoseSlideOp *pso, tPChanFCurveLink *pfl, float vec[3], const char propName[])
279 {
280         LinkData *ld=NULL;
281         char *path=NULL;
282         
283         /* get the path to use... */
284         path= BLI_sprintfN("%s.%s", pfl->pchan_path, propName);
285         
286         /* using this path, find each matching F-Curve for the variables we're interested in */
287         while ( (ld= poseAnim_mapping_getNextFCurve(&pfl->fcurves, ld, path)) ) {
288                 FCurve *fcu= (FCurve *)ld->data;
289                 
290                 /* just work on these channels one by one... there's no interaction between values */
291                 pose_slide_apply_val(pso, fcu, &vec[fcu->array_index]);
292         }
293         
294         /* free the temp path we got */
295         MEM_freeN(path);
296 }
297
298 /* helper for apply() - perform sliding for custom properties */
299 static void pose_slide_apply_props (tPoseSlideOp *pso, tPChanFCurveLink *pfl)
300 {
301         PointerRNA ptr = {{NULL}};
302         LinkData *ld;
303         int len = strlen(pfl->pchan_path);
304         
305         /* setup pointer RNA for resolving paths */
306         RNA_pointer_create(NULL, &RNA_PoseBone, pfl->pchan, &ptr);
307         
308         /* custom properties are just denoted using ["..."][etc.] after the end of the base path, 
309          * so just check for opening pair after the end of the path
310          */
311         for (ld = pfl->fcurves.first; ld; ld = ld->next) {
312                 FCurve *fcu = (FCurve *)ld->data;
313                 char *bPtr, *pPtr;
314                 
315                 if (fcu->rna_path == NULL)
316                         continue;
317                 
318                 /* do we have a match? 
319                  *      - bPtr is the RNA Path with the standard part chopped off
320                  *      - pPtr is the chunk of the path which is left over
321                  */
322                 bPtr = strstr(fcu->rna_path, pfl->pchan_path) + len;
323                 pPtr = strstr(bPtr, "[\"");   /* dummy " for texteditor bugs */
324                 
325                 if (pPtr) {
326                         /* use RNA to try and get a handle on this property, then, assuming that it is just
327                          * numerical, try and grab the value as a float for temp editing before setting back
328                          */
329                         PropertyRNA *prop = RNA_struct_find_property(&ptr, pPtr);
330                         
331                         if (prop) {
332                                 switch (RNA_property_type(prop)) {
333                                         case PROP_FLOAT:
334                                         {
335                                                 float tval = RNA_property_float_get(&ptr, prop);
336                                                 pose_slide_apply_val(pso, fcu, &tval);
337                                                 RNA_property_float_set(&ptr, prop, tval);
338                                         }
339                                                 break;
340                                         case PROP_BOOLEAN:
341                                         case PROP_ENUM:
342                                         case PROP_INT:
343                                         {
344                                                 float tval = (float)RNA_property_int_get(&ptr, prop);
345                                                 pose_slide_apply_val(pso, fcu, &tval);
346                                                 RNA_property_int_set(&ptr, prop, (int)tval);
347                                         }
348                                                 break;
349                                         default:
350                                                 /* cannot handle */
351                                                 //printf("Cannot Pose Slide non-numerical property\n");
352                                                 break;
353                                 }
354                         }
355                 }
356         }
357 }
358
359 /* helper for apply() - perform sliding for quaternion rotations (using quat blending) */
360 static void pose_slide_apply_quat (tPoseSlideOp *pso, tPChanFCurveLink *pfl)
361 {
362         FCurve *fcu_w=NULL, *fcu_x=NULL, *fcu_y=NULL, *fcu_z=NULL;
363         bPoseChannel *pchan= pfl->pchan;
364         LinkData *ld=NULL;
365         char *path=NULL;
366         float cframe;
367         
368         /* get the path to use - this should be quaternion rotations only (needs care) */
369         path= BLI_sprintfN("%s.%s", pfl->pchan_path, "rotation_quaternion");
370         
371         /* get the current frame number */
372         cframe= (float)pso->cframe;
373         
374         /* using this path, find each matching F-Curve for the variables we're interested in */
375         while ( (ld= poseAnim_mapping_getNextFCurve(&pfl->fcurves, ld, path)) ) {
376                 FCurve *fcu= (FCurve *)ld->data;
377                 
378                 /* assign this F-Curve to one of the relevant pointers... */
379                 switch (fcu->array_index) {
380                         case 3: /* z */
381                                 fcu_z= fcu;
382                                 break;
383                         case 2: /* y */
384                                 fcu_y= fcu;
385                                 break;
386                         case 1: /* x */
387                                 fcu_x= fcu;
388                                 break;
389                         case 0: /* w */
390                                 fcu_w= fcu;
391                                 break;
392                 }
393         }
394         
395         /* only if all channels exist, proceed */
396         if (fcu_w && fcu_x && fcu_y && fcu_z) {
397                 float quat_prev[4], quat_next[4];
398                 
399                 /* get 2 quats */
400                 quat_prev[0] = evaluate_fcurve(fcu_w, pso->prevFrame);
401                 quat_prev[1] = evaluate_fcurve(fcu_x, pso->prevFrame);
402                 quat_prev[2] = evaluate_fcurve(fcu_y, pso->prevFrame);
403                 quat_prev[3] = evaluate_fcurve(fcu_z, pso->prevFrame);
404                 
405                 quat_next[0] = evaluate_fcurve(fcu_w, pso->nextFrame);
406                 quat_next[1] = evaluate_fcurve(fcu_x, pso->nextFrame);
407                 quat_next[2] = evaluate_fcurve(fcu_y, pso->nextFrame);
408                 quat_next[3] = evaluate_fcurve(fcu_z, pso->nextFrame);
409                 
410                 /* perform blending */
411                 if (pso->mode == POSESLIDE_BREAKDOWN) {
412                         /* just perform the interpol between quat_prev and quat_next using pso->percentage as a guide */
413                         interp_qt_qtqt(pchan->quat, quat_prev, quat_next, pso->percentage);
414                 }
415                 else if (pso->mode == POSESLIDE_PUSH) {
416                         float quat_diff[4], quat_orig[4];
417                         
418                         /* calculate the delta transform from the previous to the current */
419                         // TODO: investigate ways to favour one transform more?
420                         sub_qt_qtqt(quat_diff, pchan->quat, quat_prev);
421                         
422                         /* make a copy of the original rotation */
423                         QUATCOPY(quat_orig, pchan->quat);
424                         
425                         /* increase the original by the delta transform, by an amount determined by percentage */
426                         add_qt_qtqt(pchan->quat, quat_orig, quat_diff, pso->percentage);
427                 }
428                 else {
429                         float quat_interp[4], quat_orig[4];
430                         int iters= (int)ceil(10.0f*pso->percentage); // TODO: maybe a sensitivity ctrl on top of this is needed
431                         
432                         /* perform this blending several times until a satisfactory result is reached */
433                         while (iters-- > 0) {
434                                 /* calculate the interpolation between the endpoints */
435                                 interp_qt_qtqt(quat_interp, quat_prev, quat_next, (cframe-pso->prevFrame) / (pso->nextFrame-pso->prevFrame) );
436                                 
437                                 /* make a copy of the original rotation */
438                                 QUATCOPY(quat_orig, pchan->quat);
439                                 
440                                 /* tricky interpolations - blending between original and new */
441                                 interp_qt_qtqt(pchan->quat, quat_orig, quat_interp, 1.0f/6.0f);
442                         }
443                 }
444         }
445         
446         /* free the path now */
447         MEM_freeN(path);
448 }
449
450 /* apply() - perform the pose sliding based on weighting various poses */
451 static void pose_slide_apply(bContext *C, tPoseSlideOp *pso)
452 {
453         tPChanFCurveLink *pfl;
454         
455         /* sanitise the frame ranges */
456         if (pso->prevFrame == pso->nextFrame) {
457                 /* move out one step either side */
458                 pso->prevFrame--;
459                 pso->nextFrame++;
460         }
461         
462         /* for each link, handle each set of transforms */
463         for (pfl= pso->pfLinks.first; pfl; pfl= pfl->next) {
464                 /* valid transforms for each PoseChannel should have been noted already 
465                  *      - sliding the pose should be a straightforward exercise for location+rotation, 
466                  *        but rotations get more complicated since we may want to use quaternion blending 
467                  *        for quaternions instead...
468                  */
469                 bPoseChannel *pchan= pfl->pchan;
470                  
471                 if (pchan->flag & POSE_LOC) {
472                         /* calculate these for the 'location' vector, and use location curves */
473                         pose_slide_apply_vec3(pso, pfl, pchan->loc, "location");
474                 }
475                 
476                 if (pchan->flag & POSE_SIZE) {
477                         /* calculate these for the 'scale' vector, and use scale curves */
478                         pose_slide_apply_vec3(pso, pfl, pchan->size, "scale");
479                 }
480                 
481                 if (pchan->flag & POSE_ROT) {
482                         /* everything depends on the rotation mode */
483                         if (pchan->rotmode > 0) {
484                                 /* eulers - so calculate these for the 'eul' vector, and use euler_rotation curves */
485                                 pose_slide_apply_vec3(pso, pfl, pchan->eul, "rotation_euler");
486                         }
487                         else if (pchan->rotmode == ROT_MODE_AXISANGLE) {
488                                 // TODO: need to figure out how to do this!
489                         }
490                         else {
491                                 /* quaternions - use quaternion blending */
492                                 pose_slide_apply_quat(pso, pfl);
493                         }
494                 }
495                 
496                 if (pfl->oldprops) {
497                         /* not strictly a transform, but contributes to the pose produced in many rigs */
498                         pose_slide_apply_props(pso, pfl);
499                 }
500         }
501         
502         /* depsgraph updates + redraws */
503         pose_slide_refresh(C, pso);
504 }
505
506 /* perform autokeyframing after changes were made + confirmed */
507 static void pose_slide_autoKeyframe (bContext *C, tPoseSlideOp *pso)
508 {
509         /* wrapper around the generic call */
510         poseAnim_mapping_autoKeyframe(C, pso->scene, pso->ob, &pso->pfLinks, (float)pso->cframe);
511 }
512
513 /* reset changes made to current pose */
514 static void pose_slide_reset (tPoseSlideOp *pso)
515 {
516         /* wrapper around the generic call, so that custom stuff can be added later */
517         poseAnim_mapping_reset(&pso->pfLinks);
518 }
519
520 /* ------------------------------------ */
521
522 /* common code for invoke() methods */
523 static int pose_slide_invoke_common (bContext *C, wmOperator *op, tPoseSlideOp *pso)
524 {
525         tPChanFCurveLink *pfl;
526         AnimData *adt= pso->ob->adt;
527         wmWindow *win= CTX_wm_window(C);
528         
529         /* for each link, add all its keyframes to the search tree */
530         for (pfl= pso->pfLinks.first; pfl; pfl= pfl->next) {
531                 LinkData *ld;
532                 
533                 /* do this for each F-Curve */
534                 for (ld= pfl->fcurves.first; ld; ld= ld->next) {
535                         FCurve *fcu= (FCurve *)ld->data;
536                         fcurve_to_keylist(adt, fcu, &pso->keys, NULL);
537                 }
538         }
539         
540         /* consolidate these keyframes, and figure out the nearest ones */
541         BLI_dlrbTree_linkedlist_sync(&pso->keys);
542         
543                 /* cancel if no keyframes found... */
544         if (pso->keys.root) {
545                 ActKeyColumn *ak;
546                 float cframe= (float)pso->cframe;
547                 
548                 /* firstly, check if the current frame is a keyframe... */
549                 ak= (ActKeyColumn *)BLI_dlrbTree_search_exact(&pso->keys, compare_ak_cfraPtr, &cframe);
550                 
551                 if (ak == NULL) {
552                         /* current frame is not a keyframe, so search */
553                         ActKeyColumn *pk= (ActKeyColumn *)BLI_dlrbTree_search_prev(&pso->keys, compare_ak_cfraPtr, &cframe);
554                         ActKeyColumn *nk= (ActKeyColumn *)BLI_dlrbTree_search_next(&pso->keys, compare_ak_cfraPtr, &cframe);
555                         
556                         /* new set the frames */
557                                 /* prev frame */
558                         pso->prevFrame= (pk)? (pk->cfra) : (pso->cframe - 1);
559                         RNA_int_set(op->ptr, "prev_frame", pso->prevFrame);
560                                 /* next frame */
561                         pso->nextFrame= (nk)? (nk->cfra) : (pso->cframe + 1);
562                         RNA_int_set(op->ptr, "next_frame", pso->nextFrame);
563                 }
564                 else {
565                         /* current frame itself is a keyframe, so just take keyframes on either side */
566                                 /* prev frame */
567                         pso->prevFrame= (ak->prev)? (ak->prev->cfra) : (pso->cframe - 1);
568                         RNA_int_set(op->ptr, "prev_frame", pso->prevFrame);
569                                 /* next frame */
570                         pso->nextFrame= (ak->next)? (ak->next->cfra) : (pso->cframe + 1);
571                         RNA_int_set(op->ptr, "next_frame", pso->nextFrame);
572                 }
573         }
574         else {
575                 BKE_report(op->reports, RPT_ERROR, "No keyframes to slide between.");
576                 pose_slide_exit(op);
577                 return OPERATOR_CANCELLED;
578         }
579         
580         /* initial apply for operator... */
581         // TODO: need to calculate percentage for initial round too...
582         pose_slide_apply(C, pso);
583         
584         /* depsgraph updates + redraws */
585         pose_slide_refresh(C, pso);
586         
587         /* set cursor to indicate modal */
588         WM_cursor_modal(win, BC_EW_SCROLLCURSOR);
589         
590         /* add a modal handler for this operator */
591         WM_event_add_modal_handler(C, op);
592         return OPERATOR_RUNNING_MODAL;
593 }
594
595 /* common code for modal() */
596 static int pose_slide_modal (bContext *C, wmOperator *op, wmEvent *evt)
597 {
598         tPoseSlideOp *pso= op->customdata;
599         wmWindow *win= CTX_wm_window(C);
600         
601         switch (evt->type) {
602                 case LEFTMOUSE: /* confirm */
603                 {
604                         /* return to normal cursor */
605                         WM_cursor_restore(win);
606                         
607                         /* insert keyframes as required... */
608                         pose_slide_autoKeyframe(C, pso);
609                         pose_slide_exit(op);
610                         
611                         /* done! */
612                         return OPERATOR_FINISHED;
613                 }
614                 
615                 case ESCKEY:    /* cancel */
616                 case RIGHTMOUSE: 
617                 {
618                         /* return to normal cursor */
619                         WM_cursor_restore(win);
620                         
621                         /* reset transforms back to original state */
622                         pose_slide_reset(pso);
623                         
624                         /* depsgraph updates + redraws */
625                         pose_slide_refresh(C, pso);
626                         
627                         /* clean up temp data */
628                         pose_slide_exit(op);
629                         
630                         /* cancelled! */
631                         return OPERATOR_CANCELLED;
632                 }
633                         
634                 case MOUSEMOVE: /* calculate new position */
635                 {
636                         /* calculate percentage based on position of mouse (we only use x-axis for now.
637                          * since this is more conveninent for users to do), and store new percentage value 
638                          */
639                         pso->percentage= (evt->x - pso->ar->winrct.xmin) / ((float)pso->ar->winx);
640                         RNA_float_set(op->ptr, "percentage", pso->percentage);
641                         
642                         /* reset transforms (to avoid accumulation errors) */
643                         pose_slide_reset(pso);
644                         
645                         /* apply... */
646                         pose_slide_apply(C, pso);
647                 }
648                         break;
649                         
650                 default: /* unhandled event (maybe it was some view manip? */
651                         /* allow to pass through */
652                         return OPERATOR_RUNNING_MODAL|OPERATOR_PASS_THROUGH;
653         }
654         
655         /* still running... */
656         return OPERATOR_RUNNING_MODAL;
657 }
658
659 /* common code for cancel() */
660 static int pose_slide_cancel (bContext *UNUSED(C), wmOperator *op)
661 {
662         /* cleanup and done */
663         pose_slide_exit(op);
664         return OPERATOR_CANCELLED;
665 }
666
667 /* common code for exec() methods */
668 static int pose_slide_exec_common (bContext *C, wmOperator *op, tPoseSlideOp *pso)
669 {
670         /* settings should have been set up ok for applying, so just apply! */
671         pose_slide_apply(C, pso);
672         
673         /* insert keyframes if needed */
674         pose_slide_autoKeyframe(C, pso);
675         
676         /* cleanup and done */
677         pose_slide_exit(op);
678         
679         return OPERATOR_FINISHED;
680 }
681
682 /* common code for defining RNA properties */
683 static void pose_slide_opdef_properties (wmOperatorType *ot)
684 {
685         RNA_def_int(ot->srna, "prev_frame", 0, MINAFRAME, MAXFRAME, "Previous Keyframe", "Frame number of keyframe immediately before the current frame.", 0, 50);
686         RNA_def_int(ot->srna, "next_frame", 0, MINAFRAME, MAXFRAME, "Next Keyframe", "Frame number of keyframe immediately after the current frame.", 0, 50);
687         RNA_def_float_percentage(ot->srna, "percentage", 0.5f, 0.0f, 1.0f, "Percentage", "Weighting factor for the sliding operation", 0.3, 0.7);
688 }
689
690 /* ------------------------------------ */
691
692 /* invoke() - for 'push' mode */
693 static int pose_slide_push_invoke (bContext *C, wmOperator *op, wmEvent *UNUSED(evt))
694 {
695         tPoseSlideOp *pso;
696         
697         /* initialise data  */
698         if (pose_slide_init(C, op, POSESLIDE_PUSH) == 0) {
699                 pose_slide_exit(op);
700                 return OPERATOR_CANCELLED;
701         }
702         else
703                 pso= op->customdata;
704         
705         /* do common setup work */
706         return pose_slide_invoke_common(C, op, pso);
707 }
708
709 /* exec() - for push */
710 static int pose_slide_push_exec (bContext *C, wmOperator *op)
711 {
712         tPoseSlideOp *pso;
713         
714         /* initialise data (from RNA-props) */
715         if (pose_slide_init(C, op, POSESLIDE_PUSH) == 0) {
716                 pose_slide_exit(op);
717                 return OPERATOR_CANCELLED;
718         }
719         else
720                 pso= op->customdata;
721                 
722         /* do common exec work */
723         return pose_slide_exec_common(C, op, pso);
724 }
725
726 void POSE_OT_push (wmOperatorType *ot)
727 {
728         /* identifiers */
729         ot->name= "Push Pose";
730         ot->idname= "POSE_OT_push";
731         ot->description= "Exaggerate the current pose";
732         
733         /* callbacks */
734         ot->exec= pose_slide_push_exec;
735         ot->invoke= pose_slide_push_invoke;
736         ot->modal= pose_slide_modal;
737         ot->cancel= pose_slide_cancel;
738         ot->poll= ED_operator_posemode;
739         
740         /* flags */
741         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO|OPTYPE_BLOCKING;
742         
743         /* Properties */
744         pose_slide_opdef_properties(ot);
745 }
746
747 /* ........................ */
748
749 /* invoke() - for 'relax' mode */
750 static int pose_slide_relax_invoke (bContext *C, wmOperator *op, wmEvent *UNUSED(evt))
751 {
752         tPoseSlideOp *pso;
753         
754         /* initialise data  */
755         if (pose_slide_init(C, op, POSESLIDE_RELAX) == 0) {
756                 pose_slide_exit(op);
757                 return OPERATOR_CANCELLED;
758         }
759         else
760                 pso= op->customdata;
761         
762         /* do common setup work */
763         return pose_slide_invoke_common(C, op, pso);
764 }
765
766 /* exec() - for relax */
767 static int pose_slide_relax_exec (bContext *C, wmOperator *op)
768 {
769         tPoseSlideOp *pso;
770         
771         /* initialise data (from RNA-props) */
772         if (pose_slide_init(C, op, POSESLIDE_RELAX) == 0) {
773                 pose_slide_exit(op);
774                 return OPERATOR_CANCELLED;
775         }
776         else
777                 pso= op->customdata;
778                 
779         /* do common exec work */
780         return pose_slide_exec_common(C, op, pso);
781 }
782
783 void POSE_OT_relax (wmOperatorType *ot)
784 {
785         /* identifiers */
786         ot->name= "Relax Pose";
787         ot->idname= "POSE_OT_relax";
788         ot->description= "Make the current pose more similar to its surrounding ones";
789         
790         /* callbacks */
791         ot->exec= pose_slide_relax_exec;
792         ot->invoke= pose_slide_relax_invoke;
793         ot->modal= pose_slide_modal;
794         ot->cancel= pose_slide_cancel;
795         ot->poll= ED_operator_posemode;
796         
797         /* flags */
798         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO|OPTYPE_BLOCKING;
799         
800         /* Properties */
801         pose_slide_opdef_properties(ot);
802 }
803
804 /* ........................ */
805
806 /* invoke() - for 'breakdown' mode */
807 static int pose_slide_breakdown_invoke (bContext *C, wmOperator *op, wmEvent *UNUSED(evt))
808 {
809         tPoseSlideOp *pso;
810         
811         /* initialise data  */
812         if (pose_slide_init(C, op, POSESLIDE_BREAKDOWN) == 0) {
813                 pose_slide_exit(op);
814                 return OPERATOR_CANCELLED;
815         }
816         else
817                 pso= op->customdata;
818         
819         /* do common setup work */
820         return pose_slide_invoke_common(C, op, pso);
821 }
822
823 /* exec() - for breakdown */
824 static int pose_slide_breakdown_exec (bContext *C, wmOperator *op)
825 {
826         tPoseSlideOp *pso;
827         
828         /* initialise data (from RNA-props) */
829         if (pose_slide_init(C, op, POSESLIDE_BREAKDOWN) == 0) {
830                 pose_slide_exit(op);
831                 return OPERATOR_CANCELLED;
832         }
833         else
834                 pso= op->customdata;
835                 
836         /* do common exec work */
837         return pose_slide_exec_common(C, op, pso);
838 }
839
840 void POSE_OT_breakdown (wmOperatorType *ot)
841 {
842         /* identifiers */
843         ot->name= "Pose Breakdowner";
844         ot->idname= "POSE_OT_breakdown";
845         ot->description= "Create a suitable breakdown pose on the current frame";
846         
847         /* callbacks */
848         ot->exec= pose_slide_breakdown_exec;
849         ot->invoke= pose_slide_breakdown_invoke;
850         ot->modal= pose_slide_modal;
851         ot->cancel= pose_slide_cancel;
852         ot->poll= ED_operator_posemode;
853         
854         /* flags */
855         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO|OPTYPE_BLOCKING;
856         
857         /* Properties */
858         pose_slide_opdef_properties(ot);
859 }
860
861 /* **************************************************** */
862 /* B) Pose Propagate */
863
864 /* "termination conditions" - i.e. when we stop */
865 typedef enum ePosePropagate_Termination {
866                 /* stop after the current hold ends */
867         POSE_PROPAGATE_SMART_HOLDS = 0,
868                 /* only do on the last keyframe */
869         POSE_PROPAGATE_LAST_KEY,
870                 /* stop after the next keyframe */
871         POSE_PROPAGATE_NEXT_KEY,
872                 /* stop after the specified frame */
873         POSE_PROPAGATE_BEFORE_FRAME,
874                 /* stop when we run out of keyframes */
875         POSE_PROPAGATE_BEFORE_END,
876         
877                 /* only do on the frames where markers are selected */
878         POSE_PROPAGATE_SELECTED_MARKERS
879 } ePosePropagate_Termination;
880
881 /* termination data needed for some modes - assumes only one of these entries will be needed at a time */
882 typedef union tPosePropagate_ModeData {
883         /* smart holds + before frame: frame number to stop on */
884         float end_frame;
885         
886         /* selected markers: listbase for CfraElem's marking these frames */
887         ListBase sel_markers;
888 } tPosePropagate_ModeData;
889
890 /* --------------------------------- */
891
892 /* get frame on which the "hold" for the bone ends 
893  * XXX: this may not really work that well if a bone moves on some channels and not others
894  *              if this happens to be a major issue, scrap this, and just make this happen 
895  *              independently per F-Curve
896  */
897 static float pose_propagate_get_boneHoldEndFrame (Object *ob, tPChanFCurveLink *pfl, float startFrame)
898 {
899         DLRBT_Tree keys, blocks;
900         ActKeyBlock *ab;
901         
902         AnimData *adt= ob->adt;
903         LinkData *ld;
904         float endFrame = startFrame;
905         
906         /* set up optimised data-structures for searching for relevant keyframes + holds */
907         BLI_dlrbTree_init(&keys);
908         BLI_dlrbTree_init(&blocks);
909         
910         for (ld = pfl->fcurves.first; ld; ld = ld->next) {
911                 FCurve *fcu = (FCurve *)ld->data;
912                 fcurve_to_keylist(adt, fcu, &keys, &blocks);
913         }
914         
915         BLI_dlrbTree_linkedlist_sync(&keys);
916         BLI_dlrbTree_linkedlist_sync(&blocks);
917         
918         /* find the long keyframe (i.e. hold), and hence obtain the endFrame value 
919          *      - the best case would be one that starts on the frame itself
920          */
921         ab = (ActKeyBlock *)BLI_dlrbTree_search_exact(&blocks, compare_ab_cfraPtr, &startFrame);
922         
923         if (actkeyblock_is_valid(ab, &keys) == 0) {
924                 /* There are only two cases for no-exact match:
925                  *      1) the current frame is just before another key but not on a key itself
926                  *      2) the current frame is on a key, but that key doesn't link to the next
927                  *
928                  * If we've got the first case, then we can search for another block, 
929                  * otherwise forget it, as we'd be overwriting some valid data.
930                  */
931                 if (BLI_dlrbTree_search_exact(&keys, compare_ak_cfraPtr, &startFrame) == NULL) {
932                         /* we've got case 1, so try the one after */
933                         ab = (ActKeyBlock *)BLI_dlrbTree_search_next(&blocks, compare_ab_cfraPtr, &startFrame);
934                         
935                         if (actkeyblock_is_valid(ab, &keys) == 0) {
936                                 /* try the block before this frame then as last resort */
937                                 ab = (ActKeyBlock *)BLI_dlrbTree_search_prev(&blocks, compare_ab_cfraPtr, &startFrame);
938                                 
939                                 /* whatever happens, stop searching now... */
940                                 if (actkeyblock_is_valid(ab, &keys) == 0) {
941                                         /* restrict range to just the frame itself 
942                                          * i.e. everything is in motion, so no holds to safely overwrite
943                                          */
944                                         ab = NULL;
945                                 }
946                         }
947                 }
948                 else {
949                         /* we've got case 2 - set ab to NULL just in case, since we shouldn't do anything in this case */
950                         ab = NULL;
951                 }
952         }
953         
954         /* check if we can go any further than we've already gone */
955         if (ab) {
956                 /* go to next if it is also valid and meets "extension" criteria */
957                 while (ab->next) {
958                         ActKeyBlock *abn = (ActKeyBlock *)ab->next;
959                         
960                         /* must be valid */
961                         if (actkeyblock_is_valid(abn, &keys) == 0)
962                                 break;
963                         /* should start on the same frame that the last ended on */
964                         if (ab->end != abn->start)
965                                 break;
966                         /* should have the same number of curves */
967                         if (ab->totcurve != abn->totcurve)
968                                 break;
969                         /* should have the same value 
970                          * XXX: this may be a bit fuzzy on larger data sets, so be careful
971                          */
972                         if (ab->val != abn->val)
973                                 break;
974                                 
975                         /* we can extend the bounds to the end of this "next" block now */
976                         ab = abn;
977                 }
978                 
979                 /* end frame can now take the value of the end of the block */
980                 endFrame = ab->end;
981         }
982         
983         /* free temp memory */
984         BLI_dlrbTree_free(&keys);
985         BLI_dlrbTree_free(&blocks);
986         
987         /* return the end frame we've found */
988         return endFrame;
989 }
990
991 /* get reference value from F-Curve using RNA */
992 static short pose_propagate_get_refVal (Object *ob, FCurve *fcu, float *value)
993 {
994         PointerRNA id_ptr, ptr;
995         PropertyRNA *prop;
996         short found= FALSE;
997         
998         /* base pointer is always the object -> id_ptr */
999         RNA_id_pointer_create(&ob->id, &id_ptr);
1000         
1001         /* resolve the property... */
1002         if (RNA_path_resolve(&id_ptr, fcu->rna_path, &ptr, &prop)) {
1003                 if (RNA_property_array_check(prop)) {
1004                         /* array */
1005                         if (fcu->array_index < RNA_property_array_length(&ptr, prop)) {
1006                                 found= TRUE;
1007                                 switch (RNA_property_type(prop)) {
1008                                         case PROP_BOOLEAN:
1009                                                 *value= (float)RNA_property_boolean_get_index(&ptr, prop, fcu->array_index);
1010                                                 break;
1011                                         case PROP_INT:
1012                                                 *value= (float)RNA_property_int_get_index(&ptr, prop, fcu->array_index);
1013                                                 break;
1014                                         case PROP_FLOAT:
1015                                                 *value= RNA_property_float_get_index(&ptr, prop, fcu->array_index);
1016                                                 break;
1017                                         default:
1018                                                 found= FALSE;
1019                                                 break;
1020                                 }
1021                         }
1022                 }
1023                 else {
1024                         /* not an array */
1025                         found= TRUE;
1026                         switch (RNA_property_type(prop)) {
1027                                 case PROP_BOOLEAN:
1028                                         *value= (float)RNA_property_boolean_get(&ptr, prop);
1029                                         break;
1030                                 case PROP_INT:
1031                                         *value= (float)RNA_property_int_get(&ptr, prop);
1032                                         break;
1033                                 case PROP_ENUM:
1034                                         *value= (float)RNA_property_enum_get(&ptr, prop);
1035                                         break;
1036                                 case PROP_FLOAT:
1037                                         *value= RNA_property_float_get(&ptr, prop);
1038                                         break;
1039                                 default:
1040                                         found= FALSE;
1041                                         break;
1042                         }
1043                 }
1044         }
1045         
1046         return found;
1047 }
1048
1049 /* propagate just works along each F-Curve in turn */
1050 static void pose_propagate_fcurve (wmOperator *op, Object *ob, FCurve *fcu, 
1051                                 float startFrame, tPosePropagate_ModeData modeData)
1052 {
1053         const int mode = RNA_enum_get(op->ptr, "mode");
1054         
1055         BezTriple *bezt;
1056         float refVal = 0.0f;
1057         short keyExists;
1058         int i, match;
1059         short first=1;
1060         
1061         /* skip if no keyframes to edit */
1062         if ((fcu->bezt == NULL) || (fcu->totvert < 2))
1063                 return;
1064                 
1065         /* find the reference value from bones directly, which means that the user
1066          * doesn't need to firstly keyframe the pose (though this doesn't mean that 
1067          * they can't either)
1068          */
1069         if( !pose_propagate_get_refVal(ob, fcu, &refVal))
1070                 return;
1071         
1072         /* find the first keyframe to start propagating from 
1073          *      - if there's a keyframe on the current frame, we probably want to save this value there too
1074          *        since it may be as of yet unkeyed
1075          *      - if starting before the starting frame, don't touch the key, as it may have had some valid 
1076          *        values
1077          */
1078         match = binarysearch_bezt_index(fcu->bezt, startFrame, fcu->totvert, &keyExists);
1079         
1080         if (fcu->bezt[match].vec[1][0] < startFrame)
1081                 i = match + 1;
1082         else
1083                 i = match;
1084         
1085         for (bezt = &fcu->bezt[i]; i < fcu->totvert; i++, bezt++) {
1086                 /* additional termination conditions based on the operator 'mode' property go here... */
1087                 if (ELEM(mode, POSE_PROPAGATE_BEFORE_FRAME, POSE_PROPAGATE_SMART_HOLDS)) {
1088                         /* stop if keyframe is outside the accepted range */
1089                         if (bezt->vec[1][0] > modeData.end_frame)
1090                                 break; 
1091                 }
1092                 else if (mode == POSE_PROPAGATE_NEXT_KEY) {
1093                         /* stop after the first keyframe has been processed */
1094                         if (first == 0)
1095                                 break;
1096                 }
1097                 else if (mode == POSE_PROPAGATE_LAST_KEY) {
1098                         /* only affect this frame if it will be the last one */
1099                         if (i != (fcu->totvert-1))
1100                                 continue;
1101                 }
1102                 else if (mode == POSE_PROPAGATE_SELECTED_MARKERS) {
1103                         /* only allow if there's a marker on this frame */
1104                         CfraElem *ce = NULL;
1105                         
1106                         /* stop on matching marker if there is one */
1107                         for (ce = modeData.sel_markers.first; ce; ce = ce->next) {
1108                                 if (ce->cfra == (int)(floor(bezt->vec[1][0] + 0.5f)))
1109                                         break;
1110                         }
1111                         
1112                         /* skip this keyframe if no marker */
1113                         if (ce == NULL)
1114                                 continue;
1115                 }
1116                 
1117                 /* just flatten handles, since values will now be the same either side... */
1118                 // TODO: perhaps a fade-out modulation of the value is required here (optional once again)?
1119                 bezt->vec[0][1] = bezt->vec[1][1] = bezt->vec[2][1] = refVal;
1120                 
1121                 /* select keyframe to indicate that it's been changed */
1122                 bezt->f2 |= SELECT;
1123                 first = 0;
1124         }
1125 }
1126
1127 /* --------------------------------- */
1128
1129 static int pose_propagate_exec (bContext *C, wmOperator *op)
1130 {
1131         Scene *scene = CTX_data_scene(C);
1132         Object *ob= ED_object_pose_armature(CTX_data_active_object(C));
1133         bAction *act= (ob && ob->adt)? ob->adt->action : NULL;
1134         
1135         ListBase pflinks = {NULL, NULL};
1136         tPChanFCurveLink *pfl;
1137         
1138         tPosePropagate_ModeData modeData;
1139         const int mode = RNA_enum_get(op->ptr, "mode");
1140         
1141         /* sanity checks */
1142         if (ob == NULL) {
1143                 BKE_report(op->reports, RPT_ERROR, "No object to propagate poses for");
1144                 return OPERATOR_CANCELLED;
1145         }
1146         if (act == NULL) {
1147                 BKE_report(op->reports, RPT_ERROR, "No keyframed poses to propagate to");
1148                 return OPERATOR_CANCELLED;
1149         }
1150         
1151         /* isolate F-Curves related to the selected bones */
1152         poseAnim_mapping_get(C, &pflinks, ob, act);
1153         
1154         /* mode-specific data preprocessing (requiring no access to curves) */
1155         if (mode == POSE_PROPAGATE_SELECTED_MARKERS) {
1156                 /* get a list of selected markers */
1157                 ED_markers_make_cfra_list(&scene->markers, &modeData.sel_markers, SELECT);
1158         }
1159         else {
1160                 /* assume everything else wants endFrame */
1161                 modeData.end_frame = RNA_float_get(op->ptr, "end_frame");
1162         }
1163         
1164         /* for each bone, perform the copying required */
1165         for (pfl = pflinks.first; pfl; pfl = pfl->next) {
1166                 LinkData *ld;
1167                 
1168                 /* mode-specific data preprocessing (requiring access to all curves) */
1169                 if (mode == POSE_PROPAGATE_SMART_HOLDS) {
1170                         /* we store in endFrame the end frame of the "long keyframe" (i.e. a held value) starting
1171                          * from the keyframe that occurs after the current frame
1172                          */
1173                         modeData.end_frame = pose_propagate_get_boneHoldEndFrame(ob, pfl, (float)CFRA);
1174                 }
1175                 
1176                 /* go through propagating pose to keyframes, curve by curve */
1177                 for (ld = pfl->fcurves.first; ld; ld= ld->next)
1178                         pose_propagate_fcurve(op, ob, (FCurve *)ld->data, (float)CFRA, modeData);
1179         }
1180         
1181         /* free temp data */
1182         poseAnim_mapping_free(&pflinks);
1183         
1184         if (mode == POSE_PROPAGATE_SELECTED_MARKERS)
1185                 BLI_freelistN(&modeData.sel_markers);
1186         
1187         /* updates + notifiers */
1188         poseAnim_mapping_refresh(C, scene, ob);
1189         
1190         return OPERATOR_FINISHED;
1191 }
1192
1193 /* --------------------------------- */
1194
1195 void POSE_OT_propagate (wmOperatorType *ot)
1196 {
1197         static EnumPropertyItem terminate_items[]= {
1198                 {POSE_PROPAGATE_SMART_HOLDS, "WHILE_HELD", 0, "While Held", "Propagate pose to all keyframes after current frame that don't change (Default behaviour)"},
1199                 {POSE_PROPAGATE_NEXT_KEY, "NEXT_KEY", 0, "To Next Keyframe", "Propagate pose to first keyframe following the current frame only"},
1200                 {POSE_PROPAGATE_LAST_KEY, "LAST_KEY", 0, "To Last Keyframe", "Propagate pose to the last keyframe only (i.e. making action cyclic)"},
1201                 {POSE_PROPAGATE_BEFORE_FRAME, "BEFORE_FRAME", 0, "Before Frame", "Propagate pose to all keyframes between current frame and 'Frame' property"},
1202                 {POSE_PROPAGATE_BEFORE_END, "BEFORE_END", 0, "Before Last Keyframe", "Propagate pose to all keyframes from current frame until no more are found"},
1203                 {POSE_PROPAGATE_SELECTED_MARKERS, "SELECTED_MARKERS", 0, "On Selected Markers", "Propagate pose to all keyframes occurring on frames with Scene Markers after the current frame"},
1204                 {0, NULL, 0, NULL, NULL}};
1205                 
1206         /* identifiers */
1207         ot->name= "Propagate Pose";
1208         ot->idname= "POSE_OT_propagate";
1209         ot->description= "Copy selected aspects of the current pose to subsequent poses already keyframed";
1210         
1211         /* callbacks */
1212         ot->exec= pose_propagate_exec;
1213         ot->poll= ED_operator_posemode; // XXX: needs selected bones!
1214         
1215         /* flag */
1216         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
1217         
1218         /* properties */
1219         // TODO: add "fade out" control for tapering off amount of propagation as time goes by?
1220         ot->prop= RNA_def_enum(ot->srna, "mode", terminate_items, POSE_PROPAGATE_SMART_HOLDS, "Terminate Mode", "Method used to determine when to stop propagating pose to keyframes");
1221         RNA_def_float(ot->srna, "end_frame", 250.0, FLT_MIN, FLT_MAX, "End Frame", "Frame to stop propagating frames to (for 'Before Frame' mode)", 1.0, 250.0);
1222 }
1223
1224 /* **************************************************** */