1d7ffdd130836710955cc19e0c076e64ce29e50f
[blender-staging.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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_math.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 // TODO: restructure these tests
119 // TODO: maybe for now, just allow editing always for now...
120 short fcurve_needs_draw_fmodifier_controls (FCurve *fcu, FModifier *fcm)
121 {
122         /* don't draw if there aren't any modifiers at all */
123         if (fcu->modifiers.first == NULL) 
124                 return 0;
125         
126         /* if only one modifier 
127          *      - don't draw if it is muted or disabled 
128          *      - set it as the active one if no active one is present 
129          */
130         if (fcu->modifiers.first == fcu->modifiers.last) {
131                 fcm= fcu->modifiers.first;
132                 if (fcm->flag & (FMODIFIER_FLAG_DISABLED|FMODIFIER_FLAG_MUTED)) 
133                         return 0;
134         }
135         
136         /* if there's an active modifier - don't draw if it doesn't drastically
137          * alter the curve...
138          */
139         if (fcm) {
140                 switch (fcm->type) {
141                         /* clearly harmless */
142                         case FMODIFIER_TYPE_CYCLES:
143                                 return 0;
144                         case FMODIFIER_TYPE_STEPPED:
145                                 return 0;
146                                 
147                         /* borderline... */
148                         case FMODIFIER_TYPE_NOISE:
149                                 return 0;
150                 }
151         }
152         
153         /* if only active modifier - don't draw if it is muted or disabled */
154         if (fcm) {
155                 if (fcm->flag & (FMODIFIER_FLAG_DISABLED|FMODIFIER_FLAG_MUTED)) 
156                         return 0;
157         }
158         
159         /* if we're still here, this means that there are modifiers with controls to be drawn */
160         // FIXME: what happens if all the modifiers were muted/disabled
161         return 1;
162 }
163
164 /* ------------------- */
165
166 /* Check if there are any visible keyframes (for selection tools) */
167 int graphop_visible_keyframes_poll (bContext *C)
168 {
169         bAnimContext ac;
170         bAnimListElem *ale;
171         ListBase anim_data = {NULL, NULL};
172         ScrArea *sa= CTX_wm_area(C);
173         int filter, items;
174         short found = 0;
175         
176         /* firstly, check if in Graph Editor */
177         // TODO: also check for region?
178         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
179                 return 0;
180                 
181         /* try to init Anim-Context stuff ourselves and check */
182         if (ANIM_animdata_get_context(C, &ac) == 0)
183                 return 0;
184         
185         /* loop over the visible (selection doesn't matter) F-Curves, and see if they're suitable
186          * stopping on the first successful match
187          */
188         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVESONLY);
189         items = ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
190         if (items == 0) 
191                 return 0;
192         
193         for (ale = anim_data.first; ale; ale= ale->next) {
194                 FCurve *fcu= (FCurve *)ale->data;
195                 FModifier *fcm;
196                 
197                 /* visible curves for selection must fulfull the following criteria:
198                  *      - it has bezier keyframes
199                  *      - F-Curve modifiers do not interfere with the result too much 
200                  *        (i.e. the modifier-control drawing check returns false)
201                  */
202                 if (fcu->bezt == NULL)
203                         continue;
204                 fcm= find_active_fmodifier(&fcu->modifiers);
205                 
206                 found= (fcurve_needs_draw_fmodifier_controls(fcu, fcm) == 0);
207                 if (found) break;
208         }
209         
210         /* cleanup and return findings */
211         BLI_freelistN(&anim_data);
212         return found;
213 }
214
215 /* Check if there are any visible + editable keyframes (for editing tools) */
216 int graphop_editable_keyframes_poll (bContext *C)
217 {
218         bAnimContext ac;
219         bAnimListElem *ale;
220         ListBase anim_data = {NULL, NULL};
221         ScrArea *sa= CTX_wm_area(C);
222         int filter, items;
223         short found = 0;
224         
225         /* firstly, check if in Graph Editor */
226         // TODO: also check for region?
227         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
228                 return 0;
229                 
230         /* try to init Anim-Context stuff ourselves and check */
231         if (ANIM_animdata_get_context(C, &ac) == 0)
232                 return 0;
233         
234         /* loop over the editable F-Curves, and see if they're suitable
235          * stopping on the first successful match
236          */
237         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_FOREDIT | ANIMFILTER_CURVESONLY);
238         items = ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
239         if (items == 0) 
240                 return 0;
241         
242         for (ale = anim_data.first; ale; ale= ale->next) {
243                 FCurve *fcu= (FCurve *)ale->data;
244                 FModifier *fcm;
245                 
246                 /* editable curves must fulfull the following criteria:
247                  *      - it has bezier keyframes
248                  *      - it must not be protected from editing (this is already checked for with the foredit flag
249                  *      - F-Curve modifiers do not interfere with the result too much 
250                  *        (i.e. the modifier-control drawing check returns false)
251                  */
252                 if (fcu->bezt == NULL)
253                         continue;
254                 fcm= find_active_fmodifier(&fcu->modifiers);
255                 
256                 found= (fcurve_needs_draw_fmodifier_controls(fcu, fcm) == 0);
257                 if (found) break;
258         }
259         
260         /* cleanup and return findings */
261         BLI_freelistN(&anim_data);
262         return found;
263 }
264
265 /* has active F-Curve that's editable */
266 int graphop_active_fcurve_poll (bContext *C)
267 {
268         bAnimContext ac;
269         bAnimListElem *ale;
270         ScrArea *sa= CTX_wm_area(C);
271         short has_fcurve= 0;
272         
273         /* firstly, check if in Graph Editor */
274         // TODO: also check for region?
275         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
276                 return 0;
277                 
278         /* try to init Anim-Context stuff ourselves and check */
279         if (ANIM_animdata_get_context(C, &ac) == 0)
280                 return 0;
281                 
282         /* try to get the Active F-Curve */
283         ale= get_active_fcurve_channel(&ac);
284         if (ale == NULL)
285                 return 0;
286                 
287         /* free temp data... */
288         has_fcurve= ((ale->data) && (ale->type == ANIMTYPE_FCURVE));
289         MEM_freeN(ale);
290         
291         /* return success */
292         return has_fcurve;
293 }
294
295 /* has selected F-Curve that's editable */
296 int graphop_selected_fcurve_poll (bContext *C)
297 {
298         bAnimContext ac;
299         ListBase anim_data = {NULL, NULL};
300         ScrArea *sa= CTX_wm_area(C);
301         int filter, items;
302         
303         /* firstly, check if in Graph Editor */
304         // TODO: also check for region?
305         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
306                 return 0;
307                 
308         /* try to init Anim-Context stuff ourselves and check */
309         if (ANIM_animdata_get_context(C, &ac) == 0)
310                 return 0;
311         
312         /* get the editable + selected F-Curves, and as long as we got some, we can return */
313         filter= (ANIMFILTER_VISIBLE | ANIMFILTER_SEL | ANIMFILTER_FOREDIT | ANIMFILTER_CURVESONLY);
314         items = ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
315         if (items == 0) 
316                 return 0;
317         
318         /* cleanup and return findings */
319         BLI_freelistN(&anim_data);
320         return 1;
321 }
322
323 /* ************************************************************** */