Merge from trunk -r 23000:23968.
[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 // for Sound3D
41 #include "DNA_sound_types.h"
42
43 /* ****************** ACTUATORS ********************* */
44
45 /* unused now, moved to editobjectactuator in 2.02. Still needed for dna */
46 typedef struct bAddObjectActuator {
47         int time, pad;
48         struct Object *ob;
49 } bAddObjectActuator;
50
51 typedef struct bActionActuator {                                                                
52         struct bAction *act;    /* Pointer to action */                         
53         short   type, flag;             /* Playback type */                                     
54         int     sta, end;               /* Start & End frames */                        
55         char    name[32];               /* For property-driven playback */      
56         char    frameProp[32];  /* Set this property to the actions current frame */
57         short   blendin;                /* Number of frames of blending */
58         short   priority;               /* Execution priority */
59         short   end_reset;      /* Ending the actuator (negative pulse) wont reset the the action to its starting frame */
60         short   strideaxis;             /* Displacement axis */
61         float   stridelength;   /* Displacement incurred by cycle */
62 } bActionActuator;                                                                                              
63
64 typedef struct bSoundActuator {
65         short flag, sndnr;
66         int sta, end;
67         short pad1[2];
68         float volume, pitch;
69         struct bSound *sound;
70         struct Sound3D sound3D;
71         short type, makecopy;
72         short copymade, pad2[1];
73 } bSoundActuator;
74
75 typedef struct bEditObjectActuator {
76         int time;
77         short type, flag;
78         struct Object *ob;
79         struct Mesh *me;
80         char name[32];
81         float linVelocity[3]; /* initial lin. velocity on creation */
82         float angVelocity[3]; /* initial ang. velocity on creation */
83         float mass;
84         short localflag; /* flag for the lin & ang. vel: apply locally   */
85         short dyn_operation;
86 } bEditObjectActuator;
87
88 typedef struct bSceneActuator {
89         short type, flag;
90         int pad;
91         struct Scene *scene;
92         struct Object *camera;
93 } bSceneActuator;
94
95 typedef struct bPropertyActuator {
96         int flag, type;
97         char name[32], value[32];
98         struct Object *ob;
99 } bPropertyActuator;
100
101 typedef struct bObjectActuator {
102         short flag, type, otype;
103         short damping;
104         float forceloc[3], forcerot[3];
105         float loc[3], rot[3];
106         float dloc[3], drot[3];
107         float linearvelocity[3], angularvelocity[3];
108         struct Object *reference;
109 } bObjectActuator;
110
111 typedef struct bIpoActuator {
112         short flag, type;
113         int sta, end;
114         char name[32];
115         char frameProp[32];     /* Set this property to the actions current frame */
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;         not used, remove */
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          ** bit 1: Apply recursively  
198          ** bit 2: Is this object an occluder? */
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[2];
217         short flag;
218         int type;
219         struct Object *ob;
220 } bParentActuator;
221
222 typedef struct bStateActuator {
223         int type;                       /* 0=Set, 1=Add, 2=Rem, 3=Chg */
224         unsigned int mask;      /* the bits to change */
225 } bStateActuator;
226
227 typedef struct bArmatureActuator {
228         char posechannel[32];
229         char constraint[32];
230         int type;               /* 0=run, 1=enable, 2=disable, 3=set target, 4=set weight */
231         float weight;
232         struct Object *target;
233         struct Object *subtarget;
234 } bArmatureActuator;
235
236 typedef struct bActuator {
237         struct bActuator *next, *prev, *mynew;
238         short type;
239         /**
240          * Tells what type of actuator data <data> holds. 
241          */
242         short flag;
243         short otype, go;
244         char name[32];
245
246         /**
247          * Data must point to an object actuator type struct.
248          */
249         void *data;
250
251         /**
252          * For ipo's and props: to find out which object the actuator
253          * belongs to */
254         struct Object *ob;              
255         
256 } bActuator;
257
258 typedef struct FreeCamera {
259         float mass, accelleration;
260         float maxspeed, maxrotspeed,  maxtiltspeed;
261         int flag;
262         float rotdamp, tiltdamp, speeddamp, pad;
263 } FreeCamera;
264
265 /* objectactuator->flag */
266 #define ACT_FORCE_LOCAL                 1
267 #define ACT_TORQUE_LOCAL                2
268 #define ACT_SERVO_LIMIT_X               2
269 #define ACT_DLOC_LOCAL                  4
270 #define ACT_SERVO_LIMIT_Y               4
271 #define ACT_DROT_LOCAL                  8
272 #define ACT_SERVO_LIMIT_Z               8
273 #define ACT_LIN_VEL_LOCAL               16
274 #define ACT_ANG_VEL_LOCAL               32
275 //#define ACT_ADD_LIN_VEL_LOCAL 64
276 #define ACT_ADD_LIN_VEL                 64
277
278 /* objectactuator->type */
279 #define ACT_OBJECT_NORMAL       0
280 #define ACT_OBJECT_SERVO        1
281
282 /* actuator->type */
283 #define ACT_OBJECT              0
284 #define ACT_IPO                 1
285 #define ACT_LAMP                2
286 #define ACT_CAMERA              3
287 #define ACT_MATERIAL    4
288 #define ACT_SOUND               5
289 #define ACT_PROPERTY    6
290         /* these two obsolete since 2.02 */
291 #define ACT_ADD_OBJECT  7
292 #define ACT_END_OBJECT  8
293
294 #define ACT_CONSTRAINT  9
295 #define ACT_EDIT_OBJECT 10
296 #define ACT_SCENE               11
297 #define ACT_GROUP               12
298 #define ACT_RANDOM      13
299 #define ACT_MESSAGE     14
300 #define ACT_ACTION              15      /* __ NLA */
301 #define ACT_GAME                17
302 #define ACT_VISIBILITY          18
303 #define ACT_2DFILTER    19
304 #define ACT_PARENT      20
305 #define ACT_SHAPEACTION 21
306 #define ACT_STATE               22
307 #define ACT_ARMATURE    23
308
309 /* actuator flag */
310 #define ACT_SHOW                1
311 #define ACT_DEL                 2
312 #define ACT_NEW                 4
313 #define ACT_LINKED              8       
314 #define ACT_VISIBLE             16      
315 #define ACT_PIN                 32
316
317 /* link codes */
318 #define LINK_SENSOR             0
319 #define LINK_CONTROLLER 1
320 #define LINK_ACTUATOR   2
321
322 /* keyboardsensor->type */
323 #define SENS_ALL_KEYS   1
324
325 /* actionactuator->type */
326 #define ACT_ACTION_PLAY                 0
327 #define ACT_ACTION_PINGPONG             1
328 #define ACT_ACTION_FLIPPER              2
329 #define ACT_ACTION_LOOP_STOP    3
330 #define ACT_ACTION_LOOP_END             4
331 #define ACT_ACTION_KEY2KEY              5
332 #define ACT_ACTION_FROM_PROP    6
333 #define ACT_ACTION_MOTION               7
334
335 /* ipoactuator->type */
336 #define ACT_IPO_PLAY            0
337 #define ACT_IPO_PINGPONG        1
338 #define ACT_IPO_FLIPPER         2
339 #define ACT_IPO_LOOP_STOP       3
340 #define ACT_IPO_LOOP_END        4
341 #define ACT_IPO_KEY2KEY         5
342 #define ACT_IPO_FROM_PROP       6
343
344 /* groupactuator->type */
345 #define ACT_GROUP_PLAY          0
346 #define ACT_GROUP_PINGPONG      1
347 #define ACT_GROUP_FLIPPER       2
348 #define ACT_GROUP_LOOP_STOP     3
349 #define ACT_GROUP_LOOP_END      4
350 #define ACT_GROUP_FROM_PROP     5
351 #define ACT_GROUP_SET           6
352
353 /* ipoactuator->flag */
354 #define ACT_IPOFORCE        (1 << 0)
355 #define ACT_IPOEND          (1 << 1)
356 #define ACT_IPOLOCAL            (1 << 2)
357 #define ACT_IPOCHILD        (1 << 4)    
358 #define ACT_IPOADD                      (1 << 5)
359
360 /* ipoactuator->flag for k2k */
361 #define ACT_K2K_PREV            1
362 #define ACT_K2K_CYCLIC          2
363 #define ACT_K2K_PINGPONG        4
364 #define ACT_K2K_HOLD            8
365
366 /* property actuator->type */
367 #define ACT_PROP_ASSIGN         0
368 #define ACT_PROP_ADD            1
369 #define ACT_PROP_COPY           2
370 #define ACT_PROP_TOGGLE         3
371
372 /* constraint flag */
373 #define ACT_CONST_LOCX          1
374 #define ACT_CONST_LOCY          2
375 #define ACT_CONST_LOCZ          4
376 #define ACT_CONST_ROTX          8
377 #define ACT_CONST_ROTY          16
378 #define ACT_CONST_ROTZ          32
379 #define ACT_CONST_NORMAL        64
380 #define ACT_CONST_MATERIAL      128
381 #define ACT_CONST_PERMANENT 256
382 #define ACT_CONST_DISTANCE      512
383 #define ACT_CONST_LOCAL     1024
384 #define ACT_CONST_DOROTFH       2048
385
386 /* constraint mode */
387 #define ACT_CONST_DIRPX         1
388 #define ACT_CONST_DIRPY         2
389 #define ACT_CONST_DIRPZ         4
390 #define ACT_CONST_DIRNX         8
391 #define ACT_CONST_DIRNY         16
392 #define ACT_CONST_DIRNZ         32
393
394 /* constraint type */
395 #define ACT_CONST_TYPE_LOC      0
396 #define ACT_CONST_TYPE_DIST     1
397 #define ACT_CONST_TYPE_ORI      2
398 #define ACT_CONST_TYPE_FH   3
399
400 /* editObjectActuator->type */
401 #define ACT_EDOB_ADD_OBJECT             0
402 #define ACT_EDOB_END_OBJECT             1
403 #define ACT_EDOB_REPLACE_MESH           2
404 #define ACT_EDOB_TRACK_TO               3
405 #define ACT_EDOB_DYNAMICS               4
406
407 /* editObjectActuator->localflag */
408 #define ACT_EDOB_LOCAL_LINV             2
409 #define ACT_EDOB_LOCAL_ANGV             4
410
411
412 /* editObjectActuator->flag */
413 #define ACT_TRACK_3D                    1
414
415 /* editObjectActuator->flag for replace mesh actuator */
416 #define ACT_EDOB_REPLACE_MESH_NOGFX             2 /* use for replace mesh actuator */
417 #define ACT_EDOB_REPLACE_MESH_PHYS              4
418
419 /* SceneActuator->type */
420 #define ACT_SCENE_RESTART               0
421 #define ACT_SCENE_SET                   1
422 #define ACT_SCENE_CAMERA                2
423 #define ACT_SCENE_ADD_FRONT             3
424 #define ACT_SCENE_ADD_BACK              4
425 #define ACT_SCENE_REMOVE                5
426 #define ACT_SCENE_SUSPEND               6
427 #define ACT_SCENE_RESUME                7
428
429
430 /* randomAct->distribution */
431 #define ACT_RANDOM_BOOL_CONST                  0
432 #define ACT_RANDOM_BOOL_UNIFORM                1
433 #define ACT_RANDOM_BOOL_BERNOUILLI             2
434 #define ACT_RANDOM_INT_CONST                   3
435 #define ACT_RANDOM_INT_UNIFORM                 4
436 #define ACT_RANDOM_INT_POISSON                     5
437 #define ACT_RANDOM_FLOAT_CONST                 6
438 #define ACT_RANDOM_FLOAT_UNIFORM               7
439 #define ACT_RANDOM_FLOAT_NORMAL                8
440 #define ACT_RANDOM_FLOAT_NEGATIVE_EXPONENTIAL  9
441
442 /* SoundActuator->flag */
443 #define ACT_SND_3D_SOUND                1
444
445 /*  SoundActuator->type */
446 #define ACT_SND_PLAY_STOP_SOUND         0
447 #define ACT_SND_PLAY_END_SOUND          1
448 #define ACT_SND_LOOP_STOP_SOUND         2
449 #define ACT_SND_LOOP_END_SOUND          3
450 #define ACT_SND_LOOP_BIDIRECTIONAL_SOUND                4
451 #define ACT_SND_LOOP_BIDIRECTIONAL_STOP_SOUND   5
452
453 /* messageactuator->type */
454 #define ACT_MESG_MESG           0
455 #define ACT_MESG_PROP           1
456
457 /* gameactuator->type */
458 #define ACT_GAME_LOAD           0
459 #define ACT_GAME_START          1
460 #define ACT_GAME_RESTART        2
461 #define ACT_GAME_QUIT           3
462 #define ACT_GAME_SAVECFG        4
463 #define ACT_GAME_LOADCFG        5
464
465 /* visibilityact->flag */
466 /* Set means the object will become invisible */
467 #define ACT_VISIBILITY_INVISIBLE       (1 << 0)
468 #define ACT_VISIBILITY_RECURSIVE       (1 << 1)
469 #define ACT_VISIBILITY_OCCLUSION       (1 << 2)
470
471 /* twodfilter->type */
472 #define ACT_2DFILTER_ENABLED                    -2
473 #define ACT_2DFILTER_DISABLED                   -1
474 #define ACT_2DFILTER_NOFILTER                   0
475 #define ACT_2DFILTER_MOTIONBLUR                 1
476 #define ACT_2DFILTER_BLUR                               2
477 #define ACT_2DFILTER_SHARPEN                    3
478 #define ACT_2DFILTER_DILATION                   4
479 #define ACT_2DFILTER_EROSION                    5
480 #define ACT_2DFILTER_LAPLACIAN                  6
481 #define ACT_2DFILTER_SOBEL                              7
482 #define ACT_2DFILTER_PREWITT                    8
483 #define ACT_2DFILTER_GRAYSCALE                  9
484 #define ACT_2DFILTER_SEPIA                              10
485 #define ACT_2DFILTER_INVERT                             11
486 #define ACT_2DFILTER_CUSTOMFILTER               12
487 #define ACT_2DFILTER_NUMBER_OF_FILTERS  13
488
489 /* parentactuator->type */
490 #define ACT_PARENT_SET      0
491 #define ACT_PARENT_REMOVE   1
492
493 /* parentactuator->flag */
494 #define ACT_PARENT_COMPOUND     1
495 #define ACT_PARENT_GHOST        2
496
497 /* armatureactuator->type */
498 #define ACT_ARM_RUN                     0
499 #define ACT_ARM_ENABLE          1
500 #define ACT_ARM_DISABLE         2
501 #define ACT_ARM_SETTARGET       3
502 #define ACT_ARM_SETWEIGHT       4
503 /* update this define if more type are addedd */
504 #define ACT_ARM_MAXTYPE         4
505
506 #endif
507
508