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