synched with trunk at revision 31065
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 */  // not in use
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 */ // not in use
59 } bActionActuator;                                                                                              
60
61 typedef struct Sound3D
62 {
63         float min_gain;
64         float max_gain;
65         float reference_distance;
66         float max_distance;
67         float rolloff_factor;
68         float cone_inner_angle;
69         float cone_outer_angle;
70         float cone_outer_gain;
71 } Sound3D;
72
73 typedef struct bSoundActuator {
74         short flag, sndnr;
75         int pad1, pad2;
76         short pad3[2];
77         float volume, pitch;
78         struct bSound *sound;
79         struct Sound3D sound3D;
80         short type, pad4;
81         short pad5, pad6[1];
82 } bSoundActuator;
83
84 typedef struct bEditObjectActuator {
85         int time;
86         short type, flag;
87         struct Object *ob;
88         struct Mesh *me;
89         char name[32];
90         float linVelocity[3]; /* initial lin. velocity on creation */
91         float angVelocity[3]; /* initial ang. velocity on creation */
92         float mass;
93         short localflag; /* flag for the lin & ang. vel: apply locally   */
94         short dyn_operation;
95 } bEditObjectActuator;
96
97 typedef struct bSceneActuator {
98         short type, pad1;
99         int pad;
100         struct Scene *scene;
101         struct Object *camera;
102 } bSceneActuator;
103
104 typedef struct bPropertyActuator {
105         int pad, type;
106         char name[32], value[32];
107         struct Object *ob;
108 } bPropertyActuator;
109
110 typedef struct bObjectActuator {
111         short flag, type, otype;
112         short damping;
113         float forceloc[3], forcerot[3];
114         float pad[3], pad1[3];
115         float dloc[3], drot[3];
116         float linearvelocity[3], angularvelocity[3];
117         struct Object *reference;
118 } bObjectActuator;
119
120 typedef struct bIpoActuator {
121         short flag, type;
122         int sta, end;
123         char name[32];
124         char frameProp[32];     /* Set this property to the actions current frame */
125         
126         short pad1, pad2, pad3, pad4;
127         
128 } bIpoActuator;
129
130 typedef struct bCameraActuator {
131         struct Object *ob;
132         float height, min, max;
133         float pad;
134         short pad1, axis;
135         float pad2;
136 } bCameraActuator ;
137
138 typedef struct bConstraintActuator {
139         short type, mode;
140         short flag, damp;
141         short time, rotdamp;
142         int pad;
143         float minloc[3], maxloc[3];
144         float minrot[3], maxrot[3];
145         char matprop[32];
146 } bConstraintActuator;
147
148 typedef struct bGroupActuator {
149         short flag, type;
150         int sta, end;
151         char name[32];          /* property or groupkey */
152         
153         short pad[3], cur, butsta, butend;/* not referenced, can remove? */
154         /* struct Group *group;         not used, remove */
155         
156 } bGroupActuator;
157
158 /* I added a few extra fields here, to facilitate conversions                */
159 typedef struct bRandomActuator {
160         int  seed;
161         int   distribution;
162         int int_arg_1;
163         int int_arg_2;
164         float float_arg_1;
165         float float_arg_2;
166         char  propname[32];
167 } bRandomActuator;
168
169 typedef struct bMessageActuator {
170         char toPropName[32];    /* Send to all objects with this propertyname. Empty to broadcast. */
171         struct Object *toObject;/* (Possible future use) pointer to a single destination object. */
172         char subject[32];               /* Message Subject to send. */
173         short bodyType, pad1;   /* bodyType is either 'User defined text' or PropName */
174         int pad2;
175         char body[32];                  /* Either User Defined Text or our PropName to send value of */
176 } bMessageActuator;
177
178 typedef struct bGameActuator {
179         short flag, type;
180         int sta, end;
181         char filename[64];
182         char loadaniname[64];
183 } bGameActuator;
184
185 typedef struct bVisibilityActuator {
186         /** bit 0: Is this object visible? 
187          ** bit 1: Apply recursively  
188          ** bit 2: Is this object an occluder? */
189         int flag;
190 } bVisibilityActuator;
191
192 typedef struct bTwoDFilterActuator{
193         char pad[4];
194         /* Tells what type of 2D Filter */
195         short type;
196         /* (flag == 0) means 2D filter is activate and
197            (flag != 0) means 2D filter is inactive */
198         short flag;
199         int   int_arg;
200         /* a float argument */
201         float float_arg;
202         struct Text *text;
203 }bTwoDFilterActuator;
204
205 typedef struct bParentActuator {
206         char pad[2];
207         short flag;
208         int type;
209         struct Object *ob;
210 } bParentActuator;
211
212 typedef struct bStateActuator {
213         int type;                       /* 0=Set, 1=Add, 2=Rem, 3=Chg */
214         unsigned int mask;      /* the bits to change */
215 } bStateActuator;
216
217 typedef struct bArmatureActuator {
218         char posechannel[32];
219         char constraint[32];
220         int type;               /* 0=run, 1=enable, 2=disable, 3=set target, 4=set weight */
221         float weight;
222         struct Object *target;
223         struct Object *subtarget;
224 } bArmatureActuator;
225
226 typedef struct bSteeringActuator {
227         char pad[7];
228         char flag;
229         int type;               /* 0=seek, 1=flee, 2=path following */
230         float dist;
231         float velocity;
232         float acceleration;
233         float turnspeed;
234         int updateTime;
235         struct Object *target;
236         struct Object *navmesh;
237 } bSteeringActuator;
238
239 typedef struct bActuator {
240         struct bActuator *next, *prev, *mynew;
241         short type;
242         /**
243          * Tells what type of actuator data <data> holds. 
244          */
245         short flag;
246         short otype, go;
247         char name[32];
248
249         /**
250          * Data must point to an object actuator type struct.
251          */
252         void *data;
253
254         /**
255          * For ipo's and props: to find out which object the actuator
256          * belongs to */
257         struct Object *ob;              
258         
259 } bActuator;
260
261 /* objectactuator->flag */
262 #define ACT_FORCE_LOCAL                 1
263 #define ACT_TORQUE_LOCAL                2
264 #define ACT_SERVO_LIMIT_X               2
265 #define ACT_DLOC_LOCAL                  4
266 #define ACT_SERVO_LIMIT_Y               4
267 #define ACT_DROT_LOCAL                  8
268 #define ACT_SERVO_LIMIT_Z               8
269 #define ACT_LIN_VEL_LOCAL               16
270 #define ACT_ANG_VEL_LOCAL               32
271 //#define ACT_ADD_LIN_VEL_LOCAL 64
272 #define ACT_ADD_LIN_VEL                 64
273
274 /* objectactuator->type */
275 #define ACT_OBJECT_NORMAL       0
276 #define ACT_OBJECT_SERVO        1
277
278 /* actuator->type */
279 #define ACT_OBJECT              0
280 #define ACT_IPO                 1
281 #define ACT_LAMP                2
282 #define ACT_CAMERA              3
283 #define ACT_MATERIAL    4
284 #define ACT_SOUND               5
285 #define ACT_PROPERTY    6
286         /* these two obsolete since 2.02 */
287 #define ACT_ADD_OBJECT  7
288 #define ACT_END_OBJECT  8
289
290 #define ACT_CONSTRAINT  9
291 #define ACT_EDIT_OBJECT 10
292 #define ACT_SCENE               11
293 #define ACT_GROUP               12
294 #define ACT_RANDOM      13
295 #define ACT_MESSAGE     14
296 #define ACT_ACTION              15      /* __ NLA */
297 #define ACT_GAME                17
298 #define ACT_VISIBILITY          18
299 #define ACT_2DFILTER    19
300 #define ACT_PARENT      20
301 #define ACT_SHAPEACTION 21
302 #define ACT_STATE               22
303 #define ACT_ARMATURE    23
304 #define ACT_STEERING    24
305
306 /* actuator flag */
307 #define ACT_SHOW                1
308 #define ACT_DEL                 2
309 #define ACT_NEW                 4
310 #define ACT_LINKED              8       
311 #define ACT_VISIBLE             16      
312 #define ACT_PIN                 32
313
314 /* link codes */
315 #define LINK_SENSOR             0
316 #define LINK_CONTROLLER 1
317 #define LINK_ACTUATOR   2
318
319 /* keyboardsensor->type */
320 #define SENS_ALL_KEYS   1
321
322 /* actionactuator->type */
323 #define ACT_ACTION_PLAY                 0
324 #define ACT_ACTION_PINGPONG             1
325 #define ACT_ACTION_FLIPPER              2
326 #define ACT_ACTION_LOOP_STOP    3
327 #define ACT_ACTION_LOOP_END             4
328 #define ACT_ACTION_KEY2KEY              5
329 #define ACT_ACTION_FROM_PROP    6
330 #define ACT_ACTION_MOTION               7
331
332 /* ipoactuator->type */
333 #define ACT_IPO_PLAY            0
334 #define ACT_IPO_PINGPONG        1
335 #define ACT_IPO_FLIPPER         2
336 #define ACT_IPO_LOOP_STOP       3
337 #define ACT_IPO_LOOP_END        4
338 #define ACT_IPO_KEY2KEY         5
339 #define ACT_IPO_FROM_PROP       6
340
341 /* groupactuator->type */
342 #define ACT_GROUP_PLAY          0
343 #define ACT_GROUP_PINGPONG      1
344 #define ACT_GROUP_FLIPPER       2
345 #define ACT_GROUP_LOOP_STOP     3
346 #define ACT_GROUP_LOOP_END      4
347 #define ACT_GROUP_FROM_PROP     5
348 #define ACT_GROUP_SET           6
349
350 /* ipoactuator->flag */
351 #define ACT_IPOFORCE        (1 << 0)
352 #define ACT_IPOEND          (1 << 1)
353 #define ACT_IPOLOCAL            (1 << 2)
354 #define ACT_IPOCHILD        (1 << 4)    
355 #define ACT_IPOADD                      (1 << 5)
356
357 /* ipoactuator->flag for k2k */
358 #define ACT_K2K_PREV            1
359 #define ACT_K2K_CYCLIC          2
360 #define ACT_K2K_PINGPONG        4
361 #define ACT_K2K_HOLD            8
362
363 /* property actuator->type */
364 #define ACT_PROP_ASSIGN         0
365 #define ACT_PROP_ADD            1
366 #define ACT_PROP_COPY           2
367 #define ACT_PROP_TOGGLE         3
368
369 /* constraint flag */
370 #define ACT_CONST_NONE          0
371 #define ACT_CONST_LOCX          1
372 #define ACT_CONST_LOCY          2
373 #define ACT_CONST_LOCZ          4
374 #define ACT_CONST_ROTX          8
375 #define ACT_CONST_ROTY          16
376 #define ACT_CONST_ROTZ          32
377 #define ACT_CONST_NORMAL        64
378 #define ACT_CONST_MATERIAL      128
379 #define ACT_CONST_PERMANENT 256
380 #define ACT_CONST_DISTANCE      512
381 #define ACT_CONST_LOCAL     1024
382 #define ACT_CONST_DOROTFH       2048
383
384 /* constraint mode */
385 #define ACT_CONST_DIRPX         1
386 #define ACT_CONST_DIRPY         2
387 #define ACT_CONST_DIRPZ         4
388 #define ACT_CONST_DIRNX         8
389 #define ACT_CONST_DIRNY         16
390 #define ACT_CONST_DIRNZ         32
391
392 /* constraint type */
393 #define ACT_CONST_TYPE_LOC      0
394 #define ACT_CONST_TYPE_DIST     1
395 #define ACT_CONST_TYPE_ORI      2
396 #define ACT_CONST_TYPE_FH   3
397
398 /* editObjectActuator->type */
399 #define ACT_EDOB_ADD_OBJECT             0
400 #define ACT_EDOB_END_OBJECT             1
401 #define ACT_EDOB_REPLACE_MESH           2
402 #define ACT_EDOB_TRACK_TO               3
403 #define ACT_EDOB_DYNAMICS               4
404
405 /* editObjectActuator->localflag */
406 #define ACT_EDOB_LOCAL_LINV             2
407 #define ACT_EDOB_LOCAL_ANGV             4
408
409 /* editObjectActuator->flag */
410 #define ACT_TRACK_3D                    1
411
412 /* editObjectActuator->flag for replace mesh actuator */
413 #define ACT_EDOB_REPLACE_MESH_NOGFX             2 /* use for replace mesh actuator */
414 #define ACT_EDOB_REPLACE_MESH_PHYS              4
415
416 /* editObjectActuator->dyn_operation */
417 #define ACT_EDOB_RESTORE_DYN    0
418 #define ACT_EDOB_SUSPEND_DYN    1
419 #define ACT_EDOB_ENABLE_RB              2
420 #define ACT_EDOB_DISABLE_RB             3
421 #define ACT_EDOB_SET_MASS               4
422
423
424 /* SceneActuator->type */
425 #define ACT_SCENE_RESTART               0
426 #define ACT_SCENE_SET                   1
427 #define ACT_SCENE_CAMERA                2
428 #define ACT_SCENE_ADD_FRONT             3
429 #define ACT_SCENE_ADD_BACK              4
430 #define ACT_SCENE_REMOVE                5
431 #define ACT_SCENE_SUSPEND               6
432 #define ACT_SCENE_RESUME                7
433
434
435 /* randomAct->distribution */
436 #define ACT_RANDOM_BOOL_CONST                  0
437 #define ACT_RANDOM_BOOL_UNIFORM                1
438 #define ACT_RANDOM_BOOL_BERNOUILLI             2
439 #define ACT_RANDOM_INT_CONST                   3
440 #define ACT_RANDOM_INT_UNIFORM                 4
441 #define ACT_RANDOM_INT_POISSON                     5
442 #define ACT_RANDOM_FLOAT_CONST                 6
443 #define ACT_RANDOM_FLOAT_UNIFORM               7
444 #define ACT_RANDOM_FLOAT_NORMAL                8
445 #define ACT_RANDOM_FLOAT_NEGATIVE_EXPONENTIAL  9
446
447 /* SoundActuator->flag */
448 #define ACT_SND_3D_SOUND                1
449
450 /*  SoundActuator->type */
451 #define ACT_SND_PLAY_STOP_SOUND         0
452 #define ACT_SND_PLAY_END_SOUND          1
453 #define ACT_SND_LOOP_STOP_SOUND         2
454 #define ACT_SND_LOOP_END_SOUND          3
455 #define ACT_SND_LOOP_BIDIRECTIONAL_SOUND                4
456 #define ACT_SND_LOOP_BIDIRECTIONAL_STOP_SOUND   5
457
458 /* messageactuator->type */
459 #define ACT_MESG_MESG           0
460 #define ACT_MESG_PROP           1
461
462 /* gameactuator->type */
463 #define ACT_GAME_LOAD           0
464 #define ACT_GAME_START          1
465 #define ACT_GAME_RESTART        2
466 #define ACT_GAME_QUIT           3
467 #define ACT_GAME_SAVECFG        4
468 #define ACT_GAME_LOADCFG        5
469
470 /* visibilityact->flag */
471 /* Set means the object will become invisible */
472 #define ACT_VISIBILITY_INVISIBLE       (1 << 0)
473 #define ACT_VISIBILITY_RECURSIVE       (1 << 1)
474 #define ACT_VISIBILITY_OCCLUSION       (1 << 2)
475
476 /* twodfilter->type */
477 #define ACT_2DFILTER_ENABLED                    -2
478 #define ACT_2DFILTER_DISABLED                   -1
479 #define ACT_2DFILTER_NOFILTER                   0
480 #define ACT_2DFILTER_MOTIONBLUR                 1
481 #define ACT_2DFILTER_BLUR                               2
482 #define ACT_2DFILTER_SHARPEN                    3
483 #define ACT_2DFILTER_DILATION                   4
484 #define ACT_2DFILTER_EROSION                    5
485 #define ACT_2DFILTER_LAPLACIAN                  6
486 #define ACT_2DFILTER_SOBEL                              7
487 #define ACT_2DFILTER_PREWITT                    8
488 #define ACT_2DFILTER_GRAYSCALE                  9
489 #define ACT_2DFILTER_SEPIA                              10
490 #define ACT_2DFILTER_INVERT                             11
491 #define ACT_2DFILTER_CUSTOMFILTER               12
492 #define ACT_2DFILTER_NUMBER_OF_FILTERS  13
493
494 /* parentactuator->type */
495 #define ACT_PARENT_SET      0
496 #define ACT_PARENT_REMOVE   1
497
498 /* parentactuator->flag */
499 #define ACT_PARENT_COMPOUND     1
500 #define ACT_PARENT_GHOST        2
501
502 /* armatureactuator->type */
503 #define ACT_ARM_RUN                     0
504 #define ACT_ARM_ENABLE          1
505 #define ACT_ARM_DISABLE         2
506 #define ACT_ARM_SETTARGET       3
507 #define ACT_ARM_SETWEIGHT       4
508 /* update this define if more type are addedd */
509 #define ACT_ARM_MAXTYPE         4
510
511 /* stateactuator->type */
512 #define ACT_STATE_SET           0
513 #define ACT_STATE_ADD           1
514 #define ACT_STATE_REMOVE        2
515 #define ACT_STATE_CHANGE        3
516
517 /* cameraactuator->axis */
518 #define ACT_CAMERA_X            (float)'x'
519 #define ACT_CAMERA_Y            (float)'y'
520
521 /* steeringactuator->type */
522 #define ACT_STEERING_SEEK   0
523 #define ACT_STEERING_FLEE   1
524 #define ACT_STEERING_PATHFOLLOWING   2
525 /* steeringactuator->flag */
526 #define ACT_STEERING_SELFTERMINATED   1
527 #define ACT_STEERING_ENABLEVISUALIZATION   2
528
529 #endif
530
531