==Bugfix==
[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/BL DUAL 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. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
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
42 /* ****************** ACTUATORS ********************* */
43
44 /* unused now, moved to editobjectactuator in 2.02. Still needed for dna */
45 typedef struct bAddObjectActuator {
46         int time, pad;
47         struct Object *ob;
48 } bAddObjectActuator;
49
50 typedef struct bActionActuator {                                                                
51         struct bAction *act;    /* Pointer to action */                         
52         short   type, flag;             /* Playback type */                                     
53         int     sta, end;               /* Start & End frames */                        
54         char    name[32];               /* For property-driven playback */      
55         int     blendin;                /* Number of frames of blending */      
56         short   priority;               /* Execution priority */                        
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         short localflag; /* flag for the lin. vel: apply locally   */
85         short pad;
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         int flag, type;
103         float forceloc[3], forcerot[3];
104         float loc[3], rot[3];
105         float dloc[3], drot[3];
106         float linearvelocity[3], angularvelocity[3];
107 //      float addedlinearvelocity[3];
108 //      char anotherpad[4];
109 } bObjectActuator;
110
111 typedef struct bIpoActuator {
112         short flag, type;
113         int sta, end;
114         char name[32];
115         
116         short pad1, cur, butsta, butend;
117         
118 } bIpoActuator;
119
120 typedef struct bCameraActuator {
121         struct Object *ob;
122         float height, min, max;
123         float fac;
124         short flag, axis;
125         float visifac;
126 } bCameraActuator ;
127
128 typedef struct bConstraintActuator {
129         short flag, damp;
130         float slow;
131         float minloc[3], maxloc[3];
132         float minrot[3], maxrot[3];
133 } bConstraintActuator;
134
135 typedef struct bGroupActuator {
136         short flag, type;
137         int sta, end;
138         char name[32];          /* property or groupkey */
139         
140         short pad[3], cur, butsta, butend;/* not referenced, can remove? */
141         struct Group *group;            /* only during game */
142         
143 } bGroupActuator;
144
145 /* I added a few extra fields here, to facilitate conversions                */
146 typedef struct bRandomActuator {
147         int  seed;
148         int   distribution;
149         int int_arg_1;
150         int int_arg_2;
151         float float_arg_1;
152         float float_arg_2;
153         char  propname[32];
154 } bRandomActuator;
155
156 typedef struct bMessageActuator {
157         /**
158          * Send to all objects with this propertyname. Empty to broadcast.
159          */
160         char toPropName[32];
161
162         /**
163          * (Possible future use) pointer to a single destination object.
164          */
165         struct Object *toObject;
166
167         /**
168          * Message Subject to send.
169          */
170         char subject[32];
171
172         /**
173          * bodyType is either 'User defined text' or PropName
174          */
175         short bodyType, pad1;
176         int pad2;
177
178         /**
179          * Either User Defined Text or our PropName to send value of
180          */
181         char body[32];
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         int flag;
194 } bVisibilityActuator;
195
196 typedef struct bActuator {
197         struct bActuator *next, *prev, *mynew;
198         short type;
199         /**
200          * Tells what type of actuator data <data> holds. 
201          */
202         short flag;
203         short otype, go;
204         char name[32];
205
206         /**
207          * Data must point to an object actuator type struct.
208          */
209         void *data;
210
211         /**
212          * For ipo's and props: to find out which object the actuator
213          * belongs to */
214         struct Object *ob;              
215         
216 } bActuator;
217
218 typedef struct FreeCamera {
219         float mass, accelleration;
220         float maxspeed, maxrotspeed,  maxtiltspeed;
221         int flag;
222         float rotdamp, tiltdamp, speeddamp, pad;
223 } FreeCamera;
224
225 /* objectactuator->flag */
226 #define ACT_FORCE_LOCAL                 1
227 #define ACT_TORQUE_LOCAL                2
228 #define ACT_DLOC_LOCAL                  4
229 #define ACT_DROT_LOCAL                  8
230 #define ACT_LIN_VEL_LOCAL               16
231 #define ACT_ANG_VEL_LOCAL               32
232 //#define ACT_ADD_LIN_VEL_LOCAL 64
233 #define ACT_ADD_LIN_VEL                 64
234
235 #define ACT_OBJECT_FORCE        0
236 #define ACT_OBJECT_TORQUE       1
237 #define ACT_OBJECT_DLOC         2
238 #define ACT_OBJECT_DROT         3
239 #define ACT_OBJECT_LINV         4
240 #define ACT_OBJECT_ANGV         5
241
242 /* actuator->type */
243 #define ACT_OBJECT              0
244 #define ACT_IPO                 1
245 #define ACT_LAMP                2
246 #define ACT_CAMERA              3
247 #define ACT_MATERIAL    4
248 #define ACT_SOUND               5
249 #define ACT_PROPERTY    6
250         /* these two obsolete since 2.02 */
251 #define ACT_ADD_OBJECT  7
252 #define ACT_END_OBJECT  8
253
254 #define ACT_CONSTRAINT  9
255 #define ACT_EDIT_OBJECT 10
256 #define ACT_SCENE               11
257 #define ACT_GROUP               12
258 #define ACT_RANDOM      13
259 #define ACT_MESSAGE     14
260 #define ACT_ACTION              15      /* __ NLA */
261 #define ACT_CD                  16
262 #define ACT_GAME                17
263 #define ACT_VISIBILITY          18
264
265 /* actuator flag */
266 #define ACT_SHOW                1
267 #define ACT_DEL                 2
268 #define ACT_NEW                 4
269
270 /* link codes */
271 #define LINK_SENSOR             0
272 #define LINK_CONTROLLER 1
273 #define LINK_ACTUATOR   2
274
275 /* keyboardsensor->type */
276 #define SENS_ALL_KEYS   1
277
278 /* actionactuator->type */
279 #define ACT_ACTION_PLAY                 0
280 #define ACT_ACTION_PINGPONG             1
281 #define ACT_ACTION_FLIPPER              2
282 #define ACT_ACTION_LOOP_STOP    3
283 #define ACT_ACTION_LOOP_END             4
284 #define ACT_ACTION_KEY2KEY              5
285 #define ACT_ACTION_FROM_PROP    6
286 #define ACT_ACTION_MOTION               7
287
288 /* ipoactuator->type */
289 #define ACT_IPO_PLAY            0
290 #define ACT_IPO_PINGPONG        1
291 #define ACT_IPO_FLIPPER         2
292 #define ACT_IPO_LOOP_STOP       3
293 #define ACT_IPO_LOOP_END        4
294 #define ACT_IPO_KEY2KEY         5
295 #define ACT_IPO_FROM_PROP       6
296
297 /* groupactuator->type */
298 #define ACT_GROUP_PLAY          0
299 #define ACT_GROUP_PINGPONG      1
300 #define ACT_GROUP_FLIPPER       2
301 #define ACT_GROUP_LOOP_STOP     3
302 #define ACT_GROUP_LOOP_END      4
303 #define ACT_GROUP_FROM_PROP     5
304 #define ACT_GROUP_SET           6
305
306 /* ipoactuator->flag */
307 #define ACT_IPOFORCE        (1 << 0)
308 #define ACT_IPOEND          (1 << 1)
309 #define ACT_IPOFORCE_LOCAL  (1 << 2)
310 #define ACT_IPOCHILD        (1 << 4)                    
311
312 /* ipoactuator->flag for k2k */
313 #define ACT_K2K_PREV            1
314 #define ACT_K2K_CYCLIC          2
315 #define ACT_K2K_PINGPONG        4
316 #define ACT_K2K_HOLD            8
317
318 /* property actuator->type */
319 #define ACT_PROP_ASSIGN         0
320 #define ACT_PROP_ADD            1
321 #define ACT_PROP_COPY           2
322
323 /* constraint flag */
324 #define ACT_CONST_LOCX          1
325 #define ACT_CONST_LOCY          2
326 #define ACT_CONST_LOCZ          4
327 #define ACT_CONST_ROTX          8
328 #define ACT_CONST_ROTY          16
329 #define ACT_CONST_ROTZ          32
330
331 /* editObjectActuator->type */
332 #define ACT_EDOB_ADD_OBJECT             0
333 #define ACT_EDOB_END_OBJECT             1
334 #define ACT_EDOB_REPLACE_MESH   2
335 #define ACT_EDOB_TRACK_TO               3
336 #define ACT_EDOB_MAKE_CHILD             4
337 #define ACT_EDOB_END_CHILD              5
338
339 /* editObjectActuator->flag */
340 #define ACT_TRACK_3D                    1
341
342 /* SceneActuator->type */
343 #define ACT_SCENE_RESTART               0
344 #define ACT_SCENE_SET                   1
345 #define ACT_SCENE_CAMERA                2
346 #define ACT_SCENE_ADD_FRONT             3
347 #define ACT_SCENE_ADD_BACK              4
348 #define ACT_SCENE_REMOVE                5
349 #define ACT_SCENE_SUSPEND               6
350 #define ACT_SCENE_RESUME                7
351
352
353 /* randomAct->distribution */
354 #define ACT_RANDOM_BOOL_CONST                  0
355 #define ACT_RANDOM_BOOL_UNIFORM                1
356 #define ACT_RANDOM_BOOL_BERNOUILLI             2
357 #define ACT_RANDOM_INT_CONST                   3
358 #define ACT_RANDOM_INT_UNIFORM                 4
359 #define ACT_RANDOM_INT_POISSON                     5
360 #define ACT_RANDOM_FLOAT_CONST                 6
361 #define ACT_RANDOM_FLOAT_UNIFORM               7
362 #define ACT_RANDOM_FLOAT_NORMAL                8
363 #define ACT_RANDOM_FLOAT_NEGATIVE_EXPONENTIAL  9
364
365 /*  SoundActuator->type */
366 #define ACT_SND_PLAY_STOP_SOUND         0
367 #define ACT_SND_PLAY_END_SOUND          1
368 #define ACT_SND_LOOP_STOP_SOUND         2
369 #define ACT_SND_LOOP_END_SOUND          3
370 #define ACT_SND_LOOP_BIDIRECTIONAL_SOUND                4
371 #define ACT_SND_LOOP_BIDIRECTIONAL_STOP_SOUND   5
372
373 /* messageactuator->type */
374 #define ACT_MESG_MESG           0
375 #define ACT_MESG_PROP           1
376
377 /* cdactuator->type */
378 #define ACT_CD_PLAY_ALL         0
379 #define ACT_CD_PLAY_TRACK       1
380 #define ACT_CD_LOOP_TRACK       2
381 #define ACT_CD_VOLUME           3
382 #define ACT_CD_STOP                     4
383 #define ACT_CD_PAUSE            5
384 #define ACT_CD_RESUME           6
385
386 /* gameactuator->type */
387 #define ACT_GAME_LOAD           0
388 #define ACT_GAME_START          1
389 #define ACT_GAME_RESTART        2
390 #define ACT_GAME_QUIT           3
391
392 /* visibilityact->flag */
393 /* Set means the object will become invisible */
394 #define ACT_VISIBILITY_INVISIBLE       (1 << 0)
395
396 #endif
397