New particle collisions code:
[blender.git] / source / blender / makesdna / DNA_ipo_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): Joshua Leung
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29  
30 /** \file DNA_ipo_types.h
31  *  \ingroup DNA
32  *  \deprecated
33  *   The contents of this file are now officially depreceated. They were used for the 'old' animation system,
34  *   which has (as of 2.50) been replaced with a completely new system by Joshua Leung (aligorith). All defines, 
35  *   etc. are only still maintained to provide backwards compatability for old files.
36  */
37  
38 #ifndef DNA_IPO_TYPES_H
39 #define DNA_IPO_TYPES_H
40
41 #include "DNA_listBase.h"
42 #include "DNA_curve_types.h"
43 #include "DNA_vec_types.h"
44
45 #include "DNA_ID.h"
46
47 /* -------------------------- Type Defines --------------------------- */
48
49 /* sometimes used - mainly for GE/Ketsji */
50 typedef short IPO_Channel;  
51
52
53 /* --- IPO Curve Driver --- */
54
55 /* IPO Curve Driver */
56 typedef struct IpoDriver {
57         struct Object *ob;                      /* target/driver ob */
58         short blocktype, adrcode;       /* sub-channel to use */
59         
60         short type, flag;                       /* driver settings */
61         char name[128];                         /* bone, or python expression here */
62 } IpoDriver;
63
64 /* --- IPO Curve --- */
65
66 /* IPO Curve */
67 typedef struct IpoCurve {
68         struct IpoCurve *next,  *prev;
69         
70         struct BPoint *bp;                                      /* array of BPoints (sizeof(BPoint)*totvert) - i.e. baked/imported data */
71         struct BezTriple *bezt;                         /* array of BezTriples (sizeof(BezTriple)*totvert)  - i.e. user-editable keyframes  */
72
73         rctf maxrct, totrct;                            /* bounding boxes */
74
75         short blocktype, adrcode, vartype;      /* blocktype= ipo-blocktype; adrcode= type of ipo-curve; vartype= 'format' of data */
76         short totvert;                                          /* total number of BezTriples (i.e. keyframes) on curve */
77         short ipo, extrap;                                      /* interpolation and extrapolation modes  */
78         short flag, rt;                                         /* flag= settings; rt= ??? */
79         float ymin, ymax;                                       /* minimum/maximum y-extents for curve */
80         unsigned int bitmask;                           /* ??? */
81         
82         float slide_min, slide_max;                     /* minimum/maximum values for sliders (in action editor) */
83         float curval;                                           /* value of ipo-curve for current frame */
84         
85         IpoDriver *driver;                                      /* pointer to ipo-driver for this curve */
86 } IpoCurve;
87
88 /* --- ID-Datablock --- */
89
90 /* IPO Data-Block */
91 typedef struct Ipo {
92         ID id;
93         
94         ListBase curve;                         /* A list of IpoCurve structs in a linked list. */
95         rctf cur;                                       /* Rect defining extents of keyframes? */
96         
97         short blocktype, showkey;       /* blocktype: self-explanatory; showkey: either 0 or 1 (show vertical yellow lines for editing) */
98         short muteipo, pad;                     /* muteipo: either 0 or 1 (whether ipo block is muted) */       
99 } Ipo;
100
101 /* ----------- adrcodes (for matching ipo-curves to data) ------------- */
102
103 /* defines: are these duped or new? */
104 #define IPOBUTY 17
105
106 #define TOB_IPO 1
107 #define TOB_IPODROT     2
108
109 /* disptype */
110 #define IPO_DISPDEGR    1
111 #define IPO_DISPBITS    2
112 #define IPO_DISPTIME    3
113
114 /* ********** Object (ID_OB) ********** */
115
116 #define OB_TOTIPO       30
117 #define OB_TOTNAM       30
118
119 #define OB_LOC_X        1
120 #define OB_LOC_Y        2
121 #define OB_LOC_Z        3
122 #define OB_DLOC_X       4
123 #define OB_DLOC_Y       5
124 #define OB_DLOC_Z       6
125
126 #define OB_ROT_X        7
127 #define OB_ROT_Y        8
128 #define OB_ROT_Z        9
129 #define OB_DROT_X       10
130 #define OB_DROT_Y       11
131 #define OB_DROT_Z       12
132
133 #define OB_SIZE_X       13
134 #define OB_SIZE_Y       14
135 #define OB_SIZE_Z       15
136 #define OB_DSIZE_X      16
137 #define OB_DSIZE_Y      17
138 #define OB_DSIZE_Z      18
139
140 #define OB_LAY          19
141
142 #define OB_TIME         20
143
144 #define OB_COL_R        21
145 #define OB_COL_G        22
146 #define OB_COL_B        23
147 #define OB_COL_A        24
148
149 #define OB_PD_FSTR      25
150 #define OB_PD_FFALL     26
151 #define OB_PD_SDAMP     27
152 #define OB_PD_RDAMP     28
153 #define OB_PD_PERM      29
154 #define OB_PD_FMAXD     30
155
156 /* exception: driver channel, for bone driver only */
157 #define OB_ROT_DIFF     100
158
159
160 /* ********** Material (ID_MA) ********** */
161
162 #define MA_TOTIPO       40
163 #define MA_TOTNAM       26
164
165 #define MA_COL_R        1
166 #define MA_COL_G        2
167 #define MA_COL_B        3
168 #define MA_SPEC_R       4
169 #define MA_SPEC_G       5
170 #define MA_SPEC_B       6
171 #define MA_MIR_R        7
172 #define MA_MIR_G        8
173 #define MA_MIR_B        9
174 #define MA_REF          10
175 #define MA_ALPHA        11
176 #define MA_EMIT         12
177 #define MA_AMB          13
178 #define MA_SPEC         14
179 #define MA_HARD         15
180 #define MA_SPTR         16
181 #define MA_IOR          17
182 #define MA_MODE         18
183 #define MA_HASIZE       19
184 #define MA_TRANSLU      20
185 #define MA_RAYM         21
186 #define MA_FRESMIR      22
187 #define MA_FRESMIRI     23
188 #define MA_FRESTRA      24
189 #define MA_FRESTRAI     25
190 #define MA_ADD          26
191
192 #define MA_MAP1         (1<<5)
193 #define MA_MAP2         (1<<6)
194 #define MA_MAP3         (1<<7)
195 #define MA_MAP4         (1<<8)
196 #define MA_MAP5         (1<<9)
197 #define MA_MAP6         (1<<10)
198 #define MA_MAP7         (1<<11)
199 #define MA_MAP8         (1<<12)
200 #define MA_MAP9         (1<<13)
201 #define MA_MAP10        (1<<14)
202 #define MA_MAP11        (1<<15)
203 #define MA_MAP12        (1<<16)
204 #define MA_MAP13        (1<<17)
205 #define MA_MAP14        (1<<18)
206 #define MA_MAP15        (1<<19)
207 #define MA_MAP16        (1<<20)
208 #define MA_MAP17        (1<<21)
209 #define MA_MAP18        (1<<22)
210
211 /* ********** Texture Slots (MTex) ********** */
212
213 #define TEX_TOTNAM      14
214
215 #define MAP_OFS_X       1
216 #define MAP_OFS_Y       2
217 #define MAP_OFS_Z       3
218 #define MAP_SIZE_X      4
219 #define MAP_SIZE_Y      5
220 #define MAP_SIZE_Z      6
221 #define MAP_R           7
222 #define MAP_G           8
223 #define MAP_B           9
224
225 #define MAP_DVAR        10
226 #define MAP_COLF        11
227 #define MAP_NORF        12
228 #define MAP_VARF        13
229 #define MAP_DISP        14
230
231 /* ********** Texture (ID_TE) ********** */
232
233 #define TE_TOTIPO       26
234 #define TE_TOTNAM       26
235
236 #define TE_NSIZE        1
237 #define TE_NDEPTH       2
238 #define TE_NTYPE        3
239 #define TE_TURB         4
240
241 #define TE_VNW1         5
242 #define TE_VNW2         6
243 #define TE_VNW3         7
244 #define TE_VNW4         8
245 #define TE_VNMEXP       9
246 #define TE_VN_DISTM     10
247 #define TE_VN_COLT      11
248
249 #define TE_ISCA         12
250 #define TE_DISTA        13
251
252 #define TE_MG_TYP       14
253 #define TE_MGH          15
254 #define TE_MG_LAC       16
255 #define TE_MG_OCT       17
256 #define TE_MG_OFF       18
257 #define TE_MG_GAIN      19
258
259 #define TE_N_BAS1       20
260 #define TE_N_BAS2       21
261
262 #define TE_COL_R    22
263 #define TE_COL_G    23
264 #define TE_COL_B    24
265 #define TE_BRIGHT       25
266 #define TE_CONTRA       26
267
268 /* ******** Sequence (ID_SEQ) ********** */
269
270 #define SEQ_TOTIPO      1
271 #define SEQ_TOTNAM      1
272
273 #define SEQ_FAC1        1
274 #define SEQ_FAC_SPEED   2
275 #define SEQ_FAC_OPACITY 3
276
277 /* ********* Curve (ID_CU) *********** */
278
279 #define CU_TOTIPO       1
280 #define CU_TOTNAM       1
281
282 #define CU_SPEED        1
283
284 /* ********* ShapeKey (ID_KE) *********** */
285
286 #define KEY_TOTIPO      64
287 #define KEY_TOTNAM      64
288
289 #define KEY_SPEED       0
290 #define KEY_NR          1
291
292 /* ********* World (ID_WO) *********** */
293
294 #define WO_TOTIPO       29
295 #define WO_TOTNAM       16
296
297 #define WO_HOR_R        1
298 #define WO_HOR_G        2
299 #define WO_HOR_B        3
300 #define WO_ZEN_R        4
301 #define WO_ZEN_G        5
302 #define WO_ZEN_B        6
303
304 #define WO_EXPOS        7
305
306 #define WO_MISI         8
307 #define WO_MISTDI       9
308 #define WO_MISTSTA      10
309 #define WO_MISTHI       11
310
311 #define WO_STAR_R       12
312 #define WO_STAR_G       13
313 #define WO_STAR_B       14
314 #define WO_STARDIST     15
315 #define WO_STARSIZE     16
316
317 /* ********** Lamp (ID_LA) ********** */
318
319 #define LA_TOTIPO       21
320 #define LA_TOTNAM       10
321
322 #define LA_ENERGY       1
323 #define LA_COL_R        2
324 #define LA_COL_G        3
325 #define LA_COL_B        4
326 #define LA_DIST         5
327 #define LA_SPOTSI       6
328 #define LA_SPOTBL       7
329 #define LA_QUAD1        8
330 #define LA_QUAD2        9
331 #define LA_HALOINT      10
332
333 /* ********* Camera (ID_CA) ************ */
334
335 #define CAM_TOTIPO      7
336 #define CAM_TOTNAM      7
337
338 #define CAM_LENS        1
339 #define CAM_STA         2
340 #define CAM_END         3
341
342 /* yafray aperture & focal distance curves */
343 #define CAM_YF_APERT    4
344 #define CAM_YF_FDIST    5
345
346 #define CAM_SHIFT_X             6
347 #define CAM_SHIFT_Y             7
348
349 /* ********* Sound (ID_SO) *********** */
350
351 #define SND_TOTIPO      4
352 #define SND_TOTNAM      4
353
354 #define SND_VOLUME      1
355 #define SND_PITCH       2
356 #define SND_PANNING     3
357 #define SND_ATTEN       4
358
359 /* ******* PoseChannel (ID_PO) ********* */
360
361 #define AC_TOTIPO       13
362 #define AC_TOTNAM       13
363
364 #define AC_LOC_X        1
365 #define AC_LOC_Y        2
366 #define AC_LOC_Z        3
367
368 #define AC_SIZE_X       13
369 #define AC_SIZE_Y       14
370 #define AC_SIZE_Z       15
371
372 #define AC_EUL_X        16
373 #define AC_EUL_Y        17
374 #define AC_EUL_Z        18
375
376 #define AC_QUAT_W       25
377 #define AC_QUAT_X       26
378 #define AC_QUAT_Y       27
379 #define AC_QUAT_Z       28
380
381 /* ******** Constraint (ID_CO) ********** */
382
383 #define CO_TOTIPO       2
384 #define CO_TOTNAM       2
385
386 #define CO_ENFORCE      1
387 #define CO_HEADTAIL     2
388
389 /* ****** FluidSim (ID_FLUIDSIM) ****** */
390
391 #define FLUIDSIM_TOTIPO 13
392 #define FLUIDSIM_TOTNAM 13
393
394 #define FLUIDSIM_VISC   1
395 #define FLUIDSIM_TIME   2
396
397 #define FLUIDSIM_GRAV_X 3
398 #define FLUIDSIM_GRAV_Y 4
399 #define FLUIDSIM_GRAV_Z 5
400
401 #define FLUIDSIM_VEL_X  6
402 #define FLUIDSIM_VEL_Y  7
403 #define FLUIDSIM_VEL_Z  8
404
405 #define FLUIDSIM_ACTIVE 9
406
407 #define FLUIDSIM_ATTR_FORCE_STR         10
408 #define FLUIDSIM_ATTR_FORCE_RADIUS      11
409 #define FLUIDSIM_VEL_FORCE_STR          12
410 #define FLUIDSIM_VEL_FORCE_RADIUS       13
411
412 /* ******************** */
413 /* particle ipos */
414
415 /* ******* Particle (ID_PA) ******** */
416 #define PART_TOTIPO             25
417 #define PART_TOTNAM             25
418
419 #define PART_EMIT_FREQ  1
420 /* #define PART_EMIT_LIFE       2 */ /*UNUSED*/
421 #define PART_EMIT_VEL   3
422 #define PART_EMIT_AVE   4
423 /* #define PART_EMIT_SIZE       5 */ /*UNUSED*/
424
425 #define PART_AVE                6
426 #define PART_SIZE               7
427 #define PART_DRAG               8
428 #define PART_BROWN              9
429 #define PART_DAMP               10
430 #define PART_LENGTH             11
431 #define PART_CLUMP              12
432
433 #define PART_GRAV_X             13
434 #define PART_GRAV_Y             14
435 #define PART_GRAV_Z             15
436
437 #define PART_KINK_AMP   16
438 #define PART_KINK_FREQ  17
439 #define PART_KINK_SHAPE 18
440
441 #define PART_BB_TILT    19
442
443 #define PART_PD_FSTR    20
444 #define PART_PD_FFALL   21
445 #define PART_PD_FMAXD   22
446
447 #define PART_PD2_FSTR   23
448 #define PART_PD2_FFALL  24
449 #define PART_PD2_FMAXD  25
450
451
452 /* -------------------- Defines: Flags and Types ------------------ */
453
454 /* ----- IPO Curve Defines ------- */
455
456 /* icu->vartype */
457 #define IPO_CHAR                0
458 #define IPO_SHORT               1
459 #define IPO_INT                 2
460 #define IPO_LONG                3
461 #define IPO_FLOAT               4
462 #define IPO_DOUBLE              5
463 #define IPO_FLOAT_DEGR  6
464
465         /* very special case, in keys */
466 #define IPO_BEZTRIPLE   100
467 #define IPO_BPOINT              101
468
469 /* icu->vartype */
470 #define IPO_BITS                16
471 #define IPO_CHAR_BIT    16
472 #define IPO_SHORT_BIT   17
473 #define IPO_INT_BIT             18
474
475 /* icu->ipo:  the type of curve */
476 #define IPO_CONST               0
477 #define IPO_LIN                 1
478 #define IPO_BEZ                 2
479         /* not used yet */
480 #define IPO_MIXED               3 
481
482 /* icu->extrap */
483 #define IPO_HORIZ               0
484 #define IPO_DIR                 1
485 #define IPO_CYCL                2
486 #define IPO_CYCLX               3
487
488 /* icu->flag */
489 #define IPO_VISIBLE             1
490 #define IPO_SELECT              2
491 #define IPO_EDIT                4
492 #define IPO_LOCK                8
493 #define IPO_AUTO_HORIZ  16
494 #define IPO_ACTIVE              32
495 #define IPO_PROTECT             64
496 #define IPO_MUTE                128
497
498 /* ---------- IPO Drivers ----------- */
499
500 /* offset in driver->name for finding second posechannel for rot-diff  */
501 #define DRIVER_NAME_OFFS        32 
502
503 /* driver->type */
504 #define IPO_DRIVER_TYPE_NORMAL          0
505 #define IPO_DRIVER_TYPE_PYTHON          1
506
507 /* driver->flag */
508         /* invalid flag: currently only used for buggy pydriver expressions */
509 #define IPO_DRIVER_FLAG_INVALID         (1<<0)
510
511 #endif
512
513
514