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