Dopesheet: Keyframe size can be adjusted as part of theme settings
[blender.git] / source / blender / editors / animation / anim_draw.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Joshua Leung
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/animation/anim_draw.c
28  *  \ingroup edanimation
29  */
30
31 #include "BLI_sys_types.h"
32
33 #include "DNA_anim_types.h"
34 #include "DNA_scene_types.h"
35 #include "DNA_space_types.h"
36 #include "DNA_userdef_types.h"
37 #include "DNA_screen_types.h"
38 #include "DNA_object_types.h"
39 #include "DNA_gpencil_types.h"
40 #include "DNA_mask_types.h"
41
42 #include "BLI_math.h"
43 #include "BLI_timecode.h"
44 #include "BLI_utildefines.h"
45 #include "BLI_rect.h"
46 #include "BLI_dlrbTree.h"
47
48 #include "BKE_context.h"
49 #include "BKE_global.h"
50 #include "BKE_nla.h"
51 #include "BKE_mask.h"
52
53 #include "ED_anim_api.h"
54 #include "ED_keyframes_edit.h"
55 #include "ED_keyframes_draw.h"
56
57 #include "RNA_access.h"
58
59 #include "BIF_gl.h"
60
61 #include "UI_interface.h"
62 #include "UI_resources.h"
63 #include "UI_view2d.h"
64
65 /* *************************************************** */
66 /* CURRENT FRAME DRAWING */
67
68 /* Draw current frame number in a little green box beside the current frame indicator */
69 static void draw_cfra_number(Scene *scene, View2D *v2d, const float cfra, const bool time)
70 {
71         const uiFontStyle *fstyle = UI_FSTYLE_WIDGET;
72         float xscale, yscale, x, y;
73         char numstr[32] = "    t";  /* t is the character to start replacing from */
74         int slen;
75         
76         /* because the frame number text is subject to the same scaling as the contents of the view */
77         UI_view2d_scale_get(v2d, &xscale, &yscale);
78         glScalef(1.0f / xscale, 1.0f, 1.0f);
79         
80         /* get timecode string 
81          *      - padding on str-buf passed so that it doesn't sit on the frame indicator
82          *      - power = 0, gives 'standard' behavior for time
83          *        but power = 1 is required for frames (to get integer frames)
84          */
85         if (time) {
86                 BLI_timecode_string_from_time(&numstr[4], sizeof(numstr) - 4, 0, FRA2TIME(cfra), FPS, U.timecode_style);
87         }
88         else {
89                 BLI_timecode_string_from_time_seconds(&numstr[4], sizeof(numstr) - 4, 1, cfra);
90         }
91
92         slen = UI_fontstyle_string_width(fstyle, numstr) - 1;
93         
94         /* get starting coordinates for drawing */
95         x = cfra * xscale;
96         y = 0.9f * U.widget_unit;
97         
98         /* draw green box around/behind text */
99         UI_ThemeColorShade(TH_CFRAME, 0);
100         glRectf(x, y,  x + slen,  y + 0.75f * U.widget_unit);
101         
102         /* draw current frame number - black text */
103         UI_ThemeColor(TH_TEXT);
104         UI_fontstyle_draw_simple(fstyle, x - 0.25f * U.widget_unit, y + 0.15f * U.widget_unit, numstr);
105         
106         /* restore view transform */
107         glScalef(xscale, 1.0, 1.0);
108 }
109
110 /* General call for drawing current frame indicator in animation editor */
111 void ANIM_draw_cfra(const bContext *C, View2D *v2d, short flag)
112 {
113         Scene *scene = CTX_data_scene(C);
114
115         /* Draw a light green line to indicate current frame */
116         UI_ThemeColor(TH_CFRAME);
117
118         const float x = (float)(scene->r.cfra * scene->r.framelen);
119
120         glLineWidth((flag & DRAWCFRA_WIDE) ? 3.0 : 2.0);
121
122         glBegin(GL_LINES);
123         glVertex2f(x, v2d->cur.ymin - 500.0f); /* XXX arbitrary... want it go to bottom */
124         glVertex2f(x, v2d->cur.ymax);
125         glEnd();
126
127         /* Draw current frame number in a little box */
128         if (flag & DRAWCFRA_SHOW_NUMBOX) {
129                 UI_view2d_view_orthoSpecial(CTX_wm_region(C), v2d, 1);
130                 draw_cfra_number(scene, v2d, x, (flag & DRAWCFRA_UNIT_SECONDS) != 0);
131         }
132 }
133
134 /* *************************************************** */
135 /* PREVIEW RANGE 'CURTAINS' */
136 /* Note: 'Preview Range' tools are defined in anim_ops.c */
137
138 /* Draw preview range 'curtains' for highlighting where the animation data is */
139 void ANIM_draw_previewrange(const bContext *C, View2D *v2d, int end_frame_width)
140 {
141         Scene *scene = CTX_data_scene(C);
142         
143         /* only draw this if preview range is set */
144         if (PRVRANGEON) {
145                 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
146                 glEnable(GL_BLEND);
147                 glColor4f(0.0f, 0.0f, 0.0f, 0.4f);
148                 
149                 /* only draw two separate 'curtains' if there's no overlap between them */
150                 if (PSFRA < PEFRA + end_frame_width) {
151                         glRectf(v2d->cur.xmin, v2d->cur.ymin, (float)PSFRA, v2d->cur.ymax);
152                         glRectf((float)(PEFRA + end_frame_width), v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);
153                 }
154                 else {
155                         glRectf(v2d->cur.xmin, v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);
156                 }
157                 
158                 glDisable(GL_BLEND);
159         }
160 }
161
162 /* *************************************************** */
163 /* NLA-MAPPING UTILITIES (required for drawing and also editing keyframes)  */
164
165 /* Obtain the AnimData block providing NLA-mapping for the given channel (if applicable) */
166 // TODO: do not supply return this if the animdata tells us that there is no mapping to perform
167 AnimData *ANIM_nla_mapping_get(bAnimContext *ac, bAnimListElem *ale)
168 {
169         /* sanity checks */
170         if (ac == NULL)
171                 return NULL;
172         
173         /* abort if rendering - we may get some race condition issues... */
174         if (G.is_rendering) return NULL;
175         
176         /* apart from strictly keyframe-related contexts, this shouldn't even happen */
177         // XXX: nla and channel here may not be necessary...
178         if (ELEM(ac->datatype, ANIMCONT_ACTION, ANIMCONT_SHAPEKEY, ANIMCONT_DOPESHEET,
179                                ANIMCONT_FCURVES, ANIMCONT_NLA, ANIMCONT_CHANNEL))
180         {
181                 /* handling depends on the type of animation-context we've got */
182                 if (ale) {
183                         /* NLA Control Curves occur on NLA strips, and shouldn't be subjected to this kind of mapping */
184                         if (ale->type != ANIMTYPE_NLACURVE)
185                                 return ale->adt;
186                 }
187         }
188         
189         /* cannot handle... */
190         return NULL;
191 }
192
193 /* ------------------- */
194
195 /* helper function for ANIM_nla_mapping_apply_fcurve() -> "restore", i.e. mapping points back to action-time */
196 static short bezt_nlamapping_restore(KeyframeEditData *ked, BezTriple *bezt)
197 {
198         /* AnimData block providing scaling is stored in 'data', only_keys option is stored in i1 */
199         AnimData *adt = (AnimData *)ked->data;
200         short only_keys = (short)ked->i1;
201         
202         /* adjust BezTriple handles only if allowed to */
203         if (only_keys == 0) {
204                 bezt->vec[0][0] = BKE_nla_tweakedit_remap(adt, bezt->vec[0][0], NLATIME_CONVERT_UNMAP);
205                 bezt->vec[2][0] = BKE_nla_tweakedit_remap(adt, bezt->vec[2][0], NLATIME_CONVERT_UNMAP);
206         }
207         
208         bezt->vec[1][0] = BKE_nla_tweakedit_remap(adt, bezt->vec[1][0], NLATIME_CONVERT_UNMAP);
209         
210         return 0;
211 }
212
213 /* helper function for ANIM_nla_mapping_apply_fcurve() -> "apply", i.e. mapping points to NLA-mapped global time */
214 static short bezt_nlamapping_apply(KeyframeEditData *ked, BezTriple *bezt)
215 {
216         /* AnimData block providing scaling is stored in 'data', only_keys option is stored in i1 */
217         AnimData *adt = (AnimData *)ked->data;
218         short only_keys = (short)ked->i1;
219         
220         /* adjust BezTriple handles only if allowed to */
221         if (only_keys == 0) {
222                 bezt->vec[0][0] = BKE_nla_tweakedit_remap(adt, bezt->vec[0][0], NLATIME_CONVERT_MAP);
223                 bezt->vec[2][0] = BKE_nla_tweakedit_remap(adt, bezt->vec[2][0], NLATIME_CONVERT_MAP);
224         }
225         
226         bezt->vec[1][0] = BKE_nla_tweakedit_remap(adt, bezt->vec[1][0], NLATIME_CONVERT_MAP);
227         
228         return 0;
229 }
230
231
232 /* Apply/Unapply NLA mapping to all keyframes in the nominated F-Curve 
233  *      - restore = whether to map points back to non-mapped time 
234  *  - only_keys = whether to only adjust the location of the center point of beztriples
235  */
236 void ANIM_nla_mapping_apply_fcurve(AnimData *adt, FCurve *fcu, bool restore, bool only_keys)
237 {
238         KeyframeEditData ked = {{NULL}};
239         KeyframeEditFunc map_cb;
240         
241         /* init edit data 
242          *      - AnimData is stored in 'data'
243          *      - only_keys is stored in 'i1'
244          */
245         ked.data = (void *)adt;
246         ked.i1 = (int)only_keys;
247         
248         /* get editing callback */
249         if (restore)
250                 map_cb = bezt_nlamapping_restore;
251         else
252                 map_cb = bezt_nlamapping_apply;
253         
254         /* apply to F-Curve */
255         ANIM_fcurve_keyframes_loop(&ked, fcu, NULL, map_cb, NULL);
256 }
257
258 /* *************************************************** */
259 /* UNITS CONVERSION MAPPING (required for drawing and editing keyframes) */
260
261 /* Get flags used for normalization in ANIM_unit_mapping_get_factor. */
262 short ANIM_get_normalization_flags(bAnimContext *ac)
263 {
264         if (ac->sl->spacetype == SPACE_IPO) {
265                 SpaceIpo *sipo = (SpaceIpo *) ac->sl;
266                 bool use_normalization = (sipo->flag & SIPO_NORMALIZE) != 0;
267                 bool freeze_normalization = (sipo->flag & SIPO_NORMALIZE_FREEZE) != 0;
268                 return use_normalization
269                     ? (ANIM_UNITCONV_NORMALIZE |  (freeze_normalization ? ANIM_UNITCONV_NORMALIZE_FREEZE : 0))
270                     : 0;
271         }
272
273         return 0;
274 }
275
276 static float normalization_factor_get(Scene *scene, FCurve *fcu, short flag, float *r_offset)
277 {
278         float factor = 1.0f, offset = 0.0f;
279
280         if (flag & ANIM_UNITCONV_RESTORE) {
281                 if (r_offset)
282                         *r_offset = fcu->prev_offset;
283
284                 return 1.0f / fcu->prev_norm_factor;
285         }
286
287         if (flag & ANIM_UNITCONV_NORMALIZE_FREEZE) {
288                 if (r_offset)
289                         *r_offset = fcu->prev_offset;
290                 if (fcu->prev_norm_factor == 0.0f) {
291                         /* Happens when Auto Normalize was disabled before
292                          * any curves were displayed.
293                          */
294                         return 1.0f;
295                 }
296                 return fcu->prev_norm_factor;
297         }
298
299         if (G.moving & G_TRANSFORM_FCURVES) {
300                 if (r_offset)
301                         *r_offset = fcu->prev_offset;
302                 if (fcu->prev_norm_factor == 0.0f) {
303                         /* Same as above. */
304                         return 1.0f;
305                 }
306                 return fcu->prev_norm_factor;
307         }
308
309         fcu->prev_norm_factor = 1.0f;
310         if (fcu->bezt) {
311                 BezTriple *bezt;
312                 int i;
313                 float max_coord = -FLT_MAX;
314                 float min_coord = FLT_MAX;
315                 float range;
316
317                 if (fcu->totvert < 1) {
318                         return 1.0f;
319                 }
320
321                 if (PRVRANGEON) {
322                         for (i = 0, bezt = fcu->bezt; i < fcu->totvert; i++, bezt++) {
323                                 if (IN_RANGE_INCL(bezt->vec[1][0], scene->r.psfra, scene->r.pefra)) {
324                                         max_coord = max_ff(max_coord, bezt->vec[0][1]);
325                                         max_coord = max_ff(max_coord, bezt->vec[1][1]);
326                                         max_coord = max_ff(max_coord, bezt->vec[2][1]);
327
328                                         min_coord = min_ff(min_coord, bezt->vec[0][1]);
329                                         min_coord = min_ff(min_coord, bezt->vec[1][1]);
330                                         min_coord = min_ff(min_coord, bezt->vec[2][1]);
331                                 }
332                         }
333                 }
334                 else {
335                         for (i = 0, bezt = fcu->bezt; i < fcu->totvert; i++, bezt++) {
336                                 max_coord = max_ff(max_coord, bezt->vec[0][1]);
337                                 max_coord = max_ff(max_coord, bezt->vec[1][1]);
338                                 max_coord = max_ff(max_coord, bezt->vec[2][1]);
339
340                                 min_coord = min_ff(min_coord, bezt->vec[0][1]);
341                                 min_coord = min_ff(min_coord, bezt->vec[1][1]);
342                                 min_coord = min_ff(min_coord, bezt->vec[2][1]);
343                         }
344                 }
345
346                 range = max_coord - min_coord;
347
348                 if (range > FLT_EPSILON) {
349                         factor = 2.0f / range;
350                 }
351                 offset = -min_coord - range / 2.0f;
352         }
353         BLI_assert(factor != 0.0f);
354         if (r_offset) {
355                 *r_offset = offset;
356         }
357
358         fcu->prev_norm_factor = factor;
359         fcu->prev_offset = offset;
360         return factor;
361 }
362
363 /* Get unit conversion factor for given ID + F-Curve */
364 float ANIM_unit_mapping_get_factor(Scene *scene, ID *id, FCurve *fcu, short flag, float *r_offset)
365 {
366         if (flag & ANIM_UNITCONV_NORMALIZE) {
367                 return normalization_factor_get(scene, fcu, flag, r_offset);
368         }
369
370         if (r_offset)
371                 *r_offset = 0.0f;
372
373         /* sanity checks */
374         if (id && fcu && fcu->rna_path) {
375                 PointerRNA ptr, id_ptr;
376                 PropertyRNA *prop;
377                 
378                 /* get RNA property that F-Curve affects */
379                 RNA_id_pointer_create(id, &id_ptr);
380                 if (RNA_path_resolve_property(&id_ptr, fcu->rna_path, &ptr, &prop)) {
381                         /* rotations: radians <-> degrees? */
382                         if (RNA_SUBTYPE_UNIT(RNA_property_subtype(prop)) == PROP_UNIT_ROTATION) {
383                                 /* if the radians flag is not set, default to using degrees which need conversions */
384                                 if ((scene) && (scene->unit.system_rotation == USER_UNIT_ROT_RADIANS) == 0) {
385                                         if (flag & ANIM_UNITCONV_RESTORE)
386                                                 return DEG2RADF(1.0f);  /* degrees to radians */
387                                         else
388                                                 return RAD2DEGF(1.0f);  /* radians to degrees */
389                                 }
390                         }
391                         
392                         /* TODO: other rotation types here as necessary */
393                 }
394         }
395
396         /* no mapping needs to occur... */
397         return 1.0f;
398 }
399
400 static bool find_prev_next_keyframes(struct bContext *C, int *nextfra, int *prevfra)
401 {
402         Scene *scene = CTX_data_scene(C);
403         Object *ob = CTX_data_active_object(C);
404         Mask *mask = CTX_data_edit_mask(C);
405         bDopeSheet ads = {NULL};
406         DLRBT_Tree keys;
407         ActKeyColumn *aknext, *akprev;
408         float cfranext, cfraprev;
409         bool donenext = false, doneprev = false;
410         int nextcount = 0, prevcount = 0;
411
412         cfranext = cfraprev = (float)(CFRA);
413
414         /* init binarytree-list for getting keyframes */
415         BLI_dlrbTree_init(&keys);
416
417         /* seed up dummy dopesheet context with flags to perform necessary filtering */
418         if ((scene->flag & SCE_KEYS_NO_SELONLY) == 0) {
419                 /* only selected channels are included */
420                 ads.filterflag |= ADS_FILTER_ONLYSEL;
421         }
422
423         /* populate tree with keyframe nodes */
424         scene_to_keylist(&ads, scene, &keys, NULL);
425         gpencil_to_keylist(&ads, scene->gpd, &keys);
426
427         if (ob) {
428                 ob_to_keylist(&ads, ob, &keys, NULL);
429                 gpencil_to_keylist(&ads, ob->gpd, &keys);
430         }
431
432         if (mask) {
433                 MaskLayer *masklay = BKE_mask_layer_active(mask);
434                 mask_to_keylist(&ads, masklay, &keys);
435         }
436
437         /* build linked-list for searching */
438         BLI_dlrbTree_linkedlist_sync(&keys);
439
440         /* find matching keyframe in the right direction */
441         do {
442                 aknext = (ActKeyColumn *)BLI_dlrbTree_search_next(&keys, compare_ak_cfraPtr, &cfranext);
443
444                 if (aknext) {
445                         if (CFRA == (int)aknext->cfra) {
446                                 /* make this the new starting point for the search and ignore */
447                                 cfranext = aknext->cfra;
448                         }
449                         else {
450                                 /* this changes the frame, so set the frame and we're done */
451                                 if (++nextcount == U.view_frame_keyframes)
452                                         donenext = true;
453                         }
454                         cfranext = aknext->cfra;
455                 }
456         } while ((aknext != NULL) && (donenext == false));
457
458         do {
459                 akprev = (ActKeyColumn *)BLI_dlrbTree_search_prev(&keys, compare_ak_cfraPtr, &cfraprev);
460
461                 if (akprev) {
462                         if (CFRA == (int)akprev->cfra) {
463                                 /* make this the new starting point for the search */
464                         }
465                         else {
466                                 /* this changes the frame, so set the frame and we're done */
467                                 if (++prevcount == U.view_frame_keyframes)
468                                         doneprev = true;
469                         }
470                         cfraprev = akprev->cfra;
471                 }
472         } while ((akprev != NULL) && (doneprev == false));
473
474         /* free temp stuff */
475         BLI_dlrbTree_free(&keys);
476
477         /* any success? */
478         if (doneprev || donenext) {
479                 if (doneprev)
480                         *prevfra = cfraprev;
481                 else
482                         *prevfra = CFRA - (cfranext - CFRA);
483
484                 if (donenext)
485                         *nextfra = cfranext;
486                 else
487                         *nextfra = CFRA + (CFRA - cfraprev);
488
489                 return true;
490         }
491
492         return false;
493 }
494
495 void ANIM_center_frame(struct bContext *C, int smooth_viewtx)
496 {
497         ARegion *ar = CTX_wm_region(C);
498         Scene *scene = CTX_data_scene(C);
499         float w = BLI_rctf_size_x(&ar->v2d.cur);
500         rctf newrct;
501         int nextfra, prevfra;
502
503         switch (U.view_frame_type) {
504                 case ZOOM_FRAME_MODE_SECONDS:
505                 {
506                         const float fps = FPS;
507                         newrct.xmax = scene->r.cfra + U.view_frame_seconds * fps + 1;
508                         newrct.xmin = scene->r.cfra - U.view_frame_seconds * fps - 1;
509                         newrct.ymax = ar->v2d.cur.ymax;
510                         newrct.ymin = ar->v2d.cur.ymin;
511                         break;
512                 }
513
514                 /* hardest case of all, look for all keyframes around frame and display those */
515                 case ZOOM_FRAME_MODE_KEYFRAMES:
516                         if (find_prev_next_keyframes(C, &nextfra, &prevfra)) {
517                                 newrct.xmax = nextfra;
518                                 newrct.xmin = prevfra;
519                                 newrct.ymax = ar->v2d.cur.ymax;
520                                 newrct.ymin = ar->v2d.cur.ymin;
521                                 break;
522                         }
523                         /* else drop through, keep range instead */
524
525                 case ZOOM_FRAME_MODE_KEEP_RANGE:
526                 default:
527                         newrct.xmax = scene->r.cfra + (w / 2);
528                         newrct.xmin = scene->r.cfra - (w / 2);
529                         newrct.ymax = ar->v2d.cur.ymax;
530                         newrct.ymin = ar->v2d.cur.ymin;
531                         break;
532         }
533
534         UI_view2d_smooth_view(C, ar, &newrct, smooth_viewtx);
535 }
536 /* *************************************************** */