NLA SoC: Merge from 2.5
[blender-staging.git] / source / blender / editors / animation / drivers.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, Joshua Leung
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Joshua Leung (full recode)
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29  
30 #include <stdio.h>
31 #include <stddef.h>
32 #include <string.h>
33 #include <math.h>
34 #include <float.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_blenlib.h"
39 #include "BLI_arithb.h"
40 #include "BLI_dynstr.h"
41
42 #include "DNA_anim_types.h"
43 #include "DNA_action_types.h"
44 #include "DNA_armature_types.h"
45 #include "DNA_constraint_types.h"
46 #include "DNA_key_types.h"
47 #include "DNA_object_types.h"
48 #include "DNA_material_types.h"
49 #include "DNA_scene_types.h"
50 #include "DNA_userdef_types.h"
51 #include "DNA_windowmanager_types.h"
52
53 #include "BKE_animsys.h"
54 #include "BKE_action.h"
55 #include "BKE_constraint.h"
56 #include "BKE_fcurve.h"
57 #include "BKE_utildefines.h"
58 #include "BKE_context.h"
59 #include "BKE_report.h"
60 #include "BKE_key.h"
61 #include "BKE_material.h"
62
63 #include "ED_anim_api.h"
64 #include "ED_keyframing.h"
65 #include "ED_keyframes_edit.h"
66 #include "ED_screen.h"
67 #include "ED_util.h"
68
69 #include "UI_interface.h"
70
71 #include "WM_api.h"
72 #include "WM_types.h"
73
74 #include "RNA_access.h"
75 #include "RNA_define.h"
76 #include "RNA_types.h"
77
78 /* ************************************************** */
79 /* Animation Data Validation */
80
81 /* Get (or add relevant data to be able to do so) F-Curve from the driver stack, 
82  * for the given Animation Data block. This assumes that all the destinations are valid.
83  */
84 FCurve *verify_driver_fcurve (ID *id, const char rna_path[], const int array_index, short add)
85 {
86         AnimData *adt;
87         FCurve *fcu;
88         
89         /* sanity checks */
90         if ELEM(NULL, id, rna_path)
91                 return NULL;
92         
93         /* init animdata if none available yet */
94         adt= BKE_animdata_from_id(id);
95         if ((adt == NULL) && (add))
96                 adt= BKE_id_add_animdata(id);
97         if (adt == NULL) { 
98                 /* if still none (as not allowed to add, or ID doesn't have animdata for some reason) */
99                 return NULL;
100         }
101                 
102         /* try to find f-curve matching for this setting 
103          *      - add if not found and allowed to add one
104          *              TODO: add auto-grouping support? how this works will need to be resolved
105          */
106         fcu= list_find_fcurve(&adt->drivers, rna_path, array_index);
107         
108         if ((fcu == NULL) && (add)) {
109                 /* use default settings to make a F-Curve */
110                 fcu= MEM_callocN(sizeof(FCurve), "FCurve");
111                 
112                 fcu->flag = (FCURVE_VISIBLE|FCURVE_AUTO_HANDLES|FCURVE_SELECTED);
113                 
114                 /* store path - make copy, and store that */
115                 fcu->rna_path= BLI_strdupn(rna_path, strlen(rna_path));
116                 fcu->array_index= array_index;
117                 
118                 /* add some new driver data */
119                 fcu->driver= MEM_callocN(sizeof(ChannelDriver), "ChannelDriver");
120                 
121                 /* add simple generator modifier for driver so that there is some visible representation */
122                 add_fmodifier(&fcu->modifiers, FMODIFIER_TYPE_GENERATOR);
123                 
124                 /* just add F-Curve to end of driver list */
125                 BLI_addtail(&adt->drivers, fcu);
126         }
127         
128         /* return the F-Curve */
129         return fcu;
130 }
131
132 /* ************************************************** */
133 /* Driver Management API */
134
135 /* Main Driver Management API calls:
136  *      Add a new driver for the specified property on the given ID block
137  */
138 short ANIM_add_driver (ID *id, const char rna_path[], int array_index, short flag)
139 {       
140         PointerRNA id_ptr, ptr;
141         PropertyRNA *prop;
142         FCurve *fcu;
143         
144         /* validate pointer first - exit if failure */
145         RNA_id_pointer_create(id, &id_ptr);
146         if ((RNA_path_resolve(&id_ptr, rna_path, &ptr, &prop) == 0) || (prop == NULL)) {
147                 printf("Insert Key: Could not add Driver, as RNA Path is invalid for the given ID (ID = %s, Path = %s)\n", id->name, rna_path);
148                 return 0;
149         }
150         
151         /* create F-Curve with Driver */
152         fcu= verify_driver_fcurve(id, rna_path, array_index, 1);
153         
154         /* done */
155         return (fcu != NULL);
156 }
157
158 /* Main Driver Management API calls:
159  *      Remove the driver for the specified property on the given ID block (if available)
160  */
161 short ANIM_remove_driver (struct ID *id, const char rna_path[], int array_index, short flag)
162 {
163         AnimData *adt;
164         FCurve *fcu;
165         
166         /* get F-Curve
167          * Note: here is one of the places where we don't want new F-Curve + Driver added!
168          *              so 'add' var must be 0
169          */
170         /* we don't check the validity of the path here yet, but it should be ok... */
171         fcu= verify_driver_fcurve(id, rna_path, array_index, 0);
172         adt= BKE_animdata_from_id(id);
173         
174         /* only continue if we have an driver to remove */
175         if (adt && fcu) {
176                 /* remove F-Curve from driver stack, then free it */
177                 BLI_remlink(&adt->drivers, fcu);
178                 free_fcurve(fcu);
179                 
180                 /* done successfully */
181                 return 1;
182         }
183         
184         /* failed */
185         return 0;
186 }
187
188
189 /* ************************************************** */
190 /* UI-Button Interface */
191
192 /* Add Driver Button Operator ------------------------ */
193
194 static int add_driver_button_exec (bContext *C, wmOperator *op)
195 {
196         PointerRNA ptr;
197         PropertyRNA *prop= NULL;
198         char *path;
199         short success= 0;
200         int a, index, length, all= RNA_boolean_get(op->ptr, "all");
201         
202         /* try to insert keyframe using property retrieved from UI */
203         memset(&ptr, 0, sizeof(PointerRNA));
204         uiAnimContextProperty(C, &ptr, &prop, &index);
205         
206         if (ptr.data && prop && RNA_property_animateable(ptr.data, prop)) {
207                 path= RNA_path_from_ID_to_property(&ptr, prop);
208                 
209                 if (path) {
210                         if (all) {
211                                 length= RNA_property_array_length(prop);
212                                 
213                                 if (length) index= 0;
214                                 else length= 1;
215                         }
216                         else
217                                 length= 1;
218                         
219                         for (a=0; a<length; a++)
220                                 success+= ANIM_add_driver(ptr.id.data, path, index+a, 0);
221                         
222                         MEM_freeN(path);
223                 }
224         }
225         
226         if (success) {
227                 /* send updates */
228                 ED_anim_dag_flush_update(C);    
229                 
230                 /* for now, only send ND_KEYS for KeyingSets */
231                 WM_event_add_notifier(C, ND_KEYS, NULL); // XXX
232         }
233         
234         return (success)? OPERATOR_FINISHED: OPERATOR_CANCELLED;
235 }
236
237 void ANIM_OT_add_driver_button (wmOperatorType *ot)
238 {
239         /* identifiers */
240         ot->name= "Add Driver";
241         ot->idname= "ANIM_OT_add_driver_button";
242         
243         /* callbacks */
244         ot->exec= add_driver_button_exec; 
245         //op->poll= ???
246         
247         /* flags */
248         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
249
250         /* properties */
251         RNA_def_boolean(ot->srna, "all", 1, "All", "Insert a keyframe for all element of the array.");
252 }
253
254 /* Remove Driver Button Operator ------------------------ */
255
256 static int remove_driver_button_exec (bContext *C, wmOperator *op)
257 {
258         PointerRNA ptr;
259         PropertyRNA *prop= NULL;
260         char *path;
261         short success= 0;
262         int a, index, length, all= RNA_boolean_get(op->ptr, "all");
263         
264         /* try to insert keyframe using property retrieved from UI */
265         memset(&ptr, 0, sizeof(PointerRNA));
266         uiAnimContextProperty(C, &ptr, &prop, &index);
267
268         if (ptr.data && prop) {
269                 path= RNA_path_from_ID_to_property(&ptr, prop);
270                 
271                 if (path) {
272                         if (all) {
273                                 length= RNA_property_array_length(prop);
274                                 
275                                 if(length) index= 0;
276                                 else length= 1;
277                         }
278                         else
279                                 length= 1;
280                         
281                         for (a=0; a<length; a++)
282                                 success+= ANIM_remove_driver(ptr.id.data, path, index+a, 0);
283                         
284                         MEM_freeN(path);
285                 }
286         }
287         
288         
289         if (success) {
290                 /* send updates */
291                 ED_anim_dag_flush_update(C);    
292                 
293                 /* for now, only send ND_KEYS for KeyingSets */
294                 WM_event_add_notifier(C, ND_KEYS, NULL);  // XXX
295         }
296         
297         return (success)? OPERATOR_FINISHED: OPERATOR_CANCELLED;
298 }
299
300 void ANIM_OT_remove_driver_button (wmOperatorType *ot)
301 {
302         /* identifiers */
303         ot->name= "Remove Driver";
304         ot->idname= "ANIM_OT_remove_driver_button";
305         
306         /* callbacks */
307         ot->exec= remove_driver_button_exec; 
308         //op->poll= ???
309         
310         /* flags */
311         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
312
313         /* properties */
314         RNA_def_boolean(ot->srna, "all", 1, "All", "Delete keyfames from all elements of the array.");
315 }
316
317 /* ************************************************** */