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