Driver Scripting:
[blender-staging.git] / source / blender / makesrna / intern / rna_fcurve_api.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Joshua Leung
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <time.h>
31
32 #include "RNA_define.h"
33 #include "RNA_types.h"
34
35 #include "DNA_anim_types.h"
36
37 #ifdef RNA_RUNTIME
38
39 #include <stddef.h>
40
41 #include "BLI_blenlib.h"
42
43 #include "BKE_animsys.h"
44 #include "BKE_fcurve.h"
45
46 DriverTarget *rna_Driver_add_target(ChannelDriver *driver, char *name)
47 {
48         DriverTarget *dtar= driver_add_new_target(driver);
49         
50         /* set the name if given */
51         if (name && name[0]) {
52                 BLI_strncpy(dtar->name, name, 64);
53                 BLI_uniquename(&driver->targets, dtar, "var", '_', offsetof(DriverTarget, name), 64);
54         }
55         
56         /* return this target for the users to play with */
57         return dtar;
58 }
59
60 void rna_Driver_remove_target(ChannelDriver *driver, DriverTarget *dtar)
61 {
62         /* call the API function for this */
63         driver_free_target(driver, dtar);
64 }
65
66 #else
67
68 void RNA_api_drivers(StructRNA *srna)
69 {
70         FunctionRNA *func;
71         PropertyRNA *parm;
72
73         /* add target */
74         func= RNA_def_function(srna, "add_target", "rna_Driver_add_target");
75         RNA_def_function_ui_description(func, "Add a new target for the driver.");
76                 /* return type */
77         parm= RNA_def_pointer(func, "target", "DriverTarget", "", "Newly created Driver Target.");
78                 RNA_def_function_return(func, parm);
79                 /* optional name parameter */
80         parm= RNA_def_string(func, "name", "", 64, "Name", "Name to use in scripted expressions/functions. (No spaces or dots are allowed. Also, must not start with a symbol or digit)");
81         
82         /* remove target */
83         func= RNA_def_function(srna, "remove_target", "rna_Driver_remove_target");
84                 RNA_def_function_ui_description(func, "Remove an existing target from the driver.");
85                 /* target to remove*/
86         parm= RNA_def_pointer(func, "target", "DriverTarget", "", "Target to remove from the driver.");
87                 RNA_def_property_flag(parm, PROP_REQUIRED);
88 }
89
90 #endif