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