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