soc-2008-mxcurioni: merged changes to revision 23516
[blender.git] / source / blender / editors / space_graph / graph_utils.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) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation, Joshua Leung
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <string.h>
30 #include <stdio.h>
31 #include <math.h>
32 #include <float.h>
33
34 #include "DNA_anim_types.h"
35 #include "DNA_action_types.h"
36 #include "DNA_object_types.h"
37 #include "DNA_space_types.h"
38 #include "DNA_scene_types.h"
39 #include "DNA_screen_types.h"
40 #include "DNA_userdef_types.h"
41
42 #include "MEM_guardedalloc.h"
43
44 #include "BLI_arithb.h"
45 #include "BLI_blenlib.h"
46 #include "BLI_editVert.h"
47 #include "BLI_rand.h"
48
49 #include "BKE_animsys.h"
50 #include "BKE_action.h"
51 #include "BKE_context.h"
52 #include "BKE_curve.h"
53 #include "BKE_customdata.h"
54 #include "BKE_depsgraph.h"
55 #include "BKE_fcurve.h"
56 #include "BKE_object.h"
57 #include "BKE_global.h"
58 #include "BKE_scene.h"
59 #include "BKE_screen.h"
60 #include "BKE_utildefines.h"
61
62 #include "BIF_gl.h"
63
64 #include "WM_api.h"
65 #include "WM_types.h"
66
67 #include "RNA_access.h"
68 #include "RNA_define.h"
69
70 #include "ED_anim_api.h"
71 #include "ED_keyframing.h"
72 #include "ED_screen.h"
73 #include "ED_types.h"
74 #include "ED_util.h"
75
76 #include "UI_interface.h"
77 #include "UI_resources.h"
78 #include "UI_view2d.h"
79
80 #include "graph_intern.h"       // own include
81
82 /* ************************************************************** */
83 /* Active F-Curve */
84
85 /* Find 'active' F-Curve. It must be editable, since that's the purpose of these buttons (subject to change).  
86  * We return the 'wrapper' since it contains valuable context info (about hierarchy), which will need to be freed 
87  * when the caller is done with it.
88  */
89 bAnimListElem *get_active_fcurve_channel (bAnimContext *ac)
90 {
91         ListBase anim_data = {NULL, NULL};
92         int filter= (ANIMFILTER_VISIBLE | ANIMFILTER_FOREDIT | ANIMFILTER_ACTIVE | ANIMFILTER_CURVESONLY);
93         int items = ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
94         
95         /* We take the first F-Curve only, since some other ones may have had 'active' flag set
96          * if they were from linked data.
97          */
98         if (items) {
99                 bAnimListElem *ale= (bAnimListElem *)anim_data.first;
100                 
101                 /* remove first item from list, then free the rest of the list and return the stored one */
102                 BLI_remlink(&anim_data, ale);
103                 BLI_freelistN(&anim_data);
104                 
105                 return ale;
106         }
107         
108         /* no active F-Curve */
109         return NULL;
110 }
111
112 /* ************************************************************** */
113 /* Operator Polling Callbacks */
114
115 /* check if any FModifiers to draw controls for  - fcm is 'active' modifier 
116  * used for the polling callbacks + also for drawing
117  */
118 short fcurve_needs_draw_fmodifier_controls (FCurve *fcu, FModifier *fcm)
119 {
120         /* don't draw if there aren't any modifiers at all */
121         if (fcu->modifiers.first == NULL) 
122                 return 0;
123         
124         /* if there's an active modifier - don't draw if it doesn't drastically
125          * alter the curve...
126          */
127         if (fcm) {
128                 switch (fcm->type) {
129                         /* clearly harmless */
130                         case FMODIFIER_TYPE_CYCLES:
131                                 return 0;
132                                 
133                         /* borderline... */
134                         case FMODIFIER_TYPE_NOISE:
135                                 return 0;
136                 }
137         }
138         
139         /* if only one modifier - don't draw if it is muted or disabled */
140         if (fcu->modifiers.first == fcu->modifiers.last) {
141                 fcm= fcu->modifiers.first;
142                 if (fcm->flag & (FMODIFIER_FLAG_DISABLED|FMODIFIER_FLAG_MUTED)) 
143                         return 0;
144         }
145         
146         /* if only active modifier - don't draw if it is muted or disabled */
147         if (fcm) {
148                 if (fcm->flag & (FMODIFIER_FLAG_DISABLED|FMODIFIER_FLAG_MUTED)) 
149                         return 0;
150         }
151         
152         /* if we're still here, this means that there are modifiers with controls to be drawn */
153         // FIXME: what happens if all the modifiers were muted/disabled
154         return 1;
155 }
156
157 /* ------------------- */
158
159 /* Check if there are any visible keyframes (for selection tools) */
160 int graphop_visible_keyframes_poll (bContext *C)
161 {
162         bAnimContext ac;
163         bAnimListElem *ale;
164         ListBase anim_data = {NULL, NULL};
165         ScrArea *sa= CTX_wm_area(C);
166         int filter, items;
167         short found = 0;
168         
169         /* firstly, check if in Graph Editor */
170         // TODO: also check for region?
171         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
172                 return 0;
173                 
174         /* try to init Anim-Context stuff ourselves and check */
175         if (ANIM_animdata_get_context(C, &ac) == 0)
176                 return 0;
177         
178         /* loop over the visible (selection doesn't matter) F-Curves, and see if they're suitable
179          * stopping on the first successful match
180          */
181         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
182         items = ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
183         if (items == 0) 
184                 return 0;
185         
186         for (ale = anim_data.first; ale; ale= ale->next) {
187                 FCurve *fcu= (FCurve *)ale->data;
188                 FModifier *fcm;
189                 
190                 /* visible curves for selection must fulfull the following criteria:
191                  *      - it has bezier keyframes
192                  *      - F-Curve modifiers do not interfere with the result too much 
193                  *        (i.e. the modifier-control drawing check returns false)
194                  */
195                 if (fcu->bezt == NULL)
196                         continue;
197                 fcm= find_active_fmodifier(&fcu->modifiers);
198                 
199                 found= (fcurve_needs_draw_fmodifier_controls(fcu, fcm) == 0);
200                 if (found) break;
201         }
202         
203         /* cleanup and return findings */
204         BLI_freelistN(&anim_data);
205         return found;
206 }
207
208 /* Check if there are any visible + editable keyframes (for editing tools) */
209 int graphop_editable_keyframes_poll (bContext *C)
210 {
211         bAnimContext ac;
212         bAnimListElem *ale;
213         ListBase anim_data = {NULL, NULL};
214         ScrArea *sa= CTX_wm_area(C);
215         int filter, items;
216         short found = 0;
217         
218         /* firstly, check if in Graph Editor */
219         // TODO: also check for region?
220         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
221                 return 0;
222                 
223         /* try to init Anim-Context stuff ourselves and check */
224         if (ANIM_animdata_get_context(C, &ac) == 0)
225                 return 0;
226         
227         /* loop over the editable (selected + editable) F-Curves, and see if they're suitable
228          * stopping on the first successful match
229          */
230         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_SEL | ANIMFILTER_FOREDIT | ANIMFILTER_CURVESONLY);
231         items = ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
232         if (items == 0) 
233                 return 0;
234         
235         for (ale = anim_data.first; ale; ale= ale->next) {
236                 FCurve *fcu= (FCurve *)ale->data;
237                 FModifier *fcm;
238                 
239                 /* editable curves must fulfull the following criteria:
240                  *      - it has bezier keyframes
241                  *      - it must not be protected from editing (this is already checked for with the foredit flag
242                  *      - F-Curve modifiers do not interfere with the result too much 
243                  *        (i.e. the modifier-control drawing check returns false)
244                  */
245                 if (fcu->bezt == NULL)
246                         continue;
247                 fcm= find_active_fmodifier(&fcu->modifiers);
248                 
249                 found= (fcurve_needs_draw_fmodifier_controls(fcu, fcm) == 0);
250                 if (found) break;
251         }
252         
253         /* cleanup and return findings */
254         BLI_freelistN(&anim_data);
255         return found;
256 }
257
258 /* has active F-Curve that's editable */
259 int graphop_active_fcurve_poll (bContext *C)
260 {
261         bAnimContext ac;
262         bAnimListElem *ale;
263         ScrArea *sa= CTX_wm_area(C);
264         short has_fcurve= 0;
265         
266         /* firstly, check if in Graph Editor */
267         // TODO: also check for region?
268         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
269                 return 0;
270                 
271         /* try to init Anim-Context stuff ourselves and check */
272         if (ANIM_animdata_get_context(C, &ac) == 0)
273                 return 0;
274                 
275         /* try to get the Active F-Curve */
276         ale= get_active_fcurve_channel(&ac);
277         if (ale == NULL)
278                 return 0;
279                 
280         /* free temp data... */
281         has_fcurve= ((ale->data) && (ale->type == ANIMTYPE_FCURVE));
282         MEM_freeN(ale);
283         
284         /* return success */
285         return has_fcurve;
286 }
287
288 /* has selected F-Curve that's editable */
289 int graphop_selected_fcurve_poll (bContext *C)
290 {
291         bAnimContext ac;
292         ListBase anim_data = {NULL, NULL};
293         ScrArea *sa= CTX_wm_area(C);
294         int filter, items;
295         short found = 0;
296         
297         /* firstly, check if in Graph Editor */
298         // TODO: also check for region?
299         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
300                 return 0;
301                 
302         /* try to init Anim-Context stuff ourselves and check */
303         if (ANIM_animdata_get_context(C, &ac) == 0)
304                 return 0;
305         
306         /* get the editable + selected F-Curves, and as long as we got some, we can return */
307         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_SEL | ANIMFILTER_FOREDIT | ANIMFILTER_CURVESONLY);
308         items = ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
309         if (items == 0) 
310                 return 0;
311         
312         /* cleanup and return findings */
313         BLI_freelistN(&anim_data);
314         return found;
315 }
316
317 /* ************************************************************** */