svn merge ^/trunk/blender -r41226:41227 .
[blender-staging.git] / source / blender / makesrna / intern / rna_sensor.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_sensor.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "RNA_define.h"
31 #include "RNA_enum_types.h"
32 #include "RNA_access.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_constraint_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_sensor_types.h"
39
40 #include "WM_types.h"
41
42 /* Always keep in alphabetical order */
43 EnumPropertyItem sensor_type_items[] ={
44         {SENS_ACTUATOR, "ACTUATOR", 0, "Actuator", ""},
45         {SENS_ALWAYS, "ALWAYS", 0, "Always", ""},
46         {SENS_ARMATURE, "ARMATURE", 0, "Armature", ""},
47         {SENS_COLLISION, "COLLISION", 0, "Collision", ""},
48         {SENS_DELAY, "DELAY", 0, "Delay", ""},
49         {SENS_JOYSTICK, "JOYSTICK", 0, "Joystick", ""},
50         {SENS_KEYBOARD, "KEYBOARD", 0, "Keyboard", ""},
51         {SENS_MESSAGE, "MESSAGE", 0, "Message", ""},
52         {SENS_MOUSE, "MOUSE", 0, "Mouse", ""},
53         {SENS_NEAR, "NEAR", 0, "Near", ""},
54         {SENS_PROPERTY, "PROPERTY", 0, "Property", ""},
55         {SENS_RADAR, "RADAR", 0, "Radar", ""},
56         {SENS_RANDOM, "RANDOM", 0, "Random", ""},
57         {SENS_RAY, "RAY", 0, "Ray", ""},
58         {SENS_TOUCH, "TOUCH", 0, "Touch", ""},
59         {0, NULL, 0, NULL, NULL}};
60
61 #ifdef RNA_RUNTIME
62
63 #include "BKE_sca.h"
64
65 static StructRNA* rna_Sensor_refine(struct PointerRNA *ptr)
66 {
67         bSensor *sensor= (bSensor*)ptr->data;
68
69         switch(sensor->type) {
70                 case SENS_ALWAYS:
71                         return &RNA_AlwaysSensor;
72                 case SENS_TOUCH:
73                         return &RNA_TouchSensor;
74                 case SENS_NEAR:
75                         return &RNA_NearSensor;
76                 case SENS_KEYBOARD:
77                         return &RNA_KeyboardSensor;
78                 case SENS_PROPERTY:
79                         return &RNA_PropertySensor;
80                 case SENS_ARMATURE:
81                         return &RNA_ArmatureSensor;
82                 case SENS_MOUSE:
83                         return &RNA_MouseSensor;
84                 case SENS_COLLISION:
85                         return &RNA_CollisionSensor;
86                 case SENS_RADAR:
87                         return &RNA_RadarSensor;
88                 case SENS_RANDOM:
89                         return &RNA_RandomSensor;
90                 case SENS_RAY:
91                         return &RNA_RaySensor;
92                 case SENS_MESSAGE:
93                         return &RNA_MessageSensor;
94                 case SENS_JOYSTICK:
95                         return &RNA_JoystickSensor;
96                 case SENS_ACTUATOR:
97                         return &RNA_ActuatorSensor;
98                 case SENS_DELAY:
99                         return &RNA_DelaySensor;
100                 default:
101                         return &RNA_Sensor;
102         }
103 }
104
105 static void rna_Sensor_type_set(struct PointerRNA *ptr, int value)
106 {
107         bSensor *sens= (bSensor *)ptr->data;
108         if (value != sens->type)
109         {
110                 sens->type = value;
111                 init_sensor(sens);
112         }
113 }
114
115 /* Always keep in alphabetical order */
116 EnumPropertyItem *rna_Sensor_type_itemf(bContext *C, PointerRNA *ptr, PropertyRNA *UNUSED(prop), int *free)
117 {
118         EnumPropertyItem *item= NULL;
119         Object *ob=NULL;
120         int totitem= 0;
121
122         if (ptr->type == &RNA_Sensor || RNA_struct_is_a(ptr->type, &RNA_Sensor)) {
123                 ob = (Object *)ptr->id.data;
124         } else {
125                 /* can't use ob from ptr->id.data because that enum is also used by operators */
126                 ob = CTX_data_active_object(C);
127         }
128         
129         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_ACTUATOR);
130         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_ALWAYS);
131
132         if (ob != NULL) {
133                 if (ob->type==OB_ARMATURE) {
134                         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_ARMATURE);
135                 }
136         }
137         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_COLLISION);   
138         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_DELAY);
139         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_JOYSTICK);
140         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_KEYBOARD);
141         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_MESSAGE);
142         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_MOUSE);
143         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_NEAR);
144         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_PROPERTY);
145         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_RADAR);
146         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_RANDOM);
147         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_RAY);
148         RNA_enum_items_add_value(&item, &totitem, sensor_type_items, SENS_TOUCH);
149         
150         RNA_enum_item_end(&item, &totitem);
151         *free= 1;
152         
153         return item;
154 }
155
156 static void rna_Sensor_keyboard_key_set(struct PointerRNA *ptr, int value)
157 {
158         bSensor *sens= (bSensor *)ptr->data;
159         bKeyboardSensor *ks = (bKeyboardSensor *)sens->data;
160         
161         if (ISKEYBOARD(value))
162                 ks->key = value;
163         else
164                 ks->key = 0;
165 }
166
167 static void rna_Sensor_keyboard_modifier_set(struct PointerRNA *ptr, int value)
168 {
169         bSensor *sens= (bSensor *)ptr->data;
170         bKeyboardSensor *ks = (bKeyboardSensor *)sens->data;
171         
172         if (ISKEYBOARD(value))
173                 ks->qual = value;
174         else
175                 ks->qual = 0;
176 }
177                 
178 static void rna_Sensor_keyboard_modifier2_set(struct PointerRNA *ptr, int value)
179 {
180         bSensor *sens= (bSensor *)ptr->data;
181         bKeyboardSensor *ks = (bKeyboardSensor *)sens->data;
182         
183         if (ISKEYBOARD(value))
184                 ks->qual2 = value;
185         else
186                 ks->qual2 = 0;
187 }
188
189 static void rna_Sensor_tap_set(struct PointerRNA *ptr, int value)
190 {
191         bSensor *sens= (bSensor*)ptr->data;
192
193         sens->tap = value;
194         if(sens->tap == 1)
195                 sens->level = 0;
196 }
197
198 static void rna_Sensor_level_set(struct PointerRNA *ptr, int value)
199 {
200         bSensor *sens= (bSensor*)ptr->data;
201
202         sens->level = value;
203         if(sens->level == 1)
204                 sens->tap = 0;
205 }
206
207 static void rna_Sensor_Armature_update(Main *bmain, Scene *scene, PointerRNA *ptr)
208 {
209         bSensor *sens= (bSensor *)ptr->data;
210         bArmatureSensor *as = sens->data;
211         Object *ob = (Object *)ptr->id.data;
212
213         char *posechannel= as->posechannel;
214         char *constraint= as->constraint;
215
216         /* check that bone exist in the active object */
217         if (ob->type == OB_ARMATURE && ob->pose) {
218                 bPoseChannel *pchan;
219                 bPose *pose = ob->pose;
220                 for (pchan=pose->chanbase.first; pchan; pchan=pchan->next) {
221                         if (!strcmp(pchan->name, posechannel)) {
222                                 /* found it, now look for constraint channel */
223                                 bConstraint *con;
224                                 for (con=pchan->constraints.first; con; con=con->next) {
225                                         if (!strcmp(con->name, constraint)) {
226                                                 /* found it, all ok */
227                                                 return;                                         
228                                         }
229                                 }
230                                 /* didn't find constraint, make empty */
231                                 constraint[0] = 0;
232                                 return;
233                         }
234                 }
235         }
236         /* didn't find any */
237         posechannel[0] = 0;
238         constraint[0] = 0;
239 }
240
241 /* note: the following set functions exists only to avoid id refcounting */
242 static void rna_Sensor_touch_material_set(PointerRNA *ptr, PointerRNA value)
243 {
244         bSensor *sens = (bSensor *)ptr->data;
245         bTouchSensor *ts = (bTouchSensor *) sens->data;
246
247         ts->ma = value.data;
248 }
249 #else
250
251 static void rna_def_sensor(BlenderRNA *brna)
252 {
253         StructRNA *srna;
254         PropertyRNA *prop;
255
256         srna= RNA_def_struct(brna, "Sensor", NULL);
257         RNA_def_struct_ui_text(srna, "Sensor", "Game engine logic brick to detect events");
258         RNA_def_struct_sdna(srna, "bSensor");
259         RNA_def_struct_refine_func(srna, "rna_Sensor_refine");
260
261         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
262         RNA_def_property_ui_text(prop, "Name", "Sensor name");
263         RNA_def_struct_name_property(srna, prop);
264         RNA_def_property_update(prop, NC_LOGIC, NULL);
265
266         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
267         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
268         RNA_def_property_enum_items(prop, sensor_type_items);
269         RNA_def_property_enum_funcs(prop, NULL, "rna_Sensor_type_set", "rna_Sensor_type_itemf");
270         RNA_def_property_ui_text(prop, "Type", "");
271         RNA_def_property_update(prop, NC_LOGIC, NULL);
272
273         prop= RNA_def_property(srna, "pin", PROP_BOOLEAN, PROP_NONE);
274         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_PIN);
275         RNA_def_property_ui_text(prop, "Pinned", "Display when not linked to a visible states controller");
276         RNA_def_property_ui_icon(prop, ICON_UNPINNED, 1);
277         RNA_def_property_update(prop, NC_LOGIC, NULL);
278
279         prop= RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
280         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_SHOW);
281         RNA_def_property_ui_text(prop, "Expanded", "Set sensor expanded in the user interface");
282         RNA_def_property_ui_icon(prop, ICON_TRIA_RIGHT, 1);
283         RNA_def_property_update(prop, NC_LOGIC, NULL);
284
285         prop= RNA_def_property(srna, "invert", PROP_BOOLEAN, PROP_NONE);
286         RNA_def_property_ui_text(prop, "Invert Output", "Invert the level(output) of this sensor");
287         RNA_def_property_update(prop, NC_LOGIC, NULL);
288
289         prop= RNA_def_property(srna, "use_level", PROP_BOOLEAN, PROP_NONE);
290         RNA_def_property_boolean_sdna(prop, NULL, "level", 1);
291         RNA_def_property_ui_text(prop, "Level", "Level detector, trigger controllers of new states(only applicable upon logic state transition)");
292         RNA_def_property_boolean_funcs(prop, NULL, "rna_Sensor_level_set");
293         RNA_def_property_update(prop, NC_LOGIC, NULL);
294
295         prop= RNA_def_property(srna, "use_pulse_true_level", PROP_BOOLEAN, PROP_NONE);
296         RNA_def_property_boolean_sdna(prop, NULL, "pulse", SENS_PULSE_REPEAT);
297         RNA_def_property_ui_text(prop, "Pulse True Level", "Activate TRUE level triggering (pulse mode)");
298         RNA_def_property_update(prop, NC_LOGIC, NULL);
299
300         prop= RNA_def_property(srna, "use_pulse_false_level", PROP_BOOLEAN, PROP_NONE);
301         RNA_def_property_boolean_sdna(prop, NULL, "pulse", SENS_NEG_PULSE_MODE);
302         RNA_def_property_ui_text(prop, "Pulse False Level", "Activate FALSE level triggering (pulse mode)");
303         RNA_def_property_update(prop, NC_LOGIC, NULL);
304         
305         prop= RNA_def_property(srna, "frequency", PROP_INT, PROP_NONE);
306         RNA_def_property_int_sdna(prop, NULL, "freq");
307         RNA_def_property_ui_text(prop, "Frequency", "Delay between repeated pulses(in logic tics, 0=no delay)");
308         RNA_def_property_range(prop, 0, 10000);
309         RNA_def_property_update(prop, NC_LOGIC, NULL);
310
311         prop= RNA_def_property(srna, "use_tap", PROP_BOOLEAN, PROP_NONE);
312         RNA_def_property_boolean_sdna(prop, NULL, "tap", 1);
313         RNA_def_property_boolean_funcs(prop, NULL, "rna_Sensor_tap_set");
314         RNA_def_property_ui_text(prop, "Tap", "Trigger controllers only for an instant, even while the sensor remains true");
315         RNA_def_property_update(prop, NC_LOGIC, NULL);
316
317         RNA_api_sensor(srna);
318 }
319
320 static void rna_def_always_sensor(BlenderRNA *brna)
321 {
322         StructRNA *srna;
323         srna= RNA_def_struct(brna, "AlwaysSensor", "Sensor");
324         RNA_def_struct_ui_text(srna, "Always Sensor", "Sensor to generate continuous pulses");
325 }
326
327 static void rna_def_near_sensor(BlenderRNA *brna)
328 {
329         StructRNA *srna;
330         PropertyRNA *prop;
331
332         srna= RNA_def_struct(brna, "NearSensor", "Sensor");
333         RNA_def_struct_ui_text(srna , "Near Sensor", "Sensor to detect nearby objects");
334         RNA_def_struct_sdna_from(srna, "bNearSensor", "data");
335
336         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
337         RNA_def_property_string_sdna(prop, NULL, "name");
338         RNA_def_property_ui_text(prop, "Property", "Only look for objects with this property (blank = all objects)");
339         RNA_def_property_update(prop, NC_LOGIC, NULL);
340
341         prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
342         RNA_def_property_float_sdna(prop, NULL, "dist");
343         RNA_def_property_ui_text(prop, "Distance", "Trigger distance");
344         RNA_def_property_range(prop, 0.0f, 10000.0f);
345         RNA_def_property_update(prop, NC_LOGIC, NULL);
346
347         prop= RNA_def_property(srna, "reset_distance", PROP_FLOAT, PROP_NONE);
348         RNA_def_property_float_sdna(prop, NULL, "resetdist");
349         RNA_def_property_ui_text(prop, "Reset Distance", "The distance where the sensor forgets the actor");
350         RNA_def_property_range(prop, 0.0f, 10000.0f);
351         RNA_def_property_update(prop, NC_LOGIC, NULL);
352 }
353
354 static void rna_def_mouse_sensor(BlenderRNA *brna)
355 {
356         StructRNA *srna;
357         PropertyRNA *prop;
358
359         static EnumPropertyItem mouse_event_items[] ={
360                 {BL_SENS_MOUSE_LEFT_BUTTON, "LEFTCLICK", 0, "Left Button", ""},
361                 {BL_SENS_MOUSE_MIDDLE_BUTTON, "MIDDLECLICK", 0, "Middle Button", ""},
362                 {BL_SENS_MOUSE_RIGHT_BUTTON, "RIGHTCLICK", 0, "Right Button", ""},
363                 {BL_SENS_MOUSE_WHEEL_UP, "WHEELUP", 0, "Wheel Up", ""},
364                 {BL_SENS_MOUSE_WHEEL_DOWN, "WHEELDOWN", 0, "Wheel Down", ""},
365                 {BL_SENS_MOUSE_MOVEMENT, "MOVEMENT", 0, "Movement", ""},
366                 {BL_SENS_MOUSE_MOUSEOVER, "MOUSEOVER", 0, "Mouse Over", ""},
367                 {BL_SENS_MOUSE_MOUSEOVER_ANY, "MOUSEOVERANY", 0, "Mouse Over Any", ""},
368                 {0, NULL, 0, NULL, NULL}};
369
370         srna= RNA_def_struct(brna, "MouseSensor", "Sensor");
371         RNA_def_struct_ui_text(srna, "Mouse Sensor", "Sensor to detect mouse events");
372         RNA_def_struct_sdna_from(srna, "bMouseSensor", "data");
373
374         prop= RNA_def_property(srna, "mouse_event", PROP_ENUM, PROP_NONE);
375         RNA_def_property_enum_sdna(prop, NULL, "type");
376         RNA_def_property_enum_items(prop, mouse_event_items);
377         RNA_def_property_ui_text(prop, "Mouse Event", "Specify the type of event this mouse sensor should trigger on");
378         RNA_def_property_update(prop, NC_LOGIC, NULL);
379 }
380
381 static void rna_def_touch_sensor(BlenderRNA *brna)
382 {
383         StructRNA *srna;
384         PropertyRNA *prop;
385
386         srna= RNA_def_struct(brna, "TouchSensor", "Sensor");
387         RNA_def_struct_ui_text(srna, "Touch Sensor", "Sensor to detect objects colliding with the current object");
388         RNA_def_struct_sdna_from(srna, "bTouchSensor", "data");
389
390         prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
391         RNA_def_property_struct_type(prop, "Material");
392         RNA_def_property_pointer_sdna(prop, NULL, "ma");
393         RNA_def_property_flag(prop, PROP_EDITABLE);
394         RNA_def_property_ui_text(prop, "Material", "Only look for objects with this material (blank = all objects)");
395         /* note: custom set function is ONLY to avoid rna setting a user for this. */
396         RNA_def_property_pointer_funcs(prop, NULL, "rna_Sensor_touch_material_set", NULL, NULL);
397         RNA_def_property_update(prop, NC_LOGIC, NULL);
398 }
399
400 static void rna_def_keyboard_sensor(BlenderRNA *brna)
401 {
402         StructRNA *srna;
403         PropertyRNA *prop;
404
405         srna= RNA_def_struct(brna, "KeyboardSensor", "Sensor");
406         RNA_def_struct_ui_text(srna, "Keyboard Sensor", "Sensor to detect keyboard events");
407         RNA_def_struct_sdna_from(srna, "bKeyboardSensor", "data");
408
409         prop= RNA_def_property(srna, "key", PROP_ENUM, PROP_NONE);
410         RNA_def_property_enum_sdna(prop, NULL, "key");
411         RNA_def_property_enum_items(prop, event_type_items);
412         RNA_def_property_enum_funcs(prop, NULL, "rna_Sensor_keyboard_key_set", NULL);
413         RNA_def_property_ui_text(prop, "Key",  "");
414         RNA_def_property_update(prop, NC_LOGIC, NULL);
415         
416         prop= RNA_def_property(srna, "modifier_key_1", PROP_ENUM, PROP_NONE);
417         RNA_def_property_enum_sdna(prop, NULL, "qual");
418         RNA_def_property_enum_items(prop, event_type_items);
419         RNA_def_property_enum_funcs(prop, NULL, "rna_Sensor_keyboard_modifier_set", NULL);
420         RNA_def_property_ui_text(prop, "Modifier Key", "Modifier key code");
421         RNA_def_property_update(prop, NC_LOGIC, NULL);
422         
423         prop= RNA_def_property(srna, "modifier_key_2", PROP_ENUM, PROP_NONE);
424         RNA_def_property_enum_sdna(prop, NULL, "qual2");
425         RNA_def_property_enum_items(prop, event_type_items);
426         RNA_def_property_enum_funcs(prop, NULL, "rna_Sensor_keyboard_modifier2_set", NULL);
427         RNA_def_property_ui_text(prop, "Second Modifier Key", "Modifier key code");
428         RNA_def_property_update(prop, NC_LOGIC, NULL);
429
430         prop= RNA_def_property(srna, "target", PROP_STRING, PROP_NONE);
431         RNA_def_property_string_sdna(prop, NULL, "targetName");
432         RNA_def_property_ui_text(prop, "Target", "Property that receive the keystrokes in case a string is logged");
433         RNA_def_property_update(prop, NC_LOGIC, NULL);
434
435         prop= RNA_def_property(srna, "log", PROP_STRING, PROP_NONE);
436         RNA_def_property_string_sdna(prop, NULL, "toggleName");
437         RNA_def_property_ui_text(prop, "Log Toggle", "Property that indicates whether to log keystrokes as a string");
438         RNA_def_property_update(prop, NC_LOGIC, NULL);
439
440         prop= RNA_def_property(srna, "use_all_keys", PROP_BOOLEAN, PROP_NONE);
441         RNA_def_property_boolean_sdna(prop, NULL, "type", 1);
442         RNA_def_property_ui_text(prop, "All Keys", "Trigger this sensor on any keystroke");
443         RNA_def_property_update(prop, NC_LOGIC, NULL);
444 }
445
446 static void rna_def_property_sensor(BlenderRNA *brna)
447 {
448         StructRNA *srna;
449         PropertyRNA *prop;
450         static EnumPropertyItem prop_type_items[] ={
451                 {SENS_PROP_EQUAL, "PROPEQUAL", 0, "Equal", ""},
452                 {SENS_PROP_NEQUAL, "PROPNEQUAL", 0, "Not Equal", ""},
453                 {SENS_PROP_INTERVAL, "PROPINTERVAL", 0, "Interval", ""},
454                 {SENS_PROP_CHANGED, "PROPCHANGED", 0, "Changed", ""},
455                 /* {SENS_PROP_EXPRESSION, "PROPEXPRESSION", 0, "Expression", ""},  NOT_USED_IN_UI */
456                 {0, NULL, 0, NULL, NULL}};
457
458         srna= RNA_def_struct(brna, "PropertySensor", "Sensor");
459         RNA_def_struct_ui_text(srna, "Property Sensor", "Sensor to detect values and changes in values of properties");
460         RNA_def_struct_sdna_from(srna, "bPropertySensor", "data");
461
462         prop= RNA_def_property(srna, "evaluation_type", PROP_ENUM, PROP_NONE);
463         RNA_def_property_enum_sdna(prop, NULL, "type");
464         RNA_def_property_enum_items(prop, prop_type_items);
465         RNA_def_property_ui_text(prop, "Evaluation Type", "Type of property evaluation");
466         RNA_def_property_update(prop, NC_LOGIC, NULL);
467
468         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
469         RNA_def_property_string_sdna(prop, NULL, "name");
470         RNA_def_property_ui_text(prop, "Property", "");
471         RNA_def_property_update(prop, NC_LOGIC, NULL);
472
473         prop= RNA_def_property(srna, "value", PROP_STRING, PROP_NONE);
474         RNA_def_property_string_sdna(prop, NULL, "value");
475         RNA_def_property_ui_text(prop, "Value", "Check for this value in types in Equal or Not Equal types");
476         RNA_def_property_update(prop, NC_LOGIC, NULL);
477
478         prop= RNA_def_property(srna, "value_min", PROP_STRING, PROP_NONE);
479         RNA_def_property_string_sdna(prop, NULL, "value");
480         RNA_def_property_ui_text(prop, "Minimum Value", "Specify minimum value in Interval type");
481         RNA_def_property_update(prop, NC_LOGIC, NULL);
482
483         prop= RNA_def_property(srna, "value_max", PROP_STRING, PROP_NONE);
484         RNA_def_property_string_sdna(prop, NULL, "maxvalue");
485         RNA_def_property_ui_text(prop, "Maximum Value", "Specify maximum value in Interval type");
486         RNA_def_property_update(prop, NC_LOGIC, NULL);
487 }
488
489 static void rna_def_armature_sensor(BlenderRNA *brna)
490 {
491         StructRNA *srna;
492         PropertyRNA *prop;
493         static EnumPropertyItem prop_type_items[] ={
494                 {SENS_ARM_STATE_CHANGED, "STATECHG", 0, "State Changed", ""},
495                 {SENS_ARM_LIN_ERROR_BELOW, "LINERRORBELOW", 0, "Lin error below", ""},
496                 {SENS_ARM_LIN_ERROR_ABOVE, "LINERRORABOVE", 0, "Lin error above", ""},
497                 {SENS_ARM_ROT_ERROR_BELOW, "ROTERRORBELOW", 0, "Rot error below", ""},
498                 {SENS_ARM_ROT_ERROR_ABOVE, "ROTERRORABOVE", 0, "Rot error above", ""},
499                 {0, NULL, 0, NULL, NULL}};
500
501         srna= RNA_def_struct(brna, "ArmatureSensor", "Sensor");
502         RNA_def_struct_ui_text(srna, "Armature Sensor", "Sensor to detect values and changes in values of IK solver");
503         RNA_def_struct_sdna_from(srna, "bArmatureSensor", "data");
504
505         prop= RNA_def_property(srna, "test_type", PROP_ENUM, PROP_NONE);
506         RNA_def_property_enum_sdna(prop, NULL, "type");
507         RNA_def_property_enum_items(prop, prop_type_items);
508         RNA_def_property_ui_text(prop, "Test", "Type of value and test");
509         RNA_def_property_update(prop, NC_LOGIC, NULL);
510
511         prop= RNA_def_property(srna, "bone", PROP_STRING, PROP_NONE);
512         RNA_def_property_string_sdna(prop, NULL, "posechannel");
513         RNA_def_property_ui_text(prop, "Bone Name", "Identify the bone to check value from");
514         RNA_def_property_update(prop, NC_LOGIC, "rna_Sensor_Armature_update");
515
516         prop= RNA_def_property(srna, "constraint", PROP_STRING, PROP_NONE);
517         RNA_def_property_string_sdna(prop, NULL, "constraint");
518         RNA_def_property_ui_text(prop, "Constraint Name", "Identify the bone constraint to check value from");
519         RNA_def_property_update(prop, NC_LOGIC, "rna_Sensor_Armature_update");
520
521         prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
522         RNA_def_property_float_sdna(prop, NULL, "value");
523         RNA_def_property_ui_text(prop, "Compare Value", "Specify value to be used in comparison");
524         RNA_def_property_update(prop, NC_LOGIC, NULL);
525 }
526
527 static void rna_def_actuator_sensor(BlenderRNA *brna)
528 {
529         StructRNA *srna;
530         PropertyRNA *prop;
531
532         srna= RNA_def_struct(brna, "ActuatorSensor", "Sensor");
533         RNA_def_struct_ui_text(srna, "Actuator Sensor", "Sensor to detect state modifications of actuators");
534         RNA_def_struct_sdna_from(srna, "bActuatorSensor", "data");
535
536         // XXX if eventually have Logics using RNA 100%, we could use the actuator datablock isntead of its name
537         prop= RNA_def_property(srna, "actuator", PROP_STRING, PROP_NONE);
538         RNA_def_property_string_sdna(prop, NULL, "name");
539         RNA_def_property_ui_text(prop, "Actuator", "Actuator name, actuator active state modifications will be detected");
540         RNA_def_property_update(prop, NC_LOGIC, NULL);
541 }
542
543 static void rna_def_delay_sensor(BlenderRNA *brna)
544 {
545         StructRNA *srna;
546         PropertyRNA *prop;
547
548         srna= RNA_def_struct(brna, "DelaySensor", "Sensor");
549         RNA_def_struct_ui_text(srna, "Delay Sensor", "Sensor to send delayed events");
550         RNA_def_struct_sdna_from(srna, "bDelaySensor", "data");
551
552         prop= RNA_def_property(srna, "delay", PROP_INT, PROP_NONE);
553         RNA_def_property_ui_text(prop, "Delay", "Delay in number of logic tics before the positive trigger (default 60 per second)");
554         RNA_def_property_range(prop, 0, 5000);
555         RNA_def_property_update(prop, NC_LOGIC, NULL);
556
557         prop= RNA_def_property(srna, "duration", PROP_INT, PROP_NONE);
558         RNA_def_property_ui_text(prop, "Duration", "If >0, delay in number of logic tics before the negative trigger following the positive trigger");
559         RNA_def_property_range(prop, 0, 5000);
560         RNA_def_property_update(prop, NC_LOGIC, NULL);
561
562         prop= RNA_def_property(srna, "use_repeat", PROP_BOOLEAN, PROP_NONE);
563         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_DELAY_REPEAT);
564         RNA_def_property_ui_text(prop, "Repeat", "Toggle repeat option. If selected, the sensor restarts after Delay+Dur logic tics");
565         RNA_def_property_update(prop, NC_LOGIC, NULL);
566 }
567
568 static void rna_def_collision_sensor(BlenderRNA *brna)
569 {
570         StructRNA *srna;
571         PropertyRNA *prop;
572
573         srna= RNA_def_struct(brna, "CollisionSensor", "Sensor");
574         RNA_def_struct_ui_text(srna, "Collision Sensor", "Sensor to detect objects colliding with the current object, with more settings than the Touch sensor");
575         RNA_def_struct_sdna_from(srna, "bCollisionSensor", "data");
576
577         prop= RNA_def_property(srna, "use_pulse", PROP_BOOLEAN, PROP_NONE);
578         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_COLLISION_PULSE);
579         RNA_def_property_ui_text(prop, "Pulse", "Changes to the set of colliding objects generates pulse");
580         RNA_def_property_update(prop, NC_LOGIC, NULL);
581
582         prop= RNA_def_property(srna, "use_material", PROP_BOOLEAN, PROP_NONE);
583         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_COLLISION_MATERIAL);
584         RNA_def_property_ui_text(prop, "M/P", "Toggle collision on material or property");
585         RNA_def_property_update(prop, NC_LOGIC, NULL);
586
587         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
588         RNA_def_property_string_sdna(prop, NULL, "name");
589         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property (blank = all objects)");
590         RNA_def_property_update(prop, NC_LOGIC, NULL);
591
592         //XXX to make a setFunction to create a lookup with all materials in Blend File (not only this object mat.)
593         prop= RNA_def_property(srna, "material", PROP_STRING, PROP_NONE);
594         RNA_def_property_string_sdna(prop, NULL, "materialName");
595         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material (blank = all objects)");
596         RNA_def_property_update(prop, NC_LOGIC, NULL);
597
598 /*//XXX either use a datablock look up to store the string name (material)
599   // or to do a doversion and use a material pointer.
600         prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
601         RNA_def_property_struct_type(prop, "Material");
602         RNA_def_property_flag(prop, PROP_EDITABLE);
603         RNA_def_property_pointer_sdna(prop, NULL, "ma");
604         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material (blank = all objects)");
605 */
606 }
607
608 static void rna_def_radar_sensor(BlenderRNA *brna)
609 {
610         StructRNA *srna;
611         PropertyRNA *prop;
612         static EnumPropertyItem axis_items[] ={
613                 {SENS_RADAR_X_AXIS, "XAXIS", 0, "+X axis", ""},
614                 {SENS_RADAR_Y_AXIS, "YAXIS", 0, "+Y axis", ""},
615                 {SENS_RADAR_Z_AXIS, "ZAXIS", 0, "+Z axis", ""},
616                 {SENS_RADAR_NEG_X_AXIS, "NEGXAXIS", 0, "-X axis", ""},
617                 {SENS_RADAR_NEG_Y_AXIS, "NEGYAXIS", 0, "-Y axis", ""},
618                 {SENS_RADAR_NEG_Z_AXIS, "NEGZAXIS", 0, "-Z axis", ""},
619                 {0, NULL, 0, NULL, NULL}};
620
621         srna= RNA_def_struct(brna, "RadarSensor", "Sensor");
622         RNA_def_struct_ui_text(srna, "Radar Sensor", "Sensor to detect objects in a cone shaped radar emanating from the current object");
623         RNA_def_struct_sdna_from(srna, "bRadarSensor", "data");
624
625         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
626         RNA_def_property_string_sdna(prop, NULL, "name");
627         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property (blank = all objects)");
628         RNA_def_property_update(prop, NC_LOGIC, NULL);
629
630         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
631         RNA_def_property_enum_items(prop, axis_items);
632         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the radar cone is cast");
633         RNA_def_property_update(prop, NC_LOGIC, NULL);
634
635         //XXX TODO - use radians internally then change to PROP_ANGLE
636         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_NONE);
637         RNA_def_property_range(prop, 0.0, 179.9);
638         RNA_def_property_ui_text(prop, "Angle", "Opening angle of the radar cone (in degrees)");
639         RNA_def_property_update(prop, NC_LOGIC, NULL);
640
641         prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
642         RNA_def_property_float_sdna(prop, NULL, "range");
643         RNA_def_property_range(prop, 0.0, 10000.0);
644         RNA_def_property_ui_text(prop, "Distance", "Depth of the radar cone");
645         RNA_def_property_update(prop, NC_LOGIC, NULL);
646 }
647
648 static void rna_def_random_sensor(BlenderRNA *brna)
649 {
650         StructRNA *srna;
651         PropertyRNA *prop;
652
653         srna= RNA_def_struct(brna, "RandomSensor", "Sensor");
654         RNA_def_struct_ui_text(srna, "Random Sensor", "Sensor to send random events");
655         RNA_def_struct_sdna_from(srna, "bRandomSensor", "data");
656
657         prop= RNA_def_property(srna, "seed", PROP_INT, PROP_NONE);
658         RNA_def_property_range(prop, 0, 1000);
659         RNA_def_property_ui_text(prop, "Seed", "Initial seed of the generator. (Choose 0 for not random)");
660         RNA_def_property_update(prop, NC_LOGIC, NULL);
661 }
662
663 static void rna_def_ray_sensor(BlenderRNA *brna)
664 {
665         StructRNA *srna;
666         PropertyRNA *prop;
667         static EnumPropertyItem axis_items[] ={
668                 {SENS_RAY_X_AXIS, "XAXIS", 0, "+X axis", ""},
669                 {SENS_RAY_Y_AXIS, "YAXIS", 0, "+Y axis", ""},
670                 {SENS_RAY_Z_AXIS, "ZAXIS", 0, "+Z axis", ""},
671                 {SENS_RAY_NEG_X_AXIS, "NEGXAXIS", 0, "-X axis", ""},
672                 {SENS_RAY_NEG_Y_AXIS, "NEGYAXIS", 0, "-Y axis", ""},
673                 {SENS_RAY_NEG_Z_AXIS, "NEGZAXIS", 0, "-Z axis", ""},
674                 {0, NULL, 0, NULL, NULL}};
675         
676         static const EnumPropertyItem prop_ray_type_items[]= {
677                 {SENS_COLLISION_PROPERTY, "PROPERTY", ICON_LOGIC, "Property", "Use a material for ray intersections"},
678                 {SENS_COLLISION_MATERIAL, "MATERIAL", ICON_MATERIAL_DATA, "Material", "Use a property for ray intersections"},
679                 {0, NULL, 0, NULL, NULL}};
680
681         srna= RNA_def_struct(brna, "RaySensor", "Sensor");
682         RNA_def_struct_ui_text(srna, "Ray Sensor", "Sensor to detect intersections with a ray emanating from the current object");
683         RNA_def_struct_sdna_from(srna, "bRaySensor", "data");
684         
685         prop= RNA_def_property(srna, "ray_type", PROP_ENUM, PROP_NONE);
686         RNA_def_property_enum_bitflag_sdna(prop, NULL, "mode");
687         RNA_def_property_enum_items(prop, prop_ray_type_items);
688         RNA_def_property_ui_text(prop, "Ray Type", "Toggle collision on material or property");
689         RNA_def_property_update(prop, NC_LOGIC, NULL);
690
691         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
692         RNA_def_property_string_sdna(prop, NULL, "propname");
693         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property (blank = all objects)");
694         RNA_def_property_update(prop, NC_LOGIC, NULL);
695
696         prop= RNA_def_property(srna, "material", PROP_STRING, PROP_NONE);
697         RNA_def_property_string_sdna(prop, NULL, "matname");
698         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material (blank = all objects)");
699         RNA_def_property_update(prop, NC_LOGIC, NULL);
700
701         /* //XXX either use a datablock look up to store the string name (material)
702            // or to do a doversion and use a material pointer.
703         prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
704         RNA_def_property_struct_type(prop, "Material");
705         RNA_def_property_flag(prop, PROP_EDITABLE);
706         RNA_def_property_pointer_sdna(prop, NULL, "ma");
707         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material (blank = all objects)");
708 */
709
710         prop= RNA_def_property(srna, "use_x_ray", PROP_BOOLEAN, PROP_NONE);
711         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_RAY_XRAY);
712         RNA_def_property_ui_text(prop, "X-Ray Mode", "Toggle X-Ray option (see through objects that don't have the property)");
713         RNA_def_property_update(prop, NC_LOGIC, NULL);
714
715         prop= RNA_def_property(srna, "range", PROP_FLOAT, PROP_NONE);
716         RNA_def_property_range(prop, 0.01, 10000.0);
717         RNA_def_property_ui_text(prop, "Range", "Sense objects no farther than this distance");
718         RNA_def_property_update(prop, NC_LOGIC, NULL);
719
720         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
721         RNA_def_property_enum_sdna(prop, NULL, "axisflag");
722         RNA_def_property_enum_items(prop, axis_items);
723         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the ray is cast");
724         RNA_def_property_update(prop, NC_LOGIC, NULL);
725 }
726
727 static void rna_def_message_sensor(BlenderRNA *brna)
728 {
729         StructRNA *srna;
730         PropertyRNA *prop;
731
732         srna= RNA_def_struct(brna, "MessageSensor", "Sensor");
733         RNA_def_struct_ui_text(srna, "Message Sensor", "Sensor to detect incoming messages");
734         RNA_def_struct_sdna_from(srna, "bMessageSensor", "data");
735
736         prop= RNA_def_property(srna, "subject", PROP_STRING, PROP_NONE);
737         RNA_def_property_ui_text(prop, "Subject", "Optional subject filter: only accept messages with this subject, or empty for all");
738         RNA_def_property_update(prop, NC_LOGIC, NULL);
739 }
740
741 static void rna_def_joystick_sensor(BlenderRNA *brna)
742 {
743         StructRNA *srna;
744         PropertyRNA *prop;
745
746         static EnumPropertyItem event_type_items[] ={
747                 {SENS_JOY_BUTTON, "BUTTON", 0, "Button", ""},
748                 {SENS_JOY_AXIS, "AXIS", 0, "Axis", ""},
749                 {SENS_JOY_HAT, "HAT", 0, "Hat", ""},
750                 {SENS_JOY_AXIS_SINGLE, "AXIS_SINGLE", 0, "Single Axis", ""},
751                 {0, NULL, 0, NULL, NULL}};
752
753         static EnumPropertyItem axis_direction_items[] ={
754                 {SENS_JOY_X_AXIS, "RIGHTAXIS", 0, "Right Axis", ""},
755                 {SENS_JOY_Y_AXIS, "UPAXIS", 0, "Up Axis", ""},
756                 {SENS_JOY_NEG_X_AXIS, "LEFTAXIS", 0, "Left Axis", ""},
757                 {SENS_JOY_NEG_Y_AXIS, "DOWNAXIS", 0, "Down Axis", ""},
758                 {0, NULL, 0, NULL, NULL}};
759
760         static EnumPropertyItem hat_direction_items[] ={
761                 {SENS_JOY_HAT_UP, "UP", 0, "Up", ""},
762                 {SENS_JOY_HAT_DOWN, "DOWN", 0, "Down", ""},
763                 {SENS_JOY_HAT_LEFT, "LEFT", 0, "Left", ""},
764                 {SENS_JOY_HAT_RIGHT, "RIGHT", 0, "Right", ""},
765
766                 {SENS_JOY_HAT_UP_RIGHT, "UPRIGHT", 0, "Up/Right", ""},
767                 {SENS_JOY_HAT_DOWN_LEFT, "DOWNLEFT", 0, "Down/Left", ""},
768                 {SENS_JOY_HAT_UP_LEFT, "UPLEFT", 0, "Up/Left", ""},
769                 {SENS_JOY_HAT_DOWN_RIGHT, "DOWNRIGHT", 0, "Down/Right", ""},
770                 {0, NULL, 0, NULL, NULL}};
771
772         srna= RNA_def_struct(brna, "JoystickSensor", "Sensor");
773         RNA_def_struct_ui_text(srna, "Joystick Sensor", "Sensor to detect joystick events");
774         RNA_def_struct_sdna_from(srna, "bJoystickSensor", "data");
775         
776         prop= RNA_def_property(srna, "joystick_index", PROP_INT, PROP_NONE);
777         RNA_def_property_int_sdna(prop, NULL, "joyindex");
778         RNA_def_property_ui_text(prop, "Index", "Specify which joystick to use");
779         RNA_def_property_range(prop, 0, SENS_JOY_MAXINDEX-1);
780         RNA_def_property_update(prop, NC_LOGIC, NULL);
781
782         prop= RNA_def_property(srna, "event_type", PROP_ENUM, PROP_NONE);
783         RNA_def_property_enum_sdna(prop, NULL, "type");
784         RNA_def_property_enum_items(prop, event_type_items);
785         RNA_def_property_ui_text(prop, "Event Type", "The type of event this joystick sensor is triggered on");
786         RNA_def_property_update(prop, NC_LOGIC, NULL);
787
788         prop= RNA_def_property(srna, "use_all_events", PROP_BOOLEAN, PROP_NONE);
789         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_JOY_ANY_EVENT);
790         RNA_def_property_ui_text(prop, "All Events", "Triggered by all events on this joysticks current type (axis/button/hat)");
791         RNA_def_property_update(prop, NC_LOGIC, NULL);
792
793         /* Button */
794         prop= RNA_def_property(srna, "button_number", PROP_INT, PROP_NONE);
795         RNA_def_property_int_sdna(prop, NULL, "button");
796         RNA_def_property_ui_text(prop, "Button Number", "Specify which button to use");
797         RNA_def_property_range(prop, 0, 18);
798         RNA_def_property_update(prop, NC_LOGIC, NULL);
799
800         /* Axis */
801         prop= RNA_def_property(srna, "axis_number", PROP_INT, PROP_NONE);
802         RNA_def_property_int_sdna(prop, NULL, "axis");
803         RNA_def_property_ui_text(prop, "Axis Number", "Specify which axis pair to use, 1 is usually the main direction input");
804         RNA_def_property_range(prop, 1, 8);
805         RNA_def_property_update(prop, NC_LOGIC, NULL);
806
807         prop= RNA_def_property(srna, "axis_threshold", PROP_INT, PROP_NONE);
808         RNA_def_property_int_sdna(prop, NULL, "precision");
809         RNA_def_property_ui_text(prop, "Axis Threshold", "Specify the precision of the axis");
810         RNA_def_property_range(prop, 0, 32768);
811         RNA_def_property_update(prop, NC_LOGIC, NULL);
812
813         prop= RNA_def_property(srna, "axis_direction", PROP_ENUM, PROP_NONE);
814         RNA_def_property_enum_sdna(prop, NULL, "axisf");
815         RNA_def_property_enum_items(prop, axis_direction_items);
816         RNA_def_property_ui_text(prop, "Axis Direction", "The direction of the axis");
817         RNA_def_property_update(prop, NC_LOGIC, NULL);
818
819         /* Single Axis */
820         prop= RNA_def_property(srna, "single_axis_number", PROP_INT, PROP_NONE);
821         RNA_def_property_int_sdna(prop, NULL, "axis_single");
822         RNA_def_property_ui_text(prop, "Axis Number", "Specify a single axis (verticle/horizontal/other) to detect");
823         RNA_def_property_range(prop, 1, 16);
824         RNA_def_property_update(prop, NC_LOGIC, NULL);
825
826         /* Hat */
827         prop= RNA_def_property(srna, "hat_number", PROP_INT, PROP_NONE);
828         RNA_def_property_int_sdna(prop, NULL, "hat");
829         RNA_def_property_ui_text(prop, "Hat Number", "Specify which hat to use");
830         RNA_def_property_range(prop, 1, 2);
831         RNA_def_property_update(prop, NC_LOGIC, NULL);
832
833         prop= RNA_def_property(srna, "hat_direction", PROP_ENUM, PROP_NONE);
834         RNA_def_property_enum_sdna(prop, NULL, "hatf");
835         RNA_def_property_enum_items(prop, hat_direction_items);
836         RNA_def_property_ui_text(prop, "Hat Direction", "Specify hat direction");
837         RNA_def_property_update(prop, NC_LOGIC, NULL);
838 }
839
840 void RNA_def_sensor(BlenderRNA *brna)
841 {
842         rna_def_sensor(brna);
843
844         rna_def_always_sensor(brna);
845         rna_def_near_sensor(brna);
846         rna_def_mouse_sensor(brna);
847         rna_def_touch_sensor(brna);
848         rna_def_keyboard_sensor(brna);
849         rna_def_property_sensor(brna);
850         rna_def_armature_sensor(brna);
851         rna_def_actuator_sensor(brna);
852         rna_def_delay_sensor(brna);
853         rna_def_collision_sensor(brna);
854         rna_def_radar_sensor(brna);
855         rna_def_random_sensor(brna);
856         rna_def_ray_sensor(brna);
857         rna_def_message_sensor(brna);
858         rna_def_joystick_sensor(brna);
859 }
860
861 #endif
862