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