BGE patch #14386: Action Actuator Current Frame Prop. This patch is very usefull...
[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         int     blendin;                /* Number of frames of blending */      
55         short   priority;               /* Execution priority */                        
56         short   strideaxis;             /* Displacement axis */
57         float   stridelength;   /* Displacement incurred by cycle */
58 } bActionActuator;                                                                                              
59
60 typedef struct bSoundActuator {
61         short flag, sndnr;
62         int sta, end;
63         short pad1[2];
64         struct bSound *sound;
65         short type, makecopy;
66         short copymade, pad2[1];
67 } bSoundActuator;
68
69 typedef struct bCDActuator {
70         short flag, sndnr;
71         int sta, end;
72         short type, track;
73         float volume;
74 } bCDActuator;
75
76 typedef struct bEditObjectActuator {
77         int time;
78         short type, flag;
79         struct Object *ob;
80         struct Mesh *me;
81         char name[32];
82         float linVelocity[3]; /* initial lin. velocity on creation */
83         short localflag; /* flag for the lin. vel: apply locally   */
84         short pad;
85 } bEditObjectActuator;
86
87 typedef struct bSceneActuator {
88         short type, flag;
89         int pad;
90         struct Scene *scene;
91         struct Object *camera;
92 } bSceneActuator;
93
94 typedef struct bPropertyActuator {
95         int flag, type;
96         char name[32], value[32];
97         struct Object *ob;
98 } bPropertyActuator;
99
100 typedef struct bObjectActuator {
101         int flag, type;
102         float forceloc[3], forcerot[3];
103         float loc[3], rot[3];
104         float dloc[3], drot[3];
105         float linearvelocity[3], angularvelocity[3];
106 } bObjectActuator;
107
108 typedef struct bIpoActuator {
109         short flag, type;
110         int sta, end;
111         char name[32];
112         
113         short pad1, cur, butsta, butend;
114         
115 } bIpoActuator;
116
117 typedef struct bCameraActuator {
118         struct Object *ob;
119         float height, min, max;
120         float fac;
121         short flag, axis;
122         float visifac;
123 } bCameraActuator ;
124
125 typedef struct bConstraintActuator {
126         short flag, damp;
127         float slow;
128         float minloc[3], maxloc[3];
129         float minrot[3], maxrot[3];
130 } bConstraintActuator;
131
132 typedef struct bGroupActuator {
133         short flag, type;
134         int sta, end;
135         char name[32];          /* property or groupkey */
136         
137         short pad[3], cur, butsta, butend;/* not referenced, can remove? */
138         struct Group *group;            /* only during game */
139         
140 } bGroupActuator;
141
142 /* I added a few extra fields here, to facilitate conversions                */
143 typedef struct bRandomActuator {
144         int  seed;
145         int   distribution;
146         int int_arg_1;
147         int int_arg_2;
148         float float_arg_1;
149         float float_arg_2;
150         char  propname[32];
151 } bRandomActuator;
152
153 typedef struct bMessageActuator {
154         /**
155          * Send to all objects with this propertyname. Empty to broadcast.
156          */
157         char toPropName[32];
158
159         /**
160          * (Possible future use) pointer to a single destination object.
161          */
162         struct Object *toObject;
163
164         /**
165          * Message Subject to send.
166          */
167         char subject[32];
168
169         /**
170          * bodyType is either 'User defined text' or PropName
171          */
172         short bodyType, pad1;
173         int pad2;
174
175         /**
176          * Either User Defined Text or our PropName to send value of
177          */
178         char body[32];
179 } bMessageActuator;
180
181 typedef struct bGameActuator {
182         short flag, type;
183         int sta, end;
184         char filename[64];
185         char loadaniname[64];
186 } bGameActuator;
187
188 typedef struct bVisibilityActuator {
189         /** bit 0: Is this object visible? */
190         int flag;
191 } bVisibilityActuator;
192
193 typedef struct bTwoDFilterActuator{
194         char pad[4];
195         /* Tells what type of 2D Filter*/
196         short type;
197         /* (flag == 0) means 2D filter is activate and
198            (flag != 0) means 2D filter is inactive*/
199         short flag;
200         int   int_arg;
201         /* a float argument */
202         float float_arg;
203         struct Text *text;
204 }bTwoDFilterActuator;
205
206 typedef struct bParentActuator {
207         char pad[4];
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 bActuator {
218         struct bActuator *next, *prev, *mynew;
219         short type;
220         /**
221          * Tells what type of actuator data <data> holds. 
222          */
223         short flag;
224         short otype, go;
225         char name[32];
226
227         /**
228          * Data must point to an object actuator type struct.
229          */
230         void *data;
231
232         /**
233          * For ipo's and props: to find out which object the actuator
234          * belongs to */
235         struct Object *ob;              
236         
237 } bActuator;
238
239 typedef struct FreeCamera {
240         float mass, accelleration;
241         float maxspeed, maxrotspeed,  maxtiltspeed;
242         int flag;
243         float rotdamp, tiltdamp, speeddamp, pad;
244 } FreeCamera;
245
246 /* objectactuator->flag */
247 #define ACT_FORCE_LOCAL                 1
248 #define ACT_TORQUE_LOCAL                2
249 #define ACT_DLOC_LOCAL                  4
250 #define ACT_DROT_LOCAL                  8
251 #define ACT_LIN_VEL_LOCAL               16
252 #define ACT_ANG_VEL_LOCAL               32
253 //#define ACT_ADD_LIN_VEL_LOCAL 64
254 #define ACT_ADD_LIN_VEL                 64
255
256 #define ACT_OBJECT_FORCE        0
257 #define ACT_OBJECT_TORQUE       1
258 #define ACT_OBJECT_DLOC         2
259 #define ACT_OBJECT_DROT         3
260 #define ACT_OBJECT_LINV         4
261 #define ACT_OBJECT_ANGV         5
262
263 /* actuator->type */
264 #define ACT_OBJECT              0
265 #define ACT_IPO                 1
266 #define ACT_LAMP                2
267 #define ACT_CAMERA              3
268 #define ACT_MATERIAL    4
269 #define ACT_SOUND               5
270 #define ACT_PROPERTY    6
271         /* these two obsolete since 2.02 */
272 #define ACT_ADD_OBJECT  7
273 #define ACT_END_OBJECT  8
274
275 #define ACT_CONSTRAINT  9
276 #define ACT_EDIT_OBJECT 10
277 #define ACT_SCENE               11
278 #define ACT_GROUP               12
279 #define ACT_RANDOM      13
280 #define ACT_MESSAGE     14
281 #define ACT_ACTION              15      /* __ NLA */
282 #define ACT_CD                  16
283 #define ACT_GAME                17
284 #define ACT_VISIBILITY          18
285 #define ACT_2DFILTER    19
286 #define ACT_PARENT      20
287 #define ACT_SHAPEACTION 21
288 #define ACT_STATE               22
289
290 /* actuator flag */
291 #define ACT_SHOW                1
292 #define ACT_DEL                 2
293 #define ACT_NEW                 4
294 #define ACT_LINKED              8       
295 #define ACT_VISIBLE             16      
296
297 /* link codes */
298 #define LINK_SENSOR             0
299 #define LINK_CONTROLLER 1
300 #define LINK_ACTUATOR   2
301
302 /* keyboardsensor->type */
303 #define SENS_ALL_KEYS   1
304
305 /* actionactuator->type */
306 #define ACT_ACTION_PLAY                 0
307 #define ACT_ACTION_PINGPONG             1
308 #define ACT_ACTION_FLIPPER              2
309 #define ACT_ACTION_LOOP_STOP    3
310 #define ACT_ACTION_LOOP_END             4
311 #define ACT_ACTION_KEY2KEY              5
312 #define ACT_ACTION_FROM_PROP    6
313 #define ACT_ACTION_MOTION               7
314
315 /* ipoactuator->type */
316 #define ACT_IPO_PLAY            0
317 #define ACT_IPO_PINGPONG        1
318 #define ACT_IPO_FLIPPER         2
319 #define ACT_IPO_LOOP_STOP       3
320 #define ACT_IPO_LOOP_END        4
321 #define ACT_IPO_KEY2KEY         5
322 #define ACT_IPO_FROM_PROP       6
323
324 /* groupactuator->type */
325 #define ACT_GROUP_PLAY          0
326 #define ACT_GROUP_PINGPONG      1
327 #define ACT_GROUP_FLIPPER       2
328 #define ACT_GROUP_LOOP_STOP     3
329 #define ACT_GROUP_LOOP_END      4
330 #define ACT_GROUP_FROM_PROP     5
331 #define ACT_GROUP_SET           6
332
333 /* ipoactuator->flag */
334 #define ACT_IPOFORCE        (1 << 0)
335 #define ACT_IPOEND          (1 << 1)
336 #define ACT_IPOFORCE_LOCAL  (1 << 2)
337 #define ACT_IPOCHILD        (1 << 4)                    
338
339 /* ipoactuator->flag for k2k */
340 #define ACT_K2K_PREV            1
341 #define ACT_K2K_CYCLIC          2
342 #define ACT_K2K_PINGPONG        4
343 #define ACT_K2K_HOLD            8
344
345 /* property actuator->type */
346 #define ACT_PROP_ASSIGN         0
347 #define ACT_PROP_ADD            1
348 #define ACT_PROP_COPY           2
349
350 /* constraint flag */
351 #define ACT_CONST_LOCX          1
352 #define ACT_CONST_LOCY          2
353 #define ACT_CONST_LOCZ          4
354 #define ACT_CONST_ROTX          8
355 #define ACT_CONST_ROTY          16
356 #define ACT_CONST_ROTZ          32
357
358 /* editObjectActuator->type */
359 #define ACT_EDOB_ADD_OBJECT             0
360 #define ACT_EDOB_END_OBJECT             1
361 #define ACT_EDOB_REPLACE_MESH   2
362 #define ACT_EDOB_TRACK_TO               3
363 #define ACT_EDOB_MAKE_CHILD             4
364 #define ACT_EDOB_END_CHILD              5
365
366 /* editObjectActuator->flag */
367 #define ACT_TRACK_3D                    1
368
369 /* SceneActuator->type */
370 #define ACT_SCENE_RESTART               0
371 #define ACT_SCENE_SET                   1
372 #define ACT_SCENE_CAMERA                2
373 #define ACT_SCENE_ADD_FRONT             3
374 #define ACT_SCENE_ADD_BACK              4
375 #define ACT_SCENE_REMOVE                5
376 #define ACT_SCENE_SUSPEND               6
377 #define ACT_SCENE_RESUME                7
378
379
380 /* randomAct->distribution */
381 #define ACT_RANDOM_BOOL_CONST                  0
382 #define ACT_RANDOM_BOOL_UNIFORM                1
383 #define ACT_RANDOM_BOOL_BERNOUILLI             2
384 #define ACT_RANDOM_INT_CONST                   3
385 #define ACT_RANDOM_INT_UNIFORM                 4
386 #define ACT_RANDOM_INT_POISSON                     5
387 #define ACT_RANDOM_FLOAT_CONST                 6
388 #define ACT_RANDOM_FLOAT_UNIFORM               7
389 #define ACT_RANDOM_FLOAT_NORMAL                8
390 #define ACT_RANDOM_FLOAT_NEGATIVE_EXPONENTIAL  9
391
392 /*  SoundActuator->type */
393 #define ACT_SND_PLAY_STOP_SOUND         0
394 #define ACT_SND_PLAY_END_SOUND          1
395 #define ACT_SND_LOOP_STOP_SOUND         2
396 #define ACT_SND_LOOP_END_SOUND          3
397 #define ACT_SND_LOOP_BIDIRECTIONAL_SOUND                4
398 #define ACT_SND_LOOP_BIDIRECTIONAL_STOP_SOUND   5
399
400 /* messageactuator->type */
401 #define ACT_MESG_MESG           0
402 #define ACT_MESG_PROP           1
403
404 /* cdactuator->type */
405 #define ACT_CD_PLAY_ALL         0
406 #define ACT_CD_PLAY_TRACK       1
407 #define ACT_CD_LOOP_TRACK       2
408 #define ACT_CD_VOLUME           3
409 #define ACT_CD_STOP                     4
410 #define ACT_CD_PAUSE            5
411 #define ACT_CD_RESUME           6
412
413 /* gameactuator->type */
414 #define ACT_GAME_LOAD           0
415 #define ACT_GAME_START          1
416 #define ACT_GAME_RESTART        2
417 #define ACT_GAME_QUIT           3
418
419 /* visibilityact->flag */
420 /* Set means the object will become invisible */
421 #define ACT_VISIBILITY_INVISIBLE       (1 << 0)
422
423 /* twodfilter->type */
424 #define ACT_2DFILTER_ENABLED                    -2
425 #define ACT_2DFILTER_DISABLED                   -1
426 #define ACT_2DFILTER_NOFILTER                   0
427 #define ACT_2DFILTER_MOTIONBLUR                 1
428 #define ACT_2DFILTER_BLUR                               2
429 #define ACT_2DFILTER_SHARPEN                    3
430 #define ACT_2DFILTER_DILATION                   4
431 #define ACT_2DFILTER_EROSION                    5
432 #define ACT_2DFILTER_LAPLACIAN                  6
433 #define ACT_2DFILTER_SOBEL                              7
434 #define ACT_2DFILTER_PREWITT                    8
435 #define ACT_2DFILTER_GRAYSCALE                  9
436 #define ACT_2DFILTER_SEPIA                              10
437 #define ACT_2DFILTER_INVERT                             11
438 #define ACT_2DFILTER_CUSTOMFILTER               12
439 #define ACT_2DFILTER_NUMBER_OF_FILTERS  13
440
441 /* parentactuator->type */
442 #define ACT_PARENT_SET      0
443 #define ACT_PARENT_REMOVE   1
444 #endif
445
446