f89a1eb96b813b6f16c9f5659713a600da246cc1
[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., 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): Joshua Leung
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28  
29 #include <string.h>
30 #include <stdio.h>
31
32 #include "DNA_action_types.h"
33 #include "DNA_curve_types.h"
34 #include "DNA_ipo_types.h"
35 #include "DNA_object_types.h"
36 #include "DNA_space_types.h"
37 #include "DNA_scene_types.h"
38 #include "DNA_screen_types.h"
39 #include "DNA_windowmanager_types.h"
40
41 #include "MEM_guardedalloc.h"
42
43 #include "BLI_blenlib.h"
44
45 #include "BKE_action.h"
46 #include "BKE_context.h"
47 #include "BKE_global.h"
48 #include "BKE_ipo.h"
49 #include "BKE_object.h"
50 #include "BKE_screen.h"
51 #include "BKE_utildefines.h"
52
53 #include "ED_anim_api.h"
54 #include "ED_util.h"
55
56 #include "WM_api.h"
57 #include "WM_types.h"
58
59 #include "BIF_gl.h"
60 #include "BIF_glutil.h"
61
62 #include "UI_interface.h"
63 #include "UI_resources.h"
64 #include "UI_text.h"
65 #include "UI_view2d.h"
66
67 /* XXX */
68 extern void ui_rasterpos_safe(float x, float y, float aspect);
69
70 /* *************************************************** */
71 /* CURRENT FRAME DRAWING */
72
73 /* Draw current frame number in a little green box beside the current frame indicator */
74 static void draw_cfra_number (Scene *scene, View2D *v2d, float cfra, short time)
75 {
76         float xscale, yscale, x, y;
77         char str[32];
78         short slen;
79         
80         /* because the frame number text is subject to the same scaling as the contents of the view */
81         UI_view2d_getscale(v2d, &xscale, &yscale);
82         glScalef(1.0/xscale, 1.0, 1.0);
83         
84         if (time) 
85                 sprintf(str, "   %.2f", FRA2TIME(CFRA));
86         else 
87                 sprintf(str, "   %d", CFRA);
88         slen= UI_GetStringWidth(G.font, str, 0) - 1;
89         
90         /* get starting coordinates for drawing */
91         x= cfra * xscale;
92         y= 18;
93         
94         /* draw green box around/behind text */
95         UI_ThemeColorShadeAlpha(TH_CFRAME, 0, -100);
96         glRectf(x, y,  x+slen,  y+15);
97         
98         /* draw current frame number - black text */
99         UI_ThemeColor(TH_TEXT);
100         ui_rasterpos_safe(x-5, y+3, 1.0);
101         UI_DrawString(G.fonts, str, 0); // XXX may need to be updated for font stuff
102         
103         /* restore view transform */
104         glScalef(xscale, 1.0, 1.0);
105 }
106
107 /* General call for drawing current frame indicator in a */
108 void ANIM_draw_cfra (const bContext *C, View2D *v2d, short flag)
109 {
110         Scene *scene= CTX_data_scene(C);
111         float vec[2];
112         
113         /* Draw a light green line to indicate current frame */
114         vec[0]= (float)(scene->r.cfra * scene->r.framelen);
115         
116         UI_ThemeColor(TH_CFRAME);
117         glLineWidth(2.0);
118         
119         glBegin(GL_LINE_STRIP);
120                 vec[1]= v2d->cur.ymin;
121                 glVertex2fv(vec);
122                 
123                 vec[1]= v2d->cur.ymax;
124                 glVertex2fv(vec);
125         glEnd();
126         
127         /* Draw dark green line if slow-parenting/time-offset is enabled */
128         if (flag & DRAWCFRA_SHOW_TIMEOFS) {
129                 Object *ob= (scene->basact) ? (scene->basact->object) : 0;
130                 if ((ob) && (ob->ipoflag & OB_OFFS_OB) && (give_timeoffset(ob)!=0.0)) {
131                         vec[0]-= give_timeoffset(ob); /* could avoid calling twice */
132                         
133                         UI_ThemeColorShade(TH_CFRAME, -30);
134                         
135                         glBegin(GL_LINE_STRIP);
136                                 /*vec[1]= v2d->cur.ymax;*/ // this is set already. this line is only included
137                                 glVertex2fv(vec);
138                                 
139                                 vec[1]= v2d->cur.ymin;
140                                 glVertex2fv(vec);
141                         glEnd();
142                 }
143         }
144         
145         glLineWidth(1.0);
146         
147         /* Draw current frame number in a little box */
148         if (flag & DRAWCFRA_SHOW_NUMBOX) {
149                 UI_view2d_view_orthoSpecial(C, v2d, 1);
150                 draw_cfra_number(scene, v2d, vec[0], (flag & DRAWCFRA_UNIT_SECONDS));
151         }
152 }
153
154 /* *************************************************** */
155 /* PREVIEW RANGE 'CURTAINS' */
156
157 /* Draw preview range 'curtains' for highlighting where the animation data is */
158 void ANIM_draw_previewrange (const bContext *C, View2D *v2d)
159 {
160         Scene *scene= CTX_data_scene(C);
161         
162         /* only draw this if preview range is set */
163         if (scene->r.psfra) {
164                 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
165                 glEnable(GL_BLEND);
166                 glColor4f(0.0f, 0.0f, 0.0f, 0.4f);
167                 
168                 /* only draw two separate 'curtains' if there's no overlap between them */
169                 if (PSFRA < PEFRA) {
170                         glRectf(v2d->cur.xmin, v2d->cur.ymin, PSFRA, v2d->cur.ymax);
171                         glRectf(PEFRA, v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);    
172                 } 
173                 else {
174                         glRectf(v2d->cur.xmin, v2d->cur.ymin, v2d->cur.xmax, v2d->cur.ymax);
175                 }
176                 
177                 glDisable(GL_BLEND);
178         }
179 }
180
181 /* *************************************************** */
182 /* KEYFRAME DRAWING UTILITIES */
183
184 /* Obtain the Object providing NLA-scaling for the given channel (if applicable) */
185 Object *ANIM_nla_mapping_get(bAnimContext *ac, bAnimListElem *ale)
186 {
187         /* sanity checks */
188         if (ac == NULL)
189                 return NULL;
190         
191         /* handling depends on the type of animation-context we've got */
192         if (ELEM(ac->datatype, ANIMCONT_ACTION, ANIMCONT_IPO)) {
193                 /* Action Editor (action mode) or Ipo Editor (ipo mode):
194                  * Only use if editor is not pinned, and active object has action
195                  */
196                 if (ac->obact && ac->obact->action) {
197                         /* Action Editor */
198                         if (ac->datatype == ANIMCONT_ACTION) {
199                                 SpaceAction *saction= (SpaceAction *)ac->sa->spacedata.first;
200                                 
201                                 if (saction->pin == 0)
202                                         return ac->obact;
203                         }
204                         /* IPO Editor */
205                         else if (ac->datatype == ANIMCONT_IPO) {
206                                 SpaceIpo *sipo= (SpaceIpo *)ac->sa->spacedata.first;
207                                 
208                                 if (sipo->pin == 0)
209                                         return ac->obact;
210                         }
211                 }
212         }
213         else if ((ac->datatype == ANIMCONT_DOPESHEET) && (ale)) {
214                 /* Dopesheet:
215                  *      Only if channel is available, and is owned by an Object with an Action
216                  */
217                 if ((ale->id) && (GS(ale->id->name) == ID_OB)) {
218                         Object *ob= (Object *)ale->id;
219                         
220                         if (ob->action)
221                                 return ob;
222                 }
223         }
224         
225         /* no appropriate object found */
226         return NULL;
227 }
228
229 /* Set/clear temporary mapping of coordinates from 'local-action' time to 'global-nla-scaled' time
230  *      - the old mapping is stored in a static var, but that shouldn't be too bad as UI drawing
231  *        (where this is called) is single-threaded anyway
232  */
233 // XXX was called: map_active_strip()
234 void ANIM_nla_mapping_draw(gla2DDrawInfo *di, Object *ob, short restore)
235 {
236         static rctf stored;
237         
238         if (restore) {
239                 /* restore un-mapped coordinates */
240                 gla2DSetMap(di, &stored);
241         }
242         else {
243                 /* set mapped coordinates */
244                 rctf map;
245                 
246                 gla2DGetMap(di, &stored);
247                 map= stored;
248                 
249                 map.xmin= get_action_frame(ob, map.xmin);
250                 map.xmax= get_action_frame(ob, map.xmax);
251                 
252                 if (map.xmin == map.xmax) map.xmax += 1.0f;
253                 gla2DSetMap(di, &map);
254         }
255 }
256
257 /* Apply/Unapply NLA mapping to all keyframes in the nominated IPO block
258  *      - restore = whether to map points back to ipo-time 
259  *      - only_keys = whether to only adjust the location of the center point of beztriples
260  */
261 // was called actstrip_map_ipo_keys()
262 void ANIM_nla_mapping_apply(Object *ob, Ipo *ipo, short restore, short only_keys)
263 {
264         IpoCurve *icu;
265         BezTriple *bezt;
266         int a;
267         
268         if (ipo==NULL) return;
269         
270         /* loop through all ipo curves, adjusting the times of the selected keys */
271         for (icu= ipo->curve.first; icu; icu= icu->next) {
272                 for (a=0, bezt=icu->bezt; a<icu->totvert; a++, bezt++) {
273                         /* are the times being adjusted for editing, or has editing finished */
274                         if (restore) {
275                                 if (only_keys == 0) {
276                                         bezt->vec[0][0]= get_action_frame(ob, bezt->vec[0][0]);
277                                         bezt->vec[2][0]= get_action_frame(ob, bezt->vec[2][0]);
278                                 }                                       
279                                 bezt->vec[1][0]= get_action_frame(ob, bezt->vec[1][0]);
280                         }
281                         else {
282                                 if (only_keys == 0) {
283                                         bezt->vec[0][0]= get_action_frame_inv(ob, bezt->vec[0][0]);
284                                         bezt->vec[2][0]= get_action_frame_inv(ob, bezt->vec[2][0]);
285                                 }
286                                 bezt->vec[1][0]= get_action_frame_inv(ob, bezt->vec[1][0]);
287                         }
288                 }
289         }
290 }
291
292 /* *************************************************** */