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