Driver Scripting:
[blender-staging.git] / source / blender / editors / space_graph / graph_buttons.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_action.h"
50 #include "BKE_animsys.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_library.h"
57 #include "BKE_main.h"
58 #include "BKE_object.h"
59 #include "BKE_scene.h"
60 #include "BKE_screen.h"
61 #include "BKE_utildefines.h"
62
63 #include "BIF_gl.h"
64
65 #include "WM_api.h"
66 #include "WM_types.h"
67
68 #include "RNA_access.h"
69 #include "RNA_define.h"
70
71 #include "ED_anim_api.h"
72 #include "ED_keyframing.h"
73 #include "ED_screen.h"
74 #include "ED_types.h"
75 #include "ED_util.h"
76
77 #include "UI_interface.h"
78 #include "UI_resources.h"
79 #include "UI_view2d.h"
80
81 #include "graph_intern.h"       // own include
82
83 /* XXX */
84
85 /* temporary definition for limits of float number buttons (FLT_MAX tends to infinity with old system) */
86 #define UI_FLT_MAX      10000.0f
87
88
89 /* ******************* graph editor space & buttons ************** */
90
91 #define B_NOP           1
92 #define B_REDR          2
93
94 /* -------------- */
95
96 static void do_graph_region_buttons(bContext *C, void *arg, int event)
97 {
98         //Scene *scene= CTX_data_scene(C);
99         
100         switch(event) {
101
102         }
103         
104         /* default for now */
105         //WM_event_add_notifier(C, NC_OBJECT|ND_TRANSFORM, ob);
106 }
107
108 /* -------------- */
109
110 static int graph_panel_context(const bContext *C, bAnimListElem **ale, FCurve **fcu)
111 {
112         bAnimContext ac;
113         bAnimListElem *elem= NULL;
114         
115         /* for now, only draw if we could init the anim-context info (necessary for all animation-related tools) 
116          * to work correctly is able to be correctly retrieved. There's no point showing empty panels?
117          */
118         if (ANIM_animdata_get_context(C, &ac) == 0) 
119                 return 0;
120         
121         /* try to find 'active' F-Curve */
122         elem= get_active_fcurve_channel(&ac);
123         if(elem == NULL) 
124                 return 0;
125         
126         if(fcu)
127                 *fcu= (FCurve*)elem->data;
128         if(ale)
129                 *ale= elem;
130         else
131                 MEM_freeN(elem);
132         
133         return 1;
134 }
135
136 static int graph_panel_poll(const bContext *C, PanelType *pt)
137 {
138         return graph_panel_context(C, NULL, NULL);
139 }
140
141 /* -------------- */
142
143 /* Graph Editor View Settings */
144 static void graph_panel_view(const bContext *C, Panel *pa)
145 {
146         bScreen *sc= CTX_wm_screen(C);
147         SpaceIpo *sipo= CTX_wm_space_graph(C);
148         Scene *scene= CTX_data_scene(C);
149         PointerRNA spaceptr, sceneptr;
150         uiLayout *col, *subcol;
151         
152         /* get RNA pointers for use when creating the UI elements */
153         RNA_id_pointer_create(&scene->id, &sceneptr);
154         RNA_pointer_create(&sc->id, &RNA_SpaceGraphEditor, sipo, &spaceptr);
155
156         /* 2D-Cursor */
157         col= uiLayoutColumn(pa->layout, 0);
158                 uiItemR(col, NULL, 0, &spaceptr, "show_cursor", 0);
159                 
160                 subcol= uiLayoutColumn(col, 1);
161                 uiLayoutSetActive(subcol, RNA_boolean_get(&spaceptr, "show_cursor")); 
162                         uiItemR(subcol, "Cursor X", 0, &sceneptr, "current_frame", 0);
163                         uiItemR(subcol, "Cursor Y", 0, &spaceptr, "cursor_value", 0);
164                         
165                 subcol= uiLayoutColumn(col, 1);
166                 uiLayoutSetActive(subcol, RNA_boolean_get(&spaceptr, "show_cursor")); 
167                         uiItemO(subcol, "Cursor from Selection", 0, "GRAPH_OT_frame_jump");
168 }
169
170 /* ******************* active F-Curve ************** */
171
172 static void graph_panel_properties(const bContext *C, Panel *pa)
173 {
174         bAnimListElem *ale;
175         FCurve *fcu;
176         uiBlock *block;
177         char name[128];
178
179         if(!graph_panel_context(C, &ale, &fcu))
180                 return;
181
182         block= uiLayoutAbsoluteBlock(pa->layout);
183         uiBlockSetHandleFunc(block, do_graph_region_buttons, NULL);
184
185         /* Info - Active F-Curve */
186         uiDefBut(block, LABEL, 1, "Active F-Curve:",                                    10, 200, 150, 19, NULL, 0.0, 0.0, 0, 0, "");
187         
188         if (ale->id) { 
189                 // icon of active blocktype - is this really necessary?
190                 int icon= geticon_anim_blocktype(GS(ale->id->name));
191                 
192                 // xxx type of icon-but is currently "LABEL", as that one is plain...
193                 uiDefIconBut(block, LABEL, 1, icon, 10, 180, 20, 19, NULL, 0, 0, 0, 0, "ID-type that F-Curve belongs to");
194         }
195         
196         getname_anim_fcurve(name, ale->id, fcu);
197         uiDefBut(block, LABEL, 1, name, 40, 180, 300, 19, NULL, 0.0, 0.0, 0, 0, "Name of Active F-Curve");
198         
199         /* TODO: the following settings could be added here
200          *      - F-Curve coloring mode - mode selector + color selector
201          *      - Access details (ID-block + RNA-Path + Array Index)
202          *      - ...
203          */
204
205         MEM_freeN(ale);
206 }
207
208 /* ******************* drivers ******************************** */
209
210 #define B_IPO_DEPCHANGE         10
211
212 static void do_graph_region_driver_buttons(bContext *C, void *arg, int event)
213 {
214         Scene *scene= CTX_data_scene(C);
215         
216         switch (event) {
217                 case B_IPO_DEPCHANGE:
218                 {
219                         /* rebuild depsgraph for the new deps */
220                         DAG_scene_sort(scene);
221                         
222                         /* force an update of depsgraph */
223                         ED_anim_dag_flush_update(C);
224                 }
225                         break;
226         }
227         
228         /* default for now */
229         WM_event_add_notifier(C, NC_SCENE, scene); // XXX does this always work?
230 }
231
232 /* callback to remove the active driver */
233 static void driver_remove_cb (bContext *C, void *ale_v, void *dummy_v)
234 {
235         bAnimListElem *ale= (bAnimListElem *)ale_v;
236         ID *id= ale->id;
237         FCurve *fcu= ale->data;
238         
239         /* try to get F-Curve that driver lives on, and ID block which has this AnimData */
240         if (ELEM(NULL, id, fcu))
241                 return;
242         
243         /* call API method to remove this driver  */    
244         ANIM_remove_driver(id, fcu->rna_path, fcu->array_index, 0);
245 }
246
247 /* callback to add a target variable to the active driver */
248 static void driver_add_var_cb (bContext *C, void *driver_v, void *dummy_v)
249 {
250         ChannelDriver *driver= (ChannelDriver *)driver_v;
251         
252         /* add a new var */
253         driver_add_new_target(driver);
254 }
255
256 /* callback to remove target variable from active driver */
257 static void driver_delete_var_cb (bContext *C, void *driver_v, void *dtar_v)
258 {
259         ChannelDriver *driver= (ChannelDriver *)driver_v;
260         DriverTarget *dtar= (DriverTarget *)dtar_v;
261         
262         /* remove the active target */
263         driver_free_target(driver, dtar);
264 }
265
266 /* callback to reset the driver's flags */
267 static void driver_update_flags_cb (bContext *C, void *fcu_v, void *dummy_v)
268 {
269         FCurve *fcu= (FCurve *)fcu_v;
270         ChannelDriver *driver= fcu->driver;
271         
272         /* clear invalid flags */
273         driver->flag &= ~DRIVER_FLAG_INVALID;
274 }
275
276 /* drivers panel poll */
277 static int graph_panel_drivers_poll(const bContext *C, PanelType *pt)
278 {
279         SpaceIpo *sipo= CTX_wm_space_graph(C);
280
281         if(sipo->mode != SIPO_MODE_DRIVERS)
282                 return 0;
283
284         return graph_panel_context(C, NULL, NULL);
285 }
286
287
288 /* driver settings for active F-Curve (only for 'Drivers' mode) */
289 static void graph_panel_drivers(const bContext *C, Panel *pa)
290 {
291         bAnimListElem *ale;
292         FCurve *fcu;
293         ChannelDriver *driver;
294         DriverTarget *dtar;
295         
296         PointerRNA driver_ptr;
297         uiLayout *col;
298         uiBlock *block;
299         uiBut *but;
300         
301         /* Get settings from context */
302         if (!graph_panel_context(C, &ale, &fcu))
303                 return;
304         driver= fcu->driver;
305         
306         /* set event handler for panel */
307         block= uiLayoutGetBlock(pa->layout); // xxx?
308         uiBlockSetHandleFunc(block, do_graph_region_driver_buttons, NULL);
309         
310         /* general actions - management */
311         col= uiLayoutColumn(pa->layout, 0);
312         block= uiLayoutGetBlock(col);
313                 but= uiDefBut(block, BUT, B_IPO_DEPCHANGE, "Update Dependencies", 0, 0, 10*UI_UNIT_X, 22, NULL, 0.0, 0.0, 0, 0, "Force updates of dependencies");
314                 uiButSetFunc(but, driver_update_flags_cb, fcu, NULL);
315                 
316                 but= uiDefBut(block, BUT, B_IPO_DEPCHANGE, "Remove Driver", 0, 0, 10*UI_UNIT_X, 18, NULL, 0.0, 0.0, 0, 0, "Remove this driver");
317                 uiButSetFunc(but, driver_remove_cb, ale, NULL);
318                 
319         /* driver-level settings - type, expressions, and errors */
320         RNA_pointer_create(ale->id, &RNA_Driver, driver, &driver_ptr);
321         
322         col= uiLayoutColumn(pa->layout, 1);
323         block= uiLayoutGetBlock(col);
324                 uiItemR(col, NULL, 0, &driver_ptr, "type", 0);
325                 
326                 /* show expression box if doing scripted drivers, and/or error messages when invalid drivers exist */
327                 if (driver->type == DRIVER_TYPE_PYTHON) {
328                         /* expression */
329                         uiItemR(col, "Expr:", 0, &driver_ptr, "expression", 0);
330                         
331                         /* errors? */
332                         if (driver->flag & DRIVER_FLAG_INVALID)
333                                 uiItemL(col, "ERROR: invalid Python expression", ICON_ERROR);
334                 }
335                 else {
336                         /* errors? */
337                         if (driver->flag & DRIVER_FLAG_INVALID)
338                                 uiItemL(col, "ERROR: invalid target channel(s)", ICON_ERROR);
339                 }
340         
341         /* add driver target variables */
342         col= uiLayoutColumn(pa->layout, 0);
343         block= uiLayoutGetBlock(col);
344                 but= uiDefBut(block, BUT, B_IPO_DEPCHANGE, "Add Target", 0, 0, 10*UI_UNIT_X, UI_UNIT_Y, NULL, 0.0, 0.0, 0, 0, "Add a new target variable for this Driver");
345                 uiButSetFunc(but, driver_add_var_cb, driver, NULL);
346         
347         /* loop over targets, drawing them */
348         for (dtar= driver->targets.first; dtar; dtar= dtar->next) {
349                 PointerRNA dtar_ptr;
350                 uiLayout *box, *row;
351                 
352                 /* panel holding the buttons */
353                 box= uiLayoutBox(pa->layout);
354                 
355                 /* first row context info for driver */
356                 RNA_pointer_create(ale->id, &RNA_DriverTarget, dtar, &dtar_ptr);
357                 
358                 row= uiLayoutRow(box, 0);
359                 block= uiLayoutGetBlock(row);
360                         /* variable name */
361                         uiItemR(row, "", 0, &dtar_ptr, "name", 0);
362                         
363                         /* remove button */
364                         but= uiDefIconBut(block, BUT, B_REDR, ICON_X, 290, 0, UI_UNIT_X, UI_UNIT_Y, NULL, 0.0, 0.0, 0.0, 0.0, "Delete target variable.");
365                         uiButSetFunc(but, driver_delete_var_cb, driver, dtar);
366                 
367                 
368                 /* Target ID */
369                 row= uiLayoutRow(box, 0);
370                         uiTemplateAnyID(row, (bContext *)C, &dtar_ptr, "id", "id_type", "Value: ");
371                 
372                 /* Target Property */
373                 // TODO: make this less technical...
374                 if (dtar->id) {
375                         PointerRNA root_ptr;
376                         
377                         /* get pointer for resolving the property selected */
378                         RNA_id_pointer_create(dtar->id, &root_ptr);
379                         
380                         col= uiLayoutColumn(box, 1);
381                         block= uiLayoutGetBlock(col);
382                                 /* rna path */
383                                 uiTemplatePathBuilder(col, (bContext *)C, &dtar_ptr, "rna_path", &root_ptr, "Path");
384                                 
385                                 /* array index */
386                                 // TODO: this needs selector which limits it to ok values
387                                 uiItemR(col, "Index", 0, &dtar_ptr, "array_index", 0);
388                 }
389         }
390         
391         /* cleanup */
392         MEM_freeN(ale);
393 }
394
395 /* ******************* f-modifiers ******************************** */
396 /* all the drawing code is in editors/animation/fmodifier_ui.c */
397
398 #define B_FMODIFIER_REDRAW              20
399
400 static void do_graph_region_modifier_buttons(bContext *C, void *arg, int event)
401 {
402         switch (event) {
403                 case B_REDR:
404                 case B_FMODIFIER_REDRAW: // XXX this should send depsgraph updates too
405                         WM_event_add_notifier(C, NC_ANIMATION, NULL); // XXX need a notifier specially for F-Modifiers
406                         break;
407         }
408 }
409
410 static void graph_panel_modifiers(const bContext *C, Panel *pa) 
411 {
412         bAnimListElem *ale;
413         FCurve *fcu;
414         FModifier *fcm;
415         uiLayout *col, *row;
416         uiBlock *block;
417         
418         if (!graph_panel_context(C, &ale, &fcu))
419                 return;
420         
421         block= uiLayoutGetBlock(pa->layout);
422         uiBlockSetHandleFunc(block, do_graph_region_modifier_buttons, NULL);
423         
424         /* 'add modifier' button at top of panel */
425         {
426                 row= uiLayoutRow(pa->layout, 0);
427                 block= uiLayoutGetBlock(row);
428                 
429                 // XXX for now, this will be a operator button which calls a temporary 'add modifier' operator
430                 uiDefButO(block, BUT, "GRAPH_OT_fmodifier_add", WM_OP_INVOKE_REGION_WIN, "Add Modifier", 10, 0, 150, 20, "Adds a new F-Curve Modifier for the active F-Curve");
431         }
432         
433         /* draw each modifier */
434         for (fcm= fcu->modifiers.first; fcm; fcm= fcm->next) {
435                 col= uiLayoutColumn(pa->layout, 1);
436                 
437                 ANIM_uiTemplate_fmodifier_draw(col, ale->id, &fcu->modifiers, fcm);
438         }
439
440         MEM_freeN(ale);
441 }
442
443 /* ******************* general ******************************** */
444
445 void graph_buttons_register(ARegionType *art)
446 {
447         PanelType *pt;
448
449         pt= MEM_callocN(sizeof(PanelType), "spacetype graph panel view");
450         strcpy(pt->idname, "GRAPH_PT_view");
451         strcpy(pt->label, "View");
452         pt->draw= graph_panel_view;
453         BLI_addtail(&art->paneltypes, pt);
454         
455         pt= MEM_callocN(sizeof(PanelType), "spacetype graph panel properties");
456         strcpy(pt->idname, "GRAPH_PT_properties");
457         strcpy(pt->label, "Properties");
458         pt->draw= graph_panel_properties;
459         pt->poll= graph_panel_poll;
460         BLI_addtail(&art->paneltypes, pt);
461
462         pt= MEM_callocN(sizeof(PanelType), "spacetype graph panel drivers");
463         strcpy(pt->idname, "GRAPH_PT_drivers");
464         strcpy(pt->label, "Drivers");
465         pt->draw= graph_panel_drivers;
466         pt->poll= graph_panel_drivers_poll;
467         BLI_addtail(&art->paneltypes, pt);
468
469         pt= MEM_callocN(sizeof(PanelType), "spacetype graph panel modifiers");
470         strcpy(pt->idname, "GRAPH_PT_modifiers");
471         strcpy(pt->label, "Modifiers");
472         pt->draw= graph_panel_modifiers;
473         pt->poll= graph_panel_poll;
474         BLI_addtail(&art->paneltypes, pt);
475 }
476
477 static int graph_properties(bContext *C, wmOperator *op)
478 {
479         ScrArea *sa= CTX_wm_area(C);
480         ARegion *ar= graph_has_buttons_region(sa);
481         
482         if(ar)
483                 ED_region_toggle_hidden(C, ar);
484
485         return OPERATOR_FINISHED;
486 }
487
488 void GRAPH_OT_properties(wmOperatorType *ot)
489 {
490         ot->name= "Properties";
491         ot->idname= "GRAPH_OT_properties";
492         
493         ot->exec= graph_properties;
494         ot->poll= ED_operator_ipo_active; // xxx
495         
496         /* flags */
497         ot->flag= 0;
498 }