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