doxygen: blender/editors tagged.
[blender-staging.git] / source / blender / editors / animation / fmodifier_ui.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.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation, Joshua Leung
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/editors/animation/fmodifier_ui.c
30  *  \ingroup edanimation
31  */
32
33
34 /* User-Interface Stuff for F-Modifiers:
35  * This file defines the (C-Coded) templates + editing callbacks needed 
36  * by the interface stuff or F-Modifiers, as used by F-Curves in the Graph Editor,
37  * and NLA-Strips in the NLA Editor.
38  *
39  * Copy/Paste Buffer for F-Modifiers:
40  * For now, this is also defined in this file so that it can be shared between the 
41  */
42  
43 #include <string.h>
44
45 #include "DNA_anim_types.h"
46 #include "DNA_scene_types.h"
47
48 #include "MEM_guardedalloc.h"
49
50 #include "BLI_blenlib.h"
51 #include "BLI_utildefines.h"
52
53 #include "BKE_context.h"
54 #include "BKE_fcurve.h"
55
56 #include "WM_api.h"
57 #include "WM_types.h"
58
59 #include "RNA_access.h"
60
61 #include "UI_interface.h"
62 #include "UI_resources.h"
63
64 #include "ED_anim_api.h"
65
66 /* ********************************************** */
67 /* UI STUFF */
68
69 // XXX! --------------------------------
70 /* temporary definition for limits of float number buttons (FLT_MAX tends to infinity with old system) */
71 #define UI_FLT_MAX      10000.0f
72
73 #define B_REDR                                  1
74 #define B_FMODIFIER_REDRAW              20
75
76 /* macro for use here to draw background box and set height */
77 // XXX for now, roundbox has it's callback func set to NULL to not intercept events
78 #define DRAW_BACKDROP(height) \
79         { \
80                 uiDefBut(block, ROUNDBOX, B_REDR, "", -3, yco-height, width+3, height-1, NULL, 5.0, 0.0, 12.0, (float)rb_col, ""); \
81         }
82
83 /* callback to verify modifier data */
84 static void validate_fmodifier_cb (bContext *UNUSED(C), void *fcm_v, void *UNUSED(arg))
85 {
86         FModifier *fcm= (FModifier *)fcm_v;
87         FModifierTypeInfo *fmi= fmodifier_get_typeinfo(fcm);
88         
89         /* call the verify callback on the modifier if applicable */
90         if (fmi && fmi->verify_data)
91                 fmi->verify_data(fcm);
92 }
93
94 /* callback to remove the given modifier  */
95 static void delete_fmodifier_cb (bContext *C, void *fmods_v, void *fcm_v)
96 {
97         ListBase *modifiers = (ListBase *)fmods_v;
98         FModifier *fcm= (FModifier *)fcm_v;
99         
100         /* remove the given F-Modifier from the active modifier-stack */
101         remove_fmodifier(modifiers, fcm);
102         
103         /* send notifiers */
104         // XXX for now, this is the only way to get updates in all the right places... but would be nice to have a special one in this case 
105         WM_event_add_notifier(C, NC_ANIMATION|ND_KEYFRAME|NA_EDITED, NULL);
106 }
107
108 /* --------------- */
109         
110 /* draw settings for generator modifier */
111 static void draw_modifier__generator(uiLayout *layout, ID *id, FModifier *fcm, short width)
112 {
113         FMod_Generator *data= (FMod_Generator *)fcm->data;
114         uiLayout *col, *row;
115         uiBlock *block;
116         uiBut *but;
117         PointerRNA ptr;
118         
119         /* init the RNA-pointer */
120         RNA_pointer_create(id, &RNA_FModifierFunctionGenerator, fcm, &ptr);
121         
122         /* basic settings (backdrop + mode selector + some padding) */
123         col= uiLayoutColumn(layout, 1);
124         block= uiLayoutGetBlock(layout);
125         uiBlockBeginAlign(block);
126                 but= uiDefButR(block, MENU, B_FMODIFIER_REDRAW, NULL, 0, 0, width-30, UI_UNIT_Y, &ptr, "mode", -1, 0, 0, -1, -1, NULL);
127                 uiButSetFunc(but, validate_fmodifier_cb, fcm, NULL);
128                 
129                 uiDefButR(block, TOG, B_FMODIFIER_REDRAW, NULL, 0, 0, width-30, UI_UNIT_Y, &ptr, "use_additive", -1, 0, 0, -1, -1, NULL);
130         uiBlockEndAlign(block);
131         
132         /* now add settings for individual modes */
133         switch (data->mode) {
134                 case FCM_GENERATOR_POLYNOMIAL: /* polynomial expression */
135                 {
136                         float *cp = NULL;
137                         char xval[32];
138                         unsigned int i;
139                         
140                         /* draw polynomial order selector */
141                         row= uiLayoutRow(layout, 0);
142                         block= uiLayoutGetBlock(row);
143                                 but= uiDefButI(block, NUM, B_FMODIFIER_REDRAW, "Poly Order: ", 10,0,width-30,19, &data->poly_order, 1, 100, 0, 0, "'Order' of the Polynomial - for a polynomial with n terms, 'order' is n-1");
144                                 uiButSetFunc(but, validate_fmodifier_cb, fcm, NULL);
145                         
146                         
147                         /* draw controls for each coefficient and a + sign at end of row */
148                         row= uiLayoutRow(layout, 1);
149                         block= uiLayoutGetBlock(row);
150                                 uiDefBut(block, LABEL, 1, "y = ", 0, 0, 50, 20, NULL, 0.0, 0.0, 0, 0, "");
151                         
152                         cp= data->coefficients;
153                         for (i=0; (i < data->arraysize) && (cp); i++, cp++) {
154                                 /* coefficient */
155                                 uiDefButF(block, NUM, B_FMODIFIER_REDRAW, "", 0, 0, 150, 20, cp, -UI_FLT_MAX, UI_FLT_MAX, 10, 3, "Coefficient for polynomial");
156                                 
157                                 /* 'x' param (and '+' if necessary) */
158                                 if (i) {
159                                         if (i == 1)
160                                                 strcpy(xval, "x");
161                                         else
162                                                 sprintf(xval, "x^%d", i);
163                                         uiDefBut(block, LABEL, 1, xval, 0, 0, 50, 20, NULL, 0.0, 0.0, 0, 0, "Power of x");
164                                 }
165                                 
166                                 if ( (i != (data->arraysize - 1)) || ((i==0) && data->arraysize==2) ) {
167                                         uiDefBut(block, LABEL, 1, "+", 0,0 , 30, 20, NULL, 0.0, 0.0, 0, 0, "");
168                                         
169                                         /* next coefficient on a new row */
170                                         row= uiLayoutRow(layout, 1);
171                                         block= uiLayoutGetBlock(row);
172                                 }
173                         }
174                 }
175                         break;
176                 
177                 case FCM_GENERATOR_POLYNOMIAL_FACTORISED: /* factorised polynomial expression */
178                 {
179                         float *cp = NULL;
180                         unsigned int i;
181                         
182                         /* draw polynomial order selector */
183                         row= uiLayoutRow(layout, 0);
184                         block= uiLayoutGetBlock(row);
185                                 but= uiDefButI(block, NUM, B_FMODIFIER_REDRAW, "Poly Order: ", 0,0,width-30,19, &data->poly_order, 1, 100, 0, 0, "'Order' of the Polynomial - for a polynomial with n terms, 'order' is n-1");
186                                 uiButSetFunc(but, validate_fmodifier_cb, fcm, NULL);
187                         
188                         
189                         /* draw controls for each pair of coefficients */
190                         row= uiLayoutRow(layout, 1);
191                         block= uiLayoutGetBlock(row);
192                                 uiDefBut(block, LABEL, 1, "y=", 0, 0, 50, 20, NULL, 0.0, 0.0, 0, 0, "");
193                         
194                         cp= data->coefficients;
195                         for (i=0; (i < data->poly_order) && (cp); i++, cp+=2) {
196                                 /* opening bracket */
197                                 uiDefBut(block, LABEL, 1, "(", 0, 0, 20, 20, NULL, 0.0, 0.0, 0, 0, "");
198                                 
199                                 /* coefficients */
200                                 uiDefButF(block, NUM, B_FMODIFIER_REDRAW, "", 0, 0, 100, 20, cp, -UI_FLT_MAX, UI_FLT_MAX, 10, 3, "Coefficient of x");
201                                 
202                                 uiDefBut(block, LABEL, 1, "x+", 0, 0, 40, 20, NULL, 0.0, 0.0, 0, 0, "");
203                                 
204                                 uiDefButF(block, NUM, B_FMODIFIER_REDRAW, "", 0, 0, 100, 20, cp+1, -UI_FLT_MAX, UI_FLT_MAX, 10, 3, "Second coefficient");
205                                 
206                                 /* closing bracket and '+' sign */
207                                 if ( (i != (data->poly_order - 1)) || ((i==0) && data->poly_order==2) ) {
208                                         uiDefBut(block, LABEL, 1, ") +", 0, 0, 30, 20, NULL, 0.0, 0.0, 0, 0, "");
209                                         
210                                         /* set up new row for the next pair of coefficients*/
211                                         row= uiLayoutRow(layout, 1);
212                                         block= uiLayoutGetBlock(row);
213                                 }
214                                 else 
215                                         uiDefBut(block, LABEL, 1, ")", 0, 0, 20, 20, NULL, 0.0, 0.0, 0, 0, "");
216                         }
217                 }
218                         break;
219         }
220 }
221
222 /* --------------- */
223
224 /* draw settings for generator modifier */
225 static void draw_modifier__fn_generator(uiLayout *layout, ID *id, FModifier *fcm, short UNUSED(width))
226 {
227         uiLayout *col;
228         PointerRNA ptr;
229         
230         /* init the RNA-pointer */
231         RNA_pointer_create(id, &RNA_FModifierFunctionGenerator, fcm, &ptr);
232         
233         /* add the settings */
234         col= uiLayoutColumn(layout, 1);
235                 uiItemR(col, &ptr, "function_type", 0, "", ICON_NONE);
236                 uiItemR(col, &ptr, "use_additive", UI_ITEM_R_TOGGLE, NULL, ICON_NONE);
237         
238         col= uiLayoutColumn(layout, 0); // no grouping for now
239                 uiItemR(col, &ptr, "amplitude", 0, NULL, ICON_NONE);
240                 uiItemR(col, &ptr, "phase_multiplier", 0, NULL, ICON_NONE);
241                 uiItemR(col, &ptr, "phase_offset", 0, NULL, ICON_NONE);
242                 uiItemR(col, &ptr, "value_offset", 0, NULL, ICON_NONE);
243 }
244
245 /* --------------- */
246
247 /* draw settings for cycles modifier */
248 static void draw_modifier__cycles(uiLayout *layout, ID *id, FModifier *fcm, short UNUSED(width))
249 {
250         uiLayout *split, *col;
251         PointerRNA ptr;
252         
253         /* init the RNA-pointer */
254         RNA_pointer_create(id, &RNA_FModifierCycles, fcm, &ptr);
255         
256         /* split into 2 columns 
257          * NOTE: the mode comboboxes shouldn't get labels, otherwise there isn't enough room
258          */
259         split= uiLayoutSplit(layout, 0.5f, 0);
260         
261         /* before range */
262         col= uiLayoutColumn(split, 1);
263                 uiItemL(col, "Before:", ICON_NONE);
264                 uiItemR(col, &ptr, "mode_before", 0, "", ICON_NONE);
265                 uiItemR(col, &ptr, "cycles_before", 0, NULL, ICON_NONE);
266                 
267         /* after range */
268         col= uiLayoutColumn(split, 1);
269                 uiItemL(col, "After:", ICON_NONE);
270                 uiItemR(col, &ptr, "mode_after", 0, "", ICON_NONE);
271                 uiItemR(col, &ptr, "cycles_after", 0, NULL, ICON_NONE);
272 }
273
274 /* --------------- */
275
276 /* draw settings for noise modifier */
277 static void draw_modifier__noise(uiLayout *layout, ID *id, FModifier *fcm, short UNUSED(width))
278 {
279         uiLayout *split, *col;
280         PointerRNA ptr;
281         
282         /* init the RNA-pointer */
283         RNA_pointer_create(id, &RNA_FModifierNoise, fcm, &ptr);
284         
285         /* blending mode */
286         uiItemR(layout, &ptr, "blend_type", 0, NULL, ICON_NONE);
287         
288         /* split into 2 columns */
289         split= uiLayoutSplit(layout, 0.5f, 0);
290         
291         /* col 1 */
292         col= uiLayoutColumn(split, 0);
293                 uiItemR(col, &ptr, "scale", 0, NULL, ICON_NONE);
294                 uiItemR(col, &ptr, "strength", 0, NULL, ICON_NONE);
295         
296         /* col 2 */
297         col= uiLayoutColumn(split, 0);
298                 uiItemR(col, &ptr, "phase", 0, NULL, ICON_NONE);
299                 uiItemR(col, &ptr, "depth", 0, NULL, ICON_NONE);
300 }
301
302 /* --------------- */
303
304 #define BINARYSEARCH_FRAMEEQ_THRESH     0.0001
305
306 /* Binary search algorithm for finding where to insert Envelope Data Point.
307  * Returns the index to insert at (data already at that index will be offset if replace is 0)
308  */
309 static int binarysearch_fcm_envelopedata_index (FCM_EnvelopeData array[], float frame, int arraylen, short *exists)
310 {
311         int start=0, end=arraylen;
312         int loopbreaker= 0, maxloop= arraylen * 2;
313         
314         /* initialise exists-flag first */
315         *exists= 0;
316         
317         /* sneaky optimisations (don't go through searching process if...):
318          *      - keyframe to be added is to be added out of current bounds
319          *      - keyframe to be added would replace one of the existing ones on bounds
320          */
321         if ((arraylen <= 0) || (array == NULL)) {
322                 printf("Warning: binarysearch_fcm_envelopedata_index() encountered invalid array \n");
323                 return 0;
324         }
325         else {
326                 /* check whether to add before/after/on */
327                 float framenum;
328                 
329                 /* 'First' Point (when only one point, this case is used) */
330                 framenum= array[0].time;
331                 if (IS_EQT(frame, framenum, BINARYSEARCH_FRAMEEQ_THRESH)) {
332                         *exists = 1;
333                         return 0;
334                 }
335                 else if (frame < framenum)
336                         return 0;
337                         
338                 /* 'Last' Point */
339                 framenum= array[(arraylen-1)].time;
340                 if (IS_EQT(frame, framenum, BINARYSEARCH_FRAMEEQ_THRESH)) {
341                         *exists= 1;
342                         return (arraylen - 1);
343                 }
344                 else if (frame > framenum)
345                         return arraylen;
346         }
347         
348         
349         /* most of the time, this loop is just to find where to put it
350          *      - 'loopbreaker' is just here to prevent infinite loops 
351          */
352         for (loopbreaker=0; (start <= end) && (loopbreaker < maxloop); loopbreaker++) {
353                 /* compute and get midpoint */
354                 int mid = start + ((end - start) / 2);  /* we calculate the midpoint this way to avoid int overflows... */
355                 float midfra= array[mid].time;
356                 
357                 /* check if exactly equal to midpoint */
358                 if (IS_EQT(frame, midfra, BINARYSEARCH_FRAMEEQ_THRESH)) {
359                         *exists = 1;
360                         return mid;
361                 }
362                 
363                 /* repeat in upper/lower half */
364                 if (frame > midfra)
365                         start= mid + 1;
366                 else if (frame < midfra)
367                         end= mid - 1;
368         }
369         
370         /* print error if loop-limit exceeded */
371         if (loopbreaker == (maxloop-1)) {
372                 printf("Error: binarysearch_fcm_envelopedata_index() was taking too long \n");
373                 
374                 // include debug info 
375                 printf("\tround = %d: start = %d, end = %d, arraylen = %d \n", loopbreaker, start, end, arraylen);
376         }
377         
378         /* not found, so return where to place it */
379         return start;
380 }
381
382 /* callback to add new envelope data point */
383 // TODO: should we have a separate file for things like this?
384 static void fmod_envelope_addpoint_cb (bContext *C, void *fcm_dv, void *UNUSED(arg))
385 {
386         Scene *scene= CTX_data_scene(C);
387         FMod_Envelope *env= (FMod_Envelope *)fcm_dv;
388         FCM_EnvelopeData *fedn;
389         FCM_EnvelopeData fed;
390         
391         /* init template data */
392         fed.min= -1.0f;
393         fed.max= 1.0f;
394         fed.time= (float)scene->r.cfra; // XXX make this int for ease of use?
395         fed.f1= fed.f2= 0;
396         
397         /* check that no data exists for the current frame... */
398         if (env->data) {
399                 short exists = -1;
400                 int i= binarysearch_fcm_envelopedata_index(env->data, (float)(scene->r.cfra), env->totvert, &exists);
401                 
402                 /* binarysearch_...() will set exists by default to 0, so if it is non-zero, that means that the point exists already */
403                 if (exists)
404                         return;
405                         
406                 /* add new */
407                 fedn= MEM_callocN((env->totvert+1)*sizeof(FCM_EnvelopeData), "FCM_EnvelopeData");
408                 
409                 /* add the points that should occur before the point to be pasted */
410                 if (i > 0)
411                         memcpy(fedn, env->data, i*sizeof(FCM_EnvelopeData));
412                 
413                 /* add point to paste at index i */
414                 *(fedn + i)= fed;
415                 
416                 /* add the points that occur after the point to be pasted */
417                 if (i < env->totvert) 
418                         memcpy(fedn+i+1, env->data+i, (env->totvert-i)*sizeof(FCM_EnvelopeData));
419                 
420                 /* replace (+ free) old with new */
421                 MEM_freeN(env->data);
422                 env->data= fedn;
423                 
424                 env->totvert++;
425         }
426         else {
427                 env->data= MEM_callocN(sizeof(FCM_EnvelopeData), "FCM_EnvelopeData");
428                 *(env->data)= fed;
429                 
430                 env->totvert= 1;
431         }
432 }
433
434 /* callback to remove envelope data point */
435 // TODO: should we have a separate file for things like this?
436 static void fmod_envelope_deletepoint_cb (bContext *UNUSED(C), void *fcm_dv, void *ind_v)
437 {
438         FMod_Envelope *env= (FMod_Envelope *)fcm_dv;
439         FCM_EnvelopeData *fedn;
440         int index= GET_INT_FROM_POINTER(ind_v);
441         
442         /* check that no data exists for the current frame... */
443         if (env->totvert > 1) {
444                 /* allocate a new smaller array */
445                 fedn= MEM_callocN(sizeof(FCM_EnvelopeData)*(env->totvert-1), "FCM_EnvelopeData");
446                 
447                 memcpy(fedn, &env->data, sizeof(FCM_EnvelopeData)*(index));
448                 memcpy(&fedn[index], &env->data[index+1], sizeof(FCM_EnvelopeData)*(env->totvert-index-1));
449                 
450                 /* free old array, and set the new */
451                 MEM_freeN(env->data);
452                 env->data= fedn;
453                 env->totvert--;
454         }
455         else {
456                 /* just free array, since the only vert was deleted */
457                 if (env->data) 
458                         MEM_freeN(env->data);
459                 env->totvert= 0;
460         }
461 }
462
463 /* draw settings for envelope modifier */
464 static void draw_modifier__envelope(uiLayout *layout, ID *id, FModifier *fcm, short UNUSED(width))
465 {
466         FMod_Envelope *env= (FMod_Envelope *)fcm->data;
467         FCM_EnvelopeData *fed;
468         uiLayout *col, *row;
469         uiBlock *block;
470         uiBut *but;
471         PointerRNA ptr;
472         int i;
473         
474         /* init the RNA-pointer */
475         RNA_pointer_create(id, &RNA_FModifierEnvelope, fcm, &ptr);
476         
477         /* general settings */
478         col= uiLayoutColumn(layout, 1);
479                 uiItemL(col, "Envelope:", ICON_NONE);
480                 uiItemR(col, &ptr, "reference_value", 0, NULL, ICON_NONE);
481                 
482                 row= uiLayoutRow(col, 1);
483                         uiItemR(row, &ptr, "default_min", 0, "Min", ICON_NONE);
484                         uiItemR(row, &ptr, "default_max", 0, "Max", ICON_NONE);
485                         
486         /* control points header */
487         // TODO: move this control-point control stuff to using the new special widgets for lists
488         // the current way is far too cramped
489         row= uiLayoutRow(layout, 0);
490         block= uiLayoutGetBlock(row);
491                 
492                 uiDefBut(block, LABEL, 1, "Control Points:", 0, 0, 150, 20, NULL, 0.0, 0.0, 0, 0, "");
493                 
494                 but= uiDefBut(block, BUT, B_FMODIFIER_REDRAW, "Add Point", 0,0,150,19, NULL, 0, 0, 0, 0, "Adds a new control-point to the envelope on the current frame");
495                 uiButSetFunc(but, fmod_envelope_addpoint_cb, env, NULL);
496                 
497         /* control points list */
498         for (i=0, fed=env->data; i < env->totvert; i++, fed++) {
499                 /* get a new row to operate on */
500                 row= uiLayoutRow(layout, 1);
501                 block= uiLayoutGetBlock(row);
502                 
503                 uiBlockBeginAlign(block);
504                         but=uiDefButF(block, NUM, B_FMODIFIER_REDRAW, "Fra:", 0, 0, 90, 20, &fed->time, -MAXFRAMEF, MAXFRAMEF, 10, 1, "Frame that envelope point occurs");
505                         uiButSetFunc(but, validate_fmodifier_cb, fcm, NULL);
506                         
507                         uiDefButF(block, NUM, B_FMODIFIER_REDRAW, "Min:", 0, 0, 100, 20, &fed->min, -UI_FLT_MAX, UI_FLT_MAX, 10, 2, "Minimum bound of envelope at this point");
508                         uiDefButF(block, NUM, B_FMODIFIER_REDRAW, "Max:", 0, 0, 100, 20, &fed->max, -UI_FLT_MAX, UI_FLT_MAX, 10, 2, "Maximum bound of envelope at this point");
509                         
510                         but= uiDefIconBut(block, BUT, B_FMODIFIER_REDRAW, ICON_X, 0, 0, 18, 20, NULL, 0.0, 0.0, 0.0, 0.0, "Delete envelope control point");
511                         uiButSetFunc(but, fmod_envelope_deletepoint_cb, env, SET_INT_IN_POINTER(i));
512                 uiBlockBeginAlign(block);
513         }
514 }
515
516 /* --------------- */
517
518 /* draw settings for limits modifier */
519 static void draw_modifier__limits(uiLayout *layout, ID *id, FModifier *fcm, short UNUSED(width))
520 {
521         uiLayout *split, *col, *row;
522         PointerRNA ptr;
523         
524         /* init the RNA-pointer */
525         RNA_pointer_create(id, &RNA_FModifierLimits, fcm, &ptr);
526         
527         /* row 1: minimum */
528         {
529                 row= uiLayoutRow(layout, 0);
530                 
531                 /* split into 2 columns */
532                 split= uiLayoutSplit(layout, 0.5f, 0);
533                 
534                 /* x-minimum */
535                 col= uiLayoutColumn(split, 1);
536                         uiItemR(col, &ptr, "use_min_x", 0, NULL, ICON_NONE);
537                         uiItemR(col, &ptr, "min_x", 0, NULL, ICON_NONE);
538                         
539                 /* y-minimum*/
540                 col= uiLayoutColumn(split, 1);
541                         uiItemR(col, &ptr, "use_min_y", 0, NULL, ICON_NONE);
542                         uiItemR(col, &ptr, "min_y", 0, NULL, ICON_NONE);
543         }
544         
545         /* row 2: maximum */
546         {
547                 row= uiLayoutRow(layout, 0);
548                 
549                 /* split into 2 columns */
550                 split= uiLayoutSplit(layout, 0.5f, 0);
551                 
552                 /* x-minimum */
553                 col= uiLayoutColumn(split, 1);
554                         uiItemR(col, &ptr, "use_max_x", 0, NULL, ICON_NONE);
555                         uiItemR(col, &ptr, "max_x", 0, NULL, ICON_NONE);
556                         
557                 /* y-minimum*/
558                 col= uiLayoutColumn(split, 1);
559                         uiItemR(col, &ptr, "use_max_y", 0, NULL, ICON_NONE);
560                         uiItemR(col, &ptr, "max_y", 0, NULL, ICON_NONE);
561         }
562 }
563
564 /* --------------- */
565
566 /* draw settings for stepped interpolation modifier */
567 static void draw_modifier__stepped(uiLayout *layout, ID *id, FModifier *fcm, short UNUSED(width))
568 {
569         uiLayout *col, *subcol;
570         PointerRNA ptr;
571         
572         /* init the RNA-pointer */
573         RNA_pointer_create(id, &RNA_FModifierStepped, fcm, &ptr);
574         
575         /* block 1: "stepping" settings */
576         col= uiLayoutColumn(layout, 0);
577                 uiItemR(col, &ptr, "frame_step", 0, NULL, ICON_NONE);
578                 uiItemR(col, &ptr, "frame_offset", 0, NULL, ICON_NONE);
579                 
580         /* block 2: start range settings */
581         col= uiLayoutColumn(layout, 1);
582                 uiItemR(col, &ptr, "use_frame_start", 0, NULL, ICON_NONE);
583                 
584                 subcol = uiLayoutColumn(col, 1);
585                 uiLayoutSetActive(subcol, RNA_boolean_get(&ptr, "use_frame_start"));
586                         uiItemR(subcol, &ptr, "frame_start", 0, NULL, ICON_NONE);
587                         
588         /* block 3: end range settings */
589         col= uiLayoutColumn(layout, 1);
590                 uiItemR(col, &ptr, "use_frame_end", 0, NULL, ICON_NONE);
591                 
592                 subcol = uiLayoutColumn(col, 1);
593                 uiLayoutSetActive(subcol, RNA_boolean_get(&ptr, "use_frame_end"));
594                         uiItemR(subcol, &ptr, "frame_end", 0, NULL, ICON_NONE);
595 }
596
597 /* --------------- */
598
599 void ANIM_uiTemplate_fmodifier_draw (uiLayout *layout, ID *id, ListBase *modifiers, FModifier *fcm)
600 {
601         FModifierTypeInfo *fmi= fmodifier_get_typeinfo(fcm);
602         uiLayout *box, *row, *subrow;
603         uiBlock *block;
604         uiBut *but;
605         short width= 314;
606         PointerRNA ptr;
607         
608         /* init the RNA-pointer */
609         RNA_pointer_create(id, &RNA_FModifier, fcm, &ptr);
610         
611         /* draw header */
612         {
613                 /* get layout-row + UI-block for this */
614                 box= uiLayoutBox(layout);
615                 
616                 row= uiLayoutRow(box, 0);
617                 block= uiLayoutGetBlock(row); // err...
618                 
619                 /* left-align -------------------------------------------- */
620                 subrow= uiLayoutRow(row, 0);
621                 uiLayoutSetAlignment(subrow, UI_LAYOUT_ALIGN_LEFT);
622                 
623                 uiBlockSetEmboss(block, UI_EMBOSSN);
624                 
625                 /* expand */
626                 uiItemR(subrow, &ptr, "show_expanded", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
627                 
628                 /* checkbox for 'active' status (for now) */
629                 uiItemR(subrow, &ptr, "active", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
630                 
631                 /* name */
632                 if (fmi)
633                         uiItemL(subrow, fmi->name, ICON_NONE);
634                 else
635                         uiItemL(subrow, "<Unknown Modifier>", ICON_NONE);
636                 
637                 /* right-align ------------------------------------------- */
638                 subrow= uiLayoutRow(row, 0);
639                 uiLayoutSetAlignment(subrow, UI_LAYOUT_ALIGN_RIGHT);
640                 
641                 
642                 /* 'mute' button */
643                 uiItemR(subrow, &ptr, "mute", UI_ITEM_R_ICON_ONLY, "", ICON_NONE);
644                 
645                 uiBlockSetEmboss(block, UI_EMBOSSN);
646                 
647                 /* delete button */
648                 but= uiDefIconBut(block, BUT, B_REDR, ICON_X, 0, 0, UI_UNIT_X, UI_UNIT_Y, NULL, 0.0, 0.0, 0.0, 0.0, "Delete F-Curve Modifier.");
649                 uiButSetFunc(but, delete_fmodifier_cb, modifiers, fcm);
650                 
651                 uiBlockSetEmboss(block, UI_EMBOSS);
652         }
653         
654         /* when modifier is expanded, draw settings */
655         if (fcm->flag & FMODIFIER_FLAG_EXPANDED) {
656                 /* set up the flexible-box layout which acts as the backdrop for the modifier settings */
657                 box= uiLayoutBox(layout); 
658                 
659                 /* draw settings for individual modifiers */
660                 switch (fcm->type) {
661                         case FMODIFIER_TYPE_GENERATOR: /* Generator */
662                                 draw_modifier__generator(box, id, fcm, width);
663                                 break;
664                                 
665                         case FMODIFIER_TYPE_FN_GENERATOR: /* Built-In Function Generator */
666                                 draw_modifier__fn_generator(box, id, fcm, width);
667                                 break;
668                                 
669                         case FMODIFIER_TYPE_CYCLES: /* Cycles */
670                                 draw_modifier__cycles(box, id, fcm, width);
671                                 break;
672                                 
673                         case FMODIFIER_TYPE_ENVELOPE: /* Envelope */
674                                 draw_modifier__envelope(box, id, fcm, width);
675                                 break;
676                                 
677                         case FMODIFIER_TYPE_LIMITS: /* Limits */
678                                 draw_modifier__limits(box, id, fcm, width);
679                                 break;
680                         
681                         case FMODIFIER_TYPE_NOISE: /* Noise */
682                                 draw_modifier__noise(box, id, fcm, width);
683                                 break;
684                                 
685                         case FMODIFIER_TYPE_STEPPED: /* Stepped */
686                                 draw_modifier__stepped(box, id, fcm, width);
687                                 break;
688                         
689                         default: /* unknown type */
690                                 break;
691                 }
692         }
693 }
694
695 /* ********************************************** */
696 /* COPY/PASTE BUFFER STUFF */
697
698 /* Copy/Paste Buffer itself (list of FModifier 's) */
699 static ListBase fmodifier_copypaste_buf = {NULL, NULL};
700
701 /* ---------- */
702
703 /* free the copy/paste buffer */
704 void free_fmodifiers_copybuf (void)
705 {
706         /* just free the whole buffer */
707         free_fmodifiers(&fmodifier_copypaste_buf);
708 }
709
710 /* copy the given F-Modifiers to the buffer, returning whether anything was copied or not
711  * assuming that the buffer has been cleared already with free_fmodifiers_copybuf()
712  *      - active: only copy the active modifier
713  */
714 short ANIM_fmodifiers_copy_to_buf (ListBase *modifiers, short active)
715 {
716         short ok = 1;
717         
718         /* sanity checks */
719         if ELEM(NULL, modifiers, modifiers->first)
720                 return 0;
721                 
722         /* copy the whole list, or just the active one? */
723         if (active) {
724                 FModifier *fcm = find_active_fmodifier(modifiers);
725                 
726                 if (fcm) {
727                         FModifier *fcmN = copy_fmodifier(fcm);
728                         BLI_addtail(&fmodifier_copypaste_buf, fcmN);
729                 }
730                 else
731                         ok = 0;
732         }
733         else
734                 copy_fmodifiers(&fmodifier_copypaste_buf, modifiers);
735                 
736         /* did we succeed? */
737         return ok;
738 }
739
740 /* 'Paste' the F-Modifier(s) from the buffer to the specified list 
741  *      - replace: free all the existing modifiers to leave only the pasted ones 
742  */
743 short ANIM_fmodifiers_paste_from_buf (ListBase *modifiers, short replace)
744 {
745         FModifier *fcm;
746         short ok = 0;
747         
748         /* sanity checks */
749         if (modifiers == NULL)
750                 return 0;
751                 
752         /* if replacing the list, free the existing modifiers */
753         if (replace)
754                 free_fmodifiers(modifiers);
755                 
756         /* now copy over all the modifiers in the buffer to the end of the list */
757         for (fcm= fmodifier_copypaste_buf.first; fcm; fcm= fcm->next) {
758                 /* make a copy of it */
759                 FModifier *fcmN = copy_fmodifier(fcm);
760                 
761                 /* make sure the new one isn't active, otherwise the list may get several actives */
762                 fcmN->flag &= ~FMODIFIER_FLAG_ACTIVE;
763                 
764                 /* now add it to the end of the list */
765                 BLI_addtail(modifiers, fcmN);
766                 ok = 1;
767         }
768         
769         /* did we succeed? */
770         return ok;
771 }
772
773 /* ********************************************** */