Spelling Cleanup
[blender.git] / source / blender / makesdna / DNA_anim_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * Contributor(s): Joshua Leung (full recode)
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file DNA_anim_types.h
27  *  \ingroup DNA
28  */
29
30 #ifndef __DNA_ANIM_TYPES_H__
31 #define __DNA_ANIM_TYPES_H__
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #include "DNA_ID.h"
38 #include "DNA_listBase.h"
39 #include "DNA_action_types.h"
40 #include "DNA_curve_types.h"
41
42 /* ************************************************ */
43 /* F-Curve DataTypes */
44
45 /* Modifiers -------------------------------------- */
46
47 /* F-Curve Modifiers (fcm) 
48  *
49  * These alter the way F-Curves behave, by altering the value that is returned
50  * when evaluating the curve's data at some time (t). 
51  */
52 typedef struct FModifier {
53         struct FModifier *next, *prev;
54         
55         void *data;                     /* pointer to modifier data */
56         void *edata;            /* pointer to temporary data used during evaluation */
57         
58         char name[64];          /* user-defined description for the modifier */
59         short type;                     /* type of f-curve modifier */
60         short flag;                     /* settings for the modifier */
61         
62         float influence;        /* the amount that the modifier should influence the value */
63         
64         float sfra;                     /* start frame of restricted frame-range */
65         float efra;                     /* end frame of restricted frame-range */
66         float blendin;          /* number of frames from sfra before modifier takes full influence */
67         float blendout;         /* number of frames from efra before modifier fades out */
68 } FModifier;
69
70 /* Types of F-Curve modifier 
71  * WARNING: order here is important!
72  */
73 typedef enum eFModifier_Types {
74         FMODIFIER_TYPE_NULL = 0,
75         FMODIFIER_TYPE_GENERATOR,
76         FMODIFIER_TYPE_FN_GENERATOR,
77         FMODIFIER_TYPE_ENVELOPE,
78         FMODIFIER_TYPE_CYCLES,
79         FMODIFIER_TYPE_NOISE,
80         FMODIFIER_TYPE_FILTER,          /* unimplemented - for applying: fft, high/low pass filters, etc. */
81         FMODIFIER_TYPE_PYTHON,  
82         FMODIFIER_TYPE_LIMITS,
83         FMODIFIER_TYPE_STEPPED,
84         
85         /* NOTE: all new modifiers must be added above this line */
86         FMODIFIER_NUM_TYPES
87 } eFModifier_Types;
88
89 /* F-Curve Modifier Settings */
90 typedef enum eFModifier_Flags {
91                 /* modifier is not able to be evaluated for some reason, and should be skipped (internal) */
92         FMODIFIER_FLAG_DISABLED          = (1<<0),
93                 /* modifier's data is expanded (in UI) */
94         FMODIFIER_FLAG_EXPANDED          = (1<<1),
95                 /* modifier is active one (in UI) for editing purposes */
96         FMODIFIER_FLAG_ACTIVE            = (1<<2),
97                 /* user wants modifier to be skipped */
98         FMODIFIER_FLAG_MUTED             = (1<<3),
99                 /* restrict range that F-Modifier can be considered over */
100         FMODIFIER_FLAG_RANGERESTRICT = (1<<4),
101                 /* use influence control */
102         FMODIFIER_FLAG_USEINFLUENCE  = (1<<5)
103 } eFModifier_Flags; 
104
105 /* --- */
106
107 /* Generator modifier data */
108 typedef struct FMod_Generator {
109                 /* general generator information */
110         float *coefficients;            /* coefficients array */
111         unsigned int arraysize;         /* size of the coefficients array */
112         
113         int poly_order;                         /* order of polynomial generated (i.e. 1 for linear, 2 for quadratic) */
114         int mode;                                       /* which 'generator' to use eFMod_Generator_Modes */
115         
116                 /* settings */
117         int flag;                                       /* settings */
118 } FMod_Generator;
119
120 /* generator modes */
121 typedef enum eFMod_Generator_Modes {
122         FCM_GENERATOR_POLYNOMIAL        = 0,
123         FCM_GENERATOR_POLYNOMIAL_FACTORISED
124 } eFMod_Generator_Modes;
125
126
127 /* generator flags 
128  *      - shared by Generator and Function Generator
129  */
130 typedef enum eFMod_Generator_Flags {
131                 /* generator works in conjunction with other modifiers (i.e. doesn't replace those before it) */
132         FCM_GENERATOR_ADDITIVE  = (1<<0)
133 } eFMod_Generator_Flags;
134
135
136 /* 'Built-In Function' Generator modifier data
137  * 
138  * This uses the general equation for equations:
139  *              y = amplitude * fn(phase_multiplier*x + phase_offset) + y_offset
140  *
141  * where amplitude, phase_multiplier/offset, y_offset are user-defined coefficients,
142  * x is the evaluation 'time', and 'y' is the resultant value
143  */
144 typedef struct FMod_FunctionGenerator {
145                 /* coefficients for general equation (as above) */
146         float amplitude;
147         float phase_multiplier;
148         float phase_offset;
149         float value_offset;
150         
151                 /* flags */
152         int type;                               /* eFMod_Generator_Functions */
153         int flag;                               /* eFMod_Generator_flags */
154 } FMod_FunctionGenerator;
155
156 /* 'function' generator types */
157 typedef enum eFMod_Generator_Functions {
158         FCM_GENERATOR_FN_SIN    = 0,
159         FCM_GENERATOR_FN_COS,
160         FCM_GENERATOR_FN_TAN,
161         FCM_GENERATOR_FN_SQRT,
162         FCM_GENERATOR_FN_LN,
163         FCM_GENERATOR_FN_SINC
164 } eFMod_Generator_Functions;
165
166
167 /* envelope modifier - envelope data */
168 typedef struct FCM_EnvelopeData {
169         float min, max;                         /* min/max values for envelope at this point (absolute values)  */
170         float time;                                     /* time for that this sample-point occurs */
171         
172         short f1;                                       /* settings for 'min' control point */
173         short f2;                                       /* settings for 'max' control point */
174 } FCM_EnvelopeData;
175
176 /* envelope-like adjustment to values (for fade in/out) */
177 typedef struct FMod_Envelope {
178         FCM_EnvelopeData *data;         /* data-points defining envelope to apply (array)  */
179         int totvert;                            /* number of envelope points */
180         
181         float midval;                           /* value that envelope's influence is centered around / based on */
182         float min, max;                         /* distances from 'middle-value' for 1:1 envelope influence */
183 } FMod_Envelope;
184
185
186 /* cycling/repetition modifier data */
187 // TODO: we can only do complete cycles...
188 typedef struct FMod_Cycles {
189         short   before_mode;            /* extrapolation mode to use before first keyframe */
190         short   after_mode;                     /* extrapolation mode to use after last keyframe */
191         short   before_cycles;          /* number of 'cycles' before first keyframe to do */
192         short   after_cycles;           /* number of 'cycles' after last keyframe to do */
193 } FMod_Cycles;
194
195 /* cycling modes */
196 typedef enum eFMod_Cycling_Modes {
197         FCM_EXTRAPOLATE_NONE = 0,                       /* don't do anything */
198         FCM_EXTRAPOLATE_CYCLIC,                         /* repeat keyframe range as-is */
199         FCM_EXTRAPOLATE_CYCLIC_OFFSET,          /* repeat keyframe range, but with offset based on gradient between values */
200         FCM_EXTRAPOLATE_MIRROR                          /* alternate between forward and reverse playback of keyframe range */
201 } eFMod_Cycling_Modes;
202
203
204 /* Python-script modifier data */
205 typedef struct FMod_Python {
206         struct Text *script;            /* text buffer containing script to execute */
207         IDProperty *prop;                       /* ID-properties to provide 'custom' settings */
208 } FMod_Python;
209
210
211 /* limits modifier data */
212 typedef struct FMod_Limits {
213         rctf rect;                                      /* rect defining the min/max values */
214         int flag;                                       /* settings for limiting */
215         int pad;
216 } FMod_Limits;
217
218 /* limiting flags */
219 typedef enum eFMod_Limit_Flags {
220         FCM_LIMIT_XMIN          = (1<<0),
221         FCM_LIMIT_XMAX          = (1<<1),
222         FCM_LIMIT_YMIN          = (1<<2),
223         FCM_LIMIT_YMAX          = (1<<3)
224 } eFMod_Limit_Flags;
225
226
227 /* noise modifier data */
228 typedef struct FMod_Noise {
229         float size;
230         float strength;
231         float phase;
232         float pad;
233         
234         short depth;
235         short modification;
236 } FMod_Noise;
237         
238 /* modification modes */
239 typedef enum eFMod_Noise_Modifications {
240         FCM_NOISE_MODIF_REPLACE = 0,    /* Modify existing curve, matching it's shape */
241         FCM_NOISE_MODIF_ADD,                    /* Add noise to the curve */
242         FCM_NOISE_MODIF_SUBTRACT,               /* Subtract noise from the curve */
243         FCM_NOISE_MODIF_MULTIPLY                /* Multiply the curve by noise */
244 } eFMod_Noise_Modifications;
245
246
247 /* stepped modifier data */
248 typedef struct FMod_Stepped {
249         float step_size;                                /* Number of frames each interpolated value should be held */
250         float offset;                                   /* Reference frame number that stepping starts from */
251         
252         float start_frame;                              /* start frame of the frame range that modifier works in */                             
253         float end_frame;                                /* end frame of the frame range that modifier works in */
254         
255         int flag;                                               /* various settings */  
256 } FMod_Stepped;
257
258 /* stepped modifier range flags */
259 typedef enum eFMod_Stepped_Flags {
260         FCM_STEPPED_NO_BEFORE   = (1<<0),       /* don't affect frames before the start frame */
261         FCM_STEPPED_NO_AFTER    = (1<<1),       /* don't affect frames after the end frame */
262 } eFMod_Stepped_Flags;
263
264 /* Drivers -------------------------------------- */
265
266 /* Driver Target (dtar)
267  *
268  * Defines how to access a dependency needed for a driver variable.
269  */
270 typedef struct DriverTarget {
271         ID      *id;                            /* ID-block which owns the target, no user count */
272         
273         char *rna_path;                 /* RNA path defining the setting to use (for DVAR_TYPE_SINGLE_PROP) */
274         
275         char pchan_name[32];    /* name of the posebone to use (for vars where DTAR_FLAG_STRUCT_REF is used) */
276         short transChan;                /* transform channel index (for DVAR_TYPE_TRANSFORM_CHAN)*/
277         
278         short flag;                             /* flags for the validity of the target (NOTE: these get reset everytime the types change) */
279         int idtype;                             /* type of ID-block that this target can use */
280 } DriverTarget;
281
282 /* Driver Target flags */
283 typedef enum eDriverTarget_Flag {
284                 /* used for targets that use the pchan_name instead of RNA path 
285                  * (i.e. rotation difference) 
286                  */
287         DTAR_FLAG_STRUCT_REF    = (1<<0),
288                 /* idtype can only be 'Object' */
289         DTAR_FLAG_ID_OB_ONLY    = (1<<1),
290         
291         /* "localspace" flags */
292                 /* base flag - basically "pre parent+constraints" */
293         DTAR_FLAG_LOCALSPACE    = (1<<2),
294                 /* include constraints transformed to space including parents */
295         DTAR_FLAG_LOCAL_CONSTS  = (1<<3),
296 } eDriverTarget_Flag;
297
298 /* Transform Channels for Driver Targets */
299 typedef enum eDriverTarget_TransformChannels {
300         DTAR_TRANSCHAN_LOCX = 0,
301         DTAR_TRANSCHAN_LOCY,
302         DTAR_TRANSCHAN_LOCZ,
303         DTAR_TRANSCHAN_ROTX,
304         DTAR_TRANSCHAN_ROTY,
305         DTAR_TRANSCHAN_ROTZ,
306         DTAR_TRANSCHAN_SCALEX,
307         DTAR_TRANSCHAN_SCALEY,
308         DTAR_TRANSCHAN_SCALEZ,
309         
310         MAX_DTAR_TRANSCHAN_TYPES
311 } eDriverTarget_TransformChannels;
312
313 /* --- */
314
315 /* maximum number of driver targets per variable */
316 #define MAX_DRIVER_TARGETS      8
317
318
319 /* Driver Variable (dvar)
320  *
321  * A 'variable' for use as an input for the driver evaluation.
322  * Defines a way of accessing some channel to use, that can be
323  * referred to in the expression as a variable, thus simplifying
324  * expressions and also Depsgraph building.
325  */
326 typedef struct DriverVar {
327         struct DriverVar *next, *prev;
328         
329         char name[64];                          /* name of the variable to use in py-expression (must be valid python identifier) */
330         
331         DriverTarget targets[8];        /* MAX_DRIVER_TARGETS, target slots */  
332         short num_targets;                      /* number of targets actually used by this variable */
333         
334         short type;                                     /* type of driver target (eDriverTarget_Types) */       
335         float curval;                           /* result of previous evaluation */
336 } DriverVar;
337
338 /* Driver Variable Types */
339 typedef enum eDriverVar_Types {
340                 /* single RNA property */
341         DVAR_TYPE_SINGLE_PROP   = 0,
342                 /* rotation difference (between 2 bones) */
343         DVAR_TYPE_ROT_DIFF,
344                 /* distance between objects/bones */
345         DVAR_TYPE_LOC_DIFF,
346                 /* 'final' transform for object/bones */
347         DVAR_TYPE_TRANSFORM_CHAN,
348         
349         /* maximum number of variable types 
350          * NOTE: this must always be th last item in this list,
351          *              so add new types above this line
352          */
353         MAX_DVAR_TYPES
354 } eDriverVar_Types;
355
356 /* --- */
357
358 /* Channel Driver (i.e. Drivers / Expressions) (driver)
359  *
360  * Channel Drivers are part of the dependency system, and are executed in addition to 
361  * normal user-defined animation. They take the animation result of some channel(s), and
362  * use that (optionally combined with its own F-Curve for modification of results) to define
363  * the value of some setting semi-procedurally.
364  *
365  * Drivers are stored as part of F-Curve data, so that the F-Curve's RNA-path settings (for storing
366  * what setting the driver will affect). The order in which they are stored defines the order that they're
367  * evaluated in. This order is set by the Depsgraph's sorting stuff. 
368  */
369 typedef struct ChannelDriver {
370         ListBase variables;     /* targets for this driver (i.e. list of DriverVar) */
371         
372         /* python expression to execute (may call functions defined in an accessory file) 
373          * which relates the target 'variables' in some way to yield a single usable value
374          */
375         char expression[256];   /* expression to compile for evaluation */
376         void *expr_comp;                /* PyObject - compiled expression, dont save this */
377         
378         float curval;           /* result of previous evaluation */
379         float influence;        /* influence of driver on result */ // XXX to be implemented... this is like the constraint influence setting
380         
381                 /* general settings */
382         int type;                       /* type of driver */
383         int flag;                       /* settings of driver */
384 } ChannelDriver;
385
386 /* driver type */
387 typedef enum eDriver_Types {
388                 /* target values are averaged together */
389         DRIVER_TYPE_AVERAGE     = 0,
390                 /* python expression/function relates targets */
391         DRIVER_TYPE_PYTHON,
392                 /* sum of all values */
393         DRIVER_TYPE_SUM,
394                 /* smallest value */
395         DRIVER_TYPE_MIN,
396                 /* largest value */
397         DRIVER_TYPE_MAX
398 } eDriver_Types;
399
400 /* driver flags */
401 typedef enum eDriver_Flags {
402                 /* driver has invalid settings (internal flag)  */
403         DRIVER_FLAG_INVALID             = (1<<0),
404                 /* driver needs recalculation (set by depsgraph) */
405         DRIVER_FLAG_RECALC              = (1<<1),
406                 /* driver does replace value, but overrides (for layering of animation over driver) */
407                 // TODO: this needs to be implemented at some stage or left out...
408         //DRIVER_FLAG_LAYERING  = (1<<2),
409                 /* use when the expression needs to be recompiled */
410         DRIVER_FLAG_RECOMPILE   = (1<<3),
411                 /* the names are cached so they dont need have python unicode versions created each time */
412         DRIVER_FLAG_RENAMEVAR   = (1<<4),
413                 /* intermediate values of driver should be shown in the UI for debugging purposes */
414         DRIVER_FLAG_SHOWDEBUG   = (1<<5)
415 } eDriver_Flags;
416
417 /* F-Curves -------------------------------------- */
418
419 /* FPoint (fpt)
420  *
421  * This is the bare-minimum data required storing motion samples. Should be more efficient
422  * than using BPoints, which contain a lot of other unnecessary data...
423  */
424 typedef struct FPoint {
425         float vec[2];           /* time + value */
426         int flag;                       /* selection info */
427         int pad;
428 } FPoint;
429
430 /* 'Function-Curve' - defines values over time for a given setting (fcu) */
431 typedef struct FCurve {
432         struct FCurve *next, *prev;
433         
434                 /* group */
435         bActionGroup *grp;              /* group that F-Curve belongs to */
436         
437                 /* driver settings */
438         ChannelDriver *driver;  /* only valid for drivers (i.e. stored in AnimData not Actions) */
439                 /* evaluation settings */
440         ListBase modifiers;             /* FCurve Modifiers */
441                 
442                 /* motion data */
443         BezTriple *bezt;                /* user-editable keyframes (array) */
444         FPoint *fpt;                    /* 'baked/imported' motion samples (array) */
445         unsigned int totvert;   /* total number of points which define the curve (i.e. size of arrays in FPoints) */
446         
447                 /* value cache + settings */
448         float curval;                   /* value stored from last time curve was evaluated */
449         short flag;                             /* user-editable settings for this curve */
450         short extend;                   /* value-extending mode for this curve (does not cover  */
451         
452                 /* RNA - data link */
453         int array_index;                /* if applicable, the index of the RNA-array item to get */
454         char *rna_path;                 /* RNA-path to resolve data-access */
455         
456                 /* curve coloring (for editor) */
457         int color_mode;                 /* coloring method to use (eFCurve_Coloring) */
458         float color[3];                 /* the last-color this curve took */
459 } FCurve;
460
461
462 /* user-editable flags/settings */
463 typedef enum eFCurve_Flags {
464                 /* curve/keyframes are visible in editor */
465         FCURVE_VISIBLE          = (1<<0),
466                 /* curve is selected for editing  */
467         FCURVE_SELECTED         = (1<<1),
468                 /* curve is active one */
469         FCURVE_ACTIVE           = (1<<2),
470                 /* keyframes (beztriples) cannot be edited */
471         FCURVE_PROTECTED        = (1<<3),
472                 /* fcurve will not be evaluated for the next round */
473         FCURVE_MUTED            = (1<<4),
474         
475                 /* fcurve uses 'auto-handles', which stay horizontal... */
476                 // DEPRECATED
477         FCURVE_AUTO_HANDLES     = (1<<5),
478         
479                 /* skip evaluation, as RNA-path cannot be resolved (similar to muting, but cannot be set by user) */
480         FCURVE_DISABLED                 = (1<<10),
481                 /* curve can only have whole-number values (integer types) */
482         FCURVE_INT_VALUES               = (1<<11),
483                 /* curve can only have certain discrete-number values (no interpolation at all, for enums/booleans) */
484         FCURVE_DISCRETE_VALUES  = (1<<12),
485         
486                 /* temporary tag for editing */
487         FCURVE_TAGGED                   = (1<<15)
488 } eFCurve_Flags;
489
490 /* extrapolation modes (only simple value 'extending') */
491 typedef enum eFCurve_Extend {
492         FCURVE_EXTRAPOLATE_CONSTANT     = 0,    /* just extend min/max keyframe value  */
493         FCURVE_EXTRAPOLATE_LINEAR                       /* just extend gradient of segment between first segment keyframes */
494 } eFCurve_Extend;
495
496 /* curve coloring modes */
497 typedef enum eFCurve_Coloring {
498         FCURVE_COLOR_AUTO_RAINBOW = 0,          /* automatically determine color using rainbow (calculated at drawtime) */
499         FCURVE_COLOR_AUTO_RGB,                          /* automatically determine color using XYZ (array index) <-> RGB */
500         FCURVE_COLOR_CUSTOM                                     /* custom color */
501 } eFCurve_Coloring;
502
503 /* ************************************************ */
504 /* 'Action' Datatypes */
505
506 /* NOTE: Although these are part of the Animation System,
507  * they are not stored here... see DNA_action_types.h instead
508  */
509
510  
511 /* ************************************************ */
512 /* Animation Reuse - i.e. users of Actions */
513
514 /* Retargetting ----------------------------------- */
515
516 /* Retargetting Pair
517  *
518  * Defines what parts of the paths should be remapped from 'abc' to 'xyz'.
519  * TODO:
520  *      - Regrex (possibly provided through PY, though having our own module might be faster)
521  *        would be important to have at some point. Current replacements are just simple
522  *        string matches...
523  */
524 typedef struct AnimMapPair {
525         char from[128];         /* part of path to bed replaced */
526         char to[128];           /* part of path to replace with */
527 } AnimMapPair;
528
529 /* Retargetting Information for Actions 
530  *
531  * This should only be used if it is strictly necessary (i.e. user will need to explictly 
532  * add this when they find that some channels do not match, or motion is not going to right 
533  * places). When executing an action, this will be checked to see if it provides any useful
534  * remaps for the given paths.
535  *
536  * NOTE: we currently don't store this in the Action itself, as that causes too many problems.
537  */
538 // FIXME: will this be too clumsy or slow? If we're using RNA paths anyway, we'll have to accept
539 // such consequences...
540 typedef struct AnimMapper {
541         struct AnimMapper *next, *prev;
542         
543         bAction *target;                /* target action */
544         ListBase mappings;              /* remapping table (bAnimMapPair) */
545 } AnimMapper;
546
547 /* ************************************************ */
548 /* NLA - Non-Linear Animation */
549
550 /* NLA Strips ------------------------------------- */
551
552 /* NLA Strip (strip)
553  *
554  * A NLA Strip is a container for the reuse of Action data, defining parameters
555  * to control the remapping of the Action data to some destination. 
556  */
557 typedef struct NlaStrip {
558         struct NlaStrip *next, *prev;
559         
560         ListBase strips;                        /* 'Child' strips (used for 'meta' strips) */
561         bAction *act;                           /* Action that is referenced by this strip (strip is 'user' of the action) */
562         AnimMapper *remap;                      /* Remapping info this strip (for tweaking correspondence of action with context) */
563         
564         ListBase fcurves;                       /* F-Curves for controlling this strip's influence and timing */        // TODO: move out?
565         ListBase modifiers;                     /* F-Curve modifiers to be applied to the entire strip's referenced F-Curves */
566         
567         char name[64];                          /* User-Visible Identifier for Strip */
568         
569         float influence;                        /* Influence of strip */
570         float strip_time;                       /* Current 'time' within action being used (automatically evaluated, but can be overridden) */
571         
572         float start, end;                       /* extents of the strip */
573         float actstart, actend;         /* range of the action to use */
574         
575         float repeat;                           /* The number of times to repeat the action range (only when no F-Curves) */
576         float scale;                            /* The amount the action range is scaled by (only when no F-Curves) */
577         
578         float blendin, blendout;        /* strip blending length (only used when there are no F-Curves) */      
579         short blendmode;                        /* strip blending mode (layer-based mixing) */
580         
581         short extendmode;                       /* strip extrapolation mode (time-based mixing) */
582         short pad1;
583         
584         short type;                                     /* type of NLA strip */
585         
586         void *speaker_handle;           /* handle for speaker objects */
587         
588         int flag;                                       /* settings */
589         int pad2;
590 } NlaStrip;
591
592 /* NLA Strip Blending Mode */
593 typedef enum eNlaStrip_Blend_Mode {
594         NLASTRIP_MODE_REPLACE = 0,
595         NLASTRIP_MODE_ADD,
596         NLASTRIP_MODE_SUBTRACT,
597         NLASTRIP_MODE_MULTIPLY
598 } eNlaStrip_Blend_Mode;
599
600 /* NLA Strip Extrpolation Mode */
601 typedef enum eNlaStrip_Extrapolate_Mode {
602                 /* extend before first frame if no previous strips in track, and always hold+extend last frame */
603         NLASTRIP_EXTEND_HOLD    = 0,            
604                 /* only hold+extend last frame */
605         NLASTRIP_EXTEND_HOLD_FORWARD,   
606                 /* don't contribute at all */
607         NLASTRIP_EXTEND_NOTHING
608 } eNlaStrip_Extrapolate_Mode;
609
610 /* NLA Strip Settings */
611 typedef enum eNlaStrip_Flag {
612         /* UI selection flags */
613                 /* NLA strip is the active one in the track (also indicates if strip is being tweaked) */
614         NLASTRIP_FLAG_ACTIVE            = (1<<0),       
615                 /* NLA strip is selected for editing */
616         NLASTRIP_FLAG_SELECT            = (1<<1),
617 //      NLASTRIP_FLAG_SELECT_L          = (1<<2),       // left handle selected
618 //      NLASTRIP_FLAG_SELECT_R          = (1<<3),       // right handle selected
619                 /* NLA strip uses the same action that the action being tweaked uses (not set for the twaking one though) */
620         NLASTRIP_FLAG_TWEAKUSER         = (1<<4),
621         
622         /* controls driven by local F-Curves */
623                 /* strip influence is controlled by local F-Curve */
624         NLASTRIP_FLAG_USR_INFLUENCE     = (1<<5),
625         NLASTRIP_FLAG_USR_TIME          = (1<<6),
626         NLASTRIP_FLAG_USR_TIME_CYCLIC = (1<<7),
627         
628                 /* NLA strip length is synced to the length of the referenced action */
629         NLASTRIP_FLAG_SYNC_LENGTH       = (1<<9),
630         
631         /* playback flags (may be overriden by F-Curves) */
632                 /* NLA strip blendin/out values are set automatically based on overlaps */
633         NLASTRIP_FLAG_AUTO_BLENDS       = (1<<10),
634                 /* NLA strip is played back in reverse order */
635         NLASTRIP_FLAG_REVERSE           = (1<<11),
636                 /* NLA strip is muted (i.e. doesn't contribute in any way) */
637         NLASTRIP_FLAG_MUTED                     = (1<<12),
638                 /* NLA Strip is played back in 'ping-pong' style */
639         NLASTRIP_FLAG_MIRROR            = (1<<13),
640         
641         /* temporary editing flags */
642                 /* NLA-Strip is really just a temporary meta used to facilitate easier transform code */
643         NLASTRIP_FLAG_TEMP_META         = (1<<30),
644         NLASTRIP_FLAG_EDIT_TOUCHED      = (1<<31)
645 } eNlaStrip_Flag;
646
647 /* NLA Strip Type */
648 typedef enum eNlaStrip_Type {   
649                 /* 'clip' - references an Action */
650         NLASTRIP_TYPE_CLIP      = 0,
651                 /* 'transition' - blends between the adjacent strips */
652         NLASTRIP_TYPE_TRANSITION,
653                 /* 'meta' - a strip which acts as a container for a few others */
654         NLASTRIP_TYPE_META,     
655         
656                 /* 'emit sound' - a strip which is used for timing when speaker emits sounds */
657         NLASTRIP_TYPE_SOUND
658 } eNlaStrip_Type;
659
660 /* NLA Tracks ------------------------------------- */
661
662 /* NLA Track (nlt)
663  *
664  * A track groups a bunch of 'strips', which should form a continous set of 
665  * motion, on top of which other such groups can be layered. This should allow
666  * for animators to work in a non-destructive manner, layering tweaks, etc. over
667  * 'rough' blocks of their work.
668  */
669 typedef struct NlaTrack {
670         struct NlaTrack *next, *prev;
671         
672         ListBase strips;                /* bActionStrips in this track */
673         
674         int flag;                               /* settings for this track */
675         int index;                              /* index of the track in the stack (NOTE: not really useful, but we need a pad var anyways!) */
676         
677         char name[64];                  /* short user-description of this track */
678 } NlaTrack;
679
680 /* settings for track */
681 typedef enum eNlaTrack_Flag {
682                 /* track is the one that settings can be modified on, also indicates if track is being 'tweaked' */
683         NLATRACK_ACTIVE         = (1<<0),
684                 /* track is selected in UI for relevant editing operations */
685         NLATRACK_SELECTED       = (1<<1),
686                 /* track is not evaluated */
687         NLATRACK_MUTED          = (1<<2),
688                 /* track is the only one evaluated (must be used in conjunction with adt->flag) */
689         NLATRACK_SOLO           = (1<<3),
690                 /* track's settings (and strips) cannot be edited (to guard against unwanted changes) */
691         NLATRACK_PROTECTED      = (1<<4),
692         
693                 /* track is not allowed to execute, usually as result of tweaking being enabled (internal flag) */
694         NLATRACK_DISABLED       = (1<<10)
695 } eNlaTrack_Flag;
696
697
698 /* ************************************ */
699 /* KeyingSet Datatypes */
700
701 /* Path for use in KeyingSet definitions (ksp) 
702  *
703  * Paths may be either specific (specifying the exact sub-ID
704  * dynamic data-block - such as PoseChannels - to act upon, ala
705  * Maya's 'Character Sets' and XSI's 'Marking Sets'), or they may
706  * be generic (using various placeholder template tags that will be
707  * replaced with appropriate information from the context). 
708  */
709 typedef struct KS_Path {
710         struct KS_Path *next, *prev;
711         
712         ID *id;                                 /* ID block that keyframes are for */
713         char group[64];                 /* name of the group to add to */
714         
715         int idtype;                             /* ID-type that path can be used on */
716         
717         short groupmode;                /* group naming (eKSP_Grouping) */
718         short pad;
719         
720         char *rna_path;                 /* dynamically (or statically in the case of predefined sets) path */
721         int array_index;                /* index that path affects */
722         
723         short flag;                             /* various settings, etc. */
724         short keyingflag;               /* settings to supply insertkey() with */
725 } KS_Path;
726
727 /* KS_Path->flag */
728 typedef enum eKSP_Settings {
729                 /* entire array (not just the specified index) gets keyframed */
730         KSP_FLAG_WHOLE_ARRAY    = (1<<0)
731 } eKSP_Settings;
732
733 /* KS_Path->groupmode */
734 typedef enum eKSP_Grouping {
735                 /* path should be grouped using group name stored in path */
736         KSP_GROUP_NAMED = 0,
737                 /* path should not be grouped at all */
738         KSP_GROUP_NONE,
739                 /* path should be grouped using KeyingSet's name */
740         KSP_GROUP_KSNAME,
741                 /* path should be grouped using name of inner-most context item from templates 
742                  *      - this is most useful for relative KeyingSets only
743                  */
744         KSP_GROUP_TEMPLATE_ITEM
745 } eKSP_Grouping;
746
747 /* ---------------- */
748  
749 /* KeyingSet definition (ks)
750  *
751  * A KeyingSet defines a group of properties that should
752  * be keyframed together, providing a convenient way for animators
753  * to insert keyframes without resorting to Auto-Keyframing.
754  *
755  * A few 'generic' (non-absolute and dependent on templates) KeyingSets 
756  * are defined 'built-in' to facilitate easy animating for the casual
757  * animator without the need to add extra steps to the rigging process.
758  */
759 typedef struct KeyingSet {
760         struct KeyingSet *next, *prev;
761         
762         ListBase paths;                 /* (KS_Path) paths to keyframe to */
763         
764         char name[64];                  /* user-viewable name for KeyingSet (for menus, etc.) */
765         char typeinfo[64];              /* name of the typeinfo data used for the relative paths */
766         
767         short flag;                             /* settings for KeyingSet */
768         short keyingflag;               /* settings to supply insertkey() with */
769         
770         int active_path;                /* index of the active path */
771 } KeyingSet;
772
773 /* KeyingSet settings */
774 typedef enum eKS_Settings {
775                 /* keyingset cannot be removed (and doesn't need to be freed) */
776         KEYINGSET_BUILTIN               = (1<<0),
777                 /* keyingset does not depend on context info (i.e. paths are absolute) */
778         KEYINGSET_ABSOLUTE              = (1<<1)
779 } eKS_Settings;
780
781 /* Flags for use by keyframe creation/deletion calls */
782 typedef enum eInsertKeyFlags {
783         INSERTKEY_NEEDED        = (1<<0),       /* only insert keyframes where they're needed */
784         INSERTKEY_MATRIX        = (1<<1),       /* insert 'visual' keyframes where possible/needed */
785         INSERTKEY_FAST          = (1<<2),       /* don't recalculate handles,etc. after adding key */
786         INSERTKEY_FASTR         = (1<<3),       /* don't realloc mem (or increase count, as array has already been set out) */
787         INSERTKEY_REPLACE       = (1<<4),       /* only replace an existing keyframe (this overrides INSERTKEY_NEEDED) */
788         INSERTKEY_XYZ2RGB       = (1<<5)        /* transform F-Curves should have XYZ->RGB color mode */
789 } eInsertKeyFlags;
790
791 /* ************************************************ */
792 /* Animation Data */
793
794 /* AnimOverride ------------------------------------- */
795
796 /* Animation Override (aor) 
797  *
798  * This is used to as temporary storage of values which have been changed by the user, but not
799  * yet keyframed (thus, would get overwritten by the animation system before the user had a chance
800  * to see the changes that were made). 
801  *
802  * It is probably not needed for overriding keyframed values in most cases, as those will only get evaluated
803  * on frame-change now. That situation may change in future.
804  */
805 typedef struct AnimOverride {
806         struct AnimOverride *next, *prev;
807         
808         char *rna_path;                 /* RNA-path to use to resolve data-access */
809         int array_index;                /* if applicable, the index of the RNA-array item to get */
810         
811         float value;                    /* value to override setting with */
812 } AnimOverride;
813
814 /* AnimData ------------------------------------- */
815
816 /* Animation data for some ID block (adt)
817  * 
818  * This block of data is used to provide all of the necessary animation data for a datablock.
819  * Currently, this data will not be reusable, as there shouldn't be any need to do so.
820  * 
821  * This information should be made available for most if not all ID-blocks, which should 
822  * enable all of its settings to be animatable locally. Animation from 'higher-up' ID-AnimData
823  * blocks may override local settings.
824  *
825  * This datablock should be placed immediately after the ID block where it is used, so that
826  * the code which retrieves this data can do so in an easier manner. See blenkernel/intern/anim_sys.c for details.
827  */
828 typedef struct AnimData {       
829                 /* active action - acts as the 'tweaking track' for the NLA */
830         bAction         *action;        
831                 /* temp-storage for the 'real' active action (i.e. the one used before the tweaking-action 
832                  * took over to be edited in the Animation Editors) 
833                  */
834         bAction         *tmpact;
835                 /* remapping-info for active action - should only be used if needed 
836                  * (for 'foreign' actions that aren't working correctly) 
837                  */
838         AnimMapper      *remap;                 
839         
840                 /* nla-tracks */
841         ListBase        nla_tracks;
842                 /* active NLA-strip (only set/used during tweaking, so no need to worry about dangling pointers) */
843         NlaStrip        *actstrip;
844         
845         /* 'drivers' for this ID-block's settings - FCurves, but are completely 
846          * separate from those for animation data 
847          */
848         ListBase        drivers;        /* standard user-created Drivers/Expressions (used as part of a rig) */
849         ListBase        overrides;      /* temp storage (AnimOverride) of values for settings that are animated (but the value hasn't been keyframed) */
850         
851                 /* settings for animation evaluation */
852         int flag;                               /* user-defined settings */
853         int recalc;                             /* depsgraph recalculation flags */     
854         
855                 /* settings for active action evaluation (based on NLA strip settings) */
856         short act_blendmode;    /* accumulation mode for active action */
857         short act_extendmode;   /* extrapolation mode for active action */
858         float act_influence;    /* influence for active action */
859 } AnimData;
860
861 /* Animation Data settings (mostly for NLA) */
862 typedef enum eAnimData_Flag {
863                 /* only evaluate a single track in the NLA */
864         ADT_NLA_SOLO_TRACK              = (1<<0),
865                 /* don't use NLA */
866         ADT_NLA_EVAL_OFF                = (1<<1),
867                 /* NLA is being 'tweaked' (i.e. in EditMode) */
868         ADT_NLA_EDIT_ON                 = (1<<2),
869                 /* active Action for 'tweaking' does not have mapping applied for editing */
870         ADT_NLA_EDIT_NOMAP              = (1<<3),
871                 /* NLA-Strip F-Curves are expanded in UI */
872         ADT_NLA_SKEYS_COLLAPSED = (1<<4),
873         
874                 /* drivers expanded in UI */
875         ADT_DRIVERS_COLLAPSED   = (1<<10),
876                 /* don't execute drivers */
877         ADT_DRIVERS_DISABLED    = (1<<11),
878         
879                 /* AnimData block is selected in UI */
880         ADT_UI_SELECTED                 = (1<<14),
881                 /* AnimData block is active in UI */
882         ADT_UI_ACTIVE                   = (1<<15),
883         
884                 /* F-Curves from this AnimData block are not visible in the Graph Editor */
885         ADT_CURVES_NOT_VISIBLE  = (1<<16)
886 } eAnimData_Flag;
887
888 /* Animation Data recalculation settings (to be set by depsgraph) */
889 typedef enum eAnimData_Recalc {
890         ADT_RECALC_DRIVERS              = (1<<0),
891         ADT_RECALC_ANIM                 = (1<<1),
892         ADT_RECALC_ALL                  = (ADT_RECALC_DRIVERS|ADT_RECALC_ANIM)
893 } eAnimData_Recalc;
894
895 /* Base Struct for Anim ------------------------------------- */
896
897 /* Used for BKE_animdata_from_id() 
898  * All ID-datablocks which have their own 'local' AnimData
899  * should have the same arrangement in their structs.
900  */
901 typedef struct IdAdtTemplate {
902         ID id;
903         AnimData *adt;
904 } IdAdtTemplate;
905
906 /* ************************************************ */
907
908 #ifdef __cplusplus
909 };
910 #endif
911
912 #endif /* __DNA_ANIM_TYPES_H__ */