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