Merged changes in the trunk up to revision 52690.
[blender.git] / source / blender / editors / animation / anim_filter.c
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) 2008 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Joshua Leung (original author)
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/animation/anim_filter.c
28  *  \ingroup edanimation
29  */
30
31
32 /* This file contains a system used to provide a layer of abstraction between sources
33  * of animation data and tools in Animation Editors. The method used here involves 
34  * generating a list of edit structures which enable tools to naively perform the actions 
35  * they require without all the boiler-plate associated with loops within loops and checking 
36  * for cases to ignore. 
37  *
38  * While this is primarily used for the Action/Dopesheet Editor (and its accessory modes),
39  * the Graph Editor also uses this for its channel list and for determining which curves
40  * are being edited. Likewise, the NLA Editor also uses this for its channel list and in
41  * its operators.
42  *
43  * Note: much of the original system this was based on was built before the creation of the RNA
44  * system. In future, it would be interesting to replace some parts of this code with RNA queries,
45  * however, RNA does not eliminate some of the boiler-plate reduction benefits presented by this 
46  * system, so if any such work does occur, it should only be used for the internals used here...
47  *
48  * -- Joshua Leung, Dec 2008 (Last revision July 2009)
49  */
50
51 #include <string.h>
52
53 #include "DNA_anim_types.h"
54 #include "DNA_armature_types.h"
55 #include "DNA_camera_types.h"
56 #include "DNA_lamp_types.h"
57 #include "DNA_lattice_types.h"
58 #include "DNA_linestyle_types.h"
59 #include "DNA_key_types.h"
60 #include "DNA_mask_types.h"
61 #include "DNA_material_types.h"
62 #include "DNA_mesh_types.h"
63 #include "DNA_meta_types.h"
64 #include "DNA_node_types.h"
65 #include "DNA_particle_types.h"
66 #include "DNA_space_types.h"
67 #include "DNA_sequence_types.h"
68 #include "DNA_scene_types.h"
69 #include "DNA_screen_types.h"
70 #include "DNA_speaker_types.h"
71 #include "DNA_world_types.h"
72 #include "DNA_gpencil_types.h"
73 #include "DNA_object_types.h"
74
75 #include "MEM_guardedalloc.h"
76
77 #include "BLI_blenlib.h"
78 #include "BLI_utildefines.h"
79 #include "BLI_ghash.h"
80
81 #include "BKE_animsys.h"
82 #include "BKE_action.h"
83 #include "BKE_fcurve.h"
84 #include "BKE_context.h"
85 #include "BKE_global.h"
86 #include "BKE_group.h"
87 #include "BKE_key.h"
88 #include "BKE_main.h"
89 #include "BKE_material.h"
90 #include "BKE_node.h"
91 #include "BKE_mask.h"
92 #include "BKE_sequencer.h"
93
94 #include "ED_anim_api.h"
95 #include "ED_markers.h"
96
97 /* ************************************************************ */
98 /* Blender Context <-> Animation Context mapping */
99
100 /* ----------- Private Stuff - Action Editor ------------- */
101
102 /* Get shapekey data being edited (for Action Editor -> ShapeKey mode) */
103 /* Note: there's a similar function in key.c (BKE_key_from_object) */
104 static Key *actedit_get_shapekeys(bAnimContext *ac)
105 {
106         Scene *scene = ac->scene;
107         Object *ob;
108         Key *key;
109         
110         ob = OBACT;
111         if (ob == NULL) 
112                 return NULL;
113         
114         /* XXX pinning is not available in 'ShapeKey' mode... */
115         //if (saction->pin) return NULL;
116         
117         /* shapekey data is stored with geometry data */
118         key = BKE_key_from_object(ob);
119         
120         if (key) {
121                 if (key->type == KEY_RELATIVE)
122                         return key;
123         }
124         
125         return NULL;
126 }
127
128 /* Get data being edited in Action Editor (depending on current 'mode') */
129 static short actedit_get_context(bAnimContext *ac, SpaceAction *saction)
130 {
131         /* get dopesheet */
132         ac->ads = &saction->ads;
133         
134         /* sync settings with current view status, then return appropriate data */
135         switch (saction->mode) {
136                 case SACTCONT_ACTION: /* 'Action Editor' */
137                         /* if not pinned, sync with active object */
138                         if (/*saction->pin == 0*/ 1) {
139                                 if (ac->obact && ac->obact->adt)
140                                         saction->action = ac->obact->adt->action;
141                                 else
142                                         saction->action = NULL;
143                         }
144                         
145                         ac->datatype = ANIMCONT_ACTION;
146                         ac->data = saction->action;
147                         
148                         ac->mode = saction->mode;
149                         return 1;
150                         
151                 case SACTCONT_SHAPEKEY: /* 'ShapeKey Editor' */
152                         ac->datatype = ANIMCONT_SHAPEKEY;
153                         ac->data = actedit_get_shapekeys(ac);
154                         
155                         /* if not pinned, sync with active object */
156                         if (/*saction->pin == 0*/ 1) {
157                                 Key *key = (Key *)ac->data;
158                                 
159                                 if (key && key->adt)
160                                         saction->action = key->adt->action;
161                                 else
162                                         saction->action = NULL;
163                         }
164                         
165                         ac->mode = saction->mode;
166                         return 1;
167                 
168                 case SACTCONT_GPENCIL: /* Grease Pencil */ /* XXX review how this mode is handled... */
169                         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
170                         saction->ads.source = (ID *)ac->scene;
171                         
172                         ac->datatype = ANIMCONT_GPENCIL;
173                         ac->data = &saction->ads;
174                         
175                         ac->mode = saction->mode;
176                         return 1;
177                         
178                 case SACTCONT_MASK: /* Mask */ /* XXX review how this mode is handled... */
179                 {
180                         /* TODO, other methods to get the mask */
181                         // Sequence *seq = BKE_sequencer_active_get(ac->scene);
182                         //MovieClip *clip = ac->scene->clip;
183 //                      struct Mask *mask = seq ? seq->mask : NULL;
184                         
185                         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
186                         saction->ads.source = (ID *)ac->scene;
187                         
188                         ac->datatype = ANIMCONT_MASK;
189                         ac->data = &saction->ads;
190                         
191                         ac->mode = saction->mode;
192                         return 1;
193                 }
194                 case SACTCONT_DOPESHEET: /* DopeSheet */
195                         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
196                         saction->ads.source = (ID *)ac->scene;
197                         
198                         ac->datatype = ANIMCONT_DOPESHEET;
199                         ac->data = &saction->ads;
200                         
201                         ac->mode = saction->mode;
202                         return 1;
203                 
204                 default: /* unhandled yet */
205                         ac->datatype = ANIMCONT_NONE;
206                         ac->data = NULL;
207                         
208                         ac->mode = -1;
209                         return 0;
210         }
211 }
212
213 /* ----------- Private Stuff - Graph Editor ------------- */
214
215 /* Get data being edited in Graph Editor (depending on current 'mode') */
216 static short graphedit_get_context(bAnimContext *ac, SpaceIpo *sipo)
217 {
218         /* init dopesheet data if non-existant (i.e. for old files) */
219         if (sipo->ads == NULL) {
220                 sipo->ads = MEM_callocN(sizeof(bDopeSheet), "GraphEdit DopeSheet");
221                 sipo->ads->source = (ID *)ac->scene;
222         }
223         ac->ads = sipo->ads;
224         
225         /* set settings for Graph Editor - "Selected = Editable" */
226         if (sipo->flag & SIPO_SELCUVERTSONLY)
227                 sipo->ads->filterflag |= ADS_FILTER_SELEDIT;
228         else
229                 sipo->ads->filterflag &= ~ADS_FILTER_SELEDIT;
230         
231         /* sync settings with current view status, then return appropriate data */
232         switch (sipo->mode) {
233                 case SIPO_MODE_ANIMATION:  /* Animation F-Curve Editor */
234                         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
235                         sipo->ads->source = (ID *)ac->scene;
236                         sipo->ads->filterflag &= ~ADS_FILTER_ONLYDRIVERS;
237                         
238                         ac->datatype = ANIMCONT_FCURVES;
239                         ac->data = sipo->ads;
240                         
241                         ac->mode = sipo->mode;
242                         return 1;
243                 
244                 case SIPO_MODE_DRIVERS:  /* Driver F-Curve Editor */
245                         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
246                         sipo->ads->source = (ID *)ac->scene;
247                         sipo->ads->filterflag |= ADS_FILTER_ONLYDRIVERS;
248                         
249                         ac->datatype = ANIMCONT_DRIVERS;
250                         ac->data = sipo->ads;
251                         
252                         ac->mode = sipo->mode;
253                         return 1;
254                 
255                 default: /* unhandled yet */
256                         ac->datatype = ANIMCONT_NONE;
257                         ac->data = NULL;
258                         
259                         ac->mode = -1;
260                         return 0;
261         }
262 }
263
264 /* ----------- Private Stuff - NLA Editor ------------- */
265
266 /* Get data being edited in Graph Editor (depending on current 'mode') */
267 static short nlaedit_get_context(bAnimContext *ac, SpaceNla *snla)
268 {
269         /* init dopesheet data if non-existant (i.e. for old files) */
270         if (snla->ads == NULL)
271                 snla->ads = MEM_callocN(sizeof(bDopeSheet), "NlaEdit DopeSheet");
272         ac->ads = snla->ads;
273         
274         /* sync settings with current view status, then return appropriate data */
275         /* update scene-pointer (no need to check for pinning yet, as not implemented) */
276         snla->ads->source = (ID *)ac->scene;
277         snla->ads->filterflag |= ADS_FILTER_ONLYNLA;
278         
279         ac->datatype = ANIMCONT_NLA;
280         ac->data = snla->ads;
281         
282         return 1;
283 }
284
285 /* ----------- Public API --------------- */
286
287 /* Obtain current anim-data context, given that context info from Blender context has already been set 
288  *      - AnimContext to write to is provided as pointer to var on stack so that we don't have
289  *        allocation/freeing costs (which are not that avoidable with channels).
290  */
291 short ANIM_animdata_context_getdata(bAnimContext *ac)
292 {
293         SpaceLink *sl = ac->sl;
294         short ok = 0;
295         
296         /* context depends on editor we are currently in */
297         if (sl) {
298                 switch (ac->spacetype) {
299                         case SPACE_ACTION:
300                         {
301                                 SpaceAction *saction = (SpaceAction *)sl;
302                                 ok = actedit_get_context(ac, saction);
303                         }
304                         break;
305                                 
306                         case SPACE_IPO:
307                         {
308                                 SpaceIpo *sipo = (SpaceIpo *)sl;
309                                 ok = graphedit_get_context(ac, sipo);
310                         }
311                         break;
312                                 
313                         case SPACE_NLA:
314                         {
315                                 SpaceNla *snla = (SpaceNla *)sl;
316                                 ok = nlaedit_get_context(ac, snla);
317                         }
318                         break;
319                 }
320         }
321         
322         /* check if there's any valid data */
323         if (ok && ac->data)
324                 return 1;
325         else
326                 return 0;
327 }
328
329 /* Obtain current anim-data context from Blender Context info 
330  *      - AnimContext to write to is provided as pointer to var on stack so that we don't have
331  *        allocation/freeing costs (which are not that avoidable with channels).
332  *      - Clears data and sets the information from Blender Context which is useful
333  */
334 short ANIM_animdata_get_context(const bContext *C, bAnimContext *ac)
335 {
336         ScrArea *sa = CTX_wm_area(C);
337         ARegion *ar = CTX_wm_region(C);
338         SpaceLink *sl = CTX_wm_space_data(C);
339         Scene *scene = CTX_data_scene(C);
340         
341         /* clear old context info */
342         if (ac == NULL) return 0;
343         memset(ac, 0, sizeof(bAnimContext));
344         
345         /* get useful default context settings from context */
346         ac->scene = scene;
347         if (scene) {
348                 ac->markers = ED_context_get_markers(C);
349                 ac->obact = (scene->basact) ?  scene->basact->object : NULL;
350         }
351         ac->sa = sa;
352         ac->ar = ar;
353         ac->sl = sl;
354         ac->spacetype = (sa) ? sa->spacetype : 0;
355         ac->regiontype = (ar) ? ar->regiontype : 0;
356         
357         /* get data context info */
358         return ANIM_animdata_context_getdata(ac);
359 }
360
361 /* ************************************************************ */
362 /* Blender Data <-- Filter --> Channels to be operated on */
363
364 /* macros to use before/after getting the sub-channels of some channel,
365  * to abstract away some of the tricky logic involved
366  *
367  * cases:
368  *      1) Graph Edit main area (just data) OR channels visible in Channel List
369  *      2) If not showing channels, we're only interested in the data (Action Editor's editing)
370  *      3) We don't care what data, we just care there is some (so that a collapsed 
371  *         channel can be kept around). No need to clear channels-flag in order to 
372  *         keep expander channels with no sub-data out, as those cases should get
373  *         dealt with by the recursive detection idiom in place.
374  *
375  * Implementation Note:
376  *  YES the _doSubChannels variable is NOT read anywhere. BUT, this is NOT an excuse
377  *  to go steamrolling the logic into a single-line expression as from experience,
378  *  those are notoriously difficult to read + debug when extending later on. The code
379  *  below is purposefully laid out so that each case noted above corresponds clearly to
380  *  one case below.
381  */
382 #define BEGIN_ANIMFILTER_SUBCHANNELS(expanded_check) \
383         { \
384                 int _filter = filter_mode; \
385                 short _doSubChannels = 0; \
386                 if (!(filter_mode & ANIMFILTER_LIST_VISIBLE) || (expanded_check)) \
387                         _doSubChannels = 1; \
388                 else if (!(filter_mode & ANIMFILTER_LIST_CHANNELS)) \
389                         _doSubChannels = 2; \
390                 else { \
391                         filter_mode |= ANIMFILTER_TMP_PEEK; \
392                 } \
393                  \
394                 { \
395                         (void) _doSubChannels; \
396                 }
397 /* ... standard sub-channel filtering can go on here now ... */
398 #define END_ANIMFILTER_SUBCHANNELS \
399                 filter_mode = _filter; \
400         } (void)0
401
402 /* ............................... */
403
404 /* quick macro to test if AnimData is usable */
405 #define ANIMDATA_HAS_KEYS(id) ((id)->adt && (id)->adt->action)
406
407 /* quick macro to test if AnimData is usable for drivers */
408 #define ANIMDATA_HAS_DRIVERS(id) ((id)->adt && (id)->adt->drivers.first)
409
410 /* quick macro to test if AnimData is usable for NLA */
411 #define ANIMDATA_HAS_NLA(id) ((id)->adt && (id)->adt->nla_tracks.first)
412
413 /* Quick macro to test for all three above usability tests, performing the appropriate provided 
414  * action for each when the AnimData context is appropriate. 
415  *
416  * Priority order for this goes (most important, to least): AnimData blocks, NLA, Drivers, Keyframes.
417  *
418  * For this to work correctly, a standard set of data needs to be available within the scope that this
419  * gets called in: 
420  *  - ListBase anim_data;
421  *  - bDopeSheet *ads;
422  *  - bAnimListElem *ale;
423  *  - size_t items;
424  *
425  *  - id: ID block which should have an AnimData pointer following it immediately, to use
426  *  - adtOk: line or block of code to execute for AnimData-blocks case (usually ANIMDATA_ADD_ANIMDATA)
427  *  - nlaOk: line or block of code to execute for NLA tracks+strips case
428  *  - driversOk: line or block of code to execute for Drivers case
429  *  - keysOk: line or block of code for Keyframes case
430  *
431  * The checks for the various cases are as follows:
432  *      0) top level: checks for animdata and also that all the F-Curves for the block will be visible
433  *      1) animdata check: for filtering animdata blocks only
434  *      2A) nla tracks: include animdata block's data as there are NLA tracks+strips there
435  *      2B) actions to convert to nla: include animdata block's data as there is an action that can be 
436  *              converted to a new NLA strip, and the filtering options allow this
437  *      2C) allow non-animated datablocks to be included so that datablocks can be added
438  *      3) drivers: include drivers from animdata block (for Drivers mode in Graph Editor)
439  *      4) normal keyframes: only when there is an active action
440  */
441 #define ANIMDATA_FILTER_CASES(id, adtOk, nlaOk, driversOk, keysOk) \
442         { \
443                 if ((id)->adt) { \
444                         if (!(filter_mode & ANIMFILTER_CURVE_VISIBLE) || !((id)->adt->flag & ADT_CURVES_NOT_VISIBLE)) { \
445                                 if (filter_mode & ANIMFILTER_ANIMDATA) { \
446                                         adtOk \
447                                 } \
448                                 else if (ads->filterflag & ADS_FILTER_ONLYNLA) { \
449                                         if (ANIMDATA_HAS_NLA(id)) { \
450                                                 nlaOk \
451                                         } \
452                                         else if (!(ads->filterflag & ADS_FILTER_NLA_NOACT) && ANIMDATA_HAS_KEYS(id)) { \
453                                                 nlaOk \
454                                         } \
455                                 } \
456                                 else if (ads->filterflag & ADS_FILTER_ONLYDRIVERS) { \
457                                         if (ANIMDATA_HAS_DRIVERS(id)) { \
458                                                 driversOk \
459                                         } \
460                                 } \
461                                 else { \
462                                         if (ANIMDATA_HAS_KEYS(id)) { \
463                                                 keysOk \
464                                         } \
465                                 } \
466                         } \
467                 } \
468         } (void)0
469
470 /* ............................... */
471
472 /* Add a new animation channel, taking into account the "peek" flag, which is used to just check 
473  * whether any channels will be added (but without needing them to actually get created).
474  *
475  * ! This causes the calling function to return early if we're only "peeking" for channels
476  */
477 // XXX: ale_statement stuff is really a hack for one special case. It shouldn't really be needed...
478 #define ANIMCHANNEL_NEW_CHANNEL_FULL(channel_data, channel_type, owner_id, ale_statement) \
479         if (filter_mode & ANIMFILTER_TMP_PEEK) \
480                 return 1; \
481         else { \
482                 bAnimListElem *ale = make_new_animlistelem(channel_data, channel_type, (ID *)owner_id); \
483                 if (ale) { \
484                         BLI_addtail(anim_data, ale); \
485                         items ++; \
486                         ale_statement \
487                 } \
488         } (void)0
489         
490 #define ANIMCHANNEL_NEW_CHANNEL(channel_data, channel_type, owner_id) \
491         ANIMCHANNEL_NEW_CHANNEL_FULL(channel_data, channel_type, owner_id, {})
492         
493 /* ............................... */
494         
495 /* quick macro to test if an anim-channel representing an AnimData block is suitably active */
496 #define ANIMCHANNEL_ACTIVEOK(ale) \
497         (!(filter_mode & ANIMFILTER_ACTIVE) || !(ale->adt) || (ale->adt->flag & ADT_UI_ACTIVE) )
498
499 /* quick macro to test if an anim-channel (F-Curve, Group, etc.) is selected in an acceptable way */
500 #define ANIMCHANNEL_SELOK(test_func) \
501         (!(filter_mode & (ANIMFILTER_SEL | ANIMFILTER_UNSEL)) || \
502          ((filter_mode & ANIMFILTER_SEL) && test_func) || \
503          ((filter_mode & ANIMFILTER_UNSEL) && test_func == 0) )
504                   
505 /* quick macro to test if an anim-channel (F-Curve) is selected ok for editing purposes 
506  *      - _SELEDIT means that only selected curves will have visible+editable keyframes
507  *
508  * checks here work as follows:
509  *      1) seledit off - don't need to consider the implications of this option
510  *      2) foredit off - we're not considering editing, so channel is ok still
511  *      3) test_func (i.e. selection test) - only if selected, this test will pass
512  */
513 #define ANIMCHANNEL_SELEDITOK(test_func) \
514         (!(filter_mode & ANIMFILTER_SELEDIT) || \
515          !(filter_mode & ANIMFILTER_FOREDIT) || \
516          (test_func) )
517
518 /* ----------- 'Private' Stuff --------------- */
519
520 /* this function allocates memory for a new bAnimListElem struct for the 
521  * provided animation channel-data. 
522  */
523 static bAnimListElem *make_new_animlistelem(void *data, short datatype, ID *owner_id)
524 {
525         bAnimListElem *ale = NULL;
526         
527         /* only allocate memory if there is data to convert */
528         if (data) {
529                 /* allocate and set generic data */
530                 ale = MEM_callocN(sizeof(bAnimListElem), "bAnimListElem");
531                 
532                 ale->data = data;
533                 ale->type = datatype;
534                 
535                 ale->id = owner_id;
536                 ale->adt = BKE_animdata_from_id(owner_id);
537                 
538                 /* do specifics */
539                 switch (datatype) {
540                         case ANIMTYPE_SUMMARY:
541                         {
542                                 /* nothing to include for now... this is just a dummy wrappy around all the other channels 
543                                  * in the DopeSheet, and gets included at the start of the list
544                                  */
545                                 ale->key_data = NULL;
546                                 ale->datatype = ALE_ALL;
547                         }
548                         break;
549                         
550                         case ANIMTYPE_SCENE:
551                         {
552                                 Scene *sce = (Scene *)data;
553                                 
554                                 ale->flag = sce->flag;
555                                 
556                                 ale->key_data = sce;
557                                 ale->datatype = ALE_SCE;
558                                 
559                                 ale->adt = BKE_animdata_from_id(data);
560                         }
561                         break;
562                         case ANIMTYPE_OBJECT:
563                         {
564                                 Base *base = (Base *)data;
565                                 Object *ob = base->object;
566                                 
567                                 ale->flag = ob->flag;
568                                 
569                                 ale->key_data = ob;
570                                 ale->datatype = ALE_OB;
571                                 
572                                 ale->adt = BKE_animdata_from_id(&ob->id);
573                         }
574                         break;
575                         case ANIMTYPE_FILLACTD:
576                         {
577                                 bAction *act = (bAction *)data;
578                                 
579                                 ale->flag = act->flag;
580                                 
581                                 ale->key_data = act;
582                                 ale->datatype = ALE_ACT;
583                         }
584                         break;
585                         case ANIMTYPE_FILLDRIVERS:
586                         {
587                                 AnimData *adt = (AnimData *)data;
588                                 
589                                 ale->flag = adt->flag;
590                                 
591                                 // XXX... drivers don't show summary for now
592                                 ale->key_data = NULL;
593                                 ale->datatype = ALE_NONE;
594                         }
595                         break;
596                         
597                         case ANIMTYPE_DSMAT:
598                         {
599                                 Material *ma = (Material *)data;
600                                 AnimData *adt = ma->adt;
601                                 
602                                 ale->flag = FILTER_MAT_OBJD(ma);
603                                 
604                                 ale->key_data = (adt) ? adt->action : NULL;
605                                 ale->datatype = ALE_ACT;
606                                 
607                                 ale->adt = BKE_animdata_from_id(data);
608                         }
609                         break;
610                         case ANIMTYPE_DSLAM:
611                         {
612                                 Lamp *la = (Lamp *)data;
613                                 AnimData *adt = la->adt;
614                                 
615                                 ale->flag = FILTER_LAM_OBJD(la);
616                                 
617                                 ale->key_data = (adt) ? adt->action : NULL;
618                                 ale->datatype = ALE_ACT;
619                                 
620                                 ale->adt = BKE_animdata_from_id(data);
621                         }
622                         break;
623                         case ANIMTYPE_DSCAM:
624                         {
625                                 Camera *ca = (Camera *)data;
626                                 AnimData *adt = ca->adt;
627                                 
628                                 ale->flag = FILTER_CAM_OBJD(ca);
629                                 
630                                 ale->key_data = (adt) ? adt->action : NULL;
631                                 ale->datatype = ALE_ACT;
632                                 
633                                 ale->adt = BKE_animdata_from_id(data);
634                         }
635                         break;
636                         case ANIMTYPE_DSCUR:
637                         {
638                                 Curve *cu = (Curve *)data;
639                                 AnimData *adt = cu->adt;
640                                 
641                                 ale->flag = FILTER_CUR_OBJD(cu);
642                                 
643                                 ale->key_data = (adt) ? adt->action : NULL;
644                                 ale->datatype = ALE_ACT;
645                                 
646                                 ale->adt = BKE_animdata_from_id(data);
647                         }
648                         break;
649                         case ANIMTYPE_DSARM:
650                         {
651                                 bArmature *arm = (bArmature *)data;
652                                 AnimData *adt = arm->adt;
653                                 
654                                 ale->flag = FILTER_ARM_OBJD(arm);
655                                 
656                                 ale->key_data = (adt) ? adt->action : NULL;
657                                 ale->datatype = ALE_ACT;
658                                 
659                                 ale->adt = BKE_animdata_from_id(data);
660                         }
661                         break;
662                         case ANIMTYPE_DSMESH:
663                         {
664                                 Mesh *me = (Mesh *)data;
665                                 AnimData *adt = me->adt;
666                                 
667                                 ale->flag = FILTER_MESH_OBJD(me);
668                                 
669                                 ale->key_data = (adt) ? adt->action : NULL;
670                                 ale->datatype = ALE_ACT;
671                                 
672                                 ale->adt = BKE_animdata_from_id(data);
673                         }
674                         break;
675                         case ANIMTYPE_DSLAT:
676                         {
677                                 Lattice *lt = (Lattice *)data;
678                                 AnimData *adt = lt->adt;
679                                 
680                                 ale->flag = FILTER_LATTICE_OBJD(lt);
681                                 
682                                 ale->key_data = (adt) ? adt->action : NULL;
683                                 ale->datatype = ALE_ACT;
684                                 
685                                 ale->adt = BKE_animdata_from_id(data);
686                         }
687                         break;
688                         case ANIMTYPE_DSSPK:
689                         {
690                                 Speaker *spk = (Speaker *)data;
691                                 AnimData *adt = spk->adt;
692                                 
693                                 ale->flag = FILTER_SPK_OBJD(spk);
694                                 
695                                 ale->key_data = (adt) ? adt->action : NULL;
696                                 ale->datatype = ALE_ACT;
697                                 
698                                 ale->adt = BKE_animdata_from_id(data);
699                         }
700                         break;
701                         case ANIMTYPE_DSSKEY:
702                         {
703                                 Key *key = (Key *)data;
704                                 AnimData *adt = key->adt;
705                                 
706                                 ale->flag = FILTER_SKE_OBJD(key);
707                                 
708                                 ale->key_data = (adt) ? adt->action : NULL;
709                                 ale->datatype = ALE_ACT;
710                                 
711                                 ale->adt = BKE_animdata_from_id(data);
712                         }
713                         break;
714                         case ANIMTYPE_DSWOR:
715                         {
716                                 World *wo = (World *)data;
717                                 AnimData *adt = wo->adt;
718                                 
719                                 ale->flag = FILTER_WOR_SCED(wo);
720                                 
721                                 ale->key_data = (adt) ? adt->action : NULL;
722                                 ale->datatype = ALE_ACT;
723                                 
724                                 ale->adt = BKE_animdata_from_id(data);
725                         }
726                         break;
727                         case ANIMTYPE_DSNTREE:
728                         {
729                                 bNodeTree *ntree = (bNodeTree *)data;
730                                 AnimData *adt = ntree->adt;
731                                 
732                                 ale->flag = FILTER_NTREE_DATA(ntree);
733                                 
734                                 ale->key_data = (adt) ? adt->action : NULL;
735                                 ale->datatype = ALE_ACT;
736                                 
737                                 ale->adt = BKE_animdata_from_id(data);
738                         }
739                         break;
740                         case ANIMTYPE_DSLINESTYLE:
741                         {
742                                 FreestyleLineStyle *linestyle= (FreestyleLineStyle *)data;
743                                 AnimData *adt= linestyle->adt;
744                                 
745                                 ale->flag= FILTER_LS_SCED(linestyle); 
746                                 
747                                 ale->key_data= (adt) ? adt->action : NULL;
748                                 ale->datatype= ALE_ACT;
749                                 
750                                 ale->adt= BKE_animdata_from_id(data);
751                         }
752                                 break;
753                         case ANIMTYPE_DSPART:
754                         {
755                                 ParticleSettings *part = (ParticleSettings *)ale->data;
756                                 AnimData *adt = part->adt;
757                                 
758                                 ale->flag = FILTER_PART_OBJD(part);
759                                 
760                                 ale->key_data = (adt) ? adt->action : NULL;
761                                 ale->datatype = ALE_ACT;
762                                 
763                                 ale->adt = BKE_animdata_from_id(data);
764                         }
765                         break;
766                         case ANIMTYPE_DSTEX:
767                         {
768                                 Tex *tex = (Tex *)data;
769                                 AnimData *adt = tex->adt;
770                                 
771                                 ale->flag = FILTER_TEX_DATA(tex);
772                                 
773                                 ale->key_data = (adt) ? adt->action : NULL;
774                                 ale->datatype = ALE_ACT;
775                                 
776                                 ale->adt = BKE_animdata_from_id(data);
777                         }
778                         break;
779                                 
780                         case ANIMTYPE_GROUP:
781                         {
782                                 bActionGroup *agrp = (bActionGroup *)data;
783                                 
784                                 ale->flag = agrp->flag;
785                                 
786                                 ale->key_data = NULL;
787                                 ale->datatype = ALE_GROUP;
788                         }
789                         break;
790                         case ANIMTYPE_FCURVE:
791                         {
792                                 FCurve *fcu = (FCurve *)data;
793                                 
794                                 ale->flag = fcu->flag;
795                                 
796                                 ale->key_data = fcu;
797                                 ale->datatype = ALE_FCURVE;
798                         }
799                         break;
800                                 
801                         case ANIMTYPE_SHAPEKEY:
802                         {
803                                 KeyBlock *kb = (KeyBlock *)data;
804                                 Key *key = (Key *)ale->id;
805                                 
806                                 ale->flag = kb->flag;
807                                 
808                                 /* whether we have keyframes depends on whether there is a Key block to find it from */
809                                 if (key) {
810                                         /* index of shapekey is defined by place in key's list */
811                                         ale->index = BLI_findindex(&key->block, kb);
812                                         
813                                         /* the corresponding keyframes are from the animdata */
814                                         if (ale->adt && ale->adt->action) {
815                                                 bAction *act = ale->adt->action;
816                                                 char *rna_path = BKE_keyblock_curval_rnapath_get(key, kb);
817                                                 
818                                                 /* try to find the F-Curve which corresponds to this exactly,
819                                                  * then free the MEM_alloc'd string
820                                                  */
821                                                 if (rna_path) {
822                                                         ale->key_data = (void *)list_find_fcurve(&act->curves, rna_path, 0);
823                                                         MEM_freeN(rna_path);
824                                                 }
825                                         }
826                                         ale->datatype = (ale->key_data) ? ALE_FCURVE : ALE_NONE;
827                                 }
828                         }
829                         break;
830                         
831                         case ANIMTYPE_GPLAYER:
832                         {
833                                 bGPDlayer *gpl = (bGPDlayer *)data;
834                                 
835                                 ale->flag = gpl->flag;
836                                 
837                                 ale->key_data = NULL;
838                                 ale->datatype = ALE_GPFRAME;
839                         }
840                         break;
841                         
842                         case ANIMTYPE_MASKLAYER:
843                         {
844                                 MaskLayer *masklay = (MaskLayer *)data;
845                                 
846                                 ale->flag = masklay->flag;
847                                 
848                                 ale->key_data = NULL;
849                                 ale->datatype = ALE_MASKLAY;
850                         }
851                         break;
852                         
853                         case ANIMTYPE_NLATRACK:
854                         {
855                                 NlaTrack *nlt = (NlaTrack *)data;
856                                 
857                                 ale->flag = nlt->flag;
858                                 
859                                 ale->key_data = &nlt->strips;
860                                 ale->datatype = ALE_NLASTRIP;
861                         }
862                         break;
863                         case ANIMTYPE_NLAACTION:
864                         {
865                                 /* nothing to include for now... nothing editable from NLA-perspective here */
866                                 ale->key_data = NULL;
867                                 ale->datatype = ALE_NONE;
868                         }
869                         break;
870                 }
871         }
872         
873         /* return created datatype */
874         return ale;
875 }
876  
877 /* ----------------------------------------- */
878
879 /* 'Only Selected' selected data and/or 'Include Hidden' filtering
880  * NOTE: when this function returns true, the F-Curve is to be skipped 
881  */
882 static short skip_fcurve_selected_data(bDopeSheet *ads, FCurve *fcu, ID *owner_id, int filter_mode)
883 {
884         /* hidden items should be skipped if we only care about visible data, but we aren't interested in hidden stuff */
885         short skip_hidden = (filter_mode & ANIMFILTER_DATA_VISIBLE) && !(ads->filterflag & ADS_FILTER_INCL_HIDDEN);
886         
887         if (GS(owner_id->name) == ID_OB) {
888                 Object *ob = (Object *)owner_id;
889                 
890                 /* only consider if F-Curve involves pose.bones */
891                 if ((fcu->rna_path) && strstr(fcu->rna_path, "pose.bones")) {
892                         bPoseChannel *pchan;
893                         char *bone_name;
894                         
895                         /* get bone-name, and check if this bone is selected */
896                         bone_name = BLI_str_quoted_substrN(fcu->rna_path, "pose.bones[");
897                         pchan = BKE_pose_channel_find_name(ob->pose, bone_name);
898                         if (bone_name) MEM_freeN(bone_name);
899                         
900                         /* check whether to continue or skip */
901                         if ((pchan) && (pchan->bone)) {
902                                 /* if only visible channels, skip if bone not visible unless user wants channels from hidden data too */
903                                 if (skip_hidden) {
904                                         bArmature *arm = (bArmature *)ob->data;
905                                         
906                                         /* skipping - not visible on currently visible layers */
907                                         if ((arm->layer & pchan->bone->layer) == 0)
908                                                 return 1;
909                                         /* skipping - is currently hidden */
910                                         if (pchan->bone->flag & BONE_HIDDEN_P)
911                                                 return 1;
912                                 }
913                                 
914                                 /* can only add this F-Curve if it is selected */
915                                 if (ads->filterflag & ADS_FILTER_ONLYSEL) {
916                                         if ((pchan->bone->flag & BONE_SELECTED) == 0)
917                                                 return 1;
918                                 }
919                         }
920                 }
921         }
922         else if (GS(owner_id->name) == ID_SCE) {
923                 Scene *scene = (Scene *)owner_id;
924                 
925                 /* only consider if F-Curve involves sequence_editor.sequences */
926                 if ((fcu->rna_path) && strstr(fcu->rna_path, "sequences_all")) {
927                         Editing *ed = BKE_sequencer_editing_get(scene, FALSE);
928                         Sequence *seq = NULL;
929                         char *seq_name;
930
931                         if (ed) {
932                                 /* get strip name, and check if this strip is selected */
933                                 seq_name = BLI_str_quoted_substrN(fcu->rna_path, "sequences_all[");
934                                 seq = BKE_sequence_get_by_name(ed->seqbasep, seq_name, FALSE);
935                                 if (seq_name) MEM_freeN(seq_name);
936                         }
937
938                         /* can only add this F-Curve if it is selected */
939                         if (ads->filterflag & ADS_FILTER_ONLYSEL) {
940                                 if ((seq == NULL) || (seq->flag & SELECT) == 0)
941                                         return 1;
942                         }
943                 }
944         }
945         else if (GS(owner_id->name) == ID_NT) {
946                 bNodeTree *ntree = (bNodeTree *)owner_id;
947                 
948                 /* check for selected nodes */
949                 if ((fcu->rna_path) && strstr(fcu->rna_path, "nodes")) {
950                         bNode *node;
951                         char *node_name;
952                         
953                         /* get strip name, and check if this strip is selected */
954                         node_name = BLI_str_quoted_substrN(fcu->rna_path, "nodes[");
955                         node = nodeFindNodebyName(ntree, node_name);
956                         if (node_name) MEM_freeN(node_name);
957                         
958                         /* can only add this F-Curve if it is selected */
959                         if (ads->filterflag & ADS_FILTER_ONLYSEL) {
960                                 if ((node) && (node->flag & NODE_SELECT) == 0)
961                                         return 1;
962                         }
963                 }
964         }
965         return 0;
966 }
967
968 /* (Display-)Name-based F-Curve filtering
969  * NOTE: when this function returns true, the F-Curve is to be skipped 
970  */
971 static short skip_fcurve_with_name(bDopeSheet *ads, FCurve *fcu, ID *owner_id)
972 {
973         bAnimListElem ale_dummy = {NULL};
974         bAnimChannelType *acf;
975         
976         /* create a dummy wrapper for the F-Curve */
977         ale_dummy.type = ANIMTYPE_FCURVE;
978         ale_dummy.id = owner_id;
979         ale_dummy.data = fcu;
980         
981         /* get type info for channel */
982         acf = ANIM_channel_get_typeinfo(&ale_dummy);
983         if (acf && acf->name) {
984                 char name[256]; /* hopefully this will be enough! */
985                 
986                 /* get name */
987                 acf->name(&ale_dummy, name);
988                 
989                 /* check for partial match with the match string, assuming case insensitive filtering 
990                  * if match, this channel shouldn't be ignored!
991                  */
992                 return BLI_strcasestr(name, ads->searchstr) == NULL;
993         }
994         
995         /* just let this go... */
996         return 1;
997 }
998
999 /* Check if F-Curve has errors and/or is disabled 
1000  * > returns: (bool) True if F-Curve has errors/is disabled
1001  */
1002 static short fcurve_has_errors(FCurve *fcu)
1003 {
1004         /* F-Curve disabled - path eval error */
1005         if (fcu->flag & FCURVE_DISABLED) {
1006                 return 1;
1007         }
1008         
1009         /* driver? */
1010         if (fcu->driver) {
1011                 /* for now, just check if the entire thing got disabled... */
1012                 if (fcu->driver->flag & DRIVER_FLAG_INVALID)
1013                         return 1;
1014         }
1015         
1016         /* no errors found */
1017         return 0;
1018 }
1019
1020 /* find the next F-Curve that is usable for inclusion */
1021 static FCurve *animfilter_fcurve_next(bDopeSheet *ads, FCurve *first, bActionGroup *grp, int filter_mode, ID *owner_id)
1022 {
1023         FCurve *fcu = NULL;
1024         
1025         /* loop over F-Curves - assume that the caller of this has already checked that these should be included 
1026          * NOTE: we need to check if the F-Curves belong to the same group, as this gets called for groups too...
1027          */
1028         for (fcu = first; ((fcu) && (fcu->grp == grp)); fcu = fcu->next) {
1029                 /* special exception for Pose-Channel/Sequence-Strip/Node Based F-Curves:
1030                  *      - the 'Only Selected' and 'Include Hidden' data filters should be applied to sub-ID data which
1031                  *        can be independently selected/hidden, such as Pose-Channels, Sequence Strips, and Nodes.
1032                  *        Since these checks were traditionally done as first check for objects, we do the same here
1033                  *      - we currently use an 'approximate' method for getting these F-Curves that doesn't require
1034                  *        carefully checking the entire path
1035                  *      - this will also affect things like Drivers, and also works for Bone Constraints
1036                  */
1037                 if (ads && owner_id) {
1038                         if ((ads->filterflag & ADS_FILTER_ONLYSEL) || (ads->filterflag & ADS_FILTER_INCL_HIDDEN) == 0) {
1039                                 if (skip_fcurve_selected_data(ads, fcu, owner_id, filter_mode))
1040                                         continue;
1041                         }
1042                 }
1043                 
1044                 /* only include if visible (Graph Editor check, not channels check) */
1045                 if (!(filter_mode & ANIMFILTER_CURVE_VISIBLE) || (fcu->flag & FCURVE_VISIBLE)) {
1046                         /* only work with this channel and its subchannels if it is editable */
1047                         if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_FCU(fcu)) {
1048                                 /* only include this curve if selected in a way consistent with the filtering requirements */
1049                                 if (ANIMCHANNEL_SELOK(SEL_FCU(fcu)) && ANIMCHANNEL_SELEDITOK(SEL_FCU(fcu))) {
1050                                         /* only include if this curve is active */
1051                                         if (!(filter_mode & ANIMFILTER_ACTIVE) || (fcu->flag & FCURVE_ACTIVE)) {
1052                                                 /* name based filtering... */
1053                                                 if ( ((ads) && (ads->filterflag & ADS_FILTER_BY_FCU_NAME)) && (owner_id) ) {
1054                                                         if (skip_fcurve_with_name(ads, fcu, owner_id))
1055                                                                 continue;
1056                                                 }
1057                                                 
1058                                                 /* error-based filtering... */
1059                                                 if ((ads) && (ads->filterflag & ADS_FILTER_ONLY_ERRORS)) {
1060                                                         /* skip if no errors... */
1061                                                         if (fcurve_has_errors(fcu) == 0)
1062                                                                 continue;
1063                                                 }
1064                                                 
1065                                                 /* this F-Curve can be used, so return it */
1066                                                 return fcu;
1067                                         }
1068                                 }
1069                         }
1070                 }
1071         }
1072         
1073         /* no (more) F-Curves from the list are suitable... */
1074         return NULL;
1075 }
1076
1077 static size_t animfilter_fcurves(ListBase *anim_data, bDopeSheet *ads, FCurve *first, bActionGroup *grp, int filter_mode, ID *owner_id)
1078 {
1079         FCurve *fcu;
1080         size_t items = 0;
1081         
1082         /* loop over every F-Curve able to be included 
1083          *      - this for-loop works like this: 
1084          *              1) the starting F-Curve is assigned to the fcu pointer so that we have a starting point to search from
1085          *              2) the first valid F-Curve to start from (which may include the one given as 'first') in the remaining 
1086          *                 list of F-Curves is found, and verified to be non-null
1087          *              3) the F-Curve referenced by fcu pointer is added to the list
1088          *              4) the fcu pointer is set to the F-Curve after the one we just added, so that we can keep going through 
1089          *                 the rest of the F-Curve list without an eternal loop. Back to step 2 :)
1090          */
1091         for (fcu = first; ( (fcu = animfilter_fcurve_next(ads, fcu, grp, filter_mode, owner_id)) ); fcu = fcu->next) {
1092                 ANIMCHANNEL_NEW_CHANNEL(fcu, ANIMTYPE_FCURVE, owner_id);
1093         }
1094         
1095         /* return the number of items added to the list */
1096         return items;
1097 }
1098
1099 static size_t animfilter_act_group(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, bAction *UNUSED(act), bActionGroup *agrp, int filter_mode, ID *owner_id)
1100 {
1101         ListBase tmp_data = {NULL, NULL};
1102         size_t tmp_items = 0;
1103         size_t items = 0;
1104         //int ofilter = filter_mode;
1105         
1106         /* if we care about the selection status of the channels, 
1107          * but the group isn't expanded (1)...
1108          *  (1) this only matters if we actually care about the hierarchy though.
1109          *              - Hierarchy matters: this hack should be applied
1110          *              - Hierarchy ignored: cases like [#21276] won't work properly, unless we skip this hack
1111          */
1112         if ( ((filter_mode & ANIMFILTER_LIST_VISIBLE) && EXPANDED_AGRP(ac, agrp) == 0) &&     /* care about hierarchy but group isn't expanded */
1113              (filter_mode & (ANIMFILTER_SEL | ANIMFILTER_UNSEL)) )                          /* care about selection status */
1114         {
1115                 /* if the group itself isn't selected appropriately, we shouldn't consider it's children either */
1116                 if (ANIMCHANNEL_SELOK(SEL_AGRP(agrp)) == 0)
1117                         return 0;
1118                 
1119                 /* if we're still here, then the selection status of the curves within this group should not matter,
1120                  * since this creates too much overhead for animators (i.e. making a slow workflow)
1121                  *
1122                  * Tools affected by this at time of coding (2010 Feb 09):
1123                  *      - inserting keyframes on selected channels only
1124                  *      - pasting keyframes
1125                  *      - creating ghost curves in Graph Editor
1126                  */
1127                 filter_mode &= ~(ANIMFILTER_SEL | ANIMFILTER_UNSEL | ANIMFILTER_LIST_VISIBLE);
1128         }
1129         
1130         /* add grouped F-Curves */
1131         BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_AGRP(ac, agrp))
1132         {
1133                 /* special filter so that we can get just the F-Curves within the active group */
1134                 if (!(filter_mode & ANIMFILTER_ACTGROUPED) || (agrp->flag & AGRP_ACTIVE)) {
1135                         /* for the Graph Editor, curves may be set to not be visible in the view to lessen clutter,
1136                          * but to do this, we need to check that the group doesn't have it's not-visible flag set preventing 
1137                          * all its sub-curves to be shown
1138                          */
1139                         if (!(filter_mode & ANIMFILTER_CURVE_VISIBLE) || !(agrp->flag & AGRP_NOTVISIBLE)) {
1140                                 /* group must be editable for its children to be editable (if we care about this) */
1141                                 if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_AGRP(agrp)) {
1142                                         /* get first F-Curve which can be used here */
1143                                         FCurve *first_fcu = animfilter_fcurve_next(ads, agrp->channels.first, agrp, filter_mode, owner_id);
1144                                         
1145                                         /* filter list, starting from this F-Curve */
1146                                         tmp_items += animfilter_fcurves(&tmp_data, ads, first_fcu, agrp, filter_mode, owner_id);
1147                                 }
1148                         }
1149                 }
1150         }
1151         END_ANIMFILTER_SUBCHANNELS;
1152         
1153         /* did we find anything? */
1154         if (tmp_items) {
1155                 /* add this group as a channel first */
1156                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1157                         /* restore original filter mode so that this next step works ok... */
1158                         //filter_mode = ofilter;
1159                         
1160                         /* filter selection of channel specially here again, since may be open and not subject to previous test */
1161                         if (ANIMCHANNEL_SELOK(SEL_AGRP(agrp)) ) {
1162                                 ANIMCHANNEL_NEW_CHANNEL(agrp, ANIMTYPE_GROUP, owner_id);
1163                         }
1164                 }
1165                 
1166                 /* now add the list of collected channels */
1167                 BLI_movelisttolist(anim_data, &tmp_data);
1168                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1169                 items += tmp_items;
1170         }
1171         
1172         /* return the number of items added to the list */
1173         return items;
1174 }
1175
1176 static size_t animfilter_action(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, bAction *act, int filter_mode, ID *owner_id)
1177 {
1178         bActionGroup *agrp;
1179         FCurve *lastchan = NULL;
1180         size_t items = 0;
1181         
1182         /* don't include anything from this action if it is linked in from another file,
1183          * and we're getting stuff for editing...
1184          */
1185         if ((filter_mode & ANIMFILTER_FOREDIT) && (act->id.lib))
1186                 return 0;
1187                 
1188         /* do groups */
1189         // TODO: do nested groups?
1190         for (agrp = act->groups.first; agrp; agrp = agrp->next) {
1191                 /* store reference to last channel of group */
1192                 if (agrp->channels.last) 
1193                         lastchan = agrp->channels.last;
1194                         
1195                 /* action group's channels */
1196                 items += animfilter_act_group(ac, anim_data, ads, act, agrp, filter_mode, owner_id);
1197         }
1198         
1199         /* un-grouped F-Curves (only if we're not only considering those channels in the active group) */
1200         if (!(filter_mode & ANIMFILTER_ACTGROUPED)) {
1201                 FCurve *firstfcu = (lastchan) ? (lastchan->next) : (act->curves.first);
1202                 items += animfilter_fcurves(anim_data, ads, firstfcu, NULL, filter_mode, owner_id);
1203         }
1204         
1205         /* return the number of items added to the list */
1206         return items;
1207 }
1208
1209 /* Include NLA-Data for NLA-Editor:
1210  *      - when ANIMFILTER_LIST_CHANNELS is used, that means we should be filtering the list for display
1211  *        Although the evaluation order is from the first track to the last and then apply the Action on top,
1212  *        we present this in the UI as the Active Action followed by the last track to the first so that we 
1213  *        get the evaluation order presented as per a stack.
1214  *      - for normal filtering (i.e. for editing), we only need the NLA-tracks but they can be in 'normal' evaluation
1215  *        order, i.e. first to last. Otherwise, some tools may get screwed up.
1216  */
1217 static size_t animfilter_nla(bAnimContext *UNUSED(ac), ListBase *anim_data, bDopeSheet *ads, AnimData *adt, int filter_mode, ID *owner_id)
1218 {
1219         NlaTrack *nlt;
1220         NlaTrack *first = NULL, *next = NULL;
1221         size_t items = 0;
1222         
1223         /* if showing channels, include active action */
1224         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1225                 /* if NLA action-line filtering is off, don't show unless there are keyframes, 
1226                  * in order to keep things more compact for doing transforms
1227                  */
1228                 if (!(ads->filterflag & ADS_FILTER_NLA_NOACT) || (adt->action)) {
1229                         /* there isn't really anything editable here, so skip if need editable */
1230                         if ((filter_mode & ANIMFILTER_FOREDIT) == 0) {
1231                                 /* just add the action track now (this MUST appear for drawing)
1232                                  *      - as AnimData may not have an action, we pass a dummy pointer just to get the list elem created, then
1233                                  *        overwrite this with the real value - REVIEW THIS...
1234                                  */
1235                                 ANIMCHANNEL_NEW_CHANNEL_FULL((void *)(&adt->action), ANIMTYPE_NLAACTION, owner_id, 
1236                                         {
1237                                                 ale->data = adt->action ? adt->action : NULL; 
1238                                         });
1239                         }
1240                 }
1241                 
1242                 /* first track to include will be the last one if we're filtering by channels */
1243                 first = adt->nla_tracks.last;
1244         }
1245         else {
1246                 /* first track to include will the the first one (as per normal) */
1247                 first = adt->nla_tracks.first;
1248         }
1249         
1250         /* loop over NLA Tracks - assume that the caller of this has already checked that these should be included */
1251         for (nlt = first; nlt; nlt = next) {
1252                 /* 'next' NLA-Track to use depends on whether we're filtering for drawing or not */
1253                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) 
1254                         next = nlt->prev;
1255                 else
1256                         next = nlt->next;
1257                 
1258                 /* if we're in NLA-tweakmode, don't show this track if it was disabled (due to tweaking) for now 
1259                  *      - active track should still get shown though (even though it has disabled flag set)
1260                  */
1261                 // FIXME: the channels after should still get drawn, just 'differently', and after an active-action channel
1262                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED) && !(nlt->flag & NLATRACK_ACTIVE))
1263                         continue;
1264                 
1265                 /* only work with this channel and its subchannels if it is editable */
1266                 if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_NLT(nlt)) {
1267                         /* only include this track if selected in a way consistent with the filtering requirements */
1268                         if (ANIMCHANNEL_SELOK(SEL_NLT(nlt))) {
1269                                 /* only include if this track is active */
1270                                 if (!(filter_mode & ANIMFILTER_ACTIVE) || (nlt->flag & NLATRACK_ACTIVE)) {
1271                                         ANIMCHANNEL_NEW_CHANNEL(nlt, ANIMTYPE_NLATRACK, owner_id);
1272                                 }
1273                         }
1274                 }
1275         }
1276         
1277         /* return the number of items added to the list */
1278         return items;
1279 }
1280
1281 /* determine what animation data from AnimData block should get displayed */
1282 static size_t animfilter_block_data(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *id, int filter_mode)
1283 {
1284         AnimData *adt = BKE_animdata_from_id(id);
1285         size_t items = 0;
1286         
1287         /* image object datablocks have no anim-data so check for NULL */
1288         if (adt) {
1289                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
1290                 
1291                 /* NOTE: this macro is used instead of inlining the logic here, since this sort of filtering is still needed
1292                  * in a few places in he rest of the code still - notably for the few cases where special mode-based
1293                  * different types of data expanders are required.
1294                  */
1295                 ANIMDATA_FILTER_CASES(iat,
1296                         { /* AnimData */
1297                                 /* specifically filter animdata block */
1298                                 ANIMCHANNEL_NEW_CHANNEL(adt, ANIMTYPE_ANIMDATA, id);
1299                         },
1300                         { /* NLA */
1301                                 items += animfilter_nla(ac, anim_data, ads, adt, filter_mode, id);
1302                         },
1303                         { /* Drivers */
1304                                 items += animfilter_fcurves(anim_data, ads, adt->drivers.first, NULL, filter_mode, id);
1305                         },
1306                         { /* Keyframes */
1307                                 items += animfilter_action(ac, anim_data, ads, adt->action, filter_mode, id);
1308                         }
1309                 );
1310         }
1311         
1312         return items;
1313 }
1314
1315
1316
1317 /* Include ShapeKey Data for ShapeKey Editor */
1318 static size_t animdata_filter_shapekey(bAnimContext *ac, ListBase *anim_data, Key *key, int filter_mode)
1319 {
1320         size_t items = 0;
1321         
1322         /* check if channels or only F-Curves */
1323         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1324                 KeyBlock *kb;
1325                 
1326                 /* loop through the channels adding ShapeKeys as appropriate */
1327                 for (kb = key->block.first; kb; kb = kb->next) {
1328                         /* skip the first one, since that's the non-animatable basis */
1329                         if (kb == key->block.first) continue;
1330                         
1331                         /* only work with this channel and its subchannels if it is editable */
1332                         if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_SHAPEKEY(kb)) {
1333                                 /* only include this track if selected in a way consistent with the filtering requirements */
1334                                 if (ANIMCHANNEL_SELOK(SEL_SHAPEKEY(kb)) ) {
1335                                         // TODO: consider 'active' too?
1336                                         
1337                                         /* owner-id here must be key so that the F-Curve can be resolved... */
1338                                         ANIMCHANNEL_NEW_CHANNEL(kb, ANIMTYPE_SHAPEKEY, key);
1339                                 }
1340                         }
1341                 }
1342         }
1343         else {
1344                 /* just use the action associated with the shapekey */
1345                 // TODO: somehow manage to pass dopesheet info down here too?
1346                 if (key->adt) {
1347                         if (filter_mode & ANIMFILTER_ANIMDATA) {
1348                                 ANIMCHANNEL_NEW_CHANNEL(key->adt, ANIMTYPE_ANIMDATA, key);
1349                         }
1350                         else if (key->adt->action) {
1351                                 items = animfilter_action(ac, anim_data, NULL, key->adt->action, filter_mode, (ID *)key);
1352                         }
1353                 }
1354         }
1355         
1356         /* return the number of items added to the list */
1357         return items;
1358 }
1359
1360 /* Helper for Grease Pencil - layers within a datablock */
1361 static size_t animdata_filter_gpencil_data(ListBase *anim_data, bGPdata *gpd, int filter_mode)
1362 {
1363         bGPDlayer *gpl;
1364         size_t items = 0;
1365         
1366         /* loop over layers as the conditions are acceptable */
1367         for (gpl = gpd->layers.first; gpl; gpl = gpl->next) {
1368                 /* only if selected */
1369                 if (ANIMCHANNEL_SELOK(SEL_GPL(gpl)) ) {
1370                         /* only if editable */
1371                         if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_GPL(gpl)) {
1372                                 /* active... */
1373                                 if (!(filter_mode & ANIMFILTER_ACTIVE) || (gpl->flag & GP_LAYER_ACTIVE)) {
1374                                         /* add to list */
1375                                         ANIMCHANNEL_NEW_CHANNEL(gpl, ANIMTYPE_GPLAYER, gpd);
1376                                 }
1377                         }
1378                 }
1379         }
1380         
1381         return items;
1382 }
1383
1384 /* Grab all Grease Pencil datablocks in file */
1385 // TODO: should this be amalgamated with the dopesheet filtering code?
1386 static size_t animdata_filter_gpencil(ListBase *anim_data, void *UNUSED(data), int filter_mode)
1387 {
1388         bGPdata *gpd;
1389         size_t items = 0;
1390         
1391         /* for now, grab grease pencil datablocks directly from main */
1392         // XXX: this is not good...
1393         for (gpd = G.main->gpencil.first; gpd; gpd = gpd->id.next) {
1394                 ListBase tmp_data = {NULL, NULL};
1395                 size_t tmp_items = 0;
1396                 
1397                 /* only show if gpd is used by something... */
1398                 if (ID_REAL_USERS(gpd) < 1)
1399                         continue;
1400                         
1401                 /* add gpencil animation channels */
1402                 BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_GPD(gpd))
1403                 {
1404                         tmp_items += animdata_filter_gpencil_data(&tmp_data, gpd, filter_mode);
1405                 }
1406                 END_ANIMFILTER_SUBCHANNELS;
1407                 
1408                 /* did we find anything? */
1409                 if (tmp_items) {
1410                         /* include data-expand widget first */
1411                         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1412                                 /* add gpd as channel too (if for drawing, and it has layers) */
1413                                 ANIMCHANNEL_NEW_CHANNEL(gpd, ANIMTYPE_GPDATABLOCK, NULL);
1414                         }
1415                         
1416                         /* now add the list of collected channels */
1417                         BLI_movelisttolist(anim_data, &tmp_data);
1418                         BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1419                         items += tmp_items;
1420                 }
1421         }
1422         
1423         /* return the number of items added to the list */
1424         return items;
1425 }
1426
1427 /* Helper for Mask Editing - mask layers */
1428 static size_t animdata_filter_mask_data(ListBase *anim_data, Mask *mask, const int filter_mode)
1429 {
1430         MaskLayer *masklay_act = BKE_mask_layer_active(mask);
1431         MaskLayer *masklay;
1432         size_t items = 0;
1433
1434         /* loop over layers as the conditions are acceptable */
1435         for (masklay = mask->masklayers.first; masklay; masklay = masklay->next) {
1436                 /* only if selected */
1437                 if (ANIMCHANNEL_SELOK(SEL_MASKLAY(masklay)) ) {
1438                         /* only if editable */
1439                         if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_MASK(masklay)) {
1440                                 /* active... */
1441                                 if (!(filter_mode & ANIMFILTER_ACTIVE) || (masklay_act == masklay)) {
1442                                         /* add to list */
1443                                         ANIMCHANNEL_NEW_CHANNEL(masklay, ANIMTYPE_MASKLAYER, mask);
1444                                 }
1445                         }
1446                 }
1447         }
1448
1449         return items;
1450 }
1451
1452 /* Grab all mask data */
1453 static size_t animdata_filter_mask(ListBase *anim_data, void *UNUSED(data), int filter_mode)
1454 {
1455         Mask *mask;
1456         size_t items = 0;
1457         
1458         /* for now, grab mask datablocks directly from main */
1459         // XXX: this is not good...
1460         for (mask = G.main->mask.first; mask; mask = mask->id.next) {
1461                 ListBase tmp_data = {NULL, NULL};
1462                 size_t tmp_items = 0;
1463                 
1464                 /* only show if mask is used by something... */
1465                 if (ID_REAL_USERS(mask) < 1)
1466                         continue;
1467                 
1468                 /* add mask animation channels */
1469                 BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_MASK(mask))
1470                 {
1471                         tmp_items += animdata_filter_mask_data(&tmp_data, mask, filter_mode);
1472                 }
1473                 END_ANIMFILTER_SUBCHANNELS;
1474                 
1475                 /* did we find anything? */
1476                 if (tmp_items) {
1477                         /* include data-expand widget first */
1478                         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1479                                 /* add gpd as channel too (if for drawing, and it has layers) */
1480                                 ANIMCHANNEL_NEW_CHANNEL(mask, ANIMTYPE_MASKDATABLOCK, NULL);
1481                         }
1482                         
1483                         /* now add the list of collected channels */
1484                         BLI_movelisttolist(anim_data, &tmp_data);
1485                         BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1486                         items += tmp_items;
1487                 }
1488         }
1489         
1490         /* return the number of items added to the list */
1491         return items;
1492 }
1493
1494 /* NOTE: owner_id is scene, material, or texture block, which is the direct owner of the node tree in question */
1495 // TODO: how to handle group nodes is still unclear...
1496 static size_t animdata_filter_ds_nodetree(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *owner_id, bNodeTree *ntree, int filter_mode)
1497 {
1498         ListBase tmp_data = {NULL, NULL};
1499         size_t tmp_items = 0;
1500         size_t items = 0;
1501         
1502         /* add nodetree animation channels */
1503         BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_NTREE_DATA(ntree))
1504         {
1505                 /* animation data filtering */
1506                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ntree, filter_mode);
1507         }
1508         END_ANIMFILTER_SUBCHANNELS;
1509         
1510         /* did we find anything? */
1511         if (tmp_items) {
1512                 /* include data-expand widget first */
1513                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1514                         /* check if filtering by active status */
1515                         if (ANIMCHANNEL_ACTIVEOK(ntree)) {
1516                                 ANIMCHANNEL_NEW_CHANNEL(ntree, ANIMTYPE_DSNTREE, owner_id);
1517                         }
1518                 }
1519                 
1520                 /* now add the list of collected channels */
1521                 BLI_movelisttolist(anim_data, &tmp_data);
1522                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1523                 items += tmp_items;
1524         }
1525         
1526         /* return the number of items added to the list */
1527         return items;
1528 }
1529
1530 static size_t animdata_filter_ds_linestyle (bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
1531 {
1532         SceneRenderLayer *srl;
1533         size_t items = 0;
1534
1535         for (srl= sce->r.layers.first; srl; srl= srl->next) {
1536                 FreestyleLineSet *lineset;
1537
1538                 /* skip render layers without Freestyle enabled */
1539                 if (!(srl->layflag & SCE_LAY_FRS))
1540                         continue;
1541
1542                 /* loop over linesets defined in the render layer */
1543                 for (lineset= srl->freestyleConfig.linesets.first; lineset; lineset= lineset->next) {
1544                         FreestyleLineStyle *linestyle = lineset->linestyle;
1545                         ListBase tmp_data = {NULL, NULL};
1546                         size_t tmp_items = 0;
1547
1548                         /* add scene-level animation channels */
1549                         BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_LS_SCED(linestyle))
1550                         {
1551                                 /* animation data filtering */
1552                                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)linestyle, filter_mode);
1553                         }
1554                         END_ANIMFILTER_SUBCHANNELS;
1555
1556                         /* did we find anything? */
1557                         if (tmp_items) {
1558                                 /* include anim-expand widget first */
1559                                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1560                                         /* check if filtering by active status */
1561                                         if ANIMCHANNEL_ACTIVEOK(linestyle) {
1562                                                 ANIMCHANNEL_NEW_CHANNEL(linestyle, ANIMTYPE_DSLINESTYLE, sce);
1563                                         }
1564                                 }
1565                                 
1566                                 /* now add the list of collected channels */
1567                                 BLI_movelisttolist(anim_data, &tmp_data);
1568                                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1569                                 items += tmp_items;
1570                         }
1571                 }
1572         }
1573         
1574         /* return the number of items added to the list */
1575         return items;
1576 }
1577
1578 /* NOTE: owner_id is either material, lamp, or world block, which is the direct owner of the texture stack in question */
1579 static size_t animdata_filter_ds_textures(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, ID *owner_id, int filter_mode)
1580 {
1581         MTex **mtex = NULL;
1582         size_t items = 0;
1583         int a = 0;
1584         
1585         /* get datatype specific data first */
1586         if (owner_id == NULL)
1587                 return 0;
1588         
1589         switch (GS(owner_id->name)) {
1590                 case ID_MA:
1591                 {
1592                         Material *ma = (Material *)owner_id;
1593                         mtex = (MTex **)(&ma->mtex);
1594                 }
1595                 break;
1596                 case ID_LA:
1597                 {
1598                         Lamp *la = (Lamp *)owner_id;
1599                         mtex = (MTex **)(&la->mtex);
1600                 }
1601                 break;
1602                 case ID_WO:
1603                 {
1604                         World *wo = (World *)owner_id;
1605                         mtex = (MTex **)(&wo->mtex);
1606                 }
1607                 break;
1608                 default: 
1609                 {
1610                         /* invalid/unsupported option */
1611                         if (G.debug & G_DEBUG)
1612                                 printf("ERROR: unsupported owner_id (i.e. texture stack) for filter textures - %s\n", owner_id->name);
1613                         return 0;
1614                 }
1615         }
1616         
1617         /* firstly check that we actuallly have some textures, by gathering all textures in a temp list */
1618         for (a = 0; a < MAX_MTEX; a++) {
1619                 Tex *tex = (mtex[a]) ? mtex[a]->tex : NULL;
1620                 ListBase tmp_data = {NULL, NULL};
1621                 size_t tmp_items = 0;
1622                 
1623                 /* for now, if no texture returned, skip (this shouldn't confuse the user I hope) */
1624                 if (tex == NULL) 
1625                         continue;
1626                 
1627                 /* add texture's animation data to temp collection */
1628                 BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_TEX_DATA(tex)) 
1629                 {
1630                         /* texture animdata */
1631                         tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)tex, filter_mode);
1632                         
1633                         /* nodes */
1634                         if ((tex->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE)) {
1635                                 /* owner_id as id instead of texture, since it'll otherwise be impossible to track the depth */
1636                                 // FIXME: perhaps as a result, textures should NOT be included under materials, but under their own section instead
1637                                 // so that free-floating textures can also be animated
1638                                 tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, (ID *)tex, tex->nodetree, filter_mode);
1639                         }
1640                 }
1641                 END_ANIMFILTER_SUBCHANNELS;
1642                 
1643                 /* did we find anything? */
1644                 if (tmp_items) {
1645                         /* include texture-expand widget? */
1646                         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1647                                 /* check if filtering by active status */
1648                                 if (ANIMCHANNEL_ACTIVEOK(tex)) {
1649                                         ANIMCHANNEL_NEW_CHANNEL(tex, ANIMTYPE_DSTEX, owner_id);
1650                                 }
1651                         }
1652                         
1653                         /* now add the list of collected channels */
1654                         BLI_movelisttolist(anim_data, &tmp_data);
1655                         BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1656                         items += tmp_items;
1657                 }
1658         }
1659         
1660         /* return the number of items added to the list */
1661         return items;
1662 }
1663
1664
1665 static size_t animdata_filter_ds_material(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Material *ma, int filter_mode)
1666 {
1667         ListBase tmp_data = {NULL, NULL};
1668         size_t tmp_items = 0;
1669         size_t items = 0;
1670         
1671         /* add material's animation data to temp collection */
1672         BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_MAT_OBJD(ma))
1673         {
1674                 /* material's animation data */
1675                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ma, filter_mode);
1676                         
1677                 /* textures */
1678                 if (!(ads->filterflag & ADS_FILTER_NOTEX))
1679                         tmp_items += animdata_filter_ds_textures(ac, &tmp_data, ads, (ID *)ma, filter_mode);
1680                         
1681                 /* nodes */
1682                 if ((ma->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE)) 
1683                         tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, (ID *)ma, ma->nodetree, filter_mode);
1684         }
1685         END_ANIMFILTER_SUBCHANNELS;
1686         
1687         /* did we find anything? */
1688         if (tmp_items) {
1689                 /* include material-expand widget first */
1690                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1691                         /* check if filtering by active status */
1692                         if (ANIMCHANNEL_ACTIVEOK(ma)) {
1693                                 ANIMCHANNEL_NEW_CHANNEL(ma, ANIMTYPE_DSMAT, ma);
1694                         }
1695                 }
1696                 
1697                 /* now add the list of collected channels */
1698                 BLI_movelisttolist(anim_data, &tmp_data);
1699                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1700                 items += tmp_items;
1701         }
1702         
1703         return items;
1704 }
1705
1706 static size_t animdata_filter_ds_materials(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
1707 {
1708         short has_nested = 0;
1709         size_t items = 0;
1710         int a = 0;
1711         
1712         /* first pass: take the materials referenced via the Material slots of the object */
1713         for (a = 1; a <= ob->totcol; a++) {
1714                 Material *ma = give_current_material(ob, a);
1715                 
1716                 /* if material is valid, try to add relevant contents from here */
1717                 if (ma) {
1718                         /* add channels */
1719                         items += animdata_filter_ds_material(ac, anim_data, ads, ma, filter_mode);
1720                         
1721                         /* for optimising second pass - check if there's a nested material here to come back for */
1722                         if (has_nested == 0)
1723                                 has_nested = give_node_material(ma) != NULL;
1724                 }
1725         }
1726         
1727         /* second pass: go through a second time looking for "nested" materials (material.material references)
1728          *
1729          * NOTE: here we ignore the expanded status of the parent, as it could be too confusing as to why these are
1730          *       disappearing/not available, since the relationships between these is not that clear
1731          */
1732         if (has_nested) {
1733                 for (a = 1; a <= ob->totcol; a++) {
1734                         Material *base = give_current_material(ob, a);
1735                         Material *ma   = give_node_material(base);
1736                         
1737                         /* add channels from the nested material if it exists */
1738                         if (ma)
1739                                 items += animdata_filter_ds_material(ac, anim_data, ads, ma, filter_mode);
1740                 }
1741         }
1742         
1743         /* return the number of items added to the list */
1744         return items;
1745 }
1746
1747 static size_t animdata_filter_ds_particles(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
1748 {
1749         ParticleSystem *psys;
1750         size_t items = 0;
1751
1752         for (psys = ob->particlesystem.first; psys; psys = psys->next) {
1753                 ListBase tmp_data = {NULL, NULL};
1754                 size_t tmp_items = 0;
1755                 
1756                 /* if no material returned, skip - so that we don't get weird blank entries... */
1757                 if (ELEM(NULL, psys->part, psys->part->adt))
1758                         continue;
1759                 
1760                 /* add particle-system's animation data to temp collection */
1761                 BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_PART_OBJD(psys->part))
1762                 {
1763                         /* material's animation data */
1764                         tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)psys->part, filter_mode);
1765                 }
1766                 END_ANIMFILTER_SUBCHANNELS;
1767                 
1768                 /* did we find anything? */
1769                 if (tmp_items) {
1770                         /* include particle-expand widget first */
1771                         if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1772                                 /* check if filtering by active status */
1773                                 if (ANIMCHANNEL_ACTIVEOK(psys->part)) {
1774                                         ANIMCHANNEL_NEW_CHANNEL(psys->part, ANIMTYPE_DSPART, psys->part);
1775                                 }
1776                         }
1777                         
1778                         /* now add the list of collected channels */
1779                         BLI_movelisttolist(anim_data, &tmp_data);
1780                         BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1781                         items += tmp_items;
1782                 }
1783         }
1784         
1785         /* return the number of items added to the list */
1786         return items;
1787 }
1788
1789 static size_t animdata_filter_ds_obdata(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
1790 {
1791         ListBase tmp_data = {NULL, NULL};
1792         size_t tmp_items = 0;
1793         size_t items = 0;
1794         
1795         IdAdtTemplate *iat = ob->data;
1796         short type = 0, expanded = 0;
1797         
1798         /* get settings based on data type */
1799         switch (ob->type) {
1800                 case OB_CAMERA: /* ------- Camera ------------ */
1801                 {
1802                         Camera *ca = (Camera *)ob->data;
1803                         
1804                         if (ads->filterflag & ADS_FILTER_NOCAM)
1805                                 return 0;
1806                         
1807                         type = ANIMTYPE_DSCAM;
1808                         expanded = FILTER_CAM_OBJD(ca);
1809                 }
1810                 break;
1811                 case OB_LAMP: /* ---------- Lamp ----------- */
1812                 {
1813                         Lamp *la = (Lamp *)ob->data;
1814                         
1815                         if (ads->filterflag & ADS_FILTER_NOLAM)
1816                                 return 0;
1817                         
1818                         type = ANIMTYPE_DSLAM;
1819                         expanded = FILTER_LAM_OBJD(la);
1820                 }
1821                 break;
1822                 case OB_CURVE: /* ------- Curve ---------- */
1823                 case OB_SURF: /* ------- Nurbs Surface ---------- */
1824                 case OB_FONT: /* ------- Text Curve ---------- */
1825                 {
1826                         Curve *cu = (Curve *)ob->data;
1827                         
1828                         if (ads->filterflag & ADS_FILTER_NOCUR)
1829                                 return 0;
1830                         
1831                         type = ANIMTYPE_DSCUR;
1832                         expanded = FILTER_CUR_OBJD(cu);
1833                 }
1834                 break;
1835                 case OB_MBALL: /* ------- MetaBall ---------- */
1836                 {
1837                         MetaBall *mb = (MetaBall *)ob->data;
1838                         
1839                         if (ads->filterflag & ADS_FILTER_NOMBA)
1840                                 return 0;
1841                         
1842                         type = ANIMTYPE_DSMBALL;
1843                         expanded = FILTER_MBALL_OBJD(mb);
1844                 }
1845                 break;
1846                 case OB_ARMATURE: /* ------- Armature ---------- */
1847                 {
1848                         bArmature *arm = (bArmature *)ob->data;
1849                         
1850                         if (ads->filterflag & ADS_FILTER_NOARM)
1851                                 return 0;
1852                         
1853                         type = ANIMTYPE_DSARM;
1854                         expanded = FILTER_ARM_OBJD(arm);
1855                 }
1856                 break;
1857                 case OB_MESH: /* ------- Mesh ---------- */
1858                 {
1859                         Mesh *me = (Mesh *)ob->data;
1860                         
1861                         if (ads->filterflag & ADS_FILTER_NOMESH)
1862                                 return 0;
1863                         
1864                         type = ANIMTYPE_DSMESH;
1865                         expanded = FILTER_MESH_OBJD(me);
1866                 }
1867                 break;
1868                 case OB_LATTICE: /* ---- Lattice ---- */
1869                 {
1870                         Lattice *lt = (Lattice *)ob->data;
1871                         
1872                         if (ads->filterflag & ADS_FILTER_NOLAT)
1873                                 return 0;
1874                         
1875                         type = ANIMTYPE_DSLAT;
1876                         expanded = FILTER_LATTICE_OBJD(lt);
1877                 }
1878                 break;
1879                 case OB_SPEAKER: /* ---------- Speaker ----------- */
1880                 {
1881                         Speaker *spk = (Speaker *)ob->data;
1882                         
1883                         type = ANIMTYPE_DSSPK;
1884                         expanded = FILTER_SPK_OBJD(spk);
1885                 }
1886                 break;
1887         }
1888         
1889         /* add object data animation channels */
1890         BEGIN_ANIMFILTER_SUBCHANNELS(expanded)
1891         {
1892                 /* animation data filtering */
1893                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)iat, filter_mode);
1894                 
1895                 /* sub-data filtering... */
1896                 switch (ob->type) {
1897                         case OB_LAMP:  /* lamp - textures + nodetree */
1898                         {
1899                                 Lamp *la = ob->data;
1900                                 bNodeTree *ntree = la->nodetree;
1901                                 
1902                                 /* nodetree */
1903                                 if ((ntree) && !(ads->filterflag & ADS_FILTER_NONTREE))
1904                                         tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, &la->id, ntree, filter_mode);
1905                                 
1906                                 /* textures */
1907                                 if (!(ads->filterflag & ADS_FILTER_NOTEX))
1908                                         tmp_items += animdata_filter_ds_textures(ac, &tmp_data, ads, &la->id, filter_mode);
1909                         }
1910                         break;
1911                 }
1912         }
1913         END_ANIMFILTER_SUBCHANNELS;
1914         
1915         /* did we find anything? */
1916         if (tmp_items) {
1917                 /* include data-expand widget first */
1918                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1919                         /* check if filtering by active status */
1920                         if (ANIMCHANNEL_ACTIVEOK(iat)) {
1921                                 ANIMCHANNEL_NEW_CHANNEL(iat, type, iat);
1922                         }
1923                 }
1924                 
1925                 /* now add the list of collected channels */
1926                 BLI_movelisttolist(anim_data, &tmp_data);
1927                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1928                 items += tmp_items;
1929         }
1930         
1931         /* return the number of items added to the list */
1932         return items;
1933 }
1934
1935 /* shapekey-level animation */
1936 static size_t animdata_filter_ds_keyanim(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, Key *key, int filter_mode)
1937 {
1938         ListBase tmp_data = {NULL, NULL};
1939         size_t tmp_items = 0;
1940         size_t items = 0;
1941         
1942         /* add shapekey-level animation channels */
1943         BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_SKE_OBJD(key))
1944         {
1945                 /* animation data filtering */
1946                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)key, filter_mode);
1947         }
1948         END_ANIMFILTER_SUBCHANNELS;
1949         
1950         /* did we find anything? */
1951         if (tmp_items) {
1952                 /* include key-expand widget first */
1953                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
1954                         if (ANIMCHANNEL_ACTIVEOK(key)) {
1955                                 ANIMCHANNEL_NEW_CHANNEL(key, ANIMTYPE_DSSKEY, ob);
1956                         }
1957                 }
1958                 
1959                 /* now add the list of collected channels */
1960                 BLI_movelisttolist(anim_data, &tmp_data);
1961                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
1962                 items += tmp_items;
1963         }
1964         
1965         /* return the number of items added to the list */
1966         return items;
1967 }
1968
1969 /* object-level animation */
1970 static size_t animdata_filter_ds_obanim(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Object *ob, int filter_mode)
1971 {
1972         ListBase tmp_data = {NULL, NULL};
1973         size_t tmp_items = 0;
1974         size_t items = 0;
1975         
1976         AnimData *adt = ob->adt;
1977         short type = 0, expanded = 1;
1978         void *cdata = NULL;
1979
1980         /* determine the type of expander channels to use */
1981         /* this is the best way to do this for now... */
1982         ANIMDATA_FILTER_CASES(ob,
1983                 { /* AnimData - no channel, but consider data */ },
1984                 { /* NLA - no channel, but consider data */ },
1985                 { /* Drivers */
1986                         type = ANIMTYPE_FILLDRIVERS;
1987                         cdata = adt;
1988                         expanded = EXPANDED_DRVD(adt);
1989                 },
1990                 { /* Keyframes */
1991                         type = ANIMTYPE_FILLACTD;
1992                         cdata = adt->action;
1993                         expanded = EXPANDED_ACTC(adt->action);
1994                 });
1995                 
1996         /* add object-level animation channels */
1997         BEGIN_ANIMFILTER_SUBCHANNELS(expanded)
1998         {
1999                 /* animation data filtering */
2000                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)ob, filter_mode);
2001         }
2002         END_ANIMFILTER_SUBCHANNELS;
2003         
2004         /* did we find anything? */
2005         if (tmp_items) {
2006                 /* include anim-expand widget first */
2007                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2008                         if (type != ANIMTYPE_NONE) {
2009                                 /* NOTE: active-status (and the associated checks) don't apply here... */
2010                                 ANIMCHANNEL_NEW_CHANNEL(cdata, type, ob);
2011                         }
2012                 }
2013                 
2014                 /* now add the list of collected channels */
2015                 BLI_movelisttolist(anim_data, &tmp_data);
2016                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
2017                 items += tmp_items;
2018         }
2019         
2020         /* return the number of items added to the list */
2021         return items;
2022 }
2023
2024 /* get animation channels from object2 */
2025 static size_t animdata_filter_dopesheet_ob(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Base *base, int filter_mode)
2026 {
2027         ListBase tmp_data = {NULL, NULL};
2028         Object *ob = base->object;
2029         size_t tmp_items = 0;
2030         size_t items = 0;
2031         
2032         /* filter data contained under object first */
2033         BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_OBJC(ob))
2034         {
2035                 Key *key = BKE_key_from_object(ob);
2036                 
2037                 /* object-level animation */
2038                 if ((ob->adt) && !(ads->filterflag & ADS_FILTER_NOOBJ)) {
2039                         tmp_items += animdata_filter_ds_obanim(ac, &tmp_data, ads, ob, filter_mode);
2040                 }
2041                 
2042                 /* shape-key */
2043                 if ((key && key->adt) && !(ads->filterflag & ADS_FILTER_NOSHAPEKEYS)) {
2044                         tmp_items += animdata_filter_ds_keyanim(ac, &tmp_data, ads, ob, key, filter_mode);
2045                 }
2046                 
2047                 /* materials */
2048                 if ((ob->totcol) && !(ads->filterflag & ADS_FILTER_NOMAT)) {
2049                         tmp_items += animdata_filter_ds_materials(ac, &tmp_data, ads, ob, filter_mode);
2050                 }
2051                 
2052                 /* object data */
2053                 if (ob->data) {
2054                         tmp_items += animdata_filter_ds_obdata(ac, &tmp_data, ads, ob, filter_mode);
2055                 }
2056                 
2057                 /* particles */
2058                 if ((ob->particlesystem.first) && !(ads->filterflag & ADS_FILTER_NOPART)) {
2059                         tmp_items += animdata_filter_ds_particles(ac, &tmp_data, ads, ob, filter_mode);
2060                 }
2061         }
2062         END_ANIMFILTER_SUBCHANNELS;
2063         
2064         
2065         /* if we collected some channels, add these to the new list... */
2066         if (tmp_items) {
2067                 /* firstly add object expander if required */
2068                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2069                         /* check if filtering by selection */
2070                         // XXX: double-check on this - most of the time, a lot of tools need to filter out these channels!
2071                         if (ANIMCHANNEL_SELOK((base->flag & SELECT))) {
2072                                 /* check if filtering by active status */
2073                                 if (ANIMCHANNEL_ACTIVEOK(ob)) {
2074                                         ANIMCHANNEL_NEW_CHANNEL(base, ANIMTYPE_OBJECT, ob);
2075                                 }
2076                         }
2077                 }
2078                 
2079                 /* now add the list of collected channels */
2080                 BLI_movelisttolist(anim_data, &tmp_data);
2081                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
2082                 items += tmp_items;
2083         }
2084         
2085         /* return the number of items added */
2086         return items;
2087 }
2088
2089 static size_t animdata_filter_ds_world(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, World *wo, int filter_mode)
2090 {
2091         ListBase tmp_data = {NULL, NULL};
2092         size_t tmp_items = 0;
2093         size_t items = 0;
2094         
2095         /* add world animation channels */
2096         BEGIN_ANIMFILTER_SUBCHANNELS(FILTER_WOR_SCED(wo))
2097         {
2098                 /* animation data filtering */
2099                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)wo, filter_mode);
2100                 
2101                 /* textures for world */
2102                 if (!(ads->filterflag & ADS_FILTER_NOTEX))
2103                         items += animdata_filter_ds_textures(ac, &tmp_data, ads, (ID *)wo, filter_mode);
2104                         
2105                 /* nodes */
2106                 if ((wo->nodetree) && !(ads->filterflag & ADS_FILTER_NONTREE)) 
2107                         tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, (ID *)wo, wo->nodetree, filter_mode);
2108         }
2109         END_ANIMFILTER_SUBCHANNELS;
2110         
2111         /* did we find anything? */
2112         if (tmp_items) {
2113                 /* include data-expand widget first */
2114                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2115                         /* check if filtering by active status */
2116                         if (ANIMCHANNEL_ACTIVEOK(wo)) {
2117                                 ANIMCHANNEL_NEW_CHANNEL(wo, ANIMTYPE_DSWOR, sce);
2118                         }
2119                 }
2120                 
2121                 /* now add the list of collected channels */
2122                 BLI_movelisttolist(anim_data, &tmp_data);
2123                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
2124                 items += tmp_items;
2125         }
2126         
2127         /* return the number of items added to the list */
2128         return items;
2129 }
2130
2131 static size_t animdata_filter_ds_scene(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
2132 {
2133         ListBase tmp_data = {NULL, NULL};
2134         size_t tmp_items = 0;
2135         size_t items = 0;
2136         
2137         AnimData *adt = sce->adt;
2138         short type = 0, expanded = 1;
2139         void *cdata = NULL;
2140         
2141         /* determine the type of expander channels to use */
2142         // this is the best way to do this for now...
2143         ANIMDATA_FILTER_CASES(sce,
2144                 { /* AnimData - no channel, but consider data */},
2145                 { /* NLA - no channel, but consider data */},
2146                 { /* Drivers */
2147                         type = ANIMTYPE_FILLDRIVERS;
2148                         cdata = adt;
2149                         expanded = EXPANDED_DRVD(adt);
2150                 },
2151                 { /* Keyframes */
2152                         type = ANIMTYPE_FILLACTD;
2153                         cdata = adt->action;
2154                         expanded = EXPANDED_ACTC(adt->action);
2155                 });
2156                 
2157         /* add scene-level animation channels */
2158         BEGIN_ANIMFILTER_SUBCHANNELS(expanded)
2159         {
2160                 /* animation data filtering */
2161                 tmp_items += animfilter_block_data(ac, &tmp_data, ads, (ID *)sce, filter_mode);
2162         }
2163         END_ANIMFILTER_SUBCHANNELS;
2164         
2165         /* did we find anything? */
2166         if (tmp_items) {
2167                 /* include anim-expand widget first */
2168                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2169                         if (type != ANIMTYPE_NONE) {
2170                                 /* NOTE: active-status (and the associated checks) don't apply here... */
2171                                 ANIMCHANNEL_NEW_CHANNEL(cdata, type, sce);
2172                         }
2173                 }
2174                 
2175                 /* now add the list of collected channels */
2176                 BLI_movelisttolist(anim_data, &tmp_data);
2177                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
2178                 items += tmp_items;
2179         }
2180         
2181         /* return the number of items added to the list */
2182         return items;
2183 }
2184
2185 static size_t animdata_filter_dopesheet_scene(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode)
2186 {
2187         ListBase tmp_data = {NULL, NULL};
2188         size_t tmp_items = 0;
2189         size_t items = 0;
2190         
2191         /* filter data contained under object first */
2192         BEGIN_ANIMFILTER_SUBCHANNELS(EXPANDED_SCEC(sce))
2193         {
2194                 bNodeTree *ntree = sce->nodetree;
2195                 World *wo = sce->world;
2196                 
2197                 /* Action, Drivers, or NLA for Scene */
2198                 if ((ads->filterflag & ADS_FILTER_NOSCE) == 0) {
2199                         tmp_items += animdata_filter_ds_scene(ac, &tmp_data, ads, sce, filter_mode);
2200                 }
2201                 
2202                 /* world */
2203                 if ((wo) && !(ads->filterflag & ADS_FILTER_NOWOR)) {
2204                         tmp_items += animdata_filter_ds_world(ac, &tmp_data, ads, sce, wo, filter_mode);
2205                 }
2206                 
2207                 /* nodetree */
2208                 if ((ntree) && !(ads->filterflag & ADS_FILTER_NONTREE)) {
2209                         tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, (ID *)sce, ntree, filter_mode);
2210                 }
2211
2212                 /* line styles */
2213                 if ((ads->filterflag & ADS_FILTER_NOLINESTYLE) == 0) {
2214                         tmp_items += animdata_filter_ds_linestyle(ac, &tmp_data, ads, sce, filter_mode);
2215                 }
2216                 
2217                 /* TODO: one day, when sequencer becomes its own datatype, perhaps it should be included here */
2218         }
2219         END_ANIMFILTER_SUBCHANNELS;
2220
2221         /* if we collected some channels, add these to the new list... */
2222         if (tmp_items) {
2223                 /* firstly add object expander if required */
2224                 if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
2225                         /* check if filtering by selection */
2226                         if (ANIMCHANNEL_SELOK((sce->flag & SCE_DS_SELECTED))) {
2227                                 /* NOTE: active-status doesn't matter for this! */
2228                                 ANIMCHANNEL_NEW_CHANNEL(sce, ANIMTYPE_SCENE, sce);
2229                         }
2230                 }
2231                 
2232                 /* now add the list of collected channels */
2233                 BLI_movelisttolist(anim_data, &tmp_data);
2234                 BLI_assert((tmp_data.first == tmp_data.last) && (tmp_data.first == NULL));
2235                 items += tmp_items;
2236         }
2237         
2238         /* return the number of items added */
2239         return items;
2240 }
2241
2242 // TODO: implement pinning... (if and when pinning is done, what we need to do is to provide freeing mechanisms - to protect against data that was deleted)
2243 static size_t animdata_filter_dopesheet(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, int filter_mode)
2244 {
2245         Scene *sce = (Scene *)ads->source;
2246         Base *base;
2247         size_t items = 0;
2248         
2249         /* check that we do indeed have a scene */
2250         if ((ads->source == NULL) || (GS(ads->source->name) != ID_SCE)) {
2251                 printf("DopeSheet Error: Not scene!\n");
2252                 if (G.debug & G_DEBUG)
2253                         printf("\tPointer = %p, Name = '%s'\n", (void *)ads->source, (ads->source) ? ads->source->name : NULL);
2254                 return 0;
2255         }
2256         
2257         /* augment the filter-flags with settings based on the dopesheet filterflags 
2258          * so that some temp settings can get added automagically...
2259          */
2260         if (ads->filterflag & ADS_FILTER_SELEDIT) {
2261                 /* only selected F-Curves should get their keyframes considered for editability */
2262                 filter_mode |= ANIMFILTER_SELEDIT;
2263         }
2264         
2265         /* scene-linked animation - e.g. world, compositing nodes, scene anim (including sequencer currently) */
2266         items += animdata_filter_dopesheet_scene(ac, anim_data, ads, sce, filter_mode);
2267         
2268         /* loop over all bases (i.e.objects) in the scene */
2269         for (base = sce->base.first; base; base = base->next) {
2270                 /* check if there's an object (all the relevant checks are done in the ob-function) */
2271                 if (base->object) {
2272                         Object *ob = base->object;
2273                         
2274                         /* firstly, check if object can be included, by the following factors:
2275                          *      - if only visible, must check for layer and also viewport visibility
2276                          *              --> while tools may demand only visible, user setting takes priority
2277                          *                      as user option controls whether sets of channels get included while
2278                          *                      tool-flag takes into account collapsed/open channels too
2279                          *      - if only selected, must check if object is selected 
2280                          *      - there must be animation data to edit (this is done recursively as we 
2281                          *        try to add the channels)
2282                          */
2283                         if ((filter_mode & ANIMFILTER_DATA_VISIBLE) && !(ads->filterflag & ADS_FILTER_INCL_HIDDEN)) {
2284                                 /* layer visibility - we check both object and base, since these may not be in sync yet */
2285                                 if ((sce->lay & (ob->lay | base->lay)) == 0) continue;
2286                                 
2287                                 /* outliner restrict-flag */
2288                                 if (ob->restrictflag & OB_RESTRICT_VIEW) continue;
2289                         }
2290                         
2291                         /* if only F-Curves with visible flags set can be shown, check that 
2292                          * datablock hasn't been set to invisible 
2293                          */
2294                         if (filter_mode & ANIMFILTER_CURVE_VISIBLE) {
2295                                 if ((ob->adt) && (ob->adt->flag & ADT_CURVES_NOT_VISIBLE))
2296                                         continue;
2297                         }
2298                         
2299                         /* check selection and object type filters */
2300                         if ( (ads->filterflag & ADS_FILTER_ONLYSEL) && !((base->flag & SELECT) /*|| (base == sce->basact)*/) ) {
2301                                 /* only selected should be shown */
2302                                 continue;
2303                         }
2304                         
2305                         /* check if object belongs to the filtering group if option to filter 
2306                          * objects by the grouped status is on
2307                          *      - used to ease the process of doing multiple-character choreographies
2308                          */
2309                         if (ads->filterflag & ADS_FILTER_ONLYOBGROUP) {
2310                                 if (object_in_group(ob, ads->filter_grp) == 0)
2311                                         continue;
2312                         }
2313                                 
2314                         /* since we're still here, this object should be usable */
2315                         items += animdata_filter_dopesheet_ob(ac, anim_data, ads, base, filter_mode);
2316                 }
2317         }
2318         
2319         /* return the number of items in the list */
2320         return items;
2321 }
2322
2323 /* Summary track for DopeSheet/Action Editor 
2324  *  - return code is whether the summary lets the other channels get drawn
2325  */
2326 static short animdata_filter_dopesheet_summary(bAnimContext *ac, ListBase *anim_data, int filter_mode, size_t *items)
2327 {
2328         bDopeSheet *ads = NULL;
2329         
2330         /* get the DopeSheet information to use 
2331          *      - we should only need to deal with the DopeSheet/Action Editor, 
2332          *        since all the other Animation Editors won't have this concept
2333          *        being applicable.
2334          */
2335         if ((ac && ac->sl) && (ac->spacetype == SPACE_ACTION)) {
2336                 SpaceAction *saction = (SpaceAction *)ac->sl;
2337                 ads = &saction->ads;
2338         }
2339         else {
2340                 /* invalid space type - skip this summary channels */
2341                 return 1;
2342         }
2343         
2344         /* dopesheet summary 
2345          *      - only for drawing and/or selecting keyframes in channels, but not for real editing 
2346          *      - only useful for DopeSheet/Action/etc. editors where it is actually useful
2347          */
2348         if ((filter_mode & ANIMFILTER_LIST_CHANNELS) && (ads->filterflag & ADS_FILTER_SUMMARY)) {
2349                 bAnimListElem *ale = make_new_animlistelem(ac, ANIMTYPE_SUMMARY, NULL);
2350                 if (ale) {
2351                         BLI_addtail(anim_data, ale);
2352                         (*items)++;
2353                 }
2354                 
2355                 /* if summary is collapsed, don't show other channels beneath this 
2356                  *      - this check is put inside the summary check so that it doesn't interfere with normal operation
2357                  */ 
2358                 if (ads->flag & ADS_FLAG_SUMMARY_COLLAPSED)
2359                         return 0;
2360         }
2361         
2362         /* the other channels beneath this can be shown */
2363         return 1;
2364 }  
2365
2366 /* ......................... */
2367
2368 /* filter data associated with a channel - usually for handling summary-channels in DopeSheet */
2369 static size_t animdata_filter_animchan(bAnimContext *ac, ListBase *anim_data, bDopeSheet *ads, bAnimListElem *channel, int filter_mode)
2370 {
2371         size_t items = 0;
2372         
2373         /* data to filter depends on channel type */
2374         /* NOTE: only common channel-types have been handled for now. More can be added as necessary */
2375         switch (channel->type) {
2376                 case ANIMTYPE_SUMMARY:
2377                         items += animdata_filter_dopesheet(ac, anim_data, ads, filter_mode);
2378                         break;
2379                         
2380                 case ANIMTYPE_SCENE:
2381                         items += animdata_filter_dopesheet_scene(ac, anim_data, ads, channel->data, filter_mode);
2382                         break;
2383                 
2384                 case ANIMTYPE_OBJECT:
2385                         items += animdata_filter_dopesheet_ob(ac, anim_data, ads, channel->data, filter_mode);
2386                         break;
2387                         
2388                 default:
2389                         printf("ERROR: Unsupported channel type (%d) in animdata_filter_animchan()\n", channel->type);
2390                         break;
2391         }
2392         
2393         return items;
2394 }
2395
2396 /* ----------- Cleanup API --------------- */
2397
2398 /* Remove entries with invalid types in animation channel list */
2399 static size_t animdata_filter_remove_invalid(ListBase *anim_data)
2400 {
2401         bAnimListElem *ale, *next;
2402         size_t items = 0;
2403         
2404         /* only keep entries with valid types */
2405         for (ale = anim_data->first; ale; ale = next) {
2406                 next = ale->next;
2407                 
2408                 if (ale->type == ANIMTYPE_NONE)
2409                         BLI_freelinkN(anim_data, ale);
2410                 else
2411                         items++;
2412         }
2413         
2414         return items;
2415 }
2416
2417 /* Remove duplicate entries in animation channel list */
2418 static size_t animdata_filter_remove_duplis(ListBase *anim_data)
2419 {
2420         bAnimListElem *ale, *next;
2421         GHash *gh;
2422         size_t items = 0;
2423         
2424         /* build new hashtable to efficiently store and retrieve which entries have been 
2425          * encountered already while searching
2426          */
2427         gh = BLI_ghash_ptr_new("animdata_filter_duplis_remove gh");
2428         
2429         /* loop through items, removing them from the list if a similar item occurs already */
2430         for (ale = anim_data->first; ale; ale = next) {
2431                 next = ale->next;
2432                 
2433                 /* check if hash has any record of an entry like this 
2434                  *      - just use ale->data for now, though it would be nicer to involve 
2435                  *        ale->type in combination too to capture corner cases (where same data performs differently)
2436                  */
2437                 if (BLI_ghash_haskey(gh, ale->data) == 0) {
2438                         /* this entry is 'unique' and can be kept */
2439                         BLI_ghash_insert(gh, ale->data, NULL);
2440                         items++;
2441                 }
2442                 else {
2443                         /* this entry isn't needed anymore */
2444                         BLI_freelinkN(anim_data, ale);
2445                 }
2446         }
2447         
2448         /* free the hash... */
2449         BLI_ghash_free(gh, NULL, NULL);
2450         
2451         /* return the number of items still in the list */
2452         return items;
2453 }
2454
2455 /* ----------- Public API --------------- */
2456
2457 /* This function filters the active data source to leave only animation channels suitable for
2458  * usage by the caller. It will return the length of the list 
2459  * 
2460  *  *anim_data: is a pointer to a ListBase, to which the filtered animation channels
2461  *              will be placed for use.
2462  *      filter_mode: how should the data be filtered - bitmapping accessed flags
2463  */
2464 size_t ANIM_animdata_filter(bAnimContext *ac, ListBase *anim_data, int filter_mode, void *data, short datatype)
2465 {
2466         size_t items = 0;
2467         
2468         /* only filter data if there's somewhere to put it */
2469         if (data && anim_data) {
2470                 
2471                 /* firstly filter the data */
2472                 switch (datatype) {
2473                         case ANIMCONT_ACTION:   /* 'Action Editor' */
2474                         {
2475                                 Object *obact = ac->obact;
2476                                 SpaceAction *saction = (SpaceAction *)ac->sl;
2477                                 bDopeSheet *ads = (saction) ? &saction->ads : NULL;
2478                                 
2479                                 /* the check for the DopeSheet summary is included here since the summary works here too */
2480                                 if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
2481                                         items += animfilter_action(ac, anim_data, ads, data, filter_mode, (ID *)obact);
2482                         }
2483                         break;
2484                         
2485                         case ANIMCONT_SHAPEKEY: /* 'ShapeKey Editor' */
2486                         {
2487                                 /* the check for the DopeSheet summary is included here since the summary works here too */
2488                                 if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
2489                                         items = animdata_filter_shapekey(ac, anim_data, data, filter_mode);
2490                         }
2491                         break;
2492                                 
2493                         case ANIMCONT_GPENCIL:
2494                         {
2495                                 if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
2496                                         items = animdata_filter_gpencil(anim_data, data, filter_mode);
2497                         }
2498                         break;
2499                         
2500                         case ANIMCONT_MASK:
2501                         {
2502                                 if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
2503                                         items = animdata_filter_mask(anim_data, data, filter_mode);
2504                         }
2505                         break;
2506                         
2507                         case ANIMCONT_DOPESHEET: /* 'DopeSheet Editor' */
2508                         {
2509                                 /* the DopeSheet editor is the primary place where the DopeSheet summaries are useful */
2510                                 if (animdata_filter_dopesheet_summary(ac, anim_data, filter_mode, &items))
2511                                         items += animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
2512                         }
2513                         break;
2514                                 
2515                         case ANIMCONT_FCURVES: /* Graph Editor -> F-Curves/Animation Editing */
2516                         case ANIMCONT_DRIVERS: /* Graph Editor -> Drivers Editing */
2517                         case ANIMCONT_NLA:     /* NLA Editor */
2518                         {
2519                                 /* all of these editors use the basic DopeSheet data for filtering options, but don't have all the same features */
2520                                 items = animdata_filter_dopesheet(ac, anim_data, data, filter_mode);
2521                         }
2522                         break;
2523                         
2524                         case ANIMCONT_CHANNEL: /* animation channel */
2525                         {
2526                                 bDopeSheet *ads = ac->ads;
2527                                 
2528                                 /* based on the channel type, filter relevant data for this */
2529                                 items = animdata_filter_animchan(ac, anim_data, ads, data, filter_mode);
2530                         }
2531                         break;
2532                 }
2533                         
2534                 /* remove any 'weedy' entries */
2535                 items = animdata_filter_remove_invalid(anim_data);
2536                 
2537                 /* remove duplicates (if required) */
2538                 if (filter_mode & ANIMFILTER_NODUPLIS)
2539                         items = animdata_filter_remove_duplis(anim_data);
2540         }
2541         
2542         /* return the number of items in the list */
2543         return items;
2544 }
2545
2546 /* ************************************************************ */