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