merge from trunk #37722
[blender-staging.git] / source / blender / makesrna / intern / rna_controller.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/makesrna/intern/rna_controller.c
26  *  \ingroup RNA
27  */
28
29
30 #include <stdlib.h>
31
32 #include "WM_types.h"
33 #include "RNA_define.h"
34
35 #include "rna_internal.h"
36 #include "DNA_object_types.h"
37 #include "DNA_controller_types.h"
38
39 EnumPropertyItem controller_type_items[] ={
40         {CONT_LOGIC_AND, "LOGIC_AND", 0, "And", "Logic And"},
41         {CONT_LOGIC_OR, "LOGIC_OR", 0, "Or", "Logic Or"},
42         {CONT_LOGIC_NAND, "LOGIC_NAND", 0, "Nand", "Logic Nand"},
43         {CONT_LOGIC_NOR, "LOGIC_NOR", 0, "Nor", "Logic Nor"},
44         {CONT_LOGIC_XOR, "LOGIC_XOR", 0, "Xor", "Logic Xor"},
45         {CONT_LOGIC_XNOR, "LOGIC_XNOR", 0, "Xnor", "Logic Xnor"},
46         {CONT_EXPRESSION, "EXPRESSION", 0, "Expression", ""},
47         {CONT_PYTHON, "PYTHON", 0, "Python", ""},
48         {0, NULL, 0, NULL, NULL}};
49
50 #ifdef RNA_RUNTIME
51
52 #include "BKE_sca.h"
53
54 static struct StructRNA* rna_Controller_refine(struct PointerRNA *ptr)
55 {
56         bController *controller= (bController*)ptr->data;
57
58         switch(controller->type) {
59         case CONT_LOGIC_AND:
60                 return &RNA_AndController;
61         case CONT_LOGIC_OR:
62                 return &RNA_OrController;
63         case CONT_LOGIC_NAND:
64                 return &RNA_NandController;
65         case CONT_LOGIC_NOR:
66                 return &RNA_NorController;
67         case CONT_LOGIC_XOR:
68                 return &RNA_XorController;
69         case CONT_LOGIC_XNOR:
70                 return &RNA_XnorController;
71         case CONT_EXPRESSION:
72                 return &RNA_ExpressionController;
73         case CONT_PYTHON:
74                 return &RNA_PythonController;
75         default:
76                 return &RNA_Controller;
77         }
78 }
79
80 static void rna_Controller_type_set(struct PointerRNA *ptr, int value)
81 {
82         bController *cont= (bController *)ptr->data;
83         if (value != cont->type)
84         {
85                 cont->type = value;
86                 init_controller(cont);
87         }
88 }
89
90 static void rna_Controller_mode_set(struct PointerRNA *ptr, int value)
91 {
92         bController *cont= (bController *)ptr->data;
93         bPythonCont *pycon= (bPythonCont *)cont->data;
94
95         // if mode changed and previous mode were Script
96         if (value != pycon->mode && pycon->mode == CONT_PY_SCRIPT)
97         {
98                 // clear script to avoid it to get linked with the controller
99                 pycon->text = NULL;
100         }
101         pycon->mode = value;
102 }
103
104 static int rna_Controller_state_number_get(struct PointerRNA *ptr)
105 {
106         bController *cont= (bController *)ptr->data;
107         int bit;
108
109         for (bit=0; bit<32; bit++) {
110                 if (cont->state_mask & (1<<bit))
111                         return bit+1;
112         }
113         return 0;
114 }
115
116 static void rna_Controller_state_number_set(struct PointerRNA *ptr, const int value)
117 {
118         bController *cont= (bController *)ptr->data;
119         if (value < 1 || value > OB_MAX_STATES)
120                 return;
121
122         cont->state_mask = (1 << (value - 1));
123 }
124
125 #if 0 /* editable is set to false, comment for now. */
126 static void rna_Controller_state_get(PointerRNA *ptr, int *values)
127 {
128         bController *cont= (bController *)ptr->data;
129         int i;
130
131         memset(values, 0, sizeof(int)*OB_MAX_STATES);
132         for(i=0; i<OB_MAX_STATES; i++)
133                 values[i] = (cont->state_mask & (1<<i));
134 }
135
136 static void rna_Controller_state_set(PointerRNA *ptr, const int *values)
137 {
138         bController *cont= (bController *)ptr->data;
139         int i, tot= 0;
140
141         /* ensure we always have some state selected */
142         for(i=0; i<OB_MAX_STATES; i++)
143                 if(values[i])
144                         tot++;
145         
146         if(tot==0)
147                 return;
148
149         /* only works for one state at once */
150         if(tot>1)
151                 return;
152
153         for(i=0; i<OB_MAX_STATES; i++) {
154                 if(values[i]) cont->state_mask |= (1<<i);
155                 else cont->state_mask &= ~(1<<i);
156         }
157 }
158 #endif
159
160 #else
161
162 void RNA_def_controller(BlenderRNA *brna)
163 {
164         StructRNA *srna;
165         PropertyRNA *prop;
166
167         static EnumPropertyItem python_controller_modes[] ={
168                 {CONT_PY_SCRIPT, "SCRIPT", 0, "Script", ""},
169                 {CONT_PY_MODULE, "MODULE", 0, "Module", ""},
170                 {0, NULL, 0, NULL, NULL}};
171
172         /* Controller */
173         srna= RNA_def_struct(brna, "Controller", NULL);
174         RNA_def_struct_sdna(srna, "bController");
175         RNA_def_struct_refine_func(srna, "rna_Controller_refine");
176         RNA_def_struct_ui_text(srna, "Controller", "Game engine logic brick to process events, connecting sensors to actuators");
177
178         RNA_api_controller(srna);
179
180         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
181         RNA_def_property_ui_text(prop, "Name", "");
182         RNA_def_struct_name_property(srna, prop);
183         RNA_def_property_update(prop, NC_LOGIC, NULL);
184
185         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
186         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
187         RNA_def_property_enum_funcs(prop, NULL, "rna_Controller_type_set", NULL);
188         RNA_def_property_enum_items(prop, controller_type_items);
189         RNA_def_property_ui_text(prop, "Type", "");
190         RNA_def_property_update(prop, NC_LOGIC, NULL);
191
192         prop= RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
193         RNA_def_property_boolean_sdna(prop, NULL, "flag", CONT_SHOW);
194         RNA_def_property_ui_text(prop, "Expanded", "Set controller expanded in the user interface");
195         RNA_def_property_ui_icon(prop, ICON_TRIA_RIGHT, 1);     
196         RNA_def_property_update(prop, NC_LOGIC, NULL);
197
198         prop= RNA_def_property(srna, "use_priority", PROP_BOOLEAN, PROP_NONE);
199         RNA_def_property_boolean_sdna(prop, NULL, "flag", CONT_PRIO);
200         RNA_def_property_ui_text(prop, "Priority", "Mark controller for execution before all non-marked controllers (good for startup scripts)");
201         RNA_def_property_ui_icon(prop, ICON_BOOKMARKS, 1);
202         RNA_def_property_update(prop, NC_LOGIC, NULL);
203
204         /* State */
205         
206         // array of OB_MAX_STATES
207         //prop= RNA_def_property(srna, "states", PROP_BOOLEAN, PROP_LAYER_MEMBER);
208         //RNA_def_property_array(prop, OB_MAX_STATES);
209         //RNA_def_property_clear_flag(prop, PROP_EDITABLE);
210         //RNA_def_property_ui_text(prop, "", "Set Controller state index (1 to 30)");
211         //RNA_def_property_boolean_funcs(prop, "rna_Controller_state_get", "rna_Controller_state_set");
212         //RNA_def_property_update(prop, NC_LOGIC, NULL);
213
214         // number of the state
215         prop= RNA_def_property(srna, "states", PROP_INT, PROP_UNSIGNED);
216         RNA_def_property_int_sdna(prop, NULL, "state_mask");
217         RNA_def_property_range(prop, 1, OB_MAX_STATES);
218         RNA_def_property_ui_text(prop, "", "Set Controller state index (1 to 30)");
219         RNA_def_property_int_funcs(prop, "rna_Controller_state_number_get", "rna_Controller_state_number_set", NULL);
220         RNA_def_property_update(prop, NC_LOGIC, NULL);
221
222         /* Expression Controller */
223         srna= RNA_def_struct(brna, "ExpressionController", "Controller");
224         RNA_def_struct_sdna_from(srna, "bExpressionCont", "data");
225         RNA_def_struct_ui_text(srna, "Expression Controller", "Controller passing on events based on the evaluation of an expression");
226
227         prop= RNA_def_property(srna, "expression", PROP_STRING, PROP_NONE);
228         RNA_def_property_string_sdna(prop, NULL, "str");
229         RNA_def_property_ui_text(prop, "Expression", "");
230         RNA_def_property_update(prop, NC_LOGIC, NULL);
231
232         /* Python Controller */
233         srna= RNA_def_struct(brna, "PythonController", "Controller" );
234         RNA_def_struct_sdna_from(srna, "bPythonCont", "data");
235         RNA_def_struct_ui_text(srna, "Python Controller", "Controller executing a python script");
236
237         prop= RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
238         RNA_def_property_enum_items(prop, python_controller_modes);
239         RNA_def_property_enum_funcs(prop, NULL, "rna_Controller_mode_set", NULL);
240         RNA_def_property_ui_text(prop, "Execution Method", "Python script type (textblock or module - faster)");
241         RNA_def_property_update(prop, NC_LOGIC, NULL);
242
243         prop= RNA_def_property(srna, "text", PROP_POINTER, PROP_NONE);
244         RNA_def_property_struct_type(prop, "Text");
245         RNA_def_property_flag(prop, PROP_EDITABLE);
246         RNA_def_property_ui_text(prop, "Text", "Text datablock with the python script");
247         RNA_def_property_update(prop, NC_LOGIC, NULL);
248
249         prop= RNA_def_property(srna, "module", PROP_STRING, PROP_NONE);
250         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");
251         RNA_def_property_update(prop, NC_LOGIC, NULL);
252
253         prop= RNA_def_property(srna, "use_debug", PROP_BOOLEAN, PROP_NONE);
254         RNA_def_property_boolean_sdna(prop, NULL, "flag", CONT_PY_DEBUG);
255         RNA_def_property_ui_text(prop, "D", "Continuously reload the module from disk for editing external modules without restarting");
256         RNA_def_property_update(prop, NC_LOGIC, NULL);
257
258         /* Other Controllers */
259         srna= RNA_def_struct(brna, "AndController", "Controller");
260         RNA_def_struct_ui_text(srna, "And Controller", "Controller passing on events based on a logical AND operation");
261         
262         srna= RNA_def_struct(brna, "OrController", "Controller");
263         RNA_def_struct_ui_text(srna, "Or Controller", "Controller passing on events based on a logical OR operation");
264         
265         srna= RNA_def_struct(brna, "NorController", "Controller");
266         RNA_def_struct_ui_text(srna, "Nor Controller", "Controller passing on events based on a logical NOR operation");
267         
268         srna= RNA_def_struct(brna, "NandController", "Controller");
269         RNA_def_struct_ui_text(srna, "Nand Controller", "Controller passing on events based on a logical NAND operation");
270         
271         srna= RNA_def_struct(brna, "XorController", "Controller");
272         RNA_def_struct_ui_text(srna, "Xor Controller", "Controller passing on events based on a logical XOR operation");
273         
274         srna= RNA_def_struct(brna, "XnorController", "Controller");
275         RNA_def_struct_ui_text(srna, "Xnor Controller", "Controller passing on events based on a logical XNOR operation");
276 }
277
278 #endif
279