Cleanup: typos
[blender-staging.git] / source / blender / editors / space_graph / graph_utils.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation, Joshua Leung
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_graph/graph_utils.c
28  *  \ingroup spgraph
29  */
30
31
32 #include <string.h>
33 #include <stdio.h>
34 #include <math.h>
35 #include <float.h>
36
37 #include "DNA_anim_types.h"
38 #include "DNA_space_types.h"
39 #include "DNA_screen_types.h"
40
41 #include "MEM_guardedalloc.h"
42
43 #include "BLI_blenlib.h"
44
45 #include "BKE_context.h"
46 #include "BKE_fcurve.h"
47
48
49 #include "WM_api.h"
50
51
52 #include "ED_anim_api.h"
53
54
55 #include "graph_intern.h"   // own include
56
57 /* ************************************************************** */
58 /* Active F-Curve */
59
60 /* Find 'active' F-Curve. It must be editable, since that's the purpose of these buttons (subject to change).  
61  * We return the 'wrapper' since it contains valuable context info (about hierarchy), which will need to be freed 
62  * when the caller is done with it.
63  *
64  * NOTE: curve-visible flag isn't included, otherwise selecting a curve via list to edit is too cumbersome
65  */
66 bAnimListElem *get_active_fcurve_channel(bAnimContext *ac)
67 {
68         ListBase anim_data = {NULL, NULL};
69         int filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_FOREDIT | ANIMFILTER_ACTIVE);
70         size_t items = ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
71         
72         /* We take the first F-Curve only, since some other ones may have had 'active' flag set
73          * if they were from linked data.
74          */
75         if (items) {
76                 bAnimListElem *ale = (bAnimListElem *)anim_data.first;
77                 
78                 /* remove first item from list, then free the rest of the list and return the stored one */
79                 BLI_remlink(&anim_data, ale);
80                 ANIM_animdata_freelist(&anim_data);
81                 
82                 return ale;
83         }
84         
85         /* no active F-Curve */
86         return NULL;
87 }
88
89 /* ************************************************************** */
90 /* Operator Polling Callbacks */
91
92 /* Check if there are any visible keyframes (for selection tools) */
93 int graphop_visible_keyframes_poll(bContext *C)
94 {
95         bAnimContext ac;
96         bAnimListElem *ale;
97         ListBase anim_data = {NULL, NULL};
98         ScrArea *sa = CTX_wm_area(C);
99         size_t items;
100         int filter;
101         short found = 0;
102         
103         /* firstly, check if in Graph Editor */
104         // TODO: also check for region?
105         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
106                 return 0;
107                 
108         /* try to init Anim-Context stuff ourselves and check */
109         if (ANIM_animdata_get_context(C, &ac) == 0)
110                 return 0;
111         
112         /* loop over the visible (selection doesn't matter) F-Curves, and see if they're suitable
113          * stopping on the first successful match
114          */
115         filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE);
116         items = ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
117         if (items == 0) 
118                 return 0;
119         
120         for (ale = anim_data.first; ale; ale = ale->next) {
121                 FCurve *fcu = (FCurve *)ale->data;
122                 
123                 /* visible curves for selection must fulfill the following criteria:
124                  *      - it has bezier keyframes
125                  *      - F-Curve modifiers do not interfere with the result too much 
126                  *        (i.e. the modifier-control drawing check returns false)
127                  */
128                 if (fcu->bezt == NULL)
129                         continue;
130                 if (fcurve_are_keyframes_usable(fcu)) {
131                         found = 1;
132                         break;
133                 }
134         }
135         
136         /* cleanup and return findings */
137         ANIM_animdata_freelist(&anim_data);
138         return found;
139 }
140
141 /* Check if there are any visible + editable keyframes (for editing tools) */
142 int graphop_editable_keyframes_poll(bContext *C)
143 {
144         bAnimContext ac;
145         bAnimListElem *ale;
146         ListBase anim_data = {NULL, NULL};
147         ScrArea *sa = CTX_wm_area(C);
148         size_t items;
149         int filter;
150         short found = 0;
151         
152         /* firstly, check if in Graph Editor */
153         // TODO: also check for region?
154         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
155                 return 0;
156                 
157         /* try to init Anim-Context stuff ourselves and check */
158         if (ANIM_animdata_get_context(C, &ac) == 0)
159                 return 0;
160         
161         /* loop over the editable F-Curves, and see if they're suitable
162          * stopping on the first successful match
163          */
164         filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_FOREDIT | ANIMFILTER_CURVE_VISIBLE);
165         items = ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
166         if (items == 0) 
167                 return 0;
168         
169         for (ale = anim_data.first; ale; ale = ale->next) {
170                 FCurve *fcu = (FCurve *)ale->data;
171                 
172                 /* editable curves must fulfill the following criteria:
173                  *      - it has bezier keyframes
174                  *      - it must not be protected from editing (this is already checked for with the edit flag
175                  *      - F-Curve modifiers do not interfere with the result too much
176                  *        (i.e. the modifier-control drawing check returns false)
177                  */
178                 if (fcu->bezt == NULL)
179                         continue;
180                 if (fcurve_is_keyframable(fcu)) {
181                         found = 1;
182                         break;
183                 }
184         }
185         
186         /* cleanup and return findings */
187         ANIM_animdata_freelist(&anim_data);
188         return found;
189 }
190
191 /* has active F-Curve that's editable */
192 int graphop_active_fcurve_poll(bContext *C)
193 {
194         bAnimContext ac;
195         bAnimListElem *ale;
196         ScrArea *sa = CTX_wm_area(C);
197         bool has_fcurve = 0;
198         
199         /* firstly, check if in Graph Editor */
200         // TODO: also check for region?
201         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
202                 return 0;
203                 
204         /* try to init Anim-Context stuff ourselves and check */
205         if (ANIM_animdata_get_context(C, &ac) == 0)
206                 return 0;
207                 
208         /* try to get the Active F-Curve */
209         ale = get_active_fcurve_channel(&ac);
210         if (ale == NULL)
211                 return 0;
212                 
213         /* do we have a suitable F-Curves?
214          * - For most cases, NLA Control Curves are sufficiently similar to NLA curves to serve this role too.
215          *   Under the hood, they are F-Curves too. The only problems which will arise here are if these need to be
216          *   in an Action too (but drivers would then also be affected!)
217          */
218         has_fcurve = ((ale->data) && ELEM(ale->type, ANIMTYPE_FCURVE, ANIMTYPE_NLACURVE));
219         if (has_fcurve) {
220                 FCurve *fcu = (FCurve *)ale->data;
221                 has_fcurve = (fcu->flag & FCURVE_VISIBLE) != 0;
222         }
223         
224         /* free temp data... */
225         MEM_freeN(ale);
226         
227         /* return success */
228         return has_fcurve;
229 }
230
231 /* has selected F-Curve that's editable */
232 int graphop_selected_fcurve_poll(bContext *C)
233 {
234         bAnimContext ac;
235         ListBase anim_data = {NULL, NULL};
236         ScrArea *sa = CTX_wm_area(C);
237         size_t items;
238         int filter;
239         
240         /* firstly, check if in Graph Editor */
241         // TODO: also check for region?
242         if ((sa == NULL) || (sa->spacetype != SPACE_IPO))
243                 return 0;
244                 
245         /* try to init Anim-Context stuff ourselves and check */
246         if (ANIM_animdata_get_context(C, &ac) == 0)
247                 return 0;
248         
249         /* get the editable + selected F-Curves, and as long as we got some, we can return 
250          * NOTE: curve-visible flag isn't included, otherwise selecting a curve via list to edit is too cumbersome
251          */
252         filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_SEL | ANIMFILTER_FOREDIT);
253         items = ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
254         if (items == 0) 
255                 return 0;
256         
257         /* cleanup and return findings */
258         ANIM_animdata_freelist(&anim_data);
259         return 1;
260 }
261
262 /* ************************************************************** */