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