f81610a4024617c07101a70dc6c6e12392fdcf5b
[blender.git] / source / blender / makesrna / intern / rna_controller.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  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_controller.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "WM_types.h"
31 #include "RNA_define.h"
32
33 #include "rna_internal.h"
34 #include "DNA_object_types.h"
35 #include "DNA_controller_types.h"
36
37 EnumPropertyItem controller_type_items[] = {
38         {CONT_LOGIC_AND, "LOGIC_AND", 0, "And", "Logic And"},
39         {CONT_LOGIC_OR, "LOGIC_OR", 0, "Or", "Logic Or"},
40         {CONT_LOGIC_NAND, "LOGIC_NAND", 0, "Nand", "Logic Nand"},
41         {CONT_LOGIC_NOR, "LOGIC_NOR", 0, "Nor", "Logic Nor"},
42         {CONT_LOGIC_XOR, "LOGIC_XOR", 0, "Xor", "Logic Xor"},
43         {CONT_LOGIC_XNOR, "LOGIC_XNOR", 0, "Xnor", "Logic Xnor"},
44         {CONT_EXPRESSION, "EXPRESSION", 0, "Expression", ""},
45         {CONT_PYTHON, "PYTHON", 0, "Python", ""},
46         {0, NULL, 0, NULL, NULL}};
47
48 #ifdef RNA_RUNTIME
49
50 #include "BKE_sca.h"
51 #include "DNA_actuator_types.h"
52
53 static struct StructRNA* rna_Controller_refine(struct PointerRNA *ptr)
54 {
55         bController *controller = (bController*)ptr->data;
56
57         switch (controller->type) {
58         case CONT_LOGIC_AND:
59                 return &RNA_AndController;
60         case CONT_LOGIC_OR:
61                 return &RNA_OrController;
62         case CONT_LOGIC_NAND:
63                 return &RNA_NandController;
64         case CONT_LOGIC_NOR:
65                 return &RNA_NorController;
66         case CONT_LOGIC_XOR:
67                 return &RNA_XorController;
68         case CONT_LOGIC_XNOR:
69                 return &RNA_XnorController;
70         case CONT_EXPRESSION:
71                 return &RNA_ExpressionController;
72         case CONT_PYTHON:
73                 return &RNA_PythonController;
74         default:
75                 return &RNA_Controller;
76         }
77 }
78
79 void rna_Constroller_name_set(PointerRNA *ptr, const char *value)
80 {
81         bController *cont = (bController *)ptr->data;
82
83         BLI_strncpy_utf8(cont->name, value, sizeof(cont->name));
84
85         if (ptr->id.data) {
86                 Object *ob = (Object *)ptr->id.data;
87                 BLI_uniquename(&ob->controllers, cont, "Controller", '.', offsetof(bController, name), sizeof(cont->name));
88         }
89 }
90
91 static void rna_Controller_type_set(struct PointerRNA *ptr, int value)
92 {
93         bController *cont = (bController *)ptr->data;
94         if (value != cont->type)
95         {
96                 cont->type = value;
97                 init_controller(cont);
98         }
99 }
100
101 static void rna_Controller_mode_set(struct PointerRNA *ptr, int value)
102 {
103         bController *cont = (bController *)ptr->data;
104         bPythonCont *pycon = (bPythonCont *)cont->data;
105
106         /* if mode changed and previous mode were Script */
107         if (value != pycon->mode && pycon->mode == CONT_PY_SCRIPT)
108         {
109                 /* clear script to avoid it to get linked with the controller */
110                 pycon->text = NULL;
111         }
112         pycon->mode = value;
113 }
114
115 static int rna_Controller_state_number_get(struct PointerRNA *ptr)
116 {
117         bController *cont = (bController *)ptr->data;
118         int bit;
119
120         for (bit = 0; bit<32; bit++) {
121                 if (cont->state_mask & (1<<bit))
122                         return bit+1;
123         }
124         return 0;
125 }
126
127 static void rna_Controller_state_number_set(struct PointerRNA *ptr, const int value)
128 {
129         bController *cont = (bController *)ptr->data;
130         if (value < 1 || value > OB_MAX_STATES)
131                 return;
132
133         cont->state_mask = (1 << (value - 1));
134 }
135
136 static void rna_Controller_actuators_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
137 {
138         bController *cont = (bController *)ptr->data;
139         rna_iterator_array_begin(iter, cont->links, sizeof(bActuator *), (int)cont->totlinks, 0, NULL);
140 }
141
142 static int rna_Controller_actuators_length(PointerRNA *ptr)
143 {
144         bController *cont = (bController *)ptr->data;
145         return (int) cont->totlinks;
146 }
147
148 #if 0 /* editable is set to false, comment for now. */
149 static void rna_Controller_state_get(PointerRNA *ptr, int *values)
150 {
151         bController *cont = (bController *)ptr->data;
152         int i;
153
154         memset(values, 0, sizeof(int)*OB_MAX_STATES);
155         for (i = 0; i<OB_MAX_STATES; i++)
156                 values[i] = (cont->state_mask & (1<<i));
157 }
158
159 static void rna_Controller_state_set(PointerRNA *ptr, const int *values)
160 {
161         bController *cont = (bController *)ptr->data;
162         int i, tot = 0;
163
164         /* ensure we always have some state selected */
165         for (i = 0; i<OB_MAX_STATES; i++)
166                 if (values[i])
167                         tot++;
168         
169         if (tot == 0)
170                 return;
171
172         /* only works for one state at once */
173         if (tot>1)
174                 return;
175
176         for (i = 0; i<OB_MAX_STATES; i++) {
177                 if (values[i]) cont->state_mask |= (1<<i);
178                 else cont->state_mask &= ~(1<<i);
179         }
180 }
181 #endif
182
183 #else
184
185 void RNA_def_controller(BlenderRNA *brna)
186 {
187         StructRNA *srna;
188         PropertyRNA *prop;
189
190         static EnumPropertyItem python_controller_modes[] = {
191                 {CONT_PY_SCRIPT, "SCRIPT", 0, "Script", ""},
192                 {CONT_PY_MODULE, "MODULE", 0, "Module", ""},
193                 {0, NULL, 0, NULL, NULL}};
194
195         /* Controller */
196         srna = RNA_def_struct(brna, "Controller", NULL);
197         RNA_def_struct_sdna(srna, "bController");
198         RNA_def_struct_refine_func(srna, "rna_Controller_refine");
199         RNA_def_struct_ui_text(srna, "Controller", "Game engine logic brick to process events, connecting sensors to actuators");
200
201         RNA_api_controller(srna);
202
203         prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
204         RNA_def_property_ui_text(prop, "Name", "");
205         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Constroller_name_set");
206         RNA_def_struct_name_property(srna, prop);
207         RNA_def_property_update(prop, NC_LOGIC, NULL);
208
209         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
210         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
211         RNA_def_property_enum_funcs(prop, NULL, "rna_Controller_type_set", NULL);
212         RNA_def_property_enum_items(prop, controller_type_items);
213         RNA_def_property_ui_text(prop, "Type", "");
214         RNA_def_property_update(prop, NC_LOGIC, NULL);
215
216         prop = RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
217         RNA_def_property_boolean_sdna(prop, NULL, "flag", CONT_SHOW);
218         RNA_def_property_ui_text(prop, "Expanded", "Set controller expanded in the user interface");
219         RNA_def_property_ui_icon(prop, ICON_TRIA_RIGHT, 1);     
220         RNA_def_property_update(prop, NC_LOGIC, NULL);
221
222         prop = RNA_def_property(srna, "use_priority", PROP_BOOLEAN, PROP_NONE);
223         RNA_def_property_boolean_sdna(prop, NULL, "flag", CONT_PRIO);
224         RNA_def_property_ui_text(prop, "Priority", "Mark controller for execution before all non-marked controllers (good for startup scripts)");
225         RNA_def_property_ui_icon(prop, ICON_BOOKMARKS, 1);
226         RNA_def_property_update(prop, NC_LOGIC, NULL);
227
228         prop = RNA_def_property(srna, "actuators", PROP_COLLECTION, PROP_NONE);
229         RNA_def_property_collection_sdna(prop, NULL, "links", NULL);
230         RNA_def_property_struct_type(prop, "Actuator");
231         RNA_def_property_ui_text(prop, "Actuators", "The list containing the actuators connected to the controller");
232         RNA_def_property_collection_funcs(prop, "rna_Controller_actuators_begin", "rna_iterator_array_next", "rna_iterator_array_end", "rna_iterator_array_dereference_get", "rna_Controller_actuators_length", NULL, NULL, NULL);
233
234         /* State */
235         
236         /* array of OB_MAX_STATES */
237         /*prop= RNA_def_property(srna, "states", PROP_BOOLEAN, PROP_LAYER_MEMBER); */
238         /*RNA_def_property_array(prop, OB_MAX_STATES); */
239         /*RNA_def_property_clear_flag(prop, PROP_EDITABLE); */
240         /*RNA_def_property_ui_text(prop, "", "Set Controller state index (1 to 30)"); */
241         /*RNA_def_property_boolean_funcs(prop, "rna_Controller_state_get", "rna_Controller_state_set"); */
242         /*RNA_def_property_update(prop, NC_LOGIC, NULL); */
243
244         /* number of the state */
245         prop = RNA_def_property(srna, "states", PROP_INT, PROP_UNSIGNED);
246         RNA_def_property_int_sdna(prop, NULL, "state_mask");
247         RNA_def_property_range(prop, 1, OB_MAX_STATES);
248         RNA_def_property_ui_text(prop, "", "Set Controller state index (1 to 30)");
249         RNA_def_property_int_funcs(prop, "rna_Controller_state_number_get", "rna_Controller_state_number_set", NULL);
250         RNA_def_property_update(prop, NC_LOGIC, NULL);
251
252         /* Expression Controller */
253         srna = RNA_def_struct(brna, "ExpressionController", "Controller");
254         RNA_def_struct_sdna_from(srna, "bExpressionCont", "data");
255         RNA_def_struct_ui_text(srna, "Expression Controller", "Controller passing on events based on the evaluation of an expression");
256
257         prop = RNA_def_property(srna, "expression", PROP_STRING, PROP_NONE);
258         RNA_def_property_string_sdna(prop, NULL, "str");
259         RNA_def_property_ui_text(prop, "Expression", "");
260         RNA_def_property_update(prop, NC_LOGIC, NULL);
261
262         /* Python Controller */
263         srna = RNA_def_struct(brna, "PythonController", "Controller" );
264         RNA_def_struct_sdna_from(srna, "bPythonCont", "data");
265         RNA_def_struct_ui_text(srna, "Python Controller", "Controller executing a python script");
266
267         prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
268         RNA_def_property_enum_items(prop, python_controller_modes);
269         RNA_def_property_enum_funcs(prop, NULL, "rna_Controller_mode_set", NULL);
270         RNA_def_property_ui_text(prop, "Execution Method", "Python script type (textblock or module - faster)");
271         RNA_def_property_update(prop, NC_LOGIC, NULL);
272
273         prop = RNA_def_property(srna, "text", PROP_POINTER, PROP_NONE);
274         RNA_def_property_struct_type(prop, "Text");
275         RNA_def_property_flag(prop, PROP_EDITABLE);
276         RNA_def_property_ui_text(prop, "Text", "Text datablock with the python script");
277         RNA_def_property_update(prop, NC_LOGIC, NULL);
278
279         prop = RNA_def_property(srna, "module", PROP_STRING, PROP_NONE);
280         RNA_def_property_ui_text(prop, "Module", "Module name and function to run, e.g. \"someModule.main\" (internal texts and external python files can be used)");
281         RNA_def_property_update(prop, NC_LOGIC, NULL);
282
283         prop = RNA_def_property(srna, "use_debug", PROP_BOOLEAN, PROP_NONE);
284         RNA_def_property_boolean_sdna(prop, NULL, "flag", CONT_PY_DEBUG);
285         RNA_def_property_ui_text(prop, "D", "Continuously reload the module from disk for editing external modules without restarting");
286         RNA_def_property_update(prop, NC_LOGIC, NULL);
287
288         /* Other Controllers */
289         srna = RNA_def_struct(brna, "AndController", "Controller");
290         RNA_def_struct_ui_text(srna, "And Controller", "Controller passing on events based on a logical AND operation");
291         
292         srna = RNA_def_struct(brna, "OrController", "Controller");
293         RNA_def_struct_ui_text(srna, "Or Controller", "Controller passing on events based on a logical OR operation");
294         
295         srna = RNA_def_struct(brna, "NorController", "Controller");
296         RNA_def_struct_ui_text(srna, "Nor Controller", "Controller passing on events based on a logical NOR operation");
297         
298         srna = RNA_def_struct(brna, "NandController", "Controller");
299         RNA_def_struct_ui_text(srna, "Nand Controller", "Controller passing on events based on a logical NAND operation");
300         
301         srna = RNA_def_struct(brna, "XorController", "Controller");
302         RNA_def_struct_ui_text(srna, "Xor Controller", "Controller passing on events based on a logical XOR operation");
303         
304         srna = RNA_def_struct(brna, "XnorController", "Controller");
305         RNA_def_struct_ui_text(srna, "Xnor Controller", "Controller passing on events based on a logical XNOR operation");
306 }
307
308 #endif
309