Fix [#21516] UI artifacts in array modifier
[blender.git] / source / blender / editors / space_time / space_time.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): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <string.h>
30 #include <stdio.h>
31
32 #include "DNA_object_types.h"
33 #include "DNA_scene_types.h"
34
35 #include "MEM_guardedalloc.h"
36
37 #include "BLI_blenlib.h"
38 #include "BLI_dlrbTree.h"
39
40 #include "BKE_context.h"
41 #include "BKE_global.h"
42 #include "BKE_screen.h"
43 #include "BKE_utildefines.h"
44
45 #include "ED_anim_api.h"
46 #include "ED_keyframes_draw.h"
47 #include "ED_screen.h"
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 #include "BIF_gl.h"
53 #include "BIF_glutil.h"
54
55 #include "UI_resources.h"
56 #include "UI_view2d.h"
57
58 #include "ED_markers.h"
59
60 #include "time_intern.h"
61
62 /* ************************ main time area region *********************** */
63
64 static void time_draw_sfra_efra(const bContext *C, SpaceTime *stime, ARegion *ar)
65 {
66         View2D *v2d= UI_view2d_fromcontext(C);
67         Scene *scene= CTX_data_scene(C);
68         
69         /* draw darkened area outside of active timeline 
70          * frame range used is preview range or scene range */
71         UI_ThemeColorShade(TH_BACK, -25);
72
73         if (PSFRA < PEFRA) {
74                 glRectf(v2d->cur.xmin, v2d->cur.ymin, (float)PSFRA, v2d->cur.ymax);
75                 glRectf((float)PEFRA, v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);
76         }
77         else {
78                 glRectf(v2d->cur.xmin, v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);
79         }
80
81         UI_ThemeColorShade(TH_BACK, -60);
82         /* thin lines where the actual frames are */
83         fdrawline((float)PSFRA, v2d->cur.ymin, (float)PSFRA, v2d->cur.ymax);
84         fdrawline((float)PEFRA, v2d->cur.ymin, (float)PEFRA, v2d->cur.ymax);
85 }
86
87 /* helper function - find actkeycolumn that occurs on cframe, or the nearest one if not found */
88 static ActKeyColumn *time_cfra_find_ak (ActKeyColumn *ak, float cframe)
89 {
90         ActKeyColumn *akn= NULL;
91         
92         /* sanity checks */
93         if (ak == NULL)
94                 return NULL;
95         
96         /* check if this is a match, or whether it is in some subtree */
97         if (cframe < ak->cfra)
98                 akn= time_cfra_find_ak(ak->left, cframe);
99         else if (cframe > ak->cfra)
100                 akn= time_cfra_find_ak(ak->right, cframe);
101                 
102         /* if no match found (or found match), just use the current one */
103         if (akn == NULL)
104                 return ak;
105         else
106                 return akn;
107 }
108
109 /* helper for time_draw_keyframes() */
110 static void time_draw_idblock_keyframes(View2D *v2d, ID *id, short onlysel)
111 {
112         bDopeSheet ads;
113         DLRBT_Tree keys;
114         ActKeyColumn *ak;
115         
116         /* init binarytree-list for getting keyframes */
117         BLI_dlrbTree_init(&keys);
118         
119         /* init dopesheet settings */
120         // FIXME: the ob_to_keylist function currently doesn't take this into account...
121         memset(&ads, 0, sizeof(bDopeSheet));
122         if (onlysel)
123                 ads.filterflag |= ADS_FILTER_ONLYSEL;
124         
125         /* populate tree with keyframe nodes */
126         switch (GS(id->name)) {
127                 case ID_SCE:
128                         scene_to_keylist(&ads, (Scene *)id, &keys, NULL);
129                         break;
130                 case ID_OB:
131                         ob_to_keylist(&ads, (Object *)id, &keys, NULL);
132                         break;
133         }
134                 
135         /* build linked-list for searching */
136         BLI_dlrbTree_linkedlist_sync(&keys);
137         
138         /* start drawing keyframes 
139          *      - we use the binary-search capabilities of the tree to only start from 
140          *        the first visible keyframe (last one can then be easily checked)
141          *      - draw within a single GL block to be faster
142          */
143         glBegin(GL_LINES);
144                 for ( ak=time_cfra_find_ak(keys.root, v2d->cur.xmin); 
145                          (ak) && (ak->cfra <= v2d->cur.xmax); 
146                           ak=ak->next ) 
147                 {
148                         glVertex2f(ak->cfra, v2d->cur.ymin);
149                         glVertex2f(ak->cfra, v2d->cur.ymax);
150                 }
151         glEnd(); // GL_LINES
152                 
153         /* free temp stuff */
154         BLI_dlrbTree_free(&keys);
155 }
156
157 /* draw keyframe lines for timeline */
158 static void time_draw_keyframes(const bContext *C, SpaceTime *stime, ARegion *ar)
159 {
160         Scene *scene= CTX_data_scene(C);
161         Object *ob= CTX_data_active_object(C);
162         View2D *v2d= &ar->v2d;
163         short onlysel= (stime->flag & TIME_ONLYACTSEL);
164         
165         /* draw scene keyframes first 
166          *      - don't try to do this when only drawing active/selected data keyframes,
167          *        since this can become quite slow
168          */
169         if (scene && onlysel==0) {
170                 /* set draw color */
171                 glColor3ub(0xDD, 0xA7, 0x00);
172                 time_draw_idblock_keyframes(v2d, (ID *)scene, onlysel);
173         }
174         
175         /* draw keyframes from selected objects 
176          *      - only do the active object if in posemode (i.e. showing only keyframes for the bones)
177          *        OR the onlysel flag was set, which means that only active object's keyframes should
178          *        be considered
179          */
180         glColor3ub(0xDD, 0xD7, 0x00);
181         
182         if (ob && ((ob->mode == OB_MODE_POSE) || onlysel)) {
183                 /* draw keyframes for active object only */
184                 time_draw_idblock_keyframes(v2d, (ID *)ob, onlysel);
185         }
186         else {
187                 short active_done = 0;
188                 
189                 /* draw keyframes from all selected objects */
190                 CTX_DATA_BEGIN(C, Object*, obsel, selected_objects) 
191                 {
192                         /* last arg is 0, since onlysel doesn't apply here... */
193                         time_draw_idblock_keyframes(v2d, (ID *)obsel, 0);
194                         
195                         /* if this object is the active one, set flag so that we don't draw again */
196                         if (obsel == ob)
197                                 active_done= 1;
198                 }
199                 CTX_DATA_END;
200                 
201                 /* if active object hasn't been done yet, draw it... */
202                 if (ob && (active_done == 0))
203                         time_draw_idblock_keyframes(v2d, (ID *)ob, 0);
204         }
205 }
206
207 /* ---------------- */
208
209 /* add handlers, stuff you only do once or on area/region changes */
210 static void time_main_area_init(wmWindowManager *wm, ARegion *ar)
211 {
212         wmKeyMap *keymap;
213         
214         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_CUSTOM, ar->winx, ar->winy);
215         
216         /* own keymap */
217         keymap= WM_keymap_find(wm->defaultconf, "Timeline", SPACE_TIME, 0);
218         WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
219 }
220
221 static void time_main_area_draw(const bContext *C, ARegion *ar)
222 {
223         /* draw entirely, view changes should be handled here */
224         SpaceTime *stime= CTX_wm_space_time(C);
225         View2D *v2d= &ar->v2d;
226         View2DGrid *grid;
227         View2DScrollers *scrollers;
228         int unit, flag=0;
229         
230         /* clear and setup matrix */
231         UI_ThemeClearColor(TH_BACK);
232         glClear(GL_COLOR_BUFFER_BIT);
233         
234         UI_view2d_view_ortho(C, v2d);
235
236         /* start and end frame */
237         time_draw_sfra_efra(C, stime, ar);
238
239         /* grid */
240         unit= (stime->flag & TIME_DRAWFRAMES)? V2D_UNIT_FRAMES: V2D_UNIT_SECONDS;
241         grid= UI_view2d_grid_calc(C, v2d, unit, V2D_GRID_CLAMP, V2D_ARG_DUMMY, V2D_ARG_DUMMY, ar->winx, ar->winy);
242         UI_view2d_grid_draw(C, v2d, grid, (V2D_VERTICAL_LINES|V2D_VERTICAL_AXIS));
243         UI_view2d_grid_free(grid);
244         
245         /* keyframes */
246         time_draw_keyframes(C, stime, ar);
247         
248         /* current frame */
249         if ((stime->flag & TIME_DRAWFRAMES)==0)         flag |= DRAWCFRA_UNIT_SECONDS;
250         if (stime->flag & TIME_CFRA_NUM)                        flag |= DRAWCFRA_SHOW_NUMBOX;
251         ANIM_draw_cfra(C, v2d, flag);
252         
253         /* markers */
254         UI_view2d_view_orthoSpecial(C, v2d, 1);
255         draw_markers_time(C, 0);
256         
257         /* reset view matrix */
258         UI_view2d_view_restore(C);
259         
260         /* scrollers */
261         scrollers= UI_view2d_scrollers_calc(C, v2d, unit, V2D_GRID_CLAMP, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
262         UI_view2d_scrollers_draw(C, v2d, scrollers);
263         UI_view2d_scrollers_free(scrollers);
264 }
265
266 static void time_main_area_listener(ARegion *ar, wmNotifier *wmn)
267 {
268         /* context changes */
269         switch(wmn->category) {
270                 case NC_SPACE:
271                         if(wmn->data == ND_SPACE_TIME)
272                                 ED_region_tag_redraw(ar);
273                         break;
274
275                 case NC_ANIMATION:
276                         ED_region_tag_redraw(ar);
277                         break;
278                 
279                 case NC_SCENE:
280                         /* any scene change for now */
281                         ED_region_tag_redraw(ar);
282                         break;
283                 
284         }
285 }
286
287 /* ************************ header time area region *********************** */
288
289 /* add handlers, stuff you only do once or on area/region changes */
290 static void time_header_area_init(wmWindowManager *wm, ARegion *ar)
291 {
292         ED_region_header_init(ar);
293 }
294
295 static void time_header_area_draw(const bContext *C, ARegion *ar)
296 {
297         ED_region_header(C, ar);
298 }
299
300 static void time_header_area_listener(ARegion *ar, wmNotifier *wmn)
301 {
302         /* context changes */
303         switch(wmn->category) {
304                 case NC_SCREEN:
305                         if(wmn->data==ND_ANIMPLAY)
306                                 ED_region_tag_redraw(ar);
307                         break;
308
309                 case NC_SCENE:
310                         switch (wmn->data) {
311                                 case ND_FRAME:
312                                 case ND_KEYINGSET:
313                                 case ND_RENDER_OPTIONS:
314                                         ED_region_tag_redraw(ar);
315                                 break;
316                         }
317
318                 case NC_SPACE:
319                         if(wmn->data == ND_SPACE_TIME)
320                                 ED_region_tag_redraw(ar);
321                         break;
322         }
323 }
324
325 /* ******************** default callbacks for time space ***************** */
326
327 static SpaceLink *time_new(const bContext *C)
328 {
329         Scene *scene= CTX_data_scene(C);
330         ARegion *ar;
331         SpaceTime *stime;
332
333         stime= MEM_callocN(sizeof(SpaceTime), "inittime");
334
335         stime->spacetype= SPACE_TIME;
336         stime->redraws= TIME_ALL_3D_WIN|TIME_ALL_ANIM_WIN;
337         stime->flag |= TIME_DRAWFRAMES;
338
339         /* header */
340         ar= MEM_callocN(sizeof(ARegion), "header for time");
341         
342         BLI_addtail(&stime->regionbase, ar);
343         ar->regiontype= RGN_TYPE_HEADER;
344         ar->alignment= RGN_ALIGN_BOTTOM;
345         
346         /* main area */
347         ar= MEM_callocN(sizeof(ARegion), "main area for time");
348         
349         BLI_addtail(&stime->regionbase, ar);
350         ar->regiontype= RGN_TYPE_WINDOW;
351         
352         ar->v2d.tot.xmin= (float)(SFRA - 4);
353         ar->v2d.tot.ymin= 0.0f;
354         ar->v2d.tot.xmax= (float)(EFRA + 4);
355         ar->v2d.tot.ymax= 50.0f;
356         
357         ar->v2d.cur= ar->v2d.tot;
358
359         ar->v2d.min[0]= 1.0f;
360         ar->v2d.min[1]= 50.0f;
361
362         ar->v2d.max[0]= MAXFRAMEF;
363         ar->v2d.max[1]= 50.0; 
364
365         ar->v2d.minzoom= 0.1f;
366         ar->v2d.maxzoom= 10.0;
367
368         ar->v2d.scroll |= (V2D_SCROLL_BOTTOM|V2D_SCROLL_SCALE_HORIZONTAL);
369         ar->v2d.align |= V2D_ALIGN_NO_NEG_Y;
370         ar->v2d.keepofs |= V2D_LOCKOFS_Y;
371         ar->v2d.keepzoom |= V2D_LOCKZOOM_Y;
372
373
374         return (SpaceLink*)stime;
375 }
376
377 /* not spacelink itself */
378 static void time_free(SpaceLink *sl)
379 {
380 }
381 /* spacetype; init callback in ED_area_initialize() */
382 /* init is called to (re)initialize an existing editor (file read, screen changes) */
383 /* validate spacedata, add own area level handlers */
384 static void time_init(wmWindowManager *wm, ScrArea *sa)
385 {
386         
387 }
388
389 static SpaceLink *time_duplicate(SpaceLink *sl)
390 {
391         SpaceTime *stime= (SpaceTime *)sl;
392         SpaceTime *stimen= MEM_dupallocN(stime);
393         
394         return (SpaceLink *)stimen;
395 }
396
397 /* only called once, from space_api/spacetypes.c */
398 /* it defines all callbacks to maintain spaces */
399 void ED_spacetype_time(void)
400 {
401         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype time");
402         ARegionType *art;
403         
404         st->spaceid= SPACE_TIME;
405         strncpy(st->name, "Timeline", BKE_ST_MAXNAME);
406         
407         st->new= time_new;
408         st->free= time_free;
409         st->init= time_init;
410         st->duplicate= time_duplicate;
411         st->operatortypes= time_operatortypes;
412         st->keymap= NULL;
413         
414         /* regions: main window */
415         art= MEM_callocN(sizeof(ARegionType), "spacetype time region");
416         art->regionid = RGN_TYPE_WINDOW;
417         art->keymapflag= ED_KEYMAP_VIEW2D|ED_KEYMAP_MARKERS|ED_KEYMAP_ANIMATION|ED_KEYMAP_FRAMES;
418         
419         art->init= time_main_area_init;
420         art->draw= time_main_area_draw;
421         art->listener= time_main_area_listener;
422         art->keymap= time_keymap;
423         BLI_addhead(&st->regiontypes, art);
424         
425         /* regions: header */
426         art= MEM_callocN(sizeof(ARegionType), "spacetype time region");
427         art->regionid = RGN_TYPE_HEADER;
428         art->prefsizey= HEADERY;
429         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D|ED_KEYMAP_FRAMES|ED_KEYMAP_HEADER;
430         
431         art->init= time_header_area_init;
432         art->draw= time_header_area_draw;
433         art->listener= time_header_area_listener;
434         BLI_addhead(&st->regiontypes, art);
435                 
436         BKE_spacetype_register(st);
437 }
438