Merge remote-tracking branch 'origin/master' into blender2.8
[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         struct FCurve *curve;  /* containing curve, only used for updates to CYCLES */
56         void *data;                     /* pointer to modifier data */
57
58         char name[64];          /* user-defined description for the modifier - MAX_ID_NAME-2 */
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 = 1,
76         FMODIFIER_TYPE_FN_GENERATOR = 2,
77         FMODIFIER_TYPE_ENVELOPE = 3,
78         FMODIFIER_TYPE_CYCLES = 4,
79         FMODIFIER_TYPE_NOISE = 5,
80         FMODIFIER_TYPE_FILTER = 6,              /* unimplemented - for applying: fft, high/low pass filters, etc. */
81         FMODIFIER_TYPE_PYTHON = 7,
82         FMODIFIER_TYPE_LIMITS = 8,
83         FMODIFIER_TYPE_STEPPED = 9,
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 = 1
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    = 1,
160         FCM_GENERATOR_FN_TAN    = 2,
161         FCM_GENERATOR_FN_SQRT   = 3,
162         FCM_GENERATOR_FN_LN     = 4,
163         FCM_GENERATOR_FN_SINC   = 5
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 offset;
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[64];    /* name of the posebone to use (for vars where DTAR_FLAG_STRUCT_REF is used) - MAX_ID_NAME-2 */
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 every time 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
297         /* error flags */
298         DTAR_FLAG_INVALID               = (1 << 4),
299 } eDriverTarget_Flag;
300
301 /* Transform Channels for Driver Targets */
302 typedef enum eDriverTarget_TransformChannels {
303         DTAR_TRANSCHAN_LOCX = 0,
304         DTAR_TRANSCHAN_LOCY,
305         DTAR_TRANSCHAN_LOCZ,
306         DTAR_TRANSCHAN_ROTX,
307         DTAR_TRANSCHAN_ROTY,
308         DTAR_TRANSCHAN_ROTZ,
309         DTAR_TRANSCHAN_SCALEX,
310         DTAR_TRANSCHAN_SCALEY,
311         DTAR_TRANSCHAN_SCALEZ,
312
313         MAX_DTAR_TRANSCHAN_TYPES
314 } eDriverTarget_TransformChannels;
315
316 /* --- */
317
318 /* maximum number of driver targets per variable */
319 #define MAX_DRIVER_TARGETS      8
320
321
322 /* Driver Variable (dvar)
323  *
324  * A 'variable' for use as an input for the driver evaluation.
325  * Defines a way of accessing some channel to use, that can be
326  * referred to in the expression as a variable, thus simplifying
327  * expressions and also Depsgraph building.
328  */
329 typedef struct DriverVar {
330         struct DriverVar *next, *prev;
331
332         char name[64];              /* name of the variable to use in py-expression (must be valid python identifier) - MAX_ID_NAME-2 */
333
334         DriverTarget targets[8];    /* MAX_DRIVER_TARGETS, target slots */
335
336         char num_targets;           /* number of targets actually used by this variable */
337         char type;                  /* type of driver variable (eDriverVar_Types) */
338
339         short flag;                 /* validation tags, etc. (eDriverVar_Flags) */
340         float curval;               /* result of previous evaluation */
341 } DriverVar;
342
343 /* Driver Variable Types */
344 typedef enum eDriverVar_Types {
345                 /* single RNA property */
346         DVAR_TYPE_SINGLE_PROP   = 0,
347                 /* rotation difference (between 2 bones) */
348         DVAR_TYPE_ROT_DIFF,
349                 /* distance between objects/bones */
350         DVAR_TYPE_LOC_DIFF,
351                 /* 'final' transform for object/bones */
352         DVAR_TYPE_TRANSFORM_CHAN,
353
354         /* maximum number of variable types
355          * NOTE: this must always be th last item in this list,
356          *       so add new types above this line.
357          */
358         MAX_DVAR_TYPES
359 } eDriverVar_Types;
360
361 /* Driver Variable Flags */
362 typedef enum eDriverVar_Flags {
363         /* variable is not set up correctly */
364         DVAR_FLAG_ERROR               = (1 << 0),
365
366         /* variable name doesn't pass the validation tests */
367         DVAR_FLAG_INVALID_NAME        = (1 << 1),
368         /* name starts with a number */
369         DVAR_FLAG_INVALID_START_NUM   = (1 << 2),
370         /* name starts with a special character (!, $, @, #, _, etc.) */
371         DVAR_FLAG_INVALID_START_CHAR  = (1 << 3),
372         /* name contains a space */
373         DVAR_FLAG_INVALID_HAS_SPACE   = (1 << 4),
374         /* name contains a dot */
375         DVAR_FLAG_INVALID_HAS_DOT     = (1 << 5),
376         /* name contains invalid chars */
377         DVAR_FLAG_INVALID_HAS_SPECIAL = (1 << 6),
378         /* name is a reserved keyword */
379         DVAR_FLAG_INVALID_PY_KEYWORD  = (1 << 7),
380         /* name is zero-length */
381         DVAR_FLAG_INVALID_EMPTY       = (1 << 8),
382 } eDriverVar_Flags;
383
384 /* All invalid dvar name flags */
385 #define DVAR_ALL_INVALID_FLAGS (   \
386         DVAR_FLAG_INVALID_NAME |       \
387         DVAR_FLAG_INVALID_START_NUM | \
388         DVAR_FLAG_INVALID_START_CHAR | \
389         DVAR_FLAG_INVALID_HAS_SPACE |  \
390         DVAR_FLAG_INVALID_HAS_DOT |    \
391         DVAR_FLAG_INVALID_HAS_SPECIAL |  \
392         DVAR_FLAG_INVALID_PY_KEYWORD  | \
393         DVAR_FLAG_INVALID_EMPTY  \
394 )
395
396 /* --- */
397
398 /* Channel Driver (i.e. Drivers / Expressions) (driver)
399  *
400  * Channel Drivers are part of the dependency system, and are executed in addition to
401  * normal user-defined animation. They take the animation result of some channel(s), and
402  * use that (optionally combined with its own F-Curve for modification of results) to define
403  * the value of some setting semi-procedurally.
404  *
405  * Drivers are stored as part of F-Curve data, so that the F-Curve's RNA-path settings (for storing
406  * what setting the driver will affect). The order in which they are stored defines the order that they're
407  * evaluated in. This order is set by the Depsgraph's sorting stuff.
408  */
409 typedef struct ChannelDriver {
410         ListBase variables;     /* targets for this driver (i.e. list of DriverVar) */
411
412         /* python expression to execute (may call functions defined in an accessory file)
413          * which relates the target 'variables' in some way to yield a single usable value
414          */
415         char expression[256];   /* expression to compile for evaluation */
416         void *expr_comp;                /* PyObject - compiled expression, don't save this */
417
418         struct ExprPyLike_Parsed *expr_simple; /* compiled simple arithmetic expression */
419
420         float curval;           /* result of previous evaluation */
421         float influence;        /* influence of driver on result */ // XXX to be implemented... this is like the constraint influence setting
422
423                 /* general settings */
424         int type;                       /* type of driver */
425         int flag;                       /* settings of driver */
426 } ChannelDriver;
427
428 /* driver type */
429 typedef enum eDriver_Types {
430                 /* target values are averaged together */
431         DRIVER_TYPE_AVERAGE     = 0,
432                 /* python expression/function relates targets */
433         DRIVER_TYPE_PYTHON,
434                 /* sum of all values */
435         DRIVER_TYPE_SUM,
436                 /* smallest value */
437         DRIVER_TYPE_MIN,
438                 /* largest value */
439         DRIVER_TYPE_MAX
440 } eDriver_Types;
441
442 /* driver flags */
443 /* note: (1<<5) is deprecated; was "DRIVER_FLAG_SHOWDEBUG" */
444 typedef enum eDriver_Flags {
445                 /* driver has invalid settings (internal flag)  */
446         DRIVER_FLAG_INVALID             = (1<<0),
447                 /* driver needs recalculation (set by depsgraph) */
448         DRIVER_FLAG_RECALC              = (1<<1),
449                 /* driver does replace value, but overrides (for layering of animation over driver) */
450                 // TODO: this needs to be implemented at some stage or left out...
451         //DRIVER_FLAG_LAYERING  = (1<<2),
452                 /* use when the expression needs to be recompiled */
453         DRIVER_FLAG_RECOMPILE   = (1<<3),
454                 /* the names are cached so they don't need have python unicode versions created each time */
455         DRIVER_FLAG_RENAMEVAR   = (1<<4),
456                 /* include 'self' in the drivers namespace. */
457         DRIVER_FLAG_USE_SELF    = (1<<6),
458 } eDriver_Flags;
459
460 /* F-Curves -------------------------------------- */
461
462 /* FPoint (fpt)
463  *
464  * This is the bare-minimum data required storing motion samples. Should be more efficient
465  * than using BPoints, which contain a lot of other unnecessary data...
466  */
467 typedef struct FPoint {
468         float vec[2];           /* time + value */
469         int flag;                       /* selection info */
470         int pad;
471 } FPoint;
472
473 /* 'Function-Curve' - defines values over time for a given setting (fcu) */
474 typedef struct FCurve {
475         struct FCurve *next, *prev;
476
477                 /* group */
478         bActionGroup *grp;              /* group that F-Curve belongs to */
479
480                 /* driver settings */
481         ChannelDriver *driver;  /* only valid for drivers (i.e. stored in AnimData not Actions) */
482                 /* evaluation settings */
483         ListBase modifiers;             /* FCurve Modifiers */
484
485                 /* motion data */
486         BezTriple *bezt;                /* user-editable keyframes (array) */
487         FPoint *fpt;                    /* 'baked/imported' motion samples (array) */
488         unsigned int totvert;   /* total number of points which define the curve (i.e. size of arrays in FPoints) */
489
490                 /* value cache + settings */
491         float curval;                   /* value stored from last time curve was evaluated (not threadsafe, debug display only!) */
492         /* Value which comes from original DNA ddatablock at a time f-curve was evaluated. */
493         float orig_dna_val;
494         short flag;                             /* user-editable settings for this curve */
495         short extend;                   /* value-extending mode for this curve (does not cover  */
496         char auto_smoothing;    /* auto-handle smoothing mode */
497
498         char pad[3];
499
500                 /* RNA - data link */
501         int array_index;                /* if applicable, the index of the RNA-array item to get */
502         char *rna_path;                 /* RNA-path to resolve data-access */
503
504                 /* curve coloring (for editor) */
505         int color_mode;                 /* coloring method to use (eFCurve_Coloring) */
506         float color[3];                 /* the last-color this curve took */
507
508         float prev_norm_factor, prev_offset;
509 } FCurve;
510
511
512 /* user-editable flags/settings */
513 typedef enum eFCurve_Flags {
514                 /* curve/keyframes are visible in editor */
515         FCURVE_VISIBLE          = (1<<0),
516                 /* curve is selected for editing  */
517         FCURVE_SELECTED         = (1<<1),
518                 /* curve is active one */
519         FCURVE_ACTIVE           = (1<<2),
520                 /* keyframes (beztriples) cannot be edited */
521         FCURVE_PROTECTED        = (1<<3),
522                 /* fcurve will not be evaluated for the next round */
523         FCURVE_MUTED            = (1<<4),
524
525                 /* fcurve uses 'auto-handles', which stay horizontal... */
526                 // DEPRECATED
527         FCURVE_AUTO_HANDLES     = (1<<5),
528         FCURVE_MOD_OFF          = (1<<6),
529                 /* skip evaluation, as RNA-path cannot be resolved (similar to muting, but cannot be set by user) */
530         FCURVE_DISABLED                 = (1<<10),
531                 /* curve can only have whole-number values (integer types) */
532         FCURVE_INT_VALUES               = (1<<11),
533                 /* curve can only have certain discrete-number values (no interpolation at all, for enums/booleans) */
534         FCURVE_DISCRETE_VALUES  = (1<<12),
535
536                 /* temporary tag for editing */
537         FCURVE_TAGGED                   = (1<<15)
538 } eFCurve_Flags;
539
540 /* extrapolation modes (only simple value 'extending') */
541 typedef enum eFCurve_Extend {
542         FCURVE_EXTRAPOLATE_CONSTANT     = 0,    /* just extend min/max keyframe value  */
543         FCURVE_EXTRAPOLATE_LINEAR                       /* just extend gradient of segment between first segment keyframes */
544 } eFCurve_Extend;
545
546 /* curve coloring modes */
547 typedef enum eFCurve_Coloring {
548         FCURVE_COLOR_AUTO_RAINBOW = 0,          /* automatically determine color using rainbow (calculated at drawtime) */
549         FCURVE_COLOR_AUTO_RGB     = 1,          /* automatically determine color using XYZ (array index) <-> RGB */
550         FCURVE_COLOR_AUTO_YRGB    = 3,          /* automatically determine color where XYZ <-> RGB, but index(X) != 0 */
551         FCURVE_COLOR_CUSTOM       = 2,          /* custom color */
552 } eFCurve_Coloring;
553
554 /* curve smoothing modes */
555 typedef enum eFCurve_Smoothing {
556         FCURVE_SMOOTH_NONE             = 0,     /* legacy mode: auto handles only consider adjacent points */
557         FCURVE_SMOOTH_CONT_ACCEL       = 1,     /* maintain continuity of the acceleration */
558 } eFCurve_Smoothing;
559
560 /* ************************************************ */
561 /* 'Action' Datatypes */
562
563 /* NOTE: Although these are part of the Animation System,
564  * they are not stored here... see DNA_action_types.h instead
565  */
566
567
568 /* ************************************************ */
569 /* NLA - Non-Linear Animation */
570
571 /* NLA Strips ------------------------------------- */
572
573 /* NLA Strip (strip)
574  *
575  * A NLA Strip is a container for the reuse of Action data, defining parameters
576  * to control the remapping of the Action data to some destination.
577  */
578 typedef struct NlaStrip {
579         struct NlaStrip *next, *prev;
580
581         ListBase strips;            /* 'Child' strips (used for 'meta' strips) */
582         bAction *act;               /* Action that is referenced by this strip (strip is 'user' of the action) */
583
584         ListBase fcurves;           /* F-Curves for controlling this strip's influence and timing */    // TODO: move out?
585         ListBase modifiers;         /* F-Curve modifiers to be applied to the entire strip's referenced F-Curves */
586
587         char name[64];              /* User-Visible Identifier for Strip - MAX_ID_NAME-2 */
588
589         float influence;            /* Influence of strip */
590         float strip_time;           /* Current 'time' within action being used (automatically evaluated, but can be overridden) */
591
592         float start, end;           /* extents of the strip */
593         float actstart, actend;     /* range of the action to use */
594
595         float repeat;               /* The number of times to repeat the action range (only when no F-Curves) */
596         float scale;                /* The amount the action range is scaled by (only when no F-Curves) */
597
598         float blendin, blendout;    /* strip blending length (only used when there are no F-Curves) */
599         short blendmode;            /* strip blending mode (layer-based mixing) */
600
601         short extendmode;           /* strip extrapolation mode (time-based mixing) */
602         short pad1;
603
604         short type;                 /* type of NLA strip */
605
606         void *speaker_handle;       /* handle for speaker objects */
607
608         int flag;                   /* settings */
609         int pad2;
610 } NlaStrip;
611
612 /* NLA Strip Blending Mode */
613 typedef enum eNlaStrip_Blend_Mode {
614         NLASTRIP_MODE_REPLACE = 0,
615         NLASTRIP_MODE_ADD,
616         NLASTRIP_MODE_SUBTRACT,
617         NLASTRIP_MODE_MULTIPLY
618 } eNlaStrip_Blend_Mode;
619
620 /* NLA Strip Extrpolation Mode */
621 typedef enum eNlaStrip_Extrapolate_Mode {
622                 /* extend before first frame if no previous strips in track, and always hold+extend last frame */
623         NLASTRIP_EXTEND_HOLD = 0,
624                 /* only hold+extend last frame */
625         NLASTRIP_EXTEND_HOLD_FORWARD = 1,
626                 /* don't contribute at all */
627         NLASTRIP_EXTEND_NOTHING = 2
628 } eNlaStrip_Extrapolate_Mode;
629
630 /* NLA Strip Settings */
631 typedef enum eNlaStrip_Flag {
632         /* UI selection flags */
633                 /* NLA strip is the active one in the track (also indicates if strip is being tweaked) */
634         NLASTRIP_FLAG_ACTIVE        = (1<<0),
635                 /* NLA strip is selected for editing */
636         NLASTRIP_FLAG_SELECT        = (1<<1),
637 //  NLASTRIP_FLAG_SELECT_L      = (1<<2),   // left handle selected
638 //  NLASTRIP_FLAG_SELECT_R      = (1<<3),   // right handle selected
639                 /* NLA strip uses the same action that the action being tweaked uses (not set for the twaking one though) */
640         NLASTRIP_FLAG_TWEAKUSER     = (1<<4),
641
642         /* controls driven by local F-Curves */
643                 /* strip influence is controlled by local F-Curve */
644         NLASTRIP_FLAG_USR_INFLUENCE = (1<<5),
645         NLASTRIP_FLAG_USR_TIME      = (1<<6),
646         NLASTRIP_FLAG_USR_TIME_CYCLIC = (1<<7),
647
648                 /* NLA strip length is synced to the length of the referenced action */
649         NLASTRIP_FLAG_SYNC_LENGTH   = (1<<9),
650
651         /* playback flags (may be overridden by F-Curves) */
652                 /* NLA strip blendin/out values are set automatically based on overlaps */
653         NLASTRIP_FLAG_AUTO_BLENDS   = (1<<10),
654                 /* NLA strip is played back in reverse order */
655         NLASTRIP_FLAG_REVERSE       = (1<<11),
656                 /* NLA strip is muted (i.e. doesn't contribute in any way) */
657         NLASTRIP_FLAG_MUTED         = (1<<12),
658                 /* NLA Strip is played back in 'ping-pong' style */
659         NLASTRIP_FLAG_MIRROR        = (1<<13),
660
661         /* temporary editing flags */
662                 /* NLA-Strip is really just a temporary meta used to facilitate easier transform code */
663         NLASTRIP_FLAG_TEMP_META     = (1<<30),
664         NLASTRIP_FLAG_EDIT_TOUCHED  = (1u << 31)
665 } eNlaStrip_Flag;
666
667 /* NLA Strip Type */
668 typedef enum eNlaStrip_Type {
669                 /* 'clip' - references an Action */
670         NLASTRIP_TYPE_CLIP      = 0,
671                 /* 'transition' - blends between the adjacent strips */
672         NLASTRIP_TYPE_TRANSITION,
673                 /* 'meta' - a strip which acts as a container for a few others */
674         NLASTRIP_TYPE_META,
675
676                 /* 'emit sound' - a strip which is used for timing when speaker emits sounds */
677         NLASTRIP_TYPE_SOUND
678 } eNlaStrip_Type;
679
680 /* NLA Tracks ------------------------------------- */
681
682 /* NLA Track (nlt)
683  *
684  * A track groups a bunch of 'strips', which should form a continuous set of
685  * motion, on top of which other such groups can be layered. This should allow
686  * for animators to work in a non-destructive manner, layering tweaks, etc. over
687  * 'rough' blocks of their work.
688  */
689 typedef struct NlaTrack {
690         struct NlaTrack *next, *prev;
691
692         ListBase strips;                /* bActionStrips in this track */
693
694         int flag;                               /* settings for this track */
695         int index;                              /* index of the track in the stack (NOTE: not really useful, but we need a pad var anyways!) */
696
697         char name[64];                  /* short user-description of this track - MAX_ID_NAME-2 */
698 } NlaTrack;
699
700 /* settings for track */
701 typedef enum eNlaTrack_Flag {
702                 /* track is the one that settings can be modified on, also indicates if track is being 'tweaked' */
703         NLATRACK_ACTIVE         = (1<<0),
704                 /* track is selected in UI for relevant editing operations */
705         NLATRACK_SELECTED       = (1<<1),
706                 /* track is not evaluated */
707         NLATRACK_MUTED          = (1<<2),
708                 /* track is the only one evaluated (must be used in conjunction with adt->flag) */
709         NLATRACK_SOLO           = (1<<3),
710                 /* track's settings (and strips) cannot be edited (to guard against unwanted changes) */
711         NLATRACK_PROTECTED      = (1<<4),
712
713                 /* track is not allowed to execute, usually as result of tweaking being enabled (internal flag) */
714         NLATRACK_DISABLED       = (1<<10)
715 } eNlaTrack_Flag;
716
717
718 /* ************************************ */
719 /* KeyingSet Datatypes */
720
721 /* Path for use in KeyingSet definitions (ksp)
722  *
723  * Paths may be either specific (specifying the exact sub-ID
724  * dynamic data-block - such as PoseChannels - to act upon, ala
725  * Maya's 'Character Sets' and XSI's 'Marking Sets'), or they may
726  * be generic (using various placeholder template tags that will be
727  * replaced with appropriate information from the context).
728  */
729 typedef struct KS_Path {
730         struct KS_Path *next, *prev;
731
732         ID *id;                                 /* ID block that keyframes are for */
733         char group[64];                 /* name of the group to add to - MAX_ID_NAME-2 */
734
735         int idtype;                             /* ID-type that path can be used on */
736
737         short groupmode;                /* group naming (eKSP_Grouping) */
738         short flag;                             /* various settings, etc. */
739
740         char *rna_path;                 /* dynamically (or statically in the case of predefined sets) path */
741         int array_index;                /* index that path affects */
742
743         short keyingflag;               /* (eInsertKeyFlags) settings to supply insertkey() with */
744         short keyingoverride;   /* (eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default */
745 } KS_Path;
746
747 /* KS_Path->flag */
748 typedef enum eKSP_Settings {
749                 /* entire array (not just the specified index) gets keyframed */
750         KSP_FLAG_WHOLE_ARRAY    = (1<<0)
751 } eKSP_Settings;
752
753 /* KS_Path->groupmode */
754 typedef enum eKSP_Grouping {
755                 /* path should be grouped using group name stored in path */
756         KSP_GROUP_NAMED = 0,
757                 /* path should not be grouped at all */
758         KSP_GROUP_NONE,
759                 /* path should be grouped using KeyingSet's name */
760         KSP_GROUP_KSNAME,
761                 /* path should be grouped using name of inner-most context item from templates
762                  * - this is most useful for relative KeyingSets only
763                  */
764         KSP_GROUP_TEMPLATE_ITEM
765 } eKSP_Grouping;
766
767 /* ---------------- */
768
769 /* KeyingSet definition (ks)
770  *
771  * A KeyingSet defines a group of properties that should
772  * be keyframed together, providing a convenient way for animators
773  * to insert keyframes without resorting to Auto-Keyframing.
774  *
775  * A few 'generic' (non-absolute and dependent on templates) KeyingSets
776  * are defined 'built-in' to facilitate easy animating for the casual
777  * animator without the need to add extra steps to the rigging process.
778  */
779 typedef struct KeyingSet {
780         struct KeyingSet *next, *prev;
781
782         ListBase paths;                 /* (KS_Path) paths to keyframe to */
783
784         char idname[64];                /* unique name (for search, etc.) - MAX_ID_NAME-2  */
785         char name[64];                  /* user-viewable name for KeyingSet (for menus, etc.) - MAX_ID_NAME-2 */
786         char description[240];  /* (RNA_DYN_DESCR_MAX) short help text. */
787         char typeinfo[64];              /* name of the typeinfo data used for the relative paths - MAX_ID_NAME-2 */
788
789         int active_path;                /* index of the active path */
790
791         short flag;                             /* settings for KeyingSet */
792
793         short keyingflag;               /* (eInsertKeyFlags) settings to supply insertkey() with */
794         short keyingoverride;   /* (eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default */
795
796         char pad[6];
797 } KeyingSet;
798
799 /* KeyingSet settings */
800 typedef enum eKS_Settings {
801                 /* keyingset cannot be removed (and doesn't need to be freed) */
802         KEYINGSET_BUILTIN               = (1<<0),
803                 /* keyingset does not depend on context info (i.e. paths are absolute) */
804         KEYINGSET_ABSOLUTE              = (1<<1)
805 } eKS_Settings;
806
807 /* Flags for use by keyframe creation/deletion calls */
808 typedef enum eInsertKeyFlags {
809         INSERTKEY_NOFLAGS       = 0,
810         INSERTKEY_NEEDED        = (1<<0),       /* only insert keyframes where they're needed */
811         INSERTKEY_MATRIX        = (1<<1),       /* insert 'visual' keyframes where possible/needed */
812         INSERTKEY_FAST          = (1<<2),       /* don't recalculate handles,etc. after adding key */
813         INSERTKEY_FASTR         = (1<<3),       /* don't realloc mem (or increase count, as array has already been set out) */
814         INSERTKEY_REPLACE       = (1<<4),       /* only replace an existing keyframe (this overrides INSERTKEY_NEEDED) */
815         INSERTKEY_XYZ2RGB       = (1<<5),       /* transform F-Curves should have XYZ->RGB color mode */
816         INSERTKEY_NO_USERPREF   = (1<<6),       /* ignore user-prefs (needed for predictable API use) */
817         /* Allow to make a full copy of new key into existing one, if any, instead of 'reusing' existing handles.
818          * Used by copy/paste code. */
819         INSERTKEY_OVERWRITE_FULL = (1<<7),
820         INSERTKEY_DRIVER         = (1<<8),      /* for driver FCurves, use driver's "input" value - for easier corrective driver setup */
821         INSERTKEY_CYCLE_AWARE    = (1<<9),      /* for cyclic FCurves, adjust key timing to preserve the cycle period and flow */
822 } eInsertKeyFlags;
823
824 /* ************************************************ */
825 /* Animation Data */
826
827 /* AnimOverride ------------------------------------- */
828
829 /* Animation Override (aor)
830  *
831  * This is used to as temporary storage of values which have been changed by the user, but not
832  * yet keyframed (thus, would get overwritten by the animation system before the user had a chance
833  * to see the changes that were made).
834  *
835  * It is probably not needed for overriding keyframed values in most cases, as those will only get evaluated
836  * on frame-change now. That situation may change in future.
837  */
838 typedef struct AnimOverride {
839         struct AnimOverride *next, *prev;
840
841         char *rna_path;                 /* RNA-path to use to resolve data-access */
842         int array_index;                /* if applicable, the index of the RNA-array item to get */
843
844         float value;                    /* value to override setting with */
845 } AnimOverride;
846
847 /* AnimData ------------------------------------- */
848
849 /* Animation data for some ID block (adt)
850  *
851  * This block of data is used to provide all of the necessary animation data for a datablock.
852  * Currently, this data will not be reusable, as there shouldn't be any need to do so.
853  *
854  * This information should be made available for most if not all ID-blocks, which should
855  * enable all of its settings to be animatable locally. Animation from 'higher-up' ID-AnimData
856  * blocks may override local settings.
857  *
858  * This datablock should be placed immediately after the ID block where it is used, so that
859  * the code which retrieves this data can do so in an easier manner. See blenkernel/intern/anim_sys.c for details.
860  */
861 typedef struct AnimData {
862                 /* active action - acts as the 'tweaking track' for the NLA */
863         bAction     *action;
864                 /* temp-storage for the 'real' active action (i.e. the one used before the tweaking-action
865                  * took over to be edited in the Animation Editors)
866                  */
867         bAction     *tmpact;
868
869                 /* nla-tracks */
870         ListBase    nla_tracks;
871                 /* active NLA-track (only set/used during tweaking, so no need to worry about dangling pointers) */
872         NlaTrack        *act_track;
873                 /* active NLA-strip (only set/used during tweaking, so no need to worry about dangling pointers) */
874         NlaStrip    *actstrip;
875
876         /* 'drivers' for this ID-block's settings - FCurves, but are completely
877          * separate from those for animation data
878          */
879         ListBase    drivers;    /* standard user-created Drivers/Expressions (used as part of a rig) */
880         ListBase    overrides;  /* temp storage (AnimOverride) of values for settings that are animated (but the value hasn't been keyframed) */
881
882         FCurve **driver_array;  /* runtime data, for depsgraph evaluation */
883
884                 /* settings for animation evaluation */
885         int flag;               /* user-defined settings */
886         int recalc;             /* depsgraph recalculation flags */
887
888                 /* settings for active action evaluation (based on NLA strip settings) */
889         short act_blendmode;    /* accumulation mode for active action */
890         short act_extendmode;   /* extrapolation mode for active action */
891         float act_influence;    /* influence for active action */
892 } AnimData;
893
894 /* Animation Data settings (mostly for NLA) */
895 typedef enum eAnimData_Flag {
896                 /* only evaluate a single track in the NLA */
897         ADT_NLA_SOLO_TRACK      = (1<<0),
898                 /* don't use NLA */
899         ADT_NLA_EVAL_OFF        = (1<<1),
900                 /* NLA is being 'tweaked' (i.e. in EditMode) */
901         ADT_NLA_EDIT_ON         = (1<<2),
902                 /* active Action for 'tweaking' does not have mapping applied for editing */
903         ADT_NLA_EDIT_NOMAP      = (1<<3),
904                 /* NLA-Strip F-Curves are expanded in UI */
905         ADT_NLA_SKEYS_COLLAPSED = (1<<4),
906
907                 /* drivers expanded in UI */
908         ADT_DRIVERS_COLLAPSED   = (1<<10),
909                 /* don't execute drivers */
910         ADT_DRIVERS_DISABLED    = (1<<11),
911
912                 /* AnimData block is selected in UI */
913         ADT_UI_SELECTED         = (1<<14),
914                 /* AnimData block is active in UI */
915         ADT_UI_ACTIVE           = (1<<15),
916
917                 /* F-Curves from this AnimData block are not visible in the Graph Editor */
918         ADT_CURVES_NOT_VISIBLE  = (1<<16),
919
920                 /* F-Curves from this AnimData block are always visible */
921         ADT_CURVES_ALWAYS_VISIBLE = (1<<17),
922 } eAnimData_Flag;
923
924 /* Animation Data recalculation settings (to be set by depsgraph) */
925 typedef enum eAnimData_Recalc {
926         ADT_RECALC_DRIVERS      = (1 << 0),
927         ADT_RECALC_ANIM         = (1 << 1),
928         ADT_RECALC_ALL          = (ADT_RECALC_DRIVERS | ADT_RECALC_ANIM)
929 } eAnimData_Recalc;
930
931 /* Base Struct for Anim ------------------------------------- */
932
933 /* Used for BKE_animdata_from_id()
934  * All ID-datablocks which have their own 'local' AnimData
935  * should have the same arrangement in their structs.
936  */
937 typedef struct IdAdtTemplate {
938         ID id;
939         AnimData *adt;
940 } IdAdtTemplate;
941
942 /* ************************************************ */
943
944 #ifdef __cplusplus
945 };
946 #endif
947
948 #endif /* __DNA_ANIM_TYPES_H__ */