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