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