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