Merge with trunk, revision 28528 - 28976.
[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 = 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 = 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 = 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 #else
232
233 static void rna_def_sensor(BlenderRNA *brna)
234 {
235         StructRNA *srna;
236         PropertyRNA *prop;
237
238         srna= RNA_def_struct(brna, "Sensor", NULL);
239         RNA_def_struct_ui_text(srna, "Sensor", "Game engine logic brick to detect events");
240         RNA_def_struct_sdna(srna, "bSensor");
241         RNA_def_struct_refine_func(srna, "rna_Sensor_refine");
242
243         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
244         RNA_def_property_ui_text(prop, "Name", "Sensor name");
245         RNA_def_struct_name_property(srna, prop);
246         RNA_def_property_update(prop, NC_LOGIC, NULL);
247
248         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
249         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
250         RNA_def_property_enum_items(prop, sensor_type_items);
251         RNA_def_property_enum_funcs(prop, NULL, "rna_Sensor_type_set", "rna_Sensor_type_itemf");
252         RNA_def_property_ui_text(prop, "Type", "");
253         RNA_def_property_update(prop, NC_LOGIC, NULL);
254
255         prop= RNA_def_property(srna, "expanded", PROP_BOOLEAN, PROP_NONE);
256         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_SHOW);
257         RNA_def_property_ui_text(prop, "Expanded", "Set sensor expanded in the user interface");
258         RNA_def_property_ui_icon(prop, ICON_TRIA_RIGHT, 1);
259         RNA_def_property_update(prop, NC_LOGIC, NULL);
260
261         prop= RNA_def_property(srna, "invert", PROP_BOOLEAN, PROP_NONE);
262         RNA_def_property_ui_text(prop, "Invert Output", "Invert the level(output) of this sensor");
263         RNA_def_property_update(prop, NC_LOGIC, NULL);
264
265         prop= RNA_def_property(srna, "level", PROP_BOOLEAN, PROP_NONE);
266         RNA_def_property_ui_text(prop, "Level", "Level detector, trigger controllers of new states(only applicable upon logic state transition)");
267         RNA_def_property_boolean_funcs(prop, NULL, "rna_Sensor_level_set");
268         RNA_def_property_update(prop, NC_LOGIC, NULL);
269
270         prop= RNA_def_property(srna, "pulse_true_level", PROP_BOOLEAN, PROP_NONE);
271         RNA_def_property_boolean_sdna(prop, NULL, "pulse", SENS_PULSE_REPEAT);
272         RNA_def_property_ui_text(prop, "Pulse True Level", "Activate TRUE level triggering (pulse mode)");
273         RNA_def_property_update(prop, NC_LOGIC, NULL);
274
275         prop= RNA_def_property(srna, "pulse_false_level", PROP_BOOLEAN, PROP_NONE);
276         RNA_def_property_boolean_sdna(prop, NULL, "pulse", SENS_NEG_PULSE_MODE);
277         RNA_def_property_ui_text(prop, "Pulse False Level", "Activate FALSE level triggering (pulse mode)");
278         RNA_def_property_update(prop, NC_LOGIC, NULL);
279         
280         prop= RNA_def_property(srna, "frequency", PROP_INT, PROP_NONE);
281         RNA_def_property_int_sdna(prop, NULL, "freq");
282         RNA_def_property_ui_text(prop, "Frequency", "Delay between repeated pulses(in logic tics, 0=no delay)");
283         RNA_def_property_range(prop, 0, 10000);
284         RNA_def_property_update(prop, NC_LOGIC, NULL);
285
286         prop= RNA_def_property(srna, "tap", PROP_BOOLEAN, PROP_NONE);
287         RNA_def_property_boolean_sdna(prop, NULL, "tap", 1);
288         RNA_def_property_boolean_funcs(prop, NULL, "rna_Sensor_tap_set");
289         RNA_def_property_ui_text(prop, "Tap", "Trigger controllers only for an instant, even while the sensor remains true");
290         RNA_def_property_update(prop, NC_LOGIC, NULL);
291 }
292
293 static void rna_def_always_sensor(BlenderRNA *brna)
294 {
295         StructRNA *srna;
296         srna= RNA_def_struct(brna, "AlwaysSensor", "Sensor");
297         RNA_def_struct_ui_text(srna, "Always Sensor", "Sensor to generate continuous pulses");
298 }
299
300 static void rna_def_near_sensor(BlenderRNA *brna)
301 {
302         StructRNA *srna;
303         PropertyRNA *prop;
304
305         srna= RNA_def_struct(brna, "NearSensor", "Sensor");
306         RNA_def_struct_ui_text(srna , "Near Sensor", "Sensor to detect nearby objects");
307         RNA_def_struct_sdna_from(srna, "bNearSensor", "data");
308
309         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
310         RNA_def_property_string_sdna(prop, NULL, "name");
311         RNA_def_property_ui_text(prop, "Property", "Only look for objects with this property");
312         RNA_def_property_update(prop, NC_LOGIC, NULL);
313
314         prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
315         RNA_def_property_float_sdna(prop, NULL, "dist");
316         RNA_def_property_ui_text(prop, "Distance", "Trigger distance");
317         RNA_def_property_range(prop, 0.0f, 10000.0f);
318         RNA_def_property_update(prop, NC_LOGIC, NULL);
319
320         prop= RNA_def_property(srna, "reset_distance", PROP_FLOAT, PROP_NONE);
321         RNA_def_property_float_sdna(prop, NULL, "resetdist");
322         RNA_def_property_ui_text(prop, "Reset Distance", "");
323         RNA_def_property_range(prop, 0.0f, 10000.0f);
324         RNA_def_property_update(prop, NC_LOGIC, NULL);
325 }
326
327 static void rna_def_mouse_sensor(BlenderRNA *brna)
328 {
329         StructRNA *srna;
330         PropertyRNA *prop;
331
332         static EnumPropertyItem mouse_event_items[] ={
333                 {BL_SENS_MOUSE_LEFT_BUTTON, "LEFTCLICK", 0, "Left Button", ""},
334                 {BL_SENS_MOUSE_MIDDLE_BUTTON, "MIDDLECLICK", 0, "Middle Button", ""},
335                 {BL_SENS_MOUSE_RIGHT_BUTTON, "RIGHTCLICK", 0, "Right Button", ""},
336                 {BL_SENS_MOUSE_WHEEL_UP, "WHEELUP", 0, "Wheel Up", ""},
337                 {BL_SENS_MOUSE_WHEEL_DOWN, "WHEELDOWN", 0, "Wheel Down", ""},
338                 {BL_SENS_MOUSE_MOVEMENT, "MOVEMENT", 0, "Movement", ""},
339                 {BL_SENS_MOUSE_MOUSEOVER, "MOUSEOVER", 0, "Mouse Over", ""},
340                 {BL_SENS_MOUSE_MOUSEOVER_ANY, "MOUSEOVERANY", 0, "Mouse Over Any", ""},
341                 {0, NULL, 0, NULL, NULL}};
342
343         srna= RNA_def_struct(brna, "MouseSensor", "Sensor");
344         RNA_def_struct_ui_text(srna, "Mouse Sensor", "Sensor to detect mouse events");
345         RNA_def_struct_sdna_from(srna, "bMouseSensor", "data");
346
347         prop= RNA_def_property(srna, "mouse_event", PROP_ENUM, PROP_NONE);
348         RNA_def_property_enum_sdna(prop, NULL, "type");
349         RNA_def_property_enum_items(prop, mouse_event_items);
350         RNA_def_property_ui_text(prop, "Mouse Event", "Specify the type of event this mouse sensor should trigger on");
351         RNA_def_property_update(prop, NC_LOGIC, NULL);
352 }
353
354 static void rna_def_touch_sensor(BlenderRNA *brna)
355 {
356         StructRNA *srna;
357         PropertyRNA *prop;
358
359         srna= RNA_def_struct(brna, "TouchSensor", "Sensor");
360         RNA_def_struct_ui_text(srna, "Touch Sensor", "Sensor to detect objects colliding with the current object");
361         RNA_def_struct_sdna_from(srna, "bTouchSensor", "data");
362
363         prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
364         RNA_def_property_struct_type(prop, "Material");
365         RNA_def_property_pointer_sdna(prop, NULL, "ma");
366         RNA_def_property_flag(prop, PROP_EDITABLE);
367         RNA_def_property_ui_text(prop, "Material", "Only look for objects with this material");
368         RNA_def_property_update(prop, NC_LOGIC, NULL);
369 }
370
371 static void rna_def_keyboard_sensor(BlenderRNA *brna)
372 {
373         StructRNA *srna;
374         PropertyRNA *prop;
375
376         srna= RNA_def_struct(brna, "KeyboardSensor", "Sensor");
377         RNA_def_struct_ui_text(srna, "Keyboard Sensor", "Sensor to detect keyboard events");
378         RNA_def_struct_sdna_from(srna, "bKeyboardSensor", "data");
379
380         prop= RNA_def_property(srna, "key", PROP_ENUM, PROP_NONE);
381         RNA_def_property_enum_sdna(prop, NULL, "key");
382         RNA_def_property_enum_items(prop, event_type_items);
383         RNA_def_property_enum_funcs(prop, NULL, "rna_Sensor_keyboard_key_set", NULL);
384         RNA_def_property_ui_text(prop, "Key",  "");
385         RNA_def_property_update(prop, NC_LOGIC, NULL);
386         
387         prop= RNA_def_property(srna, "modifier_key", PROP_ENUM, PROP_NONE);
388         RNA_def_property_enum_sdna(prop, NULL, "qual");
389         RNA_def_property_enum_items(prop, event_type_items);
390         RNA_def_property_enum_funcs(prop, NULL, "rna_Sensor_keyboard_modifier_set", NULL);
391         RNA_def_property_ui_text(prop, "Modifier Key", "Modifier key code");
392         RNA_def_property_update(prop, NC_LOGIC, NULL);
393         
394         prop= RNA_def_property(srna, "second_modifier_key", PROP_ENUM, PROP_NONE);
395         RNA_def_property_enum_sdna(prop, NULL, "qual2");
396         RNA_def_property_enum_items(prop, event_type_items);
397         RNA_def_property_enum_funcs(prop, NULL, "rna_Sensor_keyboard_modifier2_set", NULL);
398         RNA_def_property_ui_text(prop, "Second Modifier Key", "Modifier key code");
399         RNA_def_property_update(prop, NC_LOGIC, NULL);
400
401         prop= RNA_def_property(srna, "target", PROP_STRING, PROP_NONE);
402         RNA_def_property_string_sdna(prop, NULL, "targetName");
403         RNA_def_property_ui_text(prop, "Target", "Property that indicates whether to log keystrokes as a string");
404         RNA_def_property_update(prop, NC_LOGIC, NULL);
405
406         prop= RNA_def_property(srna, "log", PROP_STRING, PROP_NONE);
407         RNA_def_property_string_sdna(prop, NULL, "toggleName");
408         RNA_def_property_ui_text(prop, "Log Toggle", "Property that receive the keystrokes in case a string is logged");
409         RNA_def_property_update(prop, NC_LOGIC, NULL);
410
411         prop= RNA_def_property(srna, "all_keys", PROP_BOOLEAN, PROP_NONE);
412         RNA_def_property_boolean_sdna(prop, NULL, "type", 1);
413         RNA_def_property_ui_text(prop, "All Keys", "Trigger this sensor on any keystroke");
414         RNA_def_property_update(prop, NC_LOGIC, NULL);
415 }
416
417 static void rna_def_property_sensor(BlenderRNA *brna)
418 {
419         StructRNA *srna;
420         PropertyRNA *prop;
421         static EnumPropertyItem prop_type_items[] ={
422                 {SENS_PROP_EQUAL, "PROPEQUAL", 0, "Equal", ""},
423                 {SENS_PROP_NEQUAL, "PROPNEQUAL", 0, "Not Equal", ""},
424                 {SENS_PROP_INTERVAL, "PROPINTERVAL", 0, "Interval", ""},
425                 {SENS_PROP_CHANGED, "PROPCHANGED", 0, "Changed", ""},
426                 /* {SENS_PROP_EXPRESSION, "PROPEXPRESSION", 0, "Expression", ""},  NOT_USED_IN_UI */
427                 {0, NULL, 0, NULL, NULL}};
428
429         srna= RNA_def_struct(brna, "PropertySensor", "Sensor");
430         RNA_def_struct_ui_text(srna, "Property Sensor", "Sensor to detect values and changes in values of properties");
431         RNA_def_struct_sdna_from(srna, "bPropertySensor", "data");
432
433         prop= RNA_def_property(srna, "evaluation_type", PROP_ENUM, PROP_NONE);
434         RNA_def_property_enum_sdna(prop, NULL, "type");
435         RNA_def_property_enum_items(prop, prop_type_items);
436         RNA_def_property_ui_text(prop, "Evaluation Type", "Type of property evaluation");
437         RNA_def_property_update(prop, NC_LOGIC, NULL);
438
439         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
440         RNA_def_property_string_sdna(prop, NULL, "name");
441         RNA_def_property_ui_text(prop, "Property", "");
442         RNA_def_property_update(prop, NC_LOGIC, NULL);
443
444         prop= RNA_def_property(srna, "value", PROP_STRING, PROP_NONE);
445         RNA_def_property_string_sdna(prop, NULL, "value");
446         RNA_def_property_ui_text(prop, "Value", "Check for this value in types in Equal or Not Equal types");
447         RNA_def_property_update(prop, NC_LOGIC, NULL);
448
449         prop= RNA_def_property(srna, "min_value", PROP_STRING, PROP_NONE);
450         RNA_def_property_string_sdna(prop, NULL, "value");
451         RNA_def_property_ui_text(prop, "Minimum Value", "Specify minimum value in Interval type");
452         RNA_def_property_update(prop, NC_LOGIC, NULL);
453
454         prop= RNA_def_property(srna, "max_value", PROP_STRING, PROP_NONE);
455         RNA_def_property_string_sdna(prop, NULL, "maxvalue");
456         RNA_def_property_ui_text(prop, "Maximum Value", "Specify maximum value in Interval type");
457         RNA_def_property_update(prop, NC_LOGIC, NULL);
458 }
459
460 static void rna_def_armature_sensor(BlenderRNA *brna)
461 {
462         StructRNA *srna;
463         PropertyRNA *prop;
464         static EnumPropertyItem prop_type_items[] ={
465                 {SENS_ARM_STATE_CHANGED, "STATECHG", 0, "State Changed", ""},
466                 {SENS_ARM_LIN_ERROR_BELOW, "LINERRORBELOW", 0, "Lin error below", ""},
467                 {SENS_ARM_LIN_ERROR_ABOVE, "LINERRORABOVE", 0, "Lin error above", ""},
468                 {SENS_ARM_ROT_ERROR_BELOW, "ROTERRORBELOW", 0, "Rot error below", ""},
469                 {SENS_ARM_ROT_ERROR_ABOVE, "ROTERRORBELOW", 0, "Rot error above", ""},
470                 {0, NULL, 0, NULL, NULL}};
471
472         srna= RNA_def_struct(brna, "ArmatureSensor", "Sensor");
473         RNA_def_struct_ui_text(srna, "Armature Sensor", "Sensor to detect values and changes in values of IK solver");
474         RNA_def_struct_sdna_from(srna, "bArmatureSensor", "data");
475
476         prop= RNA_def_property(srna, "test_type", PROP_ENUM, PROP_NONE);
477         RNA_def_property_enum_sdna(prop, NULL, "type");
478         RNA_def_property_enum_items(prop, prop_type_items);
479         RNA_def_property_ui_text(prop, "Test Type", "Type of value and test");
480         RNA_def_property_update(prop, NC_LOGIC, NULL);
481
482         prop= RNA_def_property(srna, "bone", PROP_STRING, PROP_NONE);
483         RNA_def_property_string_sdna(prop, NULL, "posechannel");
484         RNA_def_property_ui_text(prop, "Bone name", "Identify the bone to check value from");
485         RNA_def_property_update(prop, NC_LOGIC, "rna_Sensor_Armature_update");
486
487         prop= RNA_def_property(srna, "constraint", PROP_STRING, PROP_NONE);
488         RNA_def_property_string_sdna(prop, NULL, "constraint");
489         RNA_def_property_ui_text(prop, "Constraint name", "Identify the bone constraint to check value from");
490         RNA_def_property_update(prop, NC_LOGIC, "rna_Sensor_Armature_update");
491
492         prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
493         RNA_def_property_float_sdna(prop, NULL, "value");
494         RNA_def_property_ui_text(prop, "Compare Value", "Specify value to be used in comparison");
495         RNA_def_property_update(prop, NC_LOGIC, NULL);
496 }
497
498 static void rna_def_actuator_sensor(BlenderRNA *brna)
499 {
500         StructRNA *srna;
501         PropertyRNA *prop;
502
503         srna= RNA_def_struct(brna, "ActuatorSensor", "Sensor");
504         RNA_def_struct_ui_text(srna, "Actuator Sensor", "Sensor to detect state modifications of actuators");
505         RNA_def_struct_sdna_from(srna, "bActuatorSensor", "data");
506
507         // XXX if eventually have Logics using RNA 100%, we could use the actuator datablock isntead of its name
508         prop= RNA_def_property(srna, "actuator", PROP_STRING, PROP_NONE);
509         RNA_def_property_string_sdna(prop, NULL, "name");
510         RNA_def_property_ui_text(prop, "Actuator", "Actuator name, actuator active state modifications will be detected");
511         RNA_def_property_update(prop, NC_LOGIC, NULL);
512 }
513
514 static void rna_def_delay_sensor(BlenderRNA *brna)
515 {
516         StructRNA *srna;
517         PropertyRNA *prop;
518
519         srna= RNA_def_struct(brna, "DelaySensor", "Sensor");
520         RNA_def_struct_ui_text(srna, "Delay Sensor", "Sensor to send delayed events");
521         RNA_def_struct_sdna_from(srna, "bDelaySensor", "data");
522
523         prop= RNA_def_property(srna, "delay", PROP_INT, PROP_NONE);
524         RNA_def_property_ui_text(prop, "Delay", "Delay in number of logic tics before the positive trigger (default 60 per second)");
525         RNA_def_property_range(prop, 0, 5000);
526         RNA_def_property_update(prop, NC_LOGIC, NULL);
527
528         prop= RNA_def_property(srna, "duration", PROP_INT, PROP_NONE);
529         RNA_def_property_ui_text(prop, "Duration", "If >0, delay in number of logic tics before the negative trigger following the positive trigger");
530         RNA_def_property_range(prop, 0, 5000);
531         RNA_def_property_update(prop, NC_LOGIC, NULL);
532
533         prop= RNA_def_property(srna, "repeat", PROP_BOOLEAN, PROP_NONE);
534         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_DELAY_REPEAT);
535         RNA_def_property_ui_text(prop, "Repeat", "Toggle repeat option. If selected, the sensor restarts after Delay+Dur logic tics");
536         RNA_def_property_update(prop, NC_LOGIC, NULL);
537 }
538
539 static void rna_def_collision_sensor(BlenderRNA *brna)
540 {
541         StructRNA *srna;
542         PropertyRNA *prop;
543
544         srna= RNA_def_struct(brna, "CollisionSensor", "Sensor");
545         RNA_def_struct_ui_text(srna, "Collision Sensor", "Sensor to detect objects colliding with the current object, with more settings than the Touch sensor");
546         RNA_def_struct_sdna_from(srna, "bCollisionSensor", "data");
547
548         prop= RNA_def_property(srna, "pulse", PROP_BOOLEAN, PROP_NONE);
549         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_COLLISION_PULSE);
550         RNA_def_property_ui_text(prop, "Pulse", "Changes to the set of colliding objects generates pulse");
551         RNA_def_property_update(prop, NC_LOGIC, NULL);
552
553         prop= RNA_def_property(srna, "collision_type", PROP_BOOLEAN, PROP_NONE);
554         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_COLLISION_MATERIAL);
555         RNA_def_property_ui_text(prop, "M/P", "Toggle collision on material or property");
556         RNA_def_property_update(prop, NC_LOGIC, NULL);
557
558         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
559         RNA_def_property_string_sdna(prop, NULL, "name");
560         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property");
561         RNA_def_property_update(prop, NC_LOGIC, NULL);
562
563         //XXX to make a setFunction to create a lookup with all materials in Blend File (not only this object mat.)
564         prop= RNA_def_property(srna, "material", PROP_STRING, PROP_NONE);
565         RNA_def_property_string_sdna(prop, NULL, "materialName");
566         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material");
567         RNA_def_property_update(prop, NC_LOGIC, NULL);
568
569 /*//XXX either use a datablock look up to store the string name (material)
570   // or to do a doversion and use a material pointer.
571         prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
572         RNA_def_property_struct_type(prop, "Material");
573         RNA_def_property_flag(prop, PROP_EDITABLE);
574         RNA_def_property_pointer_sdna(prop, NULL, "ma");
575         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material");
576 */
577 }
578
579 static void rna_def_radar_sensor(BlenderRNA *brna)
580 {
581         StructRNA *srna;
582         PropertyRNA *prop;
583         static EnumPropertyItem axis_items[] ={
584                 {SENS_RAY_X_AXIS, "XAXIS", 0, "+X axis", ""},
585                 {SENS_RAY_Y_AXIS, "YAXIS", 0, "+Y axis", ""},
586                 {SENS_RAY_Z_AXIS, "ZAXIS", 0, "+Z axis", ""},
587                 {SENS_RAY_NEG_X_AXIS, "NEGXAXIS", 0, "-X axis", ""},
588                 {SENS_RAY_NEG_Y_AXIS, "NEGYAXIS", 0, "-Y axis", ""},
589                 {SENS_RAY_NEG_Z_AXIS, "NEGZAXIS", 0, "-Z axis", ""},
590                 {0, NULL, 0, NULL, NULL}};
591
592         srna= RNA_def_struct(brna, "RadarSensor", "Sensor");
593         RNA_def_struct_ui_text(srna, "Radar Sensor", "Sensor to detect objects in a cone shaped radar emanating from the current object");
594         RNA_def_struct_sdna_from(srna, "bRadarSensor", "data");
595
596         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
597         RNA_def_property_string_sdna(prop, NULL, "name");
598         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property");
599         RNA_def_property_update(prop, NC_LOGIC, NULL);
600
601         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
602         RNA_def_property_enum_items(prop, axis_items);
603         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the radar cone is cast");
604         RNA_def_property_update(prop, NC_LOGIC, NULL);
605
606         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_NONE);
607         RNA_def_property_range(prop, 0.0, 179.9);
608         RNA_def_property_ui_text(prop, "Angle", "Opening angle of the radar cone");
609         RNA_def_property_update(prop, NC_LOGIC, NULL);
610
611         prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
612         RNA_def_property_float_sdna(prop, NULL, "range");
613         RNA_def_property_range(prop, 0.0, 10000.0);
614         RNA_def_property_ui_text(prop, "Distance", "Depth of the radar cone");
615         RNA_def_property_update(prop, NC_LOGIC, NULL);
616 }
617
618 static void rna_def_random_sensor(BlenderRNA *brna)
619 {
620         StructRNA *srna;
621         PropertyRNA *prop;
622
623         srna= RNA_def_struct(brna, "RandomSensor", "Sensor");
624         RNA_def_struct_ui_text(srna, "Random Sensor", "Sensor to send random events");
625         RNA_def_struct_sdna_from(srna, "bRandomSensor", "data");
626
627         prop= RNA_def_property(srna, "seed", PROP_INT, PROP_NONE);
628         RNA_def_property_range(prop, 0, 1000);
629         RNA_def_property_ui_text(prop, "Seed", "Initial seed of the generator. (Choose 0 for not random)");
630         RNA_def_property_update(prop, NC_LOGIC, NULL);
631 }
632
633 static void rna_def_ray_sensor(BlenderRNA *brna)
634 {
635         StructRNA *srna;
636         PropertyRNA *prop;
637         static EnumPropertyItem axis_items[] ={
638                 {SENS_RAY_X_AXIS, "XAXIS", 0, "+X axis", ""},
639                 {SENS_RAY_Y_AXIS, "YAXIS", 0, "+Y axis", ""},
640                 {SENS_RAY_Z_AXIS, "ZAXIS", 0, "+Z axis", ""},
641                 {SENS_RAY_NEG_X_AXIS, "NEGXAXIS", 0, "-X axis", ""},
642                 {SENS_RAY_NEG_Y_AXIS, "NEGYAXIS", 0, "-Y axis", ""},
643                 {SENS_RAY_NEG_Z_AXIS, "NEGZAXIS", 0, "-Z axis", ""},
644                 {0, NULL, 0, NULL, NULL}};
645         
646         static const EnumPropertyItem prop_ray_type_items[]= {
647                 {SENS_COLLISION_PROPERTY, "PROPERTY", ICON_LOGIC, "Property", "Use a material for ray intersections"},
648                 {SENS_COLLISION_MATERIAL, "MATERIAL", ICON_MATERIAL_DATA, "Material", "Use a property for ray intersections"},
649                 {0, NULL, 0, NULL, NULL}};
650
651         srna= RNA_def_struct(brna, "RaySensor", "Sensor");
652         RNA_def_struct_ui_text(srna, "Ray Sensor", "Sensor to detect intersections with a ray emanating from the current object");
653         RNA_def_struct_sdna_from(srna, "bRaySensor", "data");
654         
655         prop= RNA_def_property(srna, "ray_type", PROP_ENUM, PROP_NONE);
656         RNA_def_property_enum_bitflag_sdna(prop, NULL, "mode");
657         RNA_def_property_enum_items(prop, prop_ray_type_items);
658         RNA_def_property_ui_text(prop, "Ray Type", "Toggle collision on material or property");
659         RNA_def_property_update(prop, NC_LOGIC, NULL);
660
661         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
662         RNA_def_property_string_sdna(prop, NULL, "propname");
663         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property");
664         RNA_def_property_update(prop, NC_LOGIC, NULL);
665
666         prop= RNA_def_property(srna, "material", PROP_STRING, PROP_NONE);
667         RNA_def_property_string_sdna(prop, NULL, "matname");
668         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material");
669         RNA_def_property_update(prop, NC_LOGIC, NULL);
670
671         /* //XXX either use a datablock look up to store the string name (material)
672            // or to do a doversion and use a material pointer.
673         prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
674         RNA_def_property_struct_type(prop, "Material");
675         RNA_def_property_flag(prop, PROP_EDITABLE);
676         RNA_def_property_pointer_sdna(prop, NULL, "ma");
677         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material");
678 */
679
680         prop= RNA_def_property(srna, "x_ray_mode", PROP_BOOLEAN, PROP_NONE);
681         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_RAY_XRAY);
682         RNA_def_property_ui_text(prop, "X-Ray Mode", "Toggle X-Ray option (see through objects that don't have the property)");
683         RNA_def_property_update(prop, NC_LOGIC, NULL);
684
685         prop= RNA_def_property(srna, "range", PROP_FLOAT, PROP_NONE);
686         RNA_def_property_range(prop, 0.01, 10000.0);
687         RNA_def_property_ui_text(prop, "Range", "Sense objects no farther than this distance");
688         RNA_def_property_update(prop, NC_LOGIC, NULL);
689
690         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
691         RNA_def_property_enum_sdna(prop, NULL, "axisflag");
692         RNA_def_property_enum_items(prop, axis_items);
693         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the ray is cast");
694         RNA_def_property_update(prop, NC_LOGIC, NULL);
695 }
696
697 static void rna_def_message_sensor(BlenderRNA *brna)
698 {
699         StructRNA *srna;
700         PropertyRNA *prop;
701
702         srna= RNA_def_struct(brna, "MessageSensor", "Sensor");
703         RNA_def_struct_ui_text(srna, "Message Sensor", "Sensor to detect incoming messages");
704         RNA_def_struct_sdna_from(srna, "bMessageSensor", "data");
705
706         prop= RNA_def_property(srna, "subject", PROP_STRING, PROP_NONE);
707         RNA_def_property_ui_text(prop, "Subject", "Optional subject filter: only accept messages with this subject, or empty for all");
708         RNA_def_property_update(prop, NC_LOGIC, NULL);
709 }
710
711 static void rna_def_joystick_sensor(BlenderRNA *brna)
712 {
713         StructRNA *srna;
714         PropertyRNA *prop;
715
716         static EnumPropertyItem event_type_items[] ={
717                 {SENS_JOY_BUTTON, "BUTTON", 0, "Button", ""},
718                 {SENS_JOY_AXIS, "AXIS", 0, "Axis", ""},
719                 {SENS_JOY_HAT, "HAT", 0, "Hat", ""},
720                 {SENS_JOY_AXIS_SINGLE, "AXIS_SINGLE", 0, "Single Axis", ""},
721                 {0, NULL, 0, NULL, NULL}};
722
723         static EnumPropertyItem axis_direction_items[] ={
724                 {SENS_JOY_X_AXIS, "RIGHTAXIS", 0, "Right Axis", ""},
725                 {SENS_JOY_Y_AXIS, "UPAXIS", 0, "Up Axis", ""},
726                 {SENS_JOY_NEG_X_AXIS, "LEFTAXIS", 0, "Left Axis", ""},
727                 {SENS_JOY_NEG_Y_AXIS, "DOWNAXIS", 0, "Down Axis", ""},
728                 {0, NULL, 0, NULL, NULL}};
729
730         static EnumPropertyItem hat_direction_items[] ={
731                 {SENS_JOY_HAT_UP, "UP", 0, "Up", ""},
732                 {SENS_JOY_HAT_DOWN, "DOWN", 0, "Down", ""},
733                 {SENS_JOY_HAT_LEFT, "LEFT", 0, "Left", ""},
734                 {SENS_JOY_HAT_RIGHT, "RIGHT", 0, "Right", ""},
735
736                 {SENS_JOY_HAT_UP_RIGHT, "UPRIGHT", 0, "Up/Right", ""},
737                 {SENS_JOY_HAT_DOWN_LEFT, "DOWNLEFT", 0, "Down/Left", ""},
738                 {SENS_JOY_HAT_UP_LEFT, "UPLEFT", 0, "Up/Left", ""},
739                 {SENS_JOY_HAT_DOWN_RIGHT, "DOWNRIGHT", 0, "Down/Right", ""},
740                 {0, NULL, 0, NULL, NULL}};
741
742         srna= RNA_def_struct(brna, "JoystickSensor", "Sensor");
743         RNA_def_struct_ui_text(srna, "Joystick Sensor", "Sensor to detect joystick events");
744         RNA_def_struct_sdna_from(srna, "bJoystickSensor", "data");
745         
746         prop= RNA_def_property(srna, "joystick_index", PROP_INT, PROP_NONE);
747         RNA_def_property_int_sdna(prop, NULL, "joyindex");
748         RNA_def_property_ui_text(prop, "Index", "Specify which joystick to use");
749         RNA_def_property_range(prop, 0, SENS_JOY_MAXINDEX-1);
750         RNA_def_property_update(prop, NC_LOGIC, NULL);
751
752         prop= RNA_def_property(srna, "event_type", PROP_ENUM, PROP_NONE);
753         RNA_def_property_enum_sdna(prop, NULL, "type");
754         RNA_def_property_enum_items(prop, event_type_items);
755         RNA_def_property_ui_text(prop, "Event Type", "The type of event this joystick sensor is triggered on");
756         RNA_def_property_update(prop, NC_LOGIC, NULL);
757
758         prop= RNA_def_property(srna, "all_events", PROP_BOOLEAN, PROP_NONE);
759         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_JOY_ANY_EVENT);
760         RNA_def_property_ui_text(prop, "All Events", "Triggered by all events on this joysticks current type (axis/button/hat)");
761         RNA_def_property_update(prop, NC_LOGIC, NULL);
762
763         /* Button */
764         prop= RNA_def_property(srna, "button_number", PROP_INT, PROP_NONE);
765         RNA_def_property_int_sdna(prop, NULL, "button");
766         RNA_def_property_ui_text(prop, "Button Number", "Specify which button to use");
767         RNA_def_property_range(prop, 0, 18);
768         RNA_def_property_update(prop, NC_LOGIC, NULL);
769
770         /* Axis */
771         prop= RNA_def_property(srna, "axis_number", PROP_INT, PROP_NONE);
772         RNA_def_property_int_sdna(prop, NULL, "axis");
773         RNA_def_property_ui_text(prop, "Axis Number", "Specify which axis pair to use, 1 is usually the main direction input");
774         RNA_def_property_range(prop, 1, 2);
775         RNA_def_property_update(prop, NC_LOGIC, NULL);
776
777         prop= RNA_def_property(srna, "axis_threshold", PROP_INT, PROP_NONE);
778         RNA_def_property_int_sdna(prop, NULL, "precision");
779         RNA_def_property_ui_text(prop, "Axis Threshold", "Specify the precision of the axis");
780         RNA_def_property_range(prop, 0, 32768);
781         RNA_def_property_update(prop, NC_LOGIC, NULL);
782
783         prop= RNA_def_property(srna, "axis_direction", PROP_ENUM, PROP_NONE);
784         RNA_def_property_enum_sdna(prop, NULL, "axisf");
785         RNA_def_property_enum_items(prop, axis_direction_items);
786         RNA_def_property_ui_text(prop, "Axis Direction", "The direction of the axis");
787         RNA_def_property_update(prop, NC_LOGIC, NULL);
788
789         /* Single Axis */
790         prop= RNA_def_property(srna, "single_axis_number", PROP_INT, PROP_NONE);
791         RNA_def_property_int_sdna(prop, NULL, "axis_single");
792         RNA_def_property_ui_text(prop, "Axis Number", "Specify a single axis (verticle/horizontal/other) to detect");
793         RNA_def_property_range(prop, 1, 16);
794         RNA_def_property_update(prop, NC_LOGIC, NULL);
795
796         /* Hat */
797         prop= RNA_def_property(srna, "hat_number", PROP_INT, PROP_NONE);
798         RNA_def_property_int_sdna(prop, NULL, "hat");
799         RNA_def_property_ui_text(prop, "Hat Number", "Specify which hat to use");
800         RNA_def_property_range(prop, 1, 2);
801         RNA_def_property_update(prop, NC_LOGIC, NULL);
802
803         prop= RNA_def_property(srna, "hat_direction", PROP_ENUM, PROP_NONE);
804         RNA_def_property_enum_sdna(prop, NULL, "hatf");
805         RNA_def_property_enum_items(prop, hat_direction_items);
806         RNA_def_property_ui_text(prop, "Hat Direction", "Specify hat direction");
807         RNA_def_property_update(prop, NC_LOGIC, NULL);
808 }
809
810 void RNA_def_sensor(BlenderRNA *brna)
811 {
812         rna_def_sensor(brna);
813
814         rna_def_always_sensor(brna);
815         rna_def_near_sensor(brna);
816         rna_def_mouse_sensor(brna);
817         rna_def_touch_sensor(brna);
818         rna_def_keyboard_sensor(brna);
819         rna_def_property_sensor(brna);
820         rna_def_armature_sensor(brna);
821         rna_def_actuator_sensor(brna);
822         rna_def_delay_sensor(brna);
823         rna_def_collision_sensor(brna);
824         rna_def_radar_sensor(brna);
825         rna_def_random_sensor(brna);
826         rna_def_ray_sensor(brna);
827         rna_def_message_sensor(brna);
828         rna_def_joystick_sensor(brna);
829 }
830
831 #endif
832