BGE patch 18065: gameobj mass writeable + setmass actuator. This patch allows to...
[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 mass;
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         char frameProp[32];     /* Set this property to the actions current frame */
117         
118         short pad1, cur, butsta, butend;
119         
120 } bIpoActuator;
121
122 typedef struct bCameraActuator {
123         struct Object *ob;
124         float height, min, max;
125         float fac;
126         short flag, axis;
127         float visifac;
128 } bCameraActuator ;
129
130 typedef struct bConstraintActuator {
131         short type, mode;
132         short flag, damp;
133         short time, rotdamp;
134         int pad;
135         float minloc[3], maxloc[3];
136         float minrot[3], maxrot[3];
137         char matprop[32];
138 } bConstraintActuator;
139
140 typedef struct bGroupActuator {
141         short flag, type;
142         int sta, end;
143         char name[32];          /* property or groupkey */
144         
145         short pad[3], cur, butsta, butend;/* not referenced, can remove? */
146         struct Group *group;            /* only during game */
147         
148 } bGroupActuator;
149
150 /* I added a few extra fields here, to facilitate conversions                */
151 typedef struct bRandomActuator {
152         int  seed;
153         int   distribution;
154         int int_arg_1;
155         int int_arg_2;
156         float float_arg_1;
157         float float_arg_2;
158         char  propname[32];
159 } bRandomActuator;
160
161 typedef struct bMessageActuator {
162         /**
163          * Send to all objects with this propertyname. Empty to broadcast.
164          */
165         char toPropName[32];
166
167         /**
168          * (Possible future use) pointer to a single destination object.
169          */
170         struct Object *toObject;
171
172         /**
173          * Message Subject to send.
174          */
175         char subject[32];
176
177         /**
178          * bodyType is either 'User defined text' or PropName
179          */
180         short bodyType, pad1;
181         int pad2;
182
183         /**
184          * Either User Defined Text or our PropName to send value of
185          */
186         char body[32];
187 } bMessageActuator;
188
189 typedef struct bGameActuator {
190         short flag, type;
191         int sta, end;
192         char filename[64];
193         char loadaniname[64];
194 } bGameActuator;
195
196 typedef struct bVisibilityActuator {
197         /** bit 0: Is this object visible? 
198          ** bit 1: Apply recursively  */
199         int flag;
200 } bVisibilityActuator;
201
202 typedef struct bTwoDFilterActuator{
203         char pad[4];
204         /* Tells what type of 2D Filter */
205         short type;
206         /* (flag == 0) means 2D filter is activate and
207            (flag != 0) means 2D filter is inactive */
208         short flag;
209         int   int_arg;
210         /* a float argument */
211         float float_arg;
212         struct Text *text;
213 }bTwoDFilterActuator;
214
215 typedef struct bParentActuator {
216         char pad[4];
217         int type;
218         struct Object *ob;
219 } bParentActuator;
220
221 typedef struct bStateActuator {
222         int type;                       /* 0=Set, 1=Add, 2=Rem, 3=Chg */
223         unsigned int mask;      /* the bits to change */
224 } bStateActuator;
225
226 typedef struct bActuator {
227         struct bActuator *next, *prev, *mynew;
228         short type;
229         /**
230          * Tells what type of actuator data <data> holds. 
231          */
232         short flag;
233         short otype, go;
234         char name[32];
235
236         /**
237          * Data must point to an object actuator type struct.
238          */
239         void *data;
240
241         /**
242          * For ipo's and props: to find out which object the actuator
243          * belongs to */
244         struct Object *ob;              
245         
246 } bActuator;
247
248 typedef struct FreeCamera {
249         float mass, accelleration;
250         float maxspeed, maxrotspeed,  maxtiltspeed;
251         int flag;
252         float rotdamp, tiltdamp, speeddamp, pad;
253 } FreeCamera;
254
255 /* objectactuator->flag */
256 #define ACT_FORCE_LOCAL                 1
257 #define ACT_TORQUE_LOCAL                2
258 #define ACT_SERVO_LIMIT_X               2
259 #define ACT_DLOC_LOCAL                  4
260 #define ACT_SERVO_LIMIT_Y               4
261 #define ACT_DROT_LOCAL                  8
262 #define ACT_SERVO_LIMIT_Z               8
263 #define ACT_LIN_VEL_LOCAL               16
264 #define ACT_ANG_VEL_LOCAL               32
265 //#define ACT_ADD_LIN_VEL_LOCAL 64
266 #define ACT_ADD_LIN_VEL                 64
267
268 /* objectactuator->type */
269 #define ACT_OBJECT_NORMAL       0
270 #define ACT_OBJECT_SERVO        1
271
272 /* actuator->type */
273 #define ACT_OBJECT              0
274 #define ACT_IPO                 1
275 #define ACT_LAMP                2
276 #define ACT_CAMERA              3
277 #define ACT_MATERIAL    4
278 #define ACT_SOUND               5
279 #define ACT_PROPERTY    6
280         /* these two obsolete since 2.02 */
281 #define ACT_ADD_OBJECT  7
282 #define ACT_END_OBJECT  8
283
284 #define ACT_CONSTRAINT  9
285 #define ACT_EDIT_OBJECT 10
286 #define ACT_SCENE               11
287 #define ACT_GROUP               12
288 #define ACT_RANDOM      13
289 #define ACT_MESSAGE     14
290 #define ACT_ACTION              15      /* __ NLA */
291 #define ACT_CD                  16
292 #define ACT_GAME                17
293 #define ACT_VISIBILITY          18
294 #define ACT_2DFILTER    19
295 #define ACT_PARENT      20
296 #define ACT_SHAPEACTION 21
297 #define ACT_STATE               22
298
299 /* actuator flag */
300 #define ACT_SHOW                1
301 #define ACT_DEL                 2
302 #define ACT_NEW                 4
303 #define ACT_LINKED              8       
304 #define ACT_VISIBLE             16      
305 #define ACT_PIN                 32
306
307 /* link codes */
308 #define LINK_SENSOR             0
309 #define LINK_CONTROLLER 1
310 #define LINK_ACTUATOR   2
311
312 /* keyboardsensor->type */
313 #define SENS_ALL_KEYS   1
314
315 /* actionactuator->type */
316 #define ACT_ACTION_PLAY                 0
317 #define ACT_ACTION_PINGPONG             1
318 #define ACT_ACTION_FLIPPER              2
319 #define ACT_ACTION_LOOP_STOP    3
320 #define ACT_ACTION_LOOP_END             4
321 #define ACT_ACTION_KEY2KEY              5
322 #define ACT_ACTION_FROM_PROP    6
323 #define ACT_ACTION_MOTION               7
324
325 /* ipoactuator->type */
326 #define ACT_IPO_PLAY            0
327 #define ACT_IPO_PINGPONG        1
328 #define ACT_IPO_FLIPPER         2
329 #define ACT_IPO_LOOP_STOP       3
330 #define ACT_IPO_LOOP_END        4
331 #define ACT_IPO_KEY2KEY         5
332 #define ACT_IPO_FROM_PROP       6
333
334 /* groupactuator->type */
335 #define ACT_GROUP_PLAY          0
336 #define ACT_GROUP_PINGPONG      1
337 #define ACT_GROUP_FLIPPER       2
338 #define ACT_GROUP_LOOP_STOP     3
339 #define ACT_GROUP_LOOP_END      4
340 #define ACT_GROUP_FROM_PROP     5
341 #define ACT_GROUP_SET           6
342
343 /* ipoactuator->flag */
344 #define ACT_IPOFORCE        (1 << 0)
345 #define ACT_IPOEND          (1 << 1)
346 #define ACT_IPOLOCAL            (1 << 2)
347 #define ACT_IPOCHILD        (1 << 4)    
348 #define ACT_IPOADD                      (1 << 5)
349
350 /* ipoactuator->flag for k2k */
351 #define ACT_K2K_PREV            1
352 #define ACT_K2K_CYCLIC          2
353 #define ACT_K2K_PINGPONG        4
354 #define ACT_K2K_HOLD            8
355
356 /* property actuator->type */
357 #define ACT_PROP_ASSIGN         0
358 #define ACT_PROP_ADD            1
359 #define ACT_PROP_COPY           2
360
361 /* constraint flag */
362 #define ACT_CONST_LOCX          1
363 #define ACT_CONST_LOCY          2
364 #define ACT_CONST_LOCZ          4
365 #define ACT_CONST_ROTX          8
366 #define ACT_CONST_ROTY          16
367 #define ACT_CONST_ROTZ          32
368 #define ACT_CONST_NORMAL        64
369 #define ACT_CONST_MATERIAL      128
370 #define ACT_CONST_PERMANENT 256
371 #define ACT_CONST_DISTANCE      512
372 #define ACT_CONST_LOCAL     1024
373 #define ACT_CONST_DOROTFH       2048
374
375 /* constraint mode */
376 #define ACT_CONST_DIRPX         1
377 #define ACT_CONST_DIRPY         2
378 #define ACT_CONST_DIRPZ         4
379 #define ACT_CONST_DIRNX         8
380 #define ACT_CONST_DIRNY         16
381 #define ACT_CONST_DIRNZ         32
382
383 /* constraint type */
384 #define ACT_CONST_TYPE_LOC      0
385 #define ACT_CONST_TYPE_DIST     1
386 #define ACT_CONST_TYPE_ORI      2
387 #define ACT_CONST_TYPE_FH   3
388
389 /* editObjectActuator->type */
390 #define ACT_EDOB_ADD_OBJECT             0
391 #define ACT_EDOB_END_OBJECT             1
392 #define ACT_EDOB_REPLACE_MESH           2
393 #define ACT_EDOB_TRACK_TO               3
394 #define ACT_EDOB_DYNAMICS               4
395
396 /* editObjectActuator->localflag */
397 #define ACT_EDOB_LOCAL_LINV             2
398 #define ACT_EDOB_LOCAL_ANGV             4
399
400
401 /* editObjectActuator->flag */
402 #define ACT_TRACK_3D                    1
403
404 /* SceneActuator->type */
405 #define ACT_SCENE_RESTART               0
406 #define ACT_SCENE_SET                   1
407 #define ACT_SCENE_CAMERA                2
408 #define ACT_SCENE_ADD_FRONT             3
409 #define ACT_SCENE_ADD_BACK              4
410 #define ACT_SCENE_REMOVE                5
411 #define ACT_SCENE_SUSPEND               6
412 #define ACT_SCENE_RESUME                7
413
414
415 /* randomAct->distribution */
416 #define ACT_RANDOM_BOOL_CONST                  0
417 #define ACT_RANDOM_BOOL_UNIFORM                1
418 #define ACT_RANDOM_BOOL_BERNOUILLI             2
419 #define ACT_RANDOM_INT_CONST                   3
420 #define ACT_RANDOM_INT_UNIFORM                 4
421 #define ACT_RANDOM_INT_POISSON                     5
422 #define ACT_RANDOM_FLOAT_CONST                 6
423 #define ACT_RANDOM_FLOAT_UNIFORM               7
424 #define ACT_RANDOM_FLOAT_NORMAL                8
425 #define ACT_RANDOM_FLOAT_NEGATIVE_EXPONENTIAL  9
426
427 /*  SoundActuator->type */
428 #define ACT_SND_PLAY_STOP_SOUND         0
429 #define ACT_SND_PLAY_END_SOUND          1
430 #define ACT_SND_LOOP_STOP_SOUND         2
431 #define ACT_SND_LOOP_END_SOUND          3
432 #define ACT_SND_LOOP_BIDIRECTIONAL_SOUND                4
433 #define ACT_SND_LOOP_BIDIRECTIONAL_STOP_SOUND   5
434
435 /* messageactuator->type */
436 #define ACT_MESG_MESG           0
437 #define ACT_MESG_PROP           1
438
439 /* cdactuator->type */
440 #define ACT_CD_PLAY_ALL         0
441 #define ACT_CD_PLAY_TRACK       1
442 #define ACT_CD_LOOP_TRACK       2
443 #define ACT_CD_VOLUME           3
444 #define ACT_CD_STOP                     4
445 #define ACT_CD_PAUSE            5
446 #define ACT_CD_RESUME           6
447
448 /* gameactuator->type */
449 #define ACT_GAME_LOAD           0
450 #define ACT_GAME_START          1
451 #define ACT_GAME_RESTART        2
452 #define ACT_GAME_QUIT           3
453 #define ACT_GAME_SAVECFG        4
454 #define ACT_GAME_LOADCFG        5
455
456 /* visibilityact->flag */
457 /* Set means the object will become invisible */
458 #define ACT_VISIBILITY_INVISIBLE       (1 << 0)
459 #define ACT_VISIBILITY_RECURSIVE       (1 << 1)
460
461 /* twodfilter->type */
462 #define ACT_2DFILTER_ENABLED                    -2
463 #define ACT_2DFILTER_DISABLED                   -1
464 #define ACT_2DFILTER_NOFILTER                   0
465 #define ACT_2DFILTER_MOTIONBLUR                 1
466 #define ACT_2DFILTER_BLUR                               2
467 #define ACT_2DFILTER_SHARPEN                    3
468 #define ACT_2DFILTER_DILATION                   4
469 #define ACT_2DFILTER_EROSION                    5
470 #define ACT_2DFILTER_LAPLACIAN                  6
471 #define ACT_2DFILTER_SOBEL                              7
472 #define ACT_2DFILTER_PREWITT                    8
473 #define ACT_2DFILTER_GRAYSCALE                  9
474 #define ACT_2DFILTER_SEPIA                              10
475 #define ACT_2DFILTER_INVERT                             11
476 #define ACT_2DFILTER_CUSTOMFILTER               12
477 #define ACT_2DFILTER_NUMBER_OF_FILTERS  13
478
479 /* parentactuator->type */
480 #define ACT_PARENT_SET      0
481 #define ACT_PARENT_REMOVE   1
482 #endif
483
484