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