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