get/set Angular velocity for KX_GameObjects python api and for the AddObject actuator.
[blender.git] / source / blender / makesdna / DNA_actuator_types.h
1 /**
2  * blenlib/DNA_actuator_types.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef DNA_ACTUATOR_TYPES_H
32 #define DNA_ACTUATOR_TYPES_H
33
34 struct Object;
35 struct Mesh;
36 struct Scene;
37 struct Group;
38 struct Text;
39
40 /* ****************** ACTUATORS ********************* */
41
42 /* unused now, moved to editobjectactuator in 2.02. Still needed for dna */
43 typedef struct bAddObjectActuator {
44         int time, pad;
45         struct Object *ob;
46 } bAddObjectActuator;
47
48 typedef struct bActionActuator {                                                                
49         struct bAction *act;    /* Pointer to action */                         
50         short   type, flag;             /* Playback type */                                     
51         int     sta, end;               /* Start & End frames */                        
52         char    name[32];               /* For property-driven playback */      
53         char    frameProp[32];  /* Set this property to the actions current frame */
54         short   blendin;                /* Number of frames of blending */
55         short   priority;               /* Execution priority */
56         short   end_reset;      /* Ending the actuator (negative pulse) wont reset the the action to its starting frame */
57         short   strideaxis;             /* Displacement axis */
58         float   stridelength;   /* Displacement incurred by cycle */
59 } bActionActuator;                                                                                              
60
61 typedef struct bSoundActuator {
62         short flag, sndnr;
63         int sta, end;
64         short pad1[2];
65         struct bSound *sound;
66         short type, makecopy;
67         short copymade, pad2[1];
68 } bSoundActuator;
69
70 typedef struct bCDActuator {
71         short flag, sndnr;
72         int sta, end;
73         short type, track;
74         float volume;
75 } bCDActuator;
76
77 typedef struct bEditObjectActuator {
78         int time;
79         short type, flag;
80         struct Object *ob;
81         struct Mesh *me;
82         char name[32];
83         float linVelocity[3]; /* initial lin. velocity on creation */
84         float angVelocity[3]; /* initial ang. velocity on creation */
85         float pad;
86         short localflag; /* flag for the lin & ang. vel: apply locally   */
87         short dyn_operation;
88 } bEditObjectActuator;
89
90 typedef struct bSceneActuator {
91         short type, flag;
92         int pad;
93         struct Scene *scene;
94         struct Object *camera;
95 } bSceneActuator;
96
97 typedef struct bPropertyActuator {
98         int flag, type;
99         char name[32], value[32];
100         struct Object *ob;
101 } bPropertyActuator;
102
103 typedef struct bObjectActuator {
104         short flag, type, otype;
105         short damping;
106         float forceloc[3], forcerot[3];
107         float loc[3], rot[3];
108         float dloc[3], drot[3];
109         float linearvelocity[3], angularvelocity[3];
110 } bObjectActuator;
111
112 typedef struct bIpoActuator {
113         short flag, type;
114         int sta, end;
115         char name[32];
116         
117         short pad1, cur, butsta, butend;
118         
119 } bIpoActuator;
120
121 typedef struct bCameraActuator {
122         struct Object *ob;
123         float height, min, max;
124         float fac;
125         short flag, axis;
126         float visifac;
127 } bCameraActuator ;
128
129 typedef struct bConstraintActuator {
130         short type, mode;
131         short flag, damp;
132         short time, rotdamp;
133         int pad;
134         float minloc[3], maxloc[3];
135         float minrot[3], maxrot[3];
136         char matprop[32];
137 } bConstraintActuator;
138
139 typedef struct bGroupActuator {
140         short flag, type;
141         int sta, end;
142         char name[32];          /* property or groupkey */
143         
144         short pad[3], cur, butsta, butend;/* not referenced, can remove? */
145         struct Group *group;            /* only during game */
146         
147 } bGroupActuator;
148
149 /* I added a few extra fields here, to facilitate conversions                */
150 typedef struct bRandomActuator {
151         int  seed;
152         int   distribution;
153         int int_arg_1;
154         int int_arg_2;
155         float float_arg_1;
156         float float_arg_2;
157         char  propname[32];
158 } bRandomActuator;
159
160 typedef struct bMessageActuator {
161         /**
162          * Send to all objects with this propertyname. Empty to broadcast.
163          */
164         char toPropName[32];
165
166         /**
167          * (Possible future use) pointer to a single destination object.
168          */
169         struct Object *toObject;
170
171         /**
172          * Message Subject to send.
173          */
174         char subject[32];
175
176         /**
177          * bodyType is either 'User defined text' or PropName
178          */
179         short bodyType, pad1;
180         int pad2;
181
182         /**
183          * Either User Defined Text or our PropName to send value of
184          */
185         char body[32];
186 } bMessageActuator;
187
188 typedef struct bGameActuator {
189         short flag, type;
190         int sta, end;
191         char filename[64];
192         char loadaniname[64];
193 } bGameActuator;
194
195 typedef struct bVisibilityActuator {
196         /** bit 0: Is this object visible? */
197         int flag;
198 } bVisibilityActuator;
199
200 typedef struct bTwoDFilterActuator{
201         char pad[4];
202         /* Tells what type of 2D Filter */
203         short type;
204         /* (flag == 0) means 2D filter is activate and
205            (flag != 0) means 2D filter is inactive */
206         short flag;
207         int   int_arg;
208         /* a float argument */
209         float float_arg;
210         struct Text *text;
211 }bTwoDFilterActuator;
212
213 typedef struct bParentActuator {
214         char pad[4];
215         int type;
216         struct Object *ob;
217 } bParentActuator;
218
219 typedef struct bStateActuator {
220         int type;                       /* 0=Set, 1=Add, 2=Rem, 3=Chg */
221         unsigned int mask;      /* the bits to change */
222 } bStateActuator;
223
224 typedef struct bActuator {
225         struct bActuator *next, *prev, *mynew;
226         short type;
227         /**
228          * Tells what type of actuator data <data> holds. 
229          */
230         short flag;
231         short otype, go;
232         char name[32];
233
234         /**
235          * Data must point to an object actuator type struct.
236          */
237         void *data;
238
239         /**
240          * For ipo's and props: to find out which object the actuator
241          * belongs to */
242         struct Object *ob;              
243         
244 } bActuator;
245
246 typedef struct FreeCamera {
247         float mass, accelleration;
248         float maxspeed, maxrotspeed,  maxtiltspeed;
249         int flag;
250         float rotdamp, tiltdamp, speeddamp, pad;
251 } FreeCamera;
252
253 /* objectactuator->flag */
254 #define ACT_FORCE_LOCAL                 1
255 #define ACT_TORQUE_LOCAL                2
256 #define ACT_SERVO_LIMIT_X               2
257 #define ACT_DLOC_LOCAL                  4
258 #define ACT_SERVO_LIMIT_Y               4
259 #define ACT_DROT_LOCAL                  8
260 #define ACT_SERVO_LIMIT_Z               8
261 #define ACT_LIN_VEL_LOCAL               16
262 #define ACT_ANG_VEL_LOCAL               32
263 //#define ACT_ADD_LIN_VEL_LOCAL 64
264 #define ACT_ADD_LIN_VEL                 64
265
266 /* objectactuator->type */
267 #define ACT_OBJECT_NORMAL       0
268 #define ACT_OBJECT_SERVO        1
269
270 /* actuator->type */
271 #define ACT_OBJECT              0
272 #define ACT_IPO                 1
273 #define ACT_LAMP                2
274 #define ACT_CAMERA              3
275 #define ACT_MATERIAL    4
276 #define ACT_SOUND               5
277 #define ACT_PROPERTY    6
278         /* these two obsolete since 2.02 */
279 #define ACT_ADD_OBJECT  7
280 #define ACT_END_OBJECT  8
281
282 #define ACT_CONSTRAINT  9
283 #define ACT_EDIT_OBJECT 10
284 #define ACT_SCENE               11
285 #define ACT_GROUP               12
286 #define ACT_RANDOM      13
287 #define ACT_MESSAGE     14
288 #define ACT_ACTION              15      /* __ NLA */
289 #define ACT_CD                  16
290 #define ACT_GAME                17
291 #define ACT_VISIBILITY          18
292 #define ACT_2DFILTER    19
293 #define ACT_PARENT      20
294 #define ACT_SHAPEACTION 21
295 #define ACT_STATE               22
296
297 /* actuator flag */
298 #define ACT_SHOW                1
299 #define ACT_DEL                 2
300 #define ACT_NEW                 4
301 #define ACT_LINKED              8       
302 #define ACT_VISIBLE             16      
303
304 /* link codes */
305 #define LINK_SENSOR             0
306 #define LINK_CONTROLLER 1
307 #define LINK_ACTUATOR   2
308
309 /* keyboardsensor->type */
310 #define SENS_ALL_KEYS   1
311
312 /* actionactuator->type */
313 #define ACT_ACTION_PLAY                 0
314 #define ACT_ACTION_PINGPONG             1
315 #define ACT_ACTION_FLIPPER              2
316 #define ACT_ACTION_LOOP_STOP    3
317 #define ACT_ACTION_LOOP_END             4
318 #define ACT_ACTION_KEY2KEY              5
319 #define ACT_ACTION_FROM_PROP    6
320 #define ACT_ACTION_MOTION               7
321
322 /* ipoactuator->type */
323 #define ACT_IPO_PLAY            0
324 #define ACT_IPO_PINGPONG        1
325 #define ACT_IPO_FLIPPER         2
326 #define ACT_IPO_LOOP_STOP       3
327 #define ACT_IPO_LOOP_END        4
328 #define ACT_IPO_KEY2KEY         5
329 #define ACT_IPO_FROM_PROP       6
330
331 /* groupactuator->type */
332 #define ACT_GROUP_PLAY          0
333 #define ACT_GROUP_PINGPONG      1
334 #define ACT_GROUP_FLIPPER       2
335 #define ACT_GROUP_LOOP_STOP     3
336 #define ACT_GROUP_LOOP_END      4
337 #define ACT_GROUP_FROM_PROP     5
338 #define ACT_GROUP_SET           6
339
340 /* ipoactuator->flag */
341 #define ACT_IPOFORCE        (1 << 0)
342 #define ACT_IPOEND          (1 << 1)
343 #define ACT_IPOLOCAL            (1 << 2)
344 #define ACT_IPOCHILD        (1 << 4)    
345 #define ACT_IPOADD                      (1 << 5)
346
347 /* ipoactuator->flag for k2k */
348 #define ACT_K2K_PREV            1
349 #define ACT_K2K_CYCLIC          2
350 #define ACT_K2K_PINGPONG        4
351 #define ACT_K2K_HOLD            8
352
353 /* property actuator->type */
354 #define ACT_PROP_ASSIGN         0
355 #define ACT_PROP_ADD            1
356 #define ACT_PROP_COPY           2
357
358 /* constraint flag */
359 #define ACT_CONST_LOCX          1
360 #define ACT_CONST_LOCY          2
361 #define ACT_CONST_LOCZ          4
362 #define ACT_CONST_ROTX          8
363 #define ACT_CONST_ROTY          16
364 #define ACT_CONST_ROTZ          32
365 #define ACT_CONST_NORMAL        64
366 #define ACT_CONST_MATERIAL      128
367 #define ACT_CONST_PERMANENT 256
368 #define ACT_CONST_DISTANCE      512
369 /* constraint mode */
370 #define ACT_CONST_DIRPX         1
371 #define ACT_CONST_DIRPY         2
372 #define ACT_CONST_DIRPZ         4
373 #define ACT_CONST_DIRNX         8
374 #define ACT_CONST_DIRNY         16
375 #define ACT_CONST_DIRNZ         32
376
377 /* constraint type */
378 #define ACT_CONST_TYPE_LOC      0
379 #define ACT_CONST_TYPE_DIST     1
380 #define ACT_CONST_TYPE_ORI      2
381
382 /* editObjectActuator->type */
383 #define ACT_EDOB_ADD_OBJECT             0
384 #define ACT_EDOB_END_OBJECT             1
385 #define ACT_EDOB_REPLACE_MESH           2
386 #define ACT_EDOB_TRACK_TO               3
387 #define ACT_EDOB_DYNAMICS               4
388
389 /* editObjectActuator->localflag */
390 #define ACT_EDOB_LOCAL_LINV             2
391 #define ACT_EDOB_LOCAL_ANGV             4
392
393
394 /* editObjectActuator->flag */
395 #define ACT_TRACK_3D                    1
396
397 /* SceneActuator->type */
398 #define ACT_SCENE_RESTART               0
399 #define ACT_SCENE_SET                   1
400 #define ACT_SCENE_CAMERA                2
401 #define ACT_SCENE_ADD_FRONT             3
402 #define ACT_SCENE_ADD_BACK              4
403 #define ACT_SCENE_REMOVE                5
404 #define ACT_SCENE_SUSPEND               6
405 #define ACT_SCENE_RESUME                7
406
407
408 /* randomAct->distribution */
409 #define ACT_RANDOM_BOOL_CONST                  0
410 #define ACT_RANDOM_BOOL_UNIFORM                1
411 #define ACT_RANDOM_BOOL_BERNOUILLI             2
412 #define ACT_RANDOM_INT_CONST                   3
413 #define ACT_RANDOM_INT_UNIFORM                 4
414 #define ACT_RANDOM_INT_POISSON                     5
415 #define ACT_RANDOM_FLOAT_CONST                 6
416 #define ACT_RANDOM_FLOAT_UNIFORM               7
417 #define ACT_RANDOM_FLOAT_NORMAL                8
418 #define ACT_RANDOM_FLOAT_NEGATIVE_EXPONENTIAL  9
419
420 /*  SoundActuator->type */
421 #define ACT_SND_PLAY_STOP_SOUND         0
422 #define ACT_SND_PLAY_END_SOUND          1
423 #define ACT_SND_LOOP_STOP_SOUND         2
424 #define ACT_SND_LOOP_END_SOUND          3
425 #define ACT_SND_LOOP_BIDIRECTIONAL_SOUND                4
426 #define ACT_SND_LOOP_BIDIRECTIONAL_STOP_SOUND   5
427
428 /* messageactuator->type */
429 #define ACT_MESG_MESG           0
430 #define ACT_MESG_PROP           1
431
432 /* cdactuator->type */
433 #define ACT_CD_PLAY_ALL         0
434 #define ACT_CD_PLAY_TRACK       1
435 #define ACT_CD_LOOP_TRACK       2
436 #define ACT_CD_VOLUME           3
437 #define ACT_CD_STOP                     4
438 #define ACT_CD_PAUSE            5
439 #define ACT_CD_RESUME           6
440
441 /* gameactuator->type */
442 #define ACT_GAME_LOAD           0
443 #define ACT_GAME_START          1
444 #define ACT_GAME_RESTART        2
445 #define ACT_GAME_QUIT           3
446
447 /* visibilityact->flag */
448 /* Set means the object will become invisible */
449 #define ACT_VISIBILITY_INVISIBLE       (1 << 0)
450
451 /* twodfilter->type */
452 #define ACT_2DFILTER_ENABLED                    -2
453 #define ACT_2DFILTER_DISABLED                   -1
454 #define ACT_2DFILTER_NOFILTER                   0
455 #define ACT_2DFILTER_MOTIONBLUR                 1
456 #define ACT_2DFILTER_BLUR                               2
457 #define ACT_2DFILTER_SHARPEN                    3
458 #define ACT_2DFILTER_DILATION                   4
459 #define ACT_2DFILTER_EROSION                    5
460 #define ACT_2DFILTER_LAPLACIAN                  6
461 #define ACT_2DFILTER_SOBEL                              7
462 #define ACT_2DFILTER_PREWITT                    8
463 #define ACT_2DFILTER_GRAYSCALE                  9
464 #define ACT_2DFILTER_SEPIA                              10
465 #define ACT_2DFILTER_INVERT                             11
466 #define ACT_2DFILTER_CUSTOMFILTER               12
467 #define ACT_2DFILTER_NUMBER_OF_FILTERS  13
468
469 /* parentactuator->type */
470 #define ACT_PARENT_SET      0
471 #define ACT_PARENT_REMOVE   1
472 #endif
473
474