22ab419de2e4bc555ddc55c991b79959af9ec530
[blender.git] / source / blender / editors / animation / anim_draw.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) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Joshua Leung
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/editors/animation/anim_draw.c
30  *  \ingroup edanimation
31  */
32
33 #include "BLO_sys_types.h"
34
35 #include "DNA_anim_types.h"
36 #include "DNA_object_types.h"
37 #include "DNA_scene_types.h"
38 #include "BLI_math.h"
39
40 #include "BKE_context.h"
41 #include "BKE_nla.h"
42 #include "BKE_object.h"
43
44 #include "ED_anim_api.h"
45 #include "ED_keyframes_edit.h"
46
47 #include "RNA_access.h"
48
49 #include "BIF_gl.h"
50
51 #include "UI_interface.h"
52 #include "UI_resources.h"
53 #include "UI_view2d.h"
54
55 /* XXX */
56 extern void ui_rasterpos_safe(float x, float y, float aspect);
57
58 /* *************************************************** */
59 /* TIME CODE FORMATTING */
60
61 /* Generate timecode/frame number string and store in the supplied string 
62  *      - buffer: must be at least 13 chars long 
63  *      - power: special setting for View2D grid drawing, 
64  *        used to specify how detailed we need to be
65  *      - timecodes: boolean specifying whether timecodes or
66  *        frame numbers get drawn
67  *      - cfra: time in frames or seconds, consistent with the values shown by timecodes
68  */
69 // TODO: have this in kernel instead under scene?
70 void ANIM_timecode_string_from_frame (char *str, Scene *scene, int power, short timecodes, float cfra)
71 {
72         if (timecodes) {
73                 int hours=0, minutes=0, seconds=0, frames=0;
74                 float raw_seconds= cfra;
75                 char neg[2]= "";
76                 
77                 /* get cframes */
78                 if (cfra < 0) {
79                         /* correction for negative cfraues */
80                         sprintf(neg, "-");
81                         cfra = -cfra;
82                 }
83                 if (cfra >= 3600) {
84                         /* hours */
85                         /* XXX should we only display a single digit for hours since clips are 
86                          *         VERY UNLIKELY to be more than 1-2 hours max? However, that would 
87                          *         go against conventions...
88                          */
89                         hours= (int)cfra / 3600;
90                         cfra= (float)fmod(cfra, 3600);
91                 }
92                 if (cfra >= 60) {
93                         /* minutes */
94                         minutes= (int)cfra / 60;
95                         cfra= (float)fmod(cfra, 60);
96                 }
97                 if (power <= 0) {
98                         /* seconds + frames
99                          *      Frames are derived from 'fraction' of second. We need to perform some additional rounding
100                          *      to cope with 'half' frames, etc., which should be fine in most cases
101                          */
102                         seconds= (int)cfra;
103                         frames= (int)floor( (((double)cfra - (double)seconds) * FPS) + 0.5 );
104                 }
105                 else {
106                         /* seconds (with pixel offset rounding) */
107                         seconds= (int)floor(cfra + 0.375f);
108                 }
109                 
110                 switch (U.timecode_style) {
111                         case USER_TIMECODE_MINIMAL: 
112                         {
113                                 /*      - In general, minutes and seconds should be shown, as most clips will be
114                                  *        within this length. Hours will only be included if relevant.
115                                  *      - Only show frames when zoomed in enough for them to be relevant 
116                                  *        (using separator of '+' for frames).
117                                  *        When showing frames, use slightly different display to avoid confusion with mm:ss format
118                                  */
119                                 if (power <= 0) {
120                                         /* include "frames" in display */
121                                         if (hours) sprintf(str, "%s%02d:%02d:%02d+%02d", neg, hours, minutes, seconds, frames);
122                                         else if (minutes) sprintf(str, "%s%02d:%02d+%02d", neg, minutes, seconds, frames);
123                                         else sprintf(str, "%s%d+%02d", neg, seconds, frames);
124                                 }
125                                 else {
126                                         /* don't include 'frames' in display */
127                                         if (hours) sprintf(str, "%s%02d:%02d:%02d", neg, hours, minutes, seconds);
128                                         else sprintf(str, "%s%02d:%02d", neg, minutes, seconds);
129                                 }
130                         }
131                                 break;
132                                 
133                         case USER_TIMECODE_SMPTE_MSF:
134                         {
135                                 /* reduced SMPTE format that always shows minutes, seconds, frames. Hours only shown as needed. */
136                                 if (hours) sprintf(str, "%s%02d:%02d:%02d:%02d", neg, hours, minutes, seconds, frames);
137                                 else sprintf(str, "%s%02d:%02d:%02d", neg, minutes, seconds, frames);
138                         }
139                                 break;
140                         
141                         case USER_TIMECODE_MILLISECONDS:
142                         {
143                                 /* reduced SMPTE. Instead of frames, milliseconds are shown */
144                                 int ms_dp= (power <= 0) ? (1 - power) : 1; /* precision of decimal part */
145                                 int s_pad= ms_dp+3;     /* to get 2 digit whole-number part for seconds display (i.e. 3 is for 2 digits + radix, on top of full length) */
146                                 
147                                 if (hours) sprintf(str, "%s%02d:%02d:%0*.*f", neg, hours, minutes, s_pad, ms_dp, cfra);
148                                 else sprintf(str, "%s%02d:%0*.*f", neg, minutes, s_pad,  ms_dp, cfra);
149                         }
150                                 break;
151                                 
152                         case USER_TIMECODE_SECONDS_ONLY:
153                         {
154                                 /* only show the original seconds display */
155                                 /* round to whole numbers if power is >= 1 (i.e. scale is coarse) */
156                                 if (power <= 0) sprintf(str, "%.*f", 1-power, raw_seconds);
157                                 else sprintf(str, "%d", (int)floor(raw_seconds + 0.375f));
158                         }
159                                 break;
160                         
161                         case USER_TIMECODE_SMPTE_FULL:
162                         default:
163                         {
164                                 /* full SMPTE format */
165                                 sprintf(str, "%s%02d:%02d:%02d:%02d", neg, hours, minutes, seconds, frames);
166                         }
167                                 break;
168                 }
169         }
170         else {
171                 /* round to whole numbers if power is >= 1 (i.e. scale is coarse) */
172                 if (power <= 0) sprintf(str, "%.*f", 1-power, cfra);
173                 else sprintf(str, "%d", (int)floor(cfra + 0.375f));
174         }
175
176
177 /* *************************************************** */
178 /* CURRENT FRAME DRAWING */
179
180 /* Draw current frame number in a little green box beside the current frame indicator */
181 static void draw_cfra_number (Scene *scene, View2D *v2d, float cfra, short time)
182 {
183         float xscale, yscale, x, y;
184         char str[32] = "    t"; /* t is the character to start replacing from */
185         short slen;
186         
187         /* because the frame number text is subject to the same scaling as the contents of the view */
188         UI_view2d_getscale(v2d, &xscale, &yscale);
189         glScalef(1.0f/xscale, 1.0f, 1.0f);
190         
191         /* get timecode string 
192          *      - padding on str-buf passed so that it doesn't sit on the frame indicator
193          *      - power = 0, gives 'standard' behaviour for time
194          *        but power = 1 is required for frames (to get integer frames)
195          */
196         if (time)
197                 ANIM_timecode_string_from_frame(&str[4], scene, 0, time, FRA2TIME(cfra));
198         else    
199                 ANIM_timecode_string_from_frame(&str[4], scene, 1, time, cfra);
200         slen= (short)UI_GetStringWidth(str) - 1;
201         
202         /* get starting coordinates for drawing */
203         x= cfra * xscale;
204         y= 18;
205         
206         /* draw green box around/behind text */
207         UI_ThemeColorShade(TH_CFRAME, 0);
208         glRectf(x, y,  x+slen,  y+15);
209         
210         /* draw current frame number - black text */
211         UI_ThemeColor(TH_TEXT);
212         UI_DrawString(x-5, y+3, str);
213         
214         /* restore view transform */
215         glScalef(xscale, 1.0, 1.0);
216 }
217
218 /* General call for drawing current frame indicator in animation editor */
219 void ANIM_draw_cfra (const bContext *C, View2D *v2d, short flag)
220 {
221         Scene *scene= CTX_data_scene(C);
222         float vec[2];
223         
224         /* Draw a light green line to indicate current frame */
225         vec[0]= (float)(scene->r.cfra * scene->r.framelen);
226         
227         UI_ThemeColor(TH_CFRAME);
228         if (flag & DRAWCFRA_WIDE)
229                 glLineWidth(3.0);
230         else
231                 glLineWidth(2.0);
232         
233         glBegin(GL_LINE_STRIP);
234                 vec[1]= v2d->cur.ymin-500.0f;   /* XXX arbitrary... want it go to bottom */
235                 glVertex2fv(vec);
236                 
237                 vec[1]= v2d->cur.ymax;
238                 glVertex2fv(vec);
239         glEnd();
240         
241         /* Draw dark green line if slow-parenting/time-offset is enabled */
242         if (flag & DRAWCFRA_SHOW_TIMEOFS) {
243                 Object *ob= OBACT;
244                 if(ob) {
245                         float timeoffset= give_timeoffset(ob);
246                         // XXX ob->ipoflag is depreceated!
247                         if ((ob->ipoflag & OB_OFFS_OB) && (timeoffset != 0.0f)) {
248                                 vec[0]-= timeoffset; /* could avoid calling twice */
249                                 
250                                 UI_ThemeColorShade(TH_CFRAME, -30);
251                                 
252                                 glBegin(GL_LINE_STRIP);
253                                         /*vec[1]= v2d->cur.ymax;*/ // this is set already. this line is only included
254                                         glVertex2fv(vec);
255                                         
256                                         vec[1]= v2d->cur.ymin;
257                                         glVertex2fv(vec);
258                                 glEnd();
259                         }
260                 }
261         }
262         
263         glLineWidth(1.0);
264         
265         /* Draw current frame number in a little box */
266         if (flag & DRAWCFRA_SHOW_NUMBOX) {
267                 UI_view2d_view_orthoSpecial(CTX_wm_region(C), v2d, 1);
268                 draw_cfra_number(scene, v2d, vec[0], (flag & DRAWCFRA_UNIT_SECONDS));
269         }
270 }
271
272 /* *************************************************** */
273 /* PREVIEW RANGE 'CURTAINS' */
274 /* Note: 'Preview Range' tools are defined in anim_ops.c */
275
276 /* Draw preview range 'curtains' for highlighting where the animation data is */
277 void ANIM_draw_previewrange (const bContext *C, View2D *v2d)
278 {
279         Scene *scene= CTX_data_scene(C);
280         
281         /* only draw this if preview range is set */
282         if (PRVRANGEON) {
283                 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
284                 glEnable(GL_BLEND);
285                 glColor4f(0.0f, 0.0f, 0.0f, 0.4f);
286                 
287                 /* only draw two separate 'curtains' if there's no overlap between them */
288                 if (PSFRA < PEFRA) {
289                         glRectf(v2d->cur.xmin, v2d->cur.ymin, (float)PSFRA, v2d->cur.ymax);
290                         glRectf((float)PEFRA, v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);     
291                 } 
292                 else {
293                         glRectf(v2d->cur.xmin, v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);
294                 }
295                 
296                 glDisable(GL_BLEND);
297         }
298 }
299
300 /* *************************************************** */
301 /* NLA-MAPPING UTILITIES (required for drawing and also editing keyframes)  */
302
303 /* Obtain the AnimData block providing NLA-mapping for the given channel (if applicable) */
304 // TODO: do not supply return this if the animdata tells us that there is no mapping to perform
305 AnimData *ANIM_nla_mapping_get(bAnimContext *ac, bAnimListElem *ale)
306 {
307         /* sanity checks */
308         if (ac == NULL)
309                 return NULL;
310         
311         /* handling depends on the type of animation-context we've got */
312         if (ale)
313                 return ale->adt;
314         else
315                 return NULL;
316 }
317
318 /* ------------------- */
319
320 /* helper function for ANIM_nla_mapping_apply_fcurve() -> "restore", i.e. mapping points back to action-time */
321 static short bezt_nlamapping_restore(KeyframeEditData *ked, BezTriple *bezt)
322 {
323         /* AnimData block providing scaling is stored in 'data', only_keys option is stored in i1 */
324         AnimData *adt= (AnimData *)ked->data;
325         short only_keys= (short)ked->i1;
326         
327         /* adjust BezTriple handles only if allowed to */
328         if (only_keys == 0) {
329                 bezt->vec[0][0]= BKE_nla_tweakedit_remap(adt, bezt->vec[0][0], NLATIME_CONVERT_UNMAP);
330                 bezt->vec[2][0]= BKE_nla_tweakedit_remap(adt, bezt->vec[2][0], NLATIME_CONVERT_UNMAP);
331         }
332         
333         bezt->vec[1][0]= BKE_nla_tweakedit_remap(adt, bezt->vec[1][0], NLATIME_CONVERT_UNMAP);
334         
335         return 0;
336 }
337
338 /* helper function for ANIM_nla_mapping_apply_fcurve() -> "apply", i.e. mapping points to NLA-mapped global time */
339 static short bezt_nlamapping_apply(KeyframeEditData *ked, BezTriple *bezt)
340 {
341         /* AnimData block providing scaling is stored in 'data', only_keys option is stored in i1 */
342         AnimData *adt= (AnimData*)ked->data;
343         short only_keys= (short)ked->i1;
344         
345         /* adjust BezTriple handles only if allowed to */
346         if (only_keys == 0) {
347                 bezt->vec[0][0]= BKE_nla_tweakedit_remap(adt, bezt->vec[0][0], NLATIME_CONVERT_MAP);
348                 bezt->vec[2][0]= BKE_nla_tweakedit_remap(adt, bezt->vec[2][0], NLATIME_CONVERT_MAP);
349         }
350         
351         bezt->vec[1][0]= BKE_nla_tweakedit_remap(adt, bezt->vec[1][0], NLATIME_CONVERT_MAP);
352         
353         return 0;
354 }
355
356
357 /* Apply/Unapply NLA mapping to all keyframes in the nominated F-Curve 
358  *      - restore = whether to map points back to non-mapped time 
359  *      - only_keys = whether to only adjust the location of the center point of beztriples
360  */
361 void ANIM_nla_mapping_apply_fcurve (AnimData *adt, FCurve *fcu, short restore, short only_keys)
362 {
363         KeyframeEditData ked= {{NULL}};
364         KeyframeEditFunc map_cb;
365         
366         /* init edit data 
367          *      - AnimData is stored in 'data'
368          *      - only_keys is stored in 'i1'
369          */
370         ked.data= (void *)adt;
371         ked.i1= (int)only_keys;
372         
373         /* get editing callback */
374         if (restore)
375                 map_cb= bezt_nlamapping_restore;
376         else
377                 map_cb= bezt_nlamapping_apply;
378         
379         /* apply to F-Curve */
380         ANIM_fcurve_keyframes_loop(&ked, fcu, NULL, map_cb, NULL);
381 }
382
383 /* *************************************************** */
384 /* UNITS CONVERSION MAPPING (required for drawing and editing keyframes) */
385
386 /* Get unit conversion factor for given ID + F-Curve */
387 float ANIM_unit_mapping_get_factor (Scene *scene, ID *id, FCurve *fcu, short restore)
388 {
389         /* sanity checks */
390         if (id && fcu && fcu->rna_path) 
391         {
392                 PointerRNA ptr, id_ptr;
393                 PropertyRNA *prop;
394                 
395                 /* get RNA property that F-Curve affects */
396                 RNA_id_pointer_create(id, &id_ptr);
397                 if (RNA_path_resolve(&id_ptr, fcu->rna_path, &ptr, &prop)) 
398                 {
399                         /* rotations: radians <-> degrees? */
400                         if (RNA_SUBTYPE_UNIT(RNA_property_subtype(prop)) == PROP_UNIT_ROTATION)
401                         {
402                                 /* if the radians flag is not set, default to using degrees which need conversions */
403                                 if ((scene) && (scene->unit.system_rotation == USER_UNIT_ROT_RADIANS) == 0) {
404                                         if (restore)
405                                                 return M_PI / 180.0;    /* degrees to radians */
406                                         else
407                                                 return 180.0 / M_PI;    /* radians to degrees */
408                                 }
409                         }
410                         
411                         // TODO: other rotation types here as necessary
412                 }
413         }
414         
415         /* no mapping needs to occur... */
416         return 1.0f;
417 }
418
419 /* ----------------------- */
420
421 /* helper function for ANIM_unit_mapping_apply_fcurve -> mapping callback for unit mapping */
422 static short bezt_unit_mapping_apply (KeyframeEditData *ked, BezTriple *bezt)
423 {
424         /* mapping factor is stored in f1, flags are stored in i1 */
425         short only_keys= (ked->i1 & ANIM_UNITCONV_ONLYKEYS);
426         short sel_vs= (ked->i1 & ANIM_UNITCONV_SELVERTS);
427         float fac= ked->f1;
428         
429         /* adjust BezTriple handles only if allowed to */
430         if (only_keys == 0) {
431                 if ((sel_vs==0) || (bezt->f1 & SELECT)) 
432                         bezt->vec[0][1] *= fac;
433                 if ((sel_vs==0) || (bezt->f3 & SELECT)) 
434                         bezt->vec[2][1] *= fac;
435         }
436         
437         if ((sel_vs == 0) || (bezt->f2 & SELECT))
438                 bezt->vec[1][1] *= fac;
439         
440         return 0;
441 }
442
443 /* Apply/Unapply units conversions to keyframes */
444 void ANIM_unit_mapping_apply_fcurve (Scene *scene, ID *id, FCurve *fcu, short flag)
445 {
446         KeyframeEditData ked;
447         KeyframeEditFunc sel_cb;
448         float fac;
449         
450         /* calculate mapping factor, and abort if nothing to change */
451         fac= ANIM_unit_mapping_get_factor(scene, id, fcu, (flag & ANIM_UNITCONV_RESTORE));
452         if (fac == 1.0f)
453                 return;
454         
455         /* init edit data 
456          *      - mapping factor is stored in f1
457          *      - flags are stored in 'i1'
458          */
459         memset(&ked, 0, sizeof(KeyframeEditData));
460         ked.f1= (float)fac;
461         ked.i1= (int)flag;
462         
463         /* only selected? */
464         if (flag & ANIM_UNITCONV_ONLYSEL)
465                 sel_cb= ANIM_editkeyframes_ok(BEZT_OK_SELECTED);
466         else
467                 sel_cb= NULL;
468         
469         /* apply to F-Curve */
470         ANIM_fcurve_keyframes_loop(&ked, fcu, sel_cb, bezt_unit_mapping_apply, NULL);
471         
472         // FIXME: loop here for samples should be generalised
473         // TODO: only sel?
474         if (fcu->fpt) {
475                 FPoint *fpt;
476                 unsigned int i;
477                 
478                 for (i=0, fpt=fcu->fpt; i < fcu->totvert; i++, fpt++) {
479                         /* apply unit mapping */
480                         fpt->vec[1] *= fac;
481                 }
482         }
483 }
484
485 /* *************************************************** */