Merge with 2.5 -r 21619:21756.
[blender.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 typedef enum eFModifier_Types {
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 typedef enum eFModifier_Flags {
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 typedef enum eFMod_Generator_Modes {
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 typedef enum eFMod_Generator_Flags {
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 typedef enum eFMod_Generator_Functions {
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 typedef enum eFMod_Cycling_Modes {
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 typedef enum eFMod_Limit_Flags {
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 } FMod_Noise;
224         
225 /* modification modes */
226 typedef enum eFMod_Noise_Modifications {
227         FCM_NOISE_MODIF_REPLACE = 0,    /* Modify existing curve, matching it's shape */
228         FCM_NOISE_MODIF_ADD,                    /* Add noise to the curve */
229         FCM_NOISE_MODIF_SUBTRACT,               /* Subtract noise from the curve */
230         FCM_NOISE_MODIF_MULTIPLY,               /* Multiply the curve by noise */
231 } eFMod_Noise_Modifications;
232
233 /* Drivers -------------------------------------- */
234
235 /* Driver Target 
236  *
237  * A 'variable' for use as a target of the driver/expression.
238  * Defines a way of accessing some channel to use, that can be
239  * referred to in the expression as a variable, thus simplifying
240  * expressions and also Depsgraph building.
241  */
242 typedef struct DriverTarget {
243         struct DriverTarget *next, *prev;
244         
245         ID      *id;                    /* ID-block which owns the target */
246         char *rna_path;         /* target channel to use as driver value */
247         int array_index;        /* if applicable, the index of the RNA-array item to use as driver */
248         
249         int flags;                      /* flags for the validity of the target */
250         
251         char name[64];          /* name of the variable */
252 } DriverTarget;
253
254 /* Channel Driver (i.e. Drivers / Expressions) (driver)
255  *
256  * Channel Drivers are part of the dependency system, and are executed in addition to 
257  * normal user-defined animation. They take the animation result of some channel(s), and
258  * use that (optionally combined with its own F-Curve for modification of results) to define
259  * the value of some setting semi-procedurally.
260  *
261  * Drivers are stored as part of F-Curve data, so that the F-Curve's RNA-path settings (for storing
262  * what setting the driver will affect). The order in which they are stored defines the order that they're
263  * evaluated in. This order is set by the Depsgraph's sorting stuff. 
264  */
265 typedef struct ChannelDriver {
266         ListBase targets;       /* targets for this driver (i.e. list of DriverTarget) */
267         
268         /* python expression to execute (may call functions defined in an accessory file) 
269          * which relates the target 'variables' in some way to yield a single usable value
270          */
271         char expression[256]; 
272         
273         float curval;           /* result of previous evaluation, for subtraction from result under certain circumstances */
274         float influence;        /* influence of driver on result */ // XXX to be implemented... this is like the constraint influence setting
275         
276                 /* general settings */
277         int type;                       /* type of driver */
278         int flag;                       /* settings of driver */
279 } ChannelDriver;
280
281 /* driver type */
282 typedef enum eDriver_Types {
283                 /* target values are averaged together */
284         DRIVER_TYPE_AVERAGE     = 0,
285                 /* python expression/function relates targets */
286         DRIVER_TYPE_PYTHON,
287                 /* rotational difference (must use rotation channels only) */
288         DRIVER_TYPE_ROTDIFF,
289 } eDriver_Types;
290
291 /* driver flags */
292 typedef enum eDriver_Flags {
293                 /* driver has invalid settings (internal flag)  */
294         DRIVER_FLAG_INVALID             = (1<<0),
295                 /* driver needs recalculation (set by depsgraph) */
296         DRIVER_FLAG_RECALC              = (1<<1),
297                 /* driver does replace value, but overrides (for layering of animation over driver) */
298                 // TODO: this needs to be implemented at some stage or left out...
299         DRIVER_FLAG_LAYERING    = (1<<2),
300 } eDriver_Flags;
301
302 /* F-Curves -------------------------------------- */
303
304 /* FPoint (fpt)
305  *
306  * This is the bare-minimum data required storing motion samples. Should be more efficient
307  * than using BPoints, which contain a lot of other unnecessary data...
308  */
309 typedef struct FPoint {
310         float vec[2];           /* time + value */
311         int flag;                       /* selection info */
312         int pad;
313 } FPoint;
314
315 /* 'Function-Curve' - defines values over time for a given setting (fcu) */
316 typedef struct FCurve {
317         struct FCurve *next, *prev;
318         
319                 /* group */
320         bActionGroup *grp;              /* group that F-Curve belongs to */
321         
322                 /* driver settings */
323         ChannelDriver *driver;  /* only valid for drivers (i.e. stored in AnimData not Actions) */
324                 /* evaluation settings */
325         ListBase modifiers;             /* FCurve Modifiers */
326                 
327                 /* motion data */
328         BezTriple *bezt;                /* user-editable keyframes (array) */
329         FPoint *fpt;                    /* 'baked/imported' motion samples (array) */
330         unsigned int totvert;   /* total number of points which define the curve (i.e. size of arrays in FPoints) */
331         
332                 /* value cache + settings */
333         float curval;                   /* value stored from last time curve was evaluated */
334         short flag;                             /* user-editable settings for this curve */
335         short extend;                   /* value-extending mode for this curve (does not cover  */
336         
337                 /* RNA - data link */
338         int array_index;                /* if applicable, the index of the RNA-array item to get */
339         char *rna_path;                 /* RNA-path to resolve data-access */
340         
341                 /* curve coloring (for editor) */
342         int color_mode;                 /* coloring method to use */
343         float color[3];                 /* the last-color this curve took */
344 } FCurve;
345
346
347 /* user-editable flags/settings */
348 typedef enum eFCurve_Flags {
349                 /* curve/keyframes are visible in editor */
350         FCURVE_VISIBLE          = (1<<0),
351                 /* curve is selected for editing  */
352         FCURVE_SELECTED         = (1<<1),
353                 /* curve is active one */
354         FCURVE_ACTIVE           = (1<<2),
355                 /* keyframes (beztriples) cannot be edited */
356         FCURVE_PROTECTED        = (1<<3),
357                 /* fcurve will not be evaluated for the next round */
358         FCURVE_MUTED            = (1<<4),
359                 /* fcurve uses 'auto-handles', which stay horizontal... */
360         FCURVE_AUTO_HANDLES     = (1<<5),
361         
362                 /* skip evaluation, as RNA-path cannot be resolved (similar to muting, but cannot be set by user) */
363         FCURVE_DISABLED                 = (1<<10),
364                 /* curve can only have whole-number values (integer types) */
365         FCURVE_INT_VALUES               = (1<<11),
366                 /* curve can only have certain discrete-number values (no interpolation at all, for enums/booleans) */
367         FCURVE_DISCRETE_VALUES  = (1<<12),
368 } eFCurve_Flags;
369
370 /* extrapolation modes (only simple value 'extending') */
371 typedef enum eFCurve_Extend {
372         FCURVE_EXTRAPOLATE_CONSTANT     = 0,    /* just extend min/max keyframe value  */
373         FCURVE_EXTRAPOLATE_LINEAR,                      /* just extend gradient of segment between first segment keyframes */
374 } eFCurve_Extend;
375
376 /* curve coloring modes */
377 typedef enum eFCurve_Coloring {
378         FCURVE_COLOR_AUTO_RAINBOW = 0,          /* automatically determine color using rainbow (calculated at drawtime) */
379         FCURVE_COLOR_AUTO_RGB,                          /* automatically determine color using XYZ (array index) <-> RGB */
380         FCURVE_COLOR_CUSTOM,                            /* custom color */
381 } eFCurve_Coloring;
382
383 /* ************************************************ */
384 /* 'Action' Datatypes */
385
386 /* NOTE: Although these are part of the Animation System,
387  * they are not stored here... see DNA_action_types.h instead
388  */
389
390  
391 /* ************************************************ */
392 /* Animation Reuse - i.e. users of Actions */
393
394 /* Retargetting ----------------------------------- */
395
396 /* Retargetting Pair
397  *
398  * Defines what parts of the paths should be remapped from 'abc' to 'xyz'.
399  * TODO:
400  *      - Regrex (possibly provided through PY, though having our own module might be faster)
401  *        would be important to have at some point. Current replacements are just simple
402  *        string matches...
403  */
404 typedef struct AnimMapPair {
405         char from[128];         /* part of path to bed replaced */
406         char to[128];           /* part of path to replace with */
407 } AnimMapPair;
408
409 /* Retargetting Information for Actions 
410  *
411  * This should only be used if it is strictly necessary (i.e. user will need to explictly 
412  * add this when they find that some channels do not match, or motion is not going to right 
413  * places). When executing an action, this will be checked to see if it provides any useful
414  * remaps for the given paths.
415  *
416  * NOTE: we currently don't store this in the Action itself, as that causes too many problems.
417  */
418 // FIXME: will this be too clumsy or slow? If we're using RNA paths anyway, we'll have to accept
419 // such consequences...
420 typedef struct AnimMapper {
421         struct AnimMapper *next, *prev;
422         
423         bAction *target;                /* target action */
424         ListBase mappings;              /* remapping table (bAnimMapPair) */
425 } AnimMapper;
426
427 /* ************************************************ */
428 /* NLA - Non-Linear Animation */
429
430 /* NLA Strips ------------------------------------- */
431
432 /* NLA Strip (strip)
433  *
434  * A NLA Strip is a container for the reuse of Action data, defining parameters
435  * to control the remapping of the Action data to some destination. 
436  */
437 typedef struct NlaStrip {
438         struct NlaStrip *next, *prev;
439         
440         ListBase strips;                        /* 'Child' strips (used for 'meta' strips) */
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         
447         char name[64];                          /* User-Visible Identifier for Strip */
448         
449         float influence;                        /* Influence of strip */
450         float strip_time;                       /* Current 'time' within action being used (automatically evaluated, but can be overridden) */
451         
452         float start, end;                       /* extents of the strip */
453         float actstart, actend;         /* range of the action to use */
454         
455         float repeat;                           /* The number of times to repeat the action range (only when no F-Curves) */
456         float scale;                            /* The amount the action range is scaled by (only when no F-Curves) */
457         
458         float blendin, blendout;        /* strip blending length (only used when there are no F-Curves) */      
459         short blendmode;                        /* strip blending mode (layer-based mixing) */
460         short extendmode;                       /* strip extrapolation mode (time-based mixing) */
461         
462         short flag;                                     /* settings */
463         short type;                                     /* type of NLA strip */
464 } NlaStrip;
465
466 /* NLA Strip Blending Mode */
467 typedef enum eNlaStrip_Blend_Mode {
468         NLASTRIP_MODE_REPLACE = 0,
469         NLASTRIP_MODE_ADD,
470         NLASTRIP_MODE_SUBTRACT,
471         NLASTRIP_MODE_MULTIPLY,
472 } eNlaStrip_Blend_Mode;
473
474 /* NLA Strip Extrpolation Mode */
475 typedef enum eNlaStrip_Extrapolate_Mode {
476                 /* extend before first frame if no previous strips in track, and always hold+extend last frame */
477         NLASTRIP_EXTEND_HOLD    = 0,            
478                 /* only hold+extend last frame */
479         NLASTRIP_EXTEND_HOLD_FORWARD,   
480                 /* don't contribute at all */
481         NLASTRIP_EXTEND_NOTHING,
482 } eNlaStrip_Extrapolate_Mode;
483
484 /* NLA Strip Settings */
485 typedef enum eNlaStrip_Flag {
486         /* UI selection flags */
487                 /* NLA strip is the active one in the track (also indicates if strip is being tweaked) */
488         NLASTRIP_FLAG_ACTIVE            = (1<<0),       
489                 /* NLA strip is selected for editing */
490         NLASTRIP_FLAG_SELECT            = (1<<1),
491 //      NLASTRIP_FLAG_SELECT_L          = (1<<2),       // left handle selected
492 //      NLASTRIP_FLAG_SELECT_R          = (1<<3),       // right handle selected
493                 /* NLA strip uses the same action that the action being tweaked uses (not set for the twaking one though) */
494         NLASTRIP_FLAG_TWEAKUSER         = (1<<4),
495         
496         /* controls driven by local F-Curves */
497                 /* strip influence is controlled by local F-Curve */
498         NLASTRIP_FLAG_USR_INFLUENCE     = (1<<5),
499         NLASTRIP_FLAG_USR_TIME          = (1<<6),
500         
501         /* playback flags (may be overriden by F-Curves) */
502                 /* NLA strip blendin/out values are set automatically based on overlaps */
503         NLASTRIP_FLAG_AUTO_BLENDS       = (1<<10),
504                 /* NLA strip is played back in reverse order */
505         NLASTRIP_FLAG_REVERSE           = (1<<11),
506                 /* NLA strip is muted (i.e. doesn't contribute in any way) */
507                 // TODO: this overlaps a lot with the functionality in track
508         NLASTRIP_FLAG_MUTED                     = (1<<12),
509                 /* NLA strip length is synced to the length of the referenced action */
510         NLASTRIP_FLAG_SYNC_LENGTH       = (1<<13),
511         
512         /* temporary editing flags */
513                 /* NLA-Strip is really just a temporary meta used to facilitate easier transform code */
514         NLASTRIP_FLAG_TEMP_META         = (1<<14),
515         NLASTRIP_FLAG_EDIT_TOUCHED      = (1<<15),
516 } eNlaStrip_Flag;
517
518 /* NLA Strip Type */
519 typedef enum eNlaStrip_Type {   
520                 /* 'clip' - references an Action */
521         NLASTRIP_TYPE_CLIP      = 0,
522                 /* 'transition' - blends between the adjacent strips */
523         NLASTRIP_TYPE_TRANSITION,
524                 /* 'meta' - a strip which acts as a container for a few others */
525         NLASTRIP_TYPE_META,
526 } eNlaStrip_Type;
527
528 /* NLA Tracks ------------------------------------- */
529
530 /* NLA Track (nlt)
531  *
532  * A track groups a bunch of 'strips', which should form a continous set of 
533  * motion, on top of which other such groups can be layered. This should allow
534  * for animators to work in a non-destructive manner, layering tweaks, etc. over
535  * 'rough' blocks of their work.
536  */
537 typedef struct NlaTrack {
538         struct NlaTrack *next, *prev;
539         
540         ListBase strips;                /* bActionStrips in this track */
541         
542         int flag;                               /* settings for this track */
543         int index;                              /* index of the track in the stack (NOTE: not really useful, but we need a pad var anyways!) */
544         
545         char name[64];                  /* short user-description of this track */
546 } NlaTrack;
547
548 /* settings for track */
549 typedef enum eNlaTrack_Flag {
550                 /* track is the one that settings can be modified on, also indicates if track is being 'tweaked' */
551         NLATRACK_ACTIVE         = (1<<0),
552                 /* track is selected in UI for relevant editing operations */
553         NLATRACK_SELECTED       = (1<<1),
554                 /* track is not evaluated */
555         NLATRACK_MUTED          = (1<<2),
556                 /* track is the only one evaluated (must be used in conjunction with adt->flag) */
557         NLATRACK_SOLO           = (1<<3),
558                 /* track's settings (and strips) cannot be edited (to guard against unwanted changes) */
559         NLATRACK_PROTECTED      = (1<<4),
560         
561                 /* track is not allowed to execute, usually as result of tweaking being enabled (internal flag) */
562         NLATRACK_DISABLED       = (1<<10),
563 } eNlaTrack_Flag;
564
565
566 /* ************************************ */
567 /* KeyingSet Datatypes */
568
569 /* Path for use in KeyingSet definitions (ksp) 
570  *
571  * Paths may be either specific (specifying the exact sub-ID
572  * dynamic data-block - such as PoseChannels - to act upon, ala
573  * Maya's 'Character Sets' and XSI's 'Marking Sets'), or they may
574  * be generic (using various placeholder template tags that will be
575  * replaced with appropriate information from the context). 
576  */
577 typedef struct KS_Path {
578         struct KS_Path *next, *prev;
579         
580                 /* absolute paths only */
581         ID *id;                                 /* ID block that keyframes are for */
582         char group[64];                 /* name of the group to add to */
583         
584                 /* relative paths only */
585         int idtype;                             /* ID-type that path can be used on */
586         int templates;                  /* Templates that will be encountered in the path (as set of bitflags) */
587         
588                 /* all paths */
589         char *rna_path;                 /* dynamically (or statically in the case of predefined sets) path */
590         int array_index;                /* index that path affects */
591         
592         short flag;                             /* various settings, etc. */
593         short groupmode;                /* group naming (eKSP_Grouping) */
594 } KS_Path;
595
596 /* KS_Path->flag */
597 typedef enum eKSP_Settings {
598                 /* entire array (not just the specified index) gets keyframed */
599         KSP_FLAG_WHOLE_ARRAY    = (1<<0),
600 } eKSP_Settings;
601
602 /* KS_Path->groupmode */
603 typedef enum eKSP_Grouping {
604                 /* path should be grouped using group name stored in path */
605         KSP_GROUP_NAMED = 0,
606                 /* path should not be grouped at all */
607         KSP_GROUP_NONE,
608                 /* path should be grouped using KeyingSet's name */
609         KSP_GROUP_KSNAME,
610                 /* path should be grouped using name of inner-most context item from templates 
611                  *      - this is most useful for relative KeyingSets only
612                  */
613         KSP_GROUP_TEMPLATE_ITEM,
614 } eKSP_Grouping;
615
616 /* KS_Path->templates  (Template Flags)
617  *
618  * Templates in paths are used to substitute information from the 
619  * active context into relavent places in the path strings. This
620  * enum here defines the flags which define which templates are
621  * required by a path before it can be used
622  */
623 typedef enum eKSP_TemplateTypes {
624         KSP_TEMPLATE_OBJECT                     = (1<<0),       /* #obj - selected object */
625         KSP_TEMPLATE_PCHAN                      = (1<<1),       /* #pch - selected posechannel */
626         KSP_TEMPLATE_CONSTRAINT         = (1<<2),       /* #con - active only */
627         KSP_TEMPLATE_NODE                       = (1<<3),       /* #nod - selected node */
628 } eKSP_TemplateTypes;
629
630 /* ---------------- */
631  
632 /* KeyingSet definition (ks)
633  *
634  * A KeyingSet defines a group of properties that should
635  * be keyframed together, providing a convenient way for animators
636  * to insert keyframes without resorting to Auto-Keyframing.
637  *
638  * A few 'generic' (non-absolute and dependant on templates) KeyingSets 
639  * are defined 'built-in' to facilitate easy animating for the casual
640  * animator without the need to add extra steps to the rigging process.
641  */
642 typedef struct KeyingSet {
643         struct KeyingSet *next, *prev;
644         
645         ListBase paths;                 /* (KS_Path) paths to keyframe to */
646         
647         char name[64];                  /* user-viewable name for KeyingSet (for menus, etc.) */
648         
649         int flag;                               /* settings for KeyingSet */
650         int keyingflag;                 /* settings to supply insertkey() with */
651 } KeyingSet;
652
653 /* KeyingSet settings */
654 typedef enum eKS_Settings {
655                 /* keyingset cannot be removed (and doesn't need to be freed) */
656         KEYINGSET_BUILTIN               = (1<<0),
657                 /* keyingset does not depend on context info (i.e. paths are absolute) */
658         KEYINGSET_ABSOLUTE              = (1<<1),
659 } eKS_Settings;
660
661 /* Flags for use by keyframe creation/deletion calls */
662 typedef enum eInsertKeyFlags {
663         INSERTKEY_NEEDED        = (1<<0),       /* only insert keyframes where they're needed */
664         INSERTKEY_MATRIX        = (1<<1),       /* insert 'visual' keyframes where possible/needed */
665         INSERTKEY_FAST          = (1<<2),       /* don't recalculate handles,etc. after adding key */
666         INSERTKEY_FASTR         = (1<<3),       /* don't realloc mem (or increase count, as array has already been set out) */
667         INSERTKEY_REPLACE       = (1<<4),       /* only replace an existing keyframe (this overrides INSERTKEY_NEEDED) */
668 } eInsertKeyFlags;
669
670 /* ************************************************ */
671 /* Animation Data */
672
673 /* AnimOverride ------------------------------------- */
674
675 /* Animation Override (aor) 
676  *
677  * This is used to as temporary storage of values which have been changed by the user, but not
678  * yet keyframed (thus, would get overwritten by the animation system before the user had a chance
679  * to see the changes that were made). 
680  *
681  * It is probably not needed for overriding keyframed values in most cases, as those will only get evaluated
682  * on frame-change now. That situation may change in future.
683  */
684 typedef struct AnimOverride {
685         struct AnimOverride *next, *prev;
686         
687         char *rna_path;                 /* RNA-path to use to resolve data-access */
688         int array_index;                /* if applicable, the index of the RNA-array item to get */
689         
690         float value;                    /* value to override setting with */
691 } AnimOverride;
692
693 /* AnimData ------------------------------------- */
694
695 /* Animation data for some ID block (adt)
696  * 
697  * This block of data is used to provide all of the necessary animation data for a datablock.
698  * Currently, this data will not be reusable, as there shouldn't be any need to do so.
699  * 
700  * This information should be made available for most if not all ID-blocks, which should 
701  * enable all of its settings to be animatable locally. Animation from 'higher-up' ID-AnimData
702  * blocks may override local settings.
703  *
704  * This datablock should be placed immediately after the ID block where it is used, so that
705  * the code which retrieves this data can do so in an easier manner. See blenkernel/intern/anim_sys.c for details.
706  */
707 typedef struct AnimData {       
708                 /* active action - acts as the 'tweaking track' for the NLA */
709         bAction         *action;        
710                 /* temp-storage for the 'real' active action (i.e. the one used before the tweaking-action 
711                  * took over to be edited in the Animation Editors) 
712                  */
713         bAction         *tmpact;
714                 /* remapping-info for active action - should only be used if needed 
715                  * (for 'foreign' actions that aren't working correctly) 
716                  */
717         AnimMapper      *remap;                 
718         
719                 /* nla-tracks */
720         ListBase        nla_tracks;
721                 /* active NLA-strip (only set/used during tweaking, so no need to worry about dangling pointers) */
722         NlaStrip        *actstrip;
723         
724         /* 'drivers' for this ID-block's settings - FCurves, but are completely 
725          * separate from those for animation data 
726          */
727         ListBase        drivers;        /* standard user-created Drivers/Expressions (used as part of a rig) */
728         ListBase        overrides;      /* temp storage (AnimOverride) of values for settings that are animated (but the value hasn't been keyframed) */
729         
730                 /* settings for animation evaluation */
731         int flag;                       /* user-defined settings */
732         int recalc;                     /* depsgraph recalculation flags */             
733 } AnimData;
734
735 /* Animation Data settings (mostly for NLA) */
736 typedef enum eAnimData_Flag {
737                 /* only evaluate a single track in the NLA */
738         ADT_NLA_SOLO_TRACK              = (1<<0),
739                 /* don't use NLA */
740         ADT_NLA_EVAL_OFF                = (1<<1),
741                 /* NLA is being 'tweaked' (i.e. in EditMode) */
742         ADT_NLA_EDIT_ON                 = (1<<2),
743                 /* active Action for 'tweaking' does not have mapping applied for editing */
744         ADT_NLA_EDIT_NOMAP              = (1<<3),
745                 /* NLA-Strip F-Curves are expanded in UI */
746         ADT_NLA_SKEYS_COLLAPSED = (1<<4),
747         
748                 /* drivers expanded in UI */
749         ADT_DRIVERS_COLLAPSED   = (1<<10),
750                 /* don't execute drivers */
751         ADT_DRIVERS_DISABLED    = (1<<11),
752         
753                 /* F-Curves from this AnimData block are not visible in the Graph Editor */
754         ADT_CURVES_NOT_VISIBLE  = (1<<16),
755 } eAnimData_Flag;
756
757 /* Animation Data recalculation settings (to be set by depsgraph) */
758 typedef enum eAnimData_Recalc {
759         ADT_RECALC_DRIVERS              = (1<<0),
760         ADT_RECALC_ANIM                 = (1<<1),
761         ADT_RECALC_ALL                  = (ADT_RECALC_DRIVERS|ADT_RECALC_ANIM),
762 } eAnimData_Recalc;
763
764 /* Base Struct for Anim ------------------------------------- */
765
766 /* Used for BKE_animdata_from_id() 
767  * All ID-datablocks which have their own 'local' AnimData
768  * should have the same arrangement in their structs.
769  */
770 typedef struct IdAdtTemplate {
771         ID id;
772         AnimData *adt;
773 } IdAdtTemplate;
774
775 /* ************************************************ */
776
777 #ifdef __cplusplus
778 };
779 #endif
780
781 #endif /* DNA_ANIM_TYPES_H */