diff options
Diffstat (limited to 'source/blender/editors/animation/anim_filter.c')
| -rw-r--r-- | source/blender/editors/animation/anim_filter.c | 1423 |
1 files changed, 1423 insertions, 0 deletions
diff --git a/source/blender/editors/animation/anim_filter.c b/source/blender/editors/animation/anim_filter.c new file mode 100644 index 00000000000..afad396607b --- /dev/null +++ b/source/blender/editors/animation/anim_filter.c @@ -0,0 +1,1423 @@ +/** + * $Id$ + * + * ***** BEGIN GPL LICENSE BLOCK ***** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * The Original Code is Copyright (C) 2008 Blender Foundation. + * All rights reserved. + * + * + * Contributor(s): Joshua Leung + * + * ***** END GPL LICENSE BLOCK ***** + */ + +/* This file contains a system used to provide a layer of abstraction between sources + * of animation data and tools in Animation Editors. The method used here involves + * generating a list of edit structures which enable tools to naively perform the actions + * they require without all the boiler-plate associated with loops within loops and checking + * for cases to ignore. + * + * While this is primarily used for the Action/Dopesheet Editor (and its accessory modes), + * the IPO Editor also uses this for it's channel list and for determining which curves + * are being edited. + * + * Note: much of the original system this was based on was built before the creation of the RNA + * system. In future, it would be interesting to replace some parts of this code with RNA queries, + * however, RNA does not eliminate some of the boiler-plate reduction benefits presented by this + * system, so if any such work does occur, it should only be used for the internals used here... + * + * -- Joshua Leung, Dec 2008 + */ + +#include <string.h> +#include <stdio.h> + +#include "DNA_listBase.h" +#include "DNA_ID.h" +#include "DNA_anim_types.h" +#include "DNA_action_types.h" +#include "DNA_constraint_types.h" +#include "DNA_camera_types.h" +#include "DNA_curve_types.h" +#include "DNA_gpencil_types.h" +#include "DNA_ipo_types.h" +#include "DNA_lamp_types.h" +#include "DNA_lattice_types.h" +#include "DNA_key_types.h" +#include "DNA_material_types.h" +#include "DNA_mesh_types.h" +#include "DNA_object_types.h" +#include "DNA_space_types.h" +#include "DNA_scene_types.h" +#include "DNA_screen_types.h" +#include "DNA_windowmanager_types.h" +#include "DNA_world_types.h" + +#include "MEM_guardedalloc.h" + +#include "BLI_blenlib.h" + +#include "BKE_context.h" +#include "BKE_global.h" +#include "BKE_key.h" +#include "BKE_object.h" +#include "BKE_material.h" +#include "BKE_screen.h" +#include "BKE_utildefines.h" + +#include "ED_anim_api.h" +#include "ED_types.h" +#include "ED_util.h" + +#include "WM_api.h" +#include "WM_types.h" + +#include "BIF_gl.h" +#include "BIF_glutil.h" + +#include "UI_interface.h" +#include "UI_resources.h" +#include "UI_view2d.h" + +/* ************************************************************ */ +/* Blender Context <-> Animation Context mapping */ + +/* ----------- Private Stuff - Action Editor ------------- */ + +/* Get shapekey data being edited (for Action Editor -> ShapeKey mode) */ +/* Note: there's a similar function in key.c (ob_get_key) */ +Key *actedit_get_shapekeys (bAnimContext *ac, SpaceAction *saction) +{ + Scene *scene= ac->scene; + Object *ob; + Key *key; + + ob = OBACT; + if (ob == NULL) + return NULL; + + /* XXX pinning is not available in 'ShapeKey' mode... */ + //if (saction->pin) return NULL; + + /* shapekey data is stored with geometry data */ + switch (ob->type) { + case OB_MESH: + key= ((Mesh *)ob->data)->key; + break; + + case OB_LATTICE: + key= ((Lattice *)ob->data)->key; + break; + + case OB_CURVE: + case OB_SURF: + key= ((Curve *)ob->data)->key; + break; + + default: + return NULL; + } + + if (key) { + if (key->type == KEY_RELATIVE) + return key; + } + + return NULL; +} + +/* Get data being edited in Action Editor (depending on current 'mode') */ +static short actedit_get_context (bAnimContext *ac, SpaceAction *saction) +{ + /* sync settings with current view status, then return appropriate data */ + switch (saction->mode) { + case SACTCONT_ACTION: /* 'Action Editor' */ + /* if not pinned, sync with active object */ + if (saction->pin == 0) { + if (ac->obact && ac->obact->adt) + saction->action = ac->obact->adt->action; + else + saction->action= NULL; + } + + ac->datatype= ANIMCONT_ACTION; + ac->data= saction->action; + + ac->mode= saction->mode; + return 1; + + case SACTCONT_SHAPEKEY: /* 'ShapeKey Editor' */ + ac->datatype= ANIMCONT_SHAPEKEY; + ac->data= actedit_get_shapekeys(ac, saction); + + ac->mode= saction->mode; + return 1; + + case SACTCONT_GPENCIL: /* Grease Pencil */ // XXX review how this mode is handled... + ac->datatype=ANIMCONT_GPENCIL; + //ac->data= CTX_wm_screen(C); // FIXME: add that dopesheet type thing here! + ac->data= NULL; // !!! + + ac->mode= saction->mode; + return 1; + + case SACTCONT_DOPESHEET: /* DopeSheet */ + /* update scene-pointer (no need to check for pinning yet, as not implemented) */ + saction->ads.source= (ID *)ac->scene; + + ac->datatype= ANIMCONT_DOPESHEET; + ac->data= &saction->ads; + + ac->mode= saction->mode; + return 1; + + default: /* unhandled yet */ + ac->datatype= ANIMCONT_NONE; + ac->data= NULL; + + ac->mode= -1; + return 0; + } +} + +/* ----------- Private Stuff - IPO Editor ------------- */ + +/* Get data being edited in Graph Editor (depending on current 'mode') */ +static short graphedit_get_context (bAnimContext *ac, SpaceIpo *sipo) +{ + /* init dopesheet data if non-existant (i.e. for old files) */ + if (sipo->ads == NULL) + sipo->ads= MEM_callocN(sizeof(bDopeSheet), "GraphEdit DopeSheet"); + + /* sync settings with current view status, then return appropriate data */ + switch (sipo->mode) { + case SIPO_MODE_ANIMATION: /* Animation F-Curve Editor */ + /* update scene-pointer (no need to check for pinning yet, as not implemented) */ + sipo->ads->source= (ID *)ac->scene; + sipo->ads->filterflag &= ~ADS_FILTER_ONLYDRIVERS; + + ac->datatype= ANIMCONT_FCURVES; + ac->data= sipo->ads; + + ac->mode= sipo->mode; + return 1; + + case SIPO_MODE_DRIVERS: /* Driver F-Curve Editor */ + /* update scene-pointer (no need to check for pinning yet, as not implemented) */ + sipo->ads->source= (ID *)ac->scene; + sipo->ads->filterflag |= ADS_FILTER_ONLYDRIVERS; + + ac->datatype= ANIMCONT_DRIVERS; + ac->data= sipo->ads; + + ac->mode= sipo->mode; + return 1; + + default: /* unhandled yet */ + ac->datatype= ANIMCONT_NONE; + ac->data= NULL; + + ac->mode= -1; + return 0; + } +} + +/* ----------- Public API --------------- */ + +/* Obtain current anim-data context, given that context info from Blender context has already been set + * - AnimContext to write to is provided as pointer to var on stack so that we don't have + * allocation/freeing costs (which are not that avoidable with channels). + */ +short ANIM_animdata_context_getdata (bAnimContext *ac) +{ + ScrArea *sa= ac->sa; + short ok= 0; + + /* context depends on editor we are currently in */ + if (sa) { + switch (sa->spacetype) { + case SPACE_ACTION: + { + SpaceAction *saction= (SpaceAction *)sa->spacedata.first; + ok= actedit_get_context(ac, saction); + } + break; + + case SPACE_IPO: + { + SpaceIpo *sipo= (SpaceIpo *)sa->spacedata.first; + ok= graphedit_get_context(ac, sipo); + } + break; + } + } + + /* check if there's any valid data */ + if (ok && ac->data) + return 1; + else + return 0; +} + +/* Obtain current anim-data context from Blender Context info + * - AnimContext to write to is provided as pointer to var on stack so that we don't have + * allocation/freeing costs (which are not that avoidable with channels). + * - Clears data and sets the information from Blender Context which is useful + */ +short ANIM_animdata_get_context (const bContext *C, bAnimContext *ac) +{ + ScrArea *sa= CTX_wm_area(C); + ARegion *ar= CTX_wm_region(C); + Scene *scene= CTX_data_scene(C); + + /* clear old context info */ + if (ac == NULL) return 0; + memset(ac, 0, sizeof(bAnimContext)); + + /* get useful default context settings from context */ + ac->scene= scene; + if (scene) { + ac->markers= &scene->markers; + ac->obact= (scene->basact)? scene->basact->object : NULL; + } + ac->sa= sa; + ac->ar= ar; + ac->spacetype= (sa) ? sa->spacetype : 0; + ac->regiontype= (ar) ? ar->regiontype : 0; + + /* get data context info */ + return ANIM_animdata_context_getdata(ac); +} + +/* ************************************************************ */ +/* Blender Data <-- Filter --> Channels to be operated on */ + +/* quick macro to test if AnimData is usable */ +#define ANIMDATA_HAS_KEYS(id) ((id)->adt && (id)->adt->action) + +/* quick macro to test if AnimData is usable for drivers */ +#define ANIMDATA_HAS_DRIVERS(id) ((id)->adt && (id)->adt->drivers.first) + +/* quick macro to test if a anim-channel (F-Curve, Group, etc.) is selected in an acceptable way */ +#define ANIMCHANNEL_SELOK(test_func) \ + ( !(filter_mode & (ANIMFILTER_SEL|ANIMFILTER_UNSEL)) || \ + ((filter_mode & ANIMFILTER_SEL) && test_func) || \ + ((filter_mode & ANIMFILTER_UNSEL) && test_func==0) ) + +/* ----------- 'Private' Stuff --------------- */ + +/* this function allocates memory for a new bAnimListElem struct for the + * provided animation channel-data. + */ +bAnimListElem *make_new_animlistelem (void *data, short datatype, void *owner, short ownertype, ID *owner_id) +{ + bAnimListElem *ale= NULL; + + /* only allocate memory if there is data to convert */ + if (data) { + /* allocate and set generic data */ + ale= MEM_callocN(sizeof(bAnimListElem), "bAnimListElem"); + + ale->data= data; + ale->type= datatype; + // XXX what is the point of the owner data? + ale->owner= owner; + ale->ownertype= ownertype; + + ale->id= owner_id; + + /* do specifics */ + switch (datatype) { + case ANIMTYPE_SCENE: + { + Scene *sce= (Scene *)data; + + ale->flag= sce->flag; + + ale->key_data= sce; + ale->datatype= ALE_SCE; + } + break; + case ANIMTYPE_OBJECT: + { + Base *base= (Base *)data; + Object *ob= base->object; + + ale->flag= ob->flag; + + ale->key_data= ob; + ale->datatype= ALE_OB; + } + break; + case ANIMTYPE_FILLACTD: + { + bAction *act= (bAction *)data; + + ale->flag= act->flag; + + ale->key_data= act; + ale->datatype= ALE_ACT; + } + break; + case ANIMTYPE_FILLDRIVERS: + { + AnimData *adt= (AnimData *)data; + + ale->flag= adt->flag; + + // XXX... drivers don't show summary for now + ale->key_data= NULL; + ale->datatype= ALE_NONE; + } + break; + case ANIMTYPE_FILLMATD: + { + Object *ob= (Object *)data; + + ale->flag= FILTER_MAT_OBJC(ob); + + ale->key_data= NULL; + ale->datatype= ALE_NONE; + } + break; + + case ANIMTYPE_DSMAT: + { + Material *ma= (Material *)data; + AnimData *adt= ma->adt; + + ale->flag= FILTER_MAT_OBJD(ma); + + ale->key_data= (adt) ? adt->action : NULL; + ale->datatype= ALE_ACT; + } + break; + case ANIMTYPE_DSLAM: + { + Lamp *la= (Lamp *)data; + AnimData *adt= la->adt; + + ale->flag= FILTER_LAM_OBJD(la); + + ale->key_data= (adt) ? adt->action : NULL; + ale->datatype= ALE_ACT; + } + break; + case ANIMTYPE_DSCAM: + { + Camera *ca= (Camera *)data; + AnimData *adt= ca->adt; + + ale->flag= FILTER_CAM_OBJD(ca); + + ale->key_data= (adt) ? adt->action : NULL; + ale->datatype= ALE_ACT; + } + break; + case ANIMTYPE_DSCUR: + { + Curve *cu= (Curve *)data; + AnimData *adt= cu->adt; + + ale->flag= FILTER_CUR_OBJD(cu); + + ale->key_data= (adt) ? adt->action : NULL; + ale->datatype= ALE_ACT; + } + break; + case ANIMTYPE_DSSKEY: + { + Key *key= (Key *)data; + AnimData *adt= key->adt; + + ale->flag= FILTER_SKE_OBJD(key); + + ale->key_data= (adt) ? adt->action : NULL; + ale->datatype= ALE_ACT; + } + break; + case ANIMTYPE_DSWOR: + { + World *wo= (World *)data; + AnimData *adt= wo->adt; + + ale->flag= FILTER_WOR_SCED(wo); + + ale->key_data= (adt) ? adt->action : NULL; + ale->datatype= ALE_ACT; + } + break; + + case ANIMTYPE_GROUP: + { + bActionGroup *agrp= (bActionGroup *)data; + + ale->flag= agrp->flag; + + ale->key_data= NULL; + ale->datatype= ALE_GROUP; + } + break; + case ANIMTYPE_FCURVE: + { + FCurve *fcu= (FCurve *)data; + + ale->flag= fcu->flag; + + ale->key_data= fcu; + ale->datatype= ALE_FCURVE; + } + break; + + case ANIMTYPE_GPLAYER: + { + bGPDlayer *gpl= (bGPDlayer *)data; + + ale->flag= gpl->flag; + + ale->key_data= NULL; + ale->datatype= ALE_GPFRAME; + } + break; + } + } + + /* return created datatype */ + return ale; +} + +/* ----------------------------------------- */ + + +static int animdata_filter_fcurves (ListBase *anim_data, FCurve *first, bActionGroup *grp, void *owner, short ownertype, int filter_mode, ID *owner_id) +{ + bAnimListElem *ale = NULL; + FCurve *fcu; + int items = 0; + + /* loop over F-Curves - assume that the caller of this has already checked that these should be included + * NOTE: we need to check if the F-Curves belong to the same group, as this gets called for groups too... + */ + for (fcu= first; ((fcu) && (fcu->grp==grp)); fcu= fcu->next) { + /* only include if visible (Graph Editor check, not channels check) */ + if (!(filter_mode & ANIMFILTER_CURVEVISIBLE) || (fcu->flag & FCURVE_VISIBLE)) { + /* only work with this channel and its subchannels if it is editable */ + if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_FCU(fcu)) { + /* only include this curve if selected in a way consistent with the filtering requirements */ + if ( ANIMCHANNEL_SELOK(SEL_FCU(fcu)) ) { + /* only include if this curve is active */ + if (!(filter_mode & ANIMFILTER_ACTIVE) || (fcu->flag & FCURVE_ACTIVE)) { + /* owner/ownertype will be either object or action-channel, depending if it was dopesheet or part of an action */ + ale= make_new_animlistelem(fcu, ANIMTYPE_FCURVE, owner, ownertype, owner_id); + + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + } + } + } + } + + /* return the number of items added to the list */ + return items; +} + +static int animdata_filter_action (ListBase *anim_data, bAction *act, int filter_mode, void *owner, short ownertype, ID *owner_id) +{ + bAnimListElem *ale=NULL; + bActionGroup *agrp; + FCurve *lastchan=NULL; + int items = 0; + + /* loop over groups */ + // XXX in future, we need to be prepared for nestled groups... + for (agrp= act->groups.first; agrp; agrp= agrp->next) { + /* add this group as a channel first */ + if ((filter_mode & ANIMFILTER_CHANNELS) || !(filter_mode & ANIMFILTER_CURVESONLY)) { + /* check if filtering by selection */ + if ( ANIMCHANNEL_SELOK(SEL_AGRP(agrp)) ) { + ale= make_new_animlistelem(agrp, ANIMTYPE_GROUP, NULL, ANIMTYPE_NONE, owner_id); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + } + + /* store reference to last channel of group */ + if (agrp->channels.last) + lastchan= agrp->channels.last; + + + /* there are some situations, where only the channels of the action group should get considered */ + if (!(filter_mode & ANIMFILTER_ACTGROUPED) || (agrp->flag & AGRP_ACTIVE)) { + /* filters here are a bit convoulted... + * - groups show a "summary" of keyframes beside their name which must accessable for tools which handle keyframes + * - groups can be collapsed (and those tools which are only interested in channels rely on knowing that group is closed) + * + * cases when we should include F-Curves inside group: + * - we don't care about visibility + * - group is expanded + * - we're interested in keyframes, but not if they appear in selected channels + */ + // XXX what was the selection check here for again? + if ( (!(filter_mode & ANIMFILTER_VISIBLE) || EXPANDED_AGRP(agrp)) || + ( /*ANIMCHANNEL_SELOK(SEL_AGRP(agrp)) &&*/ (filter_mode & ANIMFILTER_CURVESONLY) ) ) + { + if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_AGRP(agrp)) { + // XXX the 'owner' info here needs review... + items += animdata_filter_fcurves(anim_data, agrp->channels.first, agrp, owner, ownertype, filter_mode, owner_id); + + /* remove group from filtered list if last element is group + * (i.e. only if group had channels, which were all hidden) + */ + // XXX this is really hacky... it should be fixed in a much more elegant way! + if ( (ale) && (anim_data->last == ale) && + (ale->data == agrp) && (agrp->channels.first) ) + { + BLI_freelinkN(anim_data, ale); + items--; + } + } + } + } + } + + /* loop over un-grouped F-Curves (only if we're not only considering those channels in the animive group) */ + if (!(filter_mode & ANIMFILTER_ACTGROUPED)) { + // XXX the 'owner' info here needs review... + items += animdata_filter_fcurves(anim_data, (lastchan)?(lastchan->next):(act->curves.first), NULL, owner, ownertype, filter_mode, owner_id); + } + + /* return the number of items added to the list */ + return items; +} + +static int animdata_filter_shapekey (ListBase *anim_data, Key *key, int filter_mode, void *owner, short ownertype, ID *owner_id) +{ + bAnimListElem *ale; + KeyBlock *kb; + //FCurve *fcu; + int i, items=0; + + /* are we filtering for display or editing */ + if (filter_mode & ANIMFILTER_CHANNELS) { + /* for display - loop over shapekeys, adding ipo-curve references where needed */ + kb= key->block.first; + + /* loop through possible shapekeys, manually creating entries */ + for (i= 1; i < key->totkey; i++) { + ale= MEM_callocN(sizeof(bAnimListElem), "bAnimListElem"); + kb = kb->next; /* do this even on the first try, as the first is 'Basis' (which doesn't get included) */ + + ale->data= kb; + ale->type= ANIMTYPE_SHAPEKEY; /* 'abused' usage of this type */ + ale->owner= key; + ale->ownertype= ANIMTYPE_SHAPEKEY; + ale->datatype= ALE_NONE; + ale->index = i; + +#if 0 // XXX fixme... old system + if (key->ipo) { + for (icu= key->ipo->curve.first; icu; icu=icu->next) { + if (icu->adrcode == i) { + ale->key_data= icu; + ale->datatype= ALE_ICU; + break; + } + } + } +#endif // XXX fixme... old system + + ale->id= owner_id; + + BLI_addtail(anim_data, ale); + items++; + } + } + else { +#if 0 // XXX fixme... old system + /* loop over ipo curves if present - for editing */ + if (key->ipo) { + if (filter_mode & ANIMFILTER_IPOKEYS) { + ale= make_new_animlistelem(key->ipo, ANIMTYPE_IPO, key, ANIMTYPE_SHAPEKEY); + if (ale) { + if (owned) ale->id= owner; + BLI_addtail(anim_data, ale); + items++; + } + } + else { + items += animdata_filter_ipocurves(anim_data, key->ipo, filter_mode, key, ANIMTYPE_SHAPEKEY, (owned)?(owner):(NULL)); + } + } +#endif // XXX fixme... old system + } + + /* return the number of items added to the list */ + return items; +} + +#if 0 +// FIXME: switch this to use the bDopeSheet... +static int animdata_filter_gpencil (ListBase *anim_data, bScreen *sc, int filter_mode) +{ + bAnimListElem *ale; + ScrArea *sa, *curarea; + bGPdata *gpd; + bGPDlayer *gpl; + int items = 0; + + /* check if filtering types are appropriate */ + { + /* special hack for fullscreen area (which must be this one then): + * - we use the curarea->full as screen to get spaces from, since the + * old (pre-fullscreen) screen was stored there... + * - this is needed as all data would otherwise disappear + */ + // XXX need to get new alternative for curarea + if ((curarea->full) && (curarea->spacetype==SPACE_ACTION)) + sc= curarea->full; + + /* loop over spaces in current screen, finding gpd blocks (could be slow!) */ + for (sa= sc->areabase.first; sa; sa= sa->next) { + /* try to get gp data */ + // XXX need to put back grease pencil api... + gpd= gpencil_data_getactive(sa); + if (gpd == NULL) continue; + + /* add gpd as channel too (if for drawing, and it has layers) */ + if ((filter_mode & ANIMFILTER_CHANNELS) && (gpd->layers.first)) { + /* add to list */ + ale= make_new_animlistelem(gpd, ANIMTYPE_GPDATABLOCK, sa, ANIMTYPE_SPECIALDATA); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* only add layers if they will be visible (if drawing channels) */ + if ( !(filter_mode & ANIMFILTER_VISIBLE) || (EXPANDED_GPD(gpd)) ) { + /* loop over layers as the conditions are acceptable */ + for (gpl= gpd->layers.first; gpl; gpl= gpl->next) { + /* only if selected */ + if ( ANIMCHANNEL_SELOK(SEL_GPL(gpl)) ) { + /* only if editable */ + if (!(filter_mode & ANIMFILTER_FOREDIT) || EDITABLE_GPL(gpl)) { + /* add to list */ + ale= make_new_animlistelem(gpl, ANIMTYPE_GPLAYER, gpd, ANIMTYPE_GPDATABLOCK); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + } + } + } + } + } + + /* return the number of items added to the list */ + return items; +} +#endif + + +static int animdata_filter_dopesheet_mats (ListBase *anim_data, bDopeSheet *ads, Base *base, int filter_mode) +{ + ListBase mats = {NULL, NULL}; + LinkData *ld; + + bAnimListElem *ale=NULL; + Object *ob= base->object; + int items=0, a=0; + + /* firstly check that we actuallly have some materials, by gathering all materials in a temp list */ + for (a=0; a < ob->totcol; a++) { + Material *ma= give_current_material(ob, a); + + /* for now, if no material returned, skip (this shouldn't confuse the user I hope) */ + if (ELEM(NULL, ma, ma->adt)) + continue; + + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS)==0) { + if (ANIMDATA_HAS_KEYS(ma) == 0) + continue; + } + else { + if (ANIMDATA_HAS_DRIVERS(ma) == 0) + continue; + } + + /* make a temp list elem for this */ + ld= MEM_callocN(sizeof(LinkData), "DopeSheet-MaterialCache"); + ld->data= ma; + BLI_addtail(&mats, ld); + } + + /* if there were no channels found, no need to carry on */ + if (mats.first == NULL) + return 0; + + /* include materials-expand widget? */ + if ((filter_mode & ANIMFILTER_CHANNELS) && !(filter_mode & ANIMFILTER_CURVESONLY)) { + ale= make_new_animlistelem(ob, ANIMTYPE_FILLMATD, base, ANIMTYPE_OBJECT, (ID *)ob); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add materials? */ + if (FILTER_MAT_OBJC(ob) || (filter_mode & ANIMFILTER_CURVESONLY)) { + /* for each material in cache, add channels */ + for (ld= mats.first; ld; ld= ld->next) { + Material *ma= (Material *)ld->data; + + /* include material-expand widget? */ + // hmm... do we need to store the index of this material in the array anywhere? + if (filter_mode & ANIMFILTER_CHANNELS) { + ale= make_new_animlistelem(ma, ANIMTYPE_DSMAT, base, ANIMTYPE_OBJECT, (ID *)ma); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add material's F-Curve or Driver channels? */ + if (FILTER_MAT_OBJD(ma) || (filter_mode & ANIMFILTER_CURVESONLY)) { + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS)==0) { + // XXX the 'owner' info here is still subject to improvement + items += animdata_filter_action(anim_data, ma->adt->action, filter_mode, ma, ANIMTYPE_DSMAT, (ID *)ma); + } + else { + // need to make the ownertype normal object here... (maybe type should be a separate one for clarity?) + items += animdata_filter_fcurves(anim_data, ma->adt->drivers.first, NULL, ma, ANIMTYPE_DSMAT, filter_mode, (ID *)ma); + } + } + } + } + + /* free cache */ + BLI_freelistN(&mats); + + /* return the number of items added to the list */ + return items; +} + +static int animdata_filter_dopesheet_obdata (ListBase *anim_data, bDopeSheet *ads, Base *base, int filter_mode) +{ + bAnimListElem *ale=NULL; + Object *ob= base->object; + IdAdtTemplate *iat= ob->data; + AnimData *adt= iat->adt; + short type=0, expanded=0; + int items= 0; + + /* get settings based on data type */ + switch (ob->type) { + case OB_CAMERA: /* ------- Camera ------------ */ + { + Camera *ca= (Camera *)ob->data; + + type= ANIMTYPE_DSCAM; + expanded= FILTER_CAM_OBJD(ca); + } + break; + case OB_LAMP: /* ---------- Lamp ----------- */ + { + Lamp *la= (Lamp *)ob->data; + + type= ANIMTYPE_DSLAM; + expanded= FILTER_LAM_OBJD(la); + } + break; + case OB_CURVE: /* ------- Curve ---------- */ + { + Curve *cu= (Curve *)ob->data; + + type= ANIMTYPE_DSCUR; + expanded= FILTER_CUR_OBJD(cu); + } + break; + } + + /* special exception for drivers instead of action */ + if (ads->filterflag & ADS_FILTER_ONLYDRIVERS) + expanded= EXPANDED_DRVD(adt); + + /* include data-expand widget? */ + if ((filter_mode & ANIMFILTER_CURVESONLY) == 0) { + ale= make_new_animlistelem(iat, type, base, ANIMTYPE_OBJECT, (ID *)iat); + if (ale) BLI_addtail(anim_data, ale); + } + + /* add object-data animation channels? */ + if ((expanded) || (filter_mode & ANIMFILTER_CURVESONLY)) { + /* Action or Drivers? */ + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS) == 0) { + // XXX the 'owner' info here is still subject to improvement + items += animdata_filter_action(anim_data, iat->adt->action, filter_mode, iat, type, (ID *)iat); + } + else { + // need to make the ownertype normal object here... (maybe type should be a separate one for clarity?) + items += animdata_filter_fcurves(anim_data, adt->drivers.first, NULL, iat, type, filter_mode, (ID *)iat); + } + } + + /* return the number of items added to the list */ + return items; +} + +static int animdata_filter_dopesheet_ob (ListBase *anim_data, bDopeSheet *ads, Base *base, int filter_mode) +{ + bAnimListElem *ale=NULL; + Object *ob= base->object; + Key *key= ob_get_key(ob); + int items = 0; + + /* add this object as a channel first */ + if ((filter_mode & ANIMFILTER_CURVESONLY) == 0) { + /* check if filtering by selection */ + if ANIMCHANNEL_SELOK((base->flag & SELECT)) { + ale= make_new_animlistelem(base, ANIMTYPE_OBJECT, NULL, ANIMTYPE_NONE, NULL); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + } + + /* if collapsed, don't go any further (unless adding keyframes only) */ + if ( (EXPANDED_OBJC(ob) == 0) && !(filter_mode & ANIMFILTER_CURVESONLY) ) + return items; + + /* Action or Drivers */ + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS) == 0) { + /* Action? */ + if (ANIMDATA_HAS_KEYS(ob) /*&& !(ads->filterflag & ADS_FILTER_NOACTS)*/) { + AnimData *adt= ob->adt; + + /* include action-expand widget? */ + if ((filter_mode & ANIMFILTER_CHANNELS) && !(filter_mode & ANIMFILTER_CURVESONLY)) { + ale= make_new_animlistelem(adt->action, ANIMTYPE_FILLACTD, base, ANIMTYPE_OBJECT, (ID *)ob); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add F-Curve channels? */ + if (EXPANDED_ACTC(adt->action) || !(filter_mode & ANIMFILTER_CHANNELS)) { + // need to make the ownertype normal object here... (maybe type should be a separate one for clarity?) + items += animdata_filter_action(anim_data, adt->action, filter_mode, ob, ANIMTYPE_OBJECT, (ID *)ob); + } + } + } + else { + /* Drivers */ + if (ANIMDATA_HAS_DRIVERS(ob)) { + AnimData *adt= ob->adt; + + /* include drivers-expand widget? */ + if ((filter_mode & ANIMFILTER_CHANNELS) && !(filter_mode & ANIMFILTER_CURVESONLY)) { + ale= make_new_animlistelem(adt->action, ANIMTYPE_FILLDRIVERS, base, ANIMTYPE_OBJECT, (ID *)ob); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add F-Curve channels (drivers are F-Curves) */ + if (EXPANDED_DRVD(adt) || !(filter_mode & ANIMFILTER_CHANNELS)) { + // need to make the ownertype normal object here... (maybe type should be a separate one for clarity?) + items += animdata_filter_fcurves(anim_data, adt->drivers.first, NULL, ob, ANIMTYPE_OBJECT, filter_mode, (ID *)ob); + } + } + } + + /* ShapeKeys? */ + if ((key) && !(ads->filterflag & ADS_FILTER_NOSHAPEKEYS)) { + /* Animation or Drivers */ + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS) == 0) { + /* include shapekey-expand widget? */ + if ((filter_mode & ANIMFILTER_CHANNELS) && !(filter_mode & ANIMFILTER_CURVESONLY)) { + ale= make_new_animlistelem(key, ANIMTYPE_DSSKEY, base, ANIMTYPE_OBJECT, (ID *)ob); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add channels */ + if (FILTER_SKE_OBJD(key) || (filter_mode & ANIMFILTER_CURVESONLY)) { + items += animdata_filter_shapekey(anim_data, key, filter_mode, ob, ANIMTYPE_OBJECT, (ID *)ob); + } + } + else { + /* Drivers */ + if (ANIMDATA_HAS_DRIVERS(key)) { + AnimData *adt= key->adt; + + /* include shapekey-expand widget? */ + if ((filter_mode & ANIMFILTER_CHANNELS) && !(filter_mode & ANIMFILTER_CURVESONLY)) { + ale= make_new_animlistelem(key, ANIMTYPE_DSSKEY, base, ANIMTYPE_OBJECT, (ID *)ob); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add F-Curve channels (drivers are F-Curves) */ + if (FILTER_SKE_OBJD(key)/*EXPANDED_DRVD(adt)*/ || !(filter_mode & ANIMFILTER_CHANNELS)) { + // XXX owner info is messed up now... + items += animdata_filter_fcurves(anim_data, adt->drivers.first, NULL, ob, ANIMTYPE_OBJECT, filter_mode, (ID *)key); + } + } + } + } + + + /* Materials? */ + if ((ob->totcol) && !(ads->filterflag & ADS_FILTER_NOMAT)) + items += animdata_filter_dopesheet_mats(anim_data, ads, base, filter_mode); + + /* Object Data */ + switch (ob->type) { + case OB_CAMERA: /* ------- Camera ------------ */ + { + Camera *ca= (Camera *)ob->data; + + if ((ads->filterflag & ADS_FILTER_NOCAM) == 0) { + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS)==0) { + if (ANIMDATA_HAS_KEYS(ca)) + items += animdata_filter_dopesheet_obdata(anim_data, ads, base, filter_mode); + } + else { + if (ANIMDATA_HAS_DRIVERS(ca)) + items += animdata_filter_dopesheet_obdata(anim_data, ads, base, filter_mode); + } + } + } + break; + case OB_LAMP: /* ---------- Lamp ----------- */ + { + Lamp *la= (Lamp *)ob->data; + + if ((ads->filterflag & ADS_FILTER_NOLAM) == 0) { + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS)==0) { + if (ANIMDATA_HAS_KEYS(la)) + items += animdata_filter_dopesheet_obdata(anim_data, ads, base, filter_mode); + } + else { + if (ANIMDATA_HAS_DRIVERS(la)) + items += animdata_filter_dopesheet_obdata(anim_data, ads, base, filter_mode); + } + } + } + break; + case OB_CURVE: /* ------- Curve ---------- */ + { + Curve *cu= (Curve *)ob->data; + + if ((ads->filterflag & ADS_FILTER_NOCUR) == 0) { + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS)==0) { + if (ANIMDATA_HAS_KEYS(cu)) + items += animdata_filter_dopesheet_obdata(anim_data, ads, base, filter_mode); + } + else { + if (ANIMDATA_HAS_DRIVERS(cu)) + items += animdata_filter_dopesheet_obdata(anim_data, ads, base, filter_mode); + } + } + } + break; + } + + /* return the number of items added to the list */ + return items; +} + +static int animdata_filter_dopesheet_scene (ListBase *anim_data, bDopeSheet *ads, Scene *sce, int filter_mode) +{ + World *wo= sce->world; + bAnimListElem *ale; + int items = 0; + + /* add scene as a channel first (even if we aren't showing scenes we still need to show the scene's sub-data */ + if ((filter_mode & ANIMFILTER_CURVESONLY) == 0) { + /* check if filtering by selection */ + if (ANIMCHANNEL_SELOK( (sce->flag & SCE_DS_SELECTED) )) { + ale= make_new_animlistelem(sce, ANIMTYPE_SCENE, NULL, ANIMTYPE_NONE, NULL); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + } + + /* if collapsed, don't go any further (unless adding keyframes only) */ + if ( (EXPANDED_SCEC(sce) == 0) && !(filter_mode & ANIMFILTER_CURVESONLY) ) + return items; + + /* Action or Drivers */ + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS) == 0) { + /* Action? */ + if (ANIMDATA_HAS_KEYS(sce) && !(ads->filterflag & ADS_FILTER_NOSCE)) { + AnimData *adt= sce->adt; + + /* include action-expand widget? */ + if ((filter_mode & ANIMFILTER_CHANNELS) && !(filter_mode & ANIMFILTER_CURVESONLY)) { + ale= make_new_animlistelem(adt->action, ANIMTYPE_FILLACTD, sce, ANIMTYPE_SCENE, (ID *)sce); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add F-Curve channels? */ + if (EXPANDED_ACTC(adt->action) || !(filter_mode & ANIMFILTER_CHANNELS)) { + items += animdata_filter_action(anim_data, adt->action, filter_mode, sce, ANIMTYPE_SCENE, (ID *)sce); + } + } + } + else { + /* Drivers */ + if (ANIMDATA_HAS_DRIVERS(sce) && !(ads->filterflag & ADS_FILTER_NOSCE)) { + AnimData *adt= sce->adt; + + /* include drivers-expand widget? */ + if ((filter_mode & ANIMFILTER_CHANNELS) && !(filter_mode & ANIMFILTER_CURVESONLY)) { + ale= make_new_animlistelem(adt->action, ANIMTYPE_FILLDRIVERS, sce, ANIMTYPE_SCENE, (ID *)sce); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add F-Curve channels (drivers are F-Curves) */ + if (EXPANDED_DRVD(adt) || !(filter_mode & ANIMFILTER_CHANNELS)) { + items += animdata_filter_fcurves(anim_data, adt->drivers.first, NULL, sce, ANIMTYPE_SCENE, filter_mode, (ID *)sce); + } + } + } + + /* world */ + if ((wo && wo->adt) && !(ads->filterflag & ADS_FILTER_NOWOR)) { + /* Animation or Drivers */ + if ((ads->filterflag & ADS_FILTER_ONLYDRIVERS) == 0) { + AnimData *adt= wo->adt; + + /* include world-expand widget? */ + if ((filter_mode & ANIMFILTER_CHANNELS) && !(filter_mode & ANIMFILTER_CURVESONLY)) { + ale= make_new_animlistelem(wo, ANIMTYPE_DSWOR, sce, ANIMTYPE_SCENE, (ID *)sce); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add channels */ + if (FILTER_WOR_SCED(wo) || (filter_mode & ANIMFILTER_CURVESONLY)) { + items += animdata_filter_action(anim_data, adt->action, filter_mode, wo, ANIMTYPE_DSWOR, (ID *)wo); + } + } + else { + /* Drivers */ + if (ANIMDATA_HAS_DRIVERS(wo)) { + AnimData *adt= wo->adt; + + /* include shapekey-expand widget? */ + if ((filter_mode & ANIMFILTER_CHANNELS) && !(filter_mode & ANIMFILTER_CURVESONLY)) { + ale= make_new_animlistelem(wo, ANIMTYPE_DSWOR, sce, ANIMTYPE_SCENE, (ID *)wo); + if (ale) { + BLI_addtail(anim_data, ale); + items++; + } + } + + /* add F-Curve channels (drivers are F-Curves) */ + if (FILTER_WOR_SCED(wo)/*EXPANDED_DRVD(adt)*/ || !(filter_mode & ANIMFILTER_CHANNELS)) { + // XXX owner info is messed up now... + items += animdata_filter_fcurves(anim_data, adt->drivers.first, NULL, wo, ANIMTYPE_DSWOR, filter_mode, (ID *)wo); + } + } + } + } + + /* return the number of items added to the list */ + return items; +} + +// 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) +static int animdata_filter_dopesheet (ListBase *anim_data, bDopeSheet *ads, int filter_mode) +{ + Scene *sce= (Scene *)ads->source; + Base *base; + int items = 0; + + /* check that we do indeed have a scene */ + if ((ads->source == NULL) || (GS(ads->source->name)!=ID_SCE)) { + printf("DopeSheet Error: Not scene! \n"); + return 0; + } + + /* scene-linked animation */ + // TODO: sequencer, composite nodes - are we to include those here too? + { + short sceOk, worOk; + + /* check filtering-flags if ok */ + if (ads->filterflag) { + if (ads->filterflag & ADS_FILTER_ONLYDRIVERS) { + sceOk= (ANIMDATA_HAS_DRIVERS(sce) && !(ads->filterflag & ADS_FILTER_NOSCE)); + worOk= ((sce->world) && ANIMDATA_HAS_DRIVERS(sce->world) && !(ads->filterflag & ADS_FILTER_NOWOR)); + } + else { + sceOk= (ANIMDATA_HAS_KEYS(sce) && !(ads->filterflag & ADS_FILTER_NOSCE)); + worOk= ((sce->world) && ANIMDATA_HAS_KEYS(sce->world) && !(ads->filterflag & ADS_FILTER_NOWOR)); + } + } + else { + sceOk= (ANIMDATA_HAS_KEYS(sce)); + worOk= ((sce->world) && ANIMDATA_HAS_KEYS(sce->world)); + } + + /* check if not all bad (i.e. so there is something to show) */ + if ( !(!sceOk && !worOk) ) { + /* add scene data to the list of filtered channels */ + items += animdata_filter_dopesheet_scene(anim_data, ads, sce, filter_mode); + } + } + + + /* loop over all bases in the scene */ + for (base= sce->base.first; base; base= base->next) { + /* check if there's an object (all the relevant checks are done in the ob-function) */ + if (base->object) { + Object *ob= base->object; + Key *key= ob_get_key(ob); + short actOk=1, keyOk=1, dataOk=1, matOk=1; + + /* firstly, check if object can be included, by the following fanimors: + * - if only visible, must check for layer and also viewport visibility + * - if only selected, must check if object is selected + * - there must be animation data to edit + */ + // TODO: if cache is implemented, just check name here, and then + if (filter_mode & ANIMFILTER_VISIBLE) { + /* layer visibility - we check both object and base, since these may not be in sync yet */ + if ((sce->lay & (ob->lay|base->lay))==0) continue; + + /* outliner restrict-flag */ + if (ob->restrictflag & OB_RESTRICT_VIEW) continue; + } + + /* additionally, dopesheet filtering also affects what objects to consider */ + if (ads->filterflag) { + /* check selection and object type filters */ + if ( (ads->filterflag & ADS_FILTER_ONLYSEL) && !((base->flag & SELECT) || (base == sce->basact)) ) { + /* only selected should be shown */ + continue; + } + + /* check filters for datatypes */ + if (ads->filterflag & ADS_FILTER_ONLYDRIVERS) { + actOk= (ANIMDATA_HAS_DRIVERS(ob)); + keyOk= ((key) && ANIMDATA_HAS_DRIVERS(key) && !(ads->filterflag & ADS_FILTER_NOSHAPEKEYS)); + } + else { + actOk= ANIMDATA_HAS_KEYS(ob); + keyOk= ((key) && ANIMDATA_HAS_KEYS(key) && !(ads->filterflag & ADS_FILTER_NOSHAPEKEYS)); + } + + /* materials - only for geometric types */ + matOk= 0; /* by default, not ok... */ + if ( !(ads->filterflag & ADS_FILTER_NOMAT) && (ob->totcol) && + ELEM5(ob->type, OB_MESH, OB_CURVE, OB_SURF, OB_FONT, OB_MBALL) ) + { + int a; + + /* firstly check that we actuallly have some materials */ + for (a=0; a < ob->totcol; a++) { + Material *ma= give_current_material(ob, a); + + /* if material has relevant animation data, break */ + if (ads->filterflag & ADS_FILTER_ONLYDRIVERS) { + if (ANIMDATA_HAS_DRIVERS(ma)) { + matOk= 1; + break; + } + } + else { + if (ANIMDATA_HAS_KEYS(ma)) { + matOk= 1; + break; + } + } + } + } + + /* data */ + switch (ob->type) { + case OB_CAMERA: /* ------- Camera ------------ */ + { + Camera *ca= (Camera *)ob->data; + if (ads->filterflag & ADS_FILTER_ONLYDRIVERS) + dataOk= (ANIMDATA_HAS_DRIVERS(ca) && !(ads->filterflag & ADS_FILTER_NOCAM)); + else + dataOk= (ANIMDATA_HAS_KEYS(ca) && !(ads->filterflag & ADS_FILTER_NOCAM)); + } + break; + case OB_LAMP: /* ---------- Lamp ----------- */ + { + Lamp *la= (Lamp *)ob->data; + if (ads->filterflag & ADS_FILTER_ONLYDRIVERS) + dataOk= (ANIMDATA_HAS_DRIVERS(la) && !(ads->filterflag & ADS_FILTER_NOLAM)); + else + dataOk= (ANIMDATA_HAS_KEYS(la) && !(ads->filterflag & ADS_FILTER_NOLAM)); + } + break; + default: /* --- other --- */ + dataOk= 0; + break; + } + + /* check if all bad (i.e. nothing to show) */ + if (!actOk && !keyOk && !dataOk && !matOk) + continue; + } + else { + /* check data-types */ + actOk= ANIMDATA_HAS_KEYS(ob); + keyOk= (key != NULL); + + /* materials - only for geometric types */ + matOk= 0; /* by default, not ok... */ + if (ELEM5(ob->type, OB_MESH, OB_CURVE, OB_SURF, OB_FONT, OB_MBALL) && (ob->totcol)) + { + int a; + + /* firstly check that we actuallly have some materials */ + for (a=0; a < ob->totcol; a++) { + Material *ma= give_current_material(ob, a); + + if ((ma) && ANIMDATA_HAS_KEYS(ma)) { + matOk= 1; + break; + } + } + } + + /* data */ + switch (ob->type) { + case OB_CAMERA: /* ------- Camera ------------ */ + { + Camera *ca= (Camera *)ob->data; + dataOk= ANIMDATA_HAS_KEYS(ca); + } + break; + case OB_LAMP: /* ---------- Lamp ----------- */ + { + Lamp *la= (Lamp *)ob->data; + dataOk= ANIMDATA_HAS_KEYS(la); + } + break; + case OB_CURVE: /* -------- Curve ---------- */ + { + Curve *cu= (Curve *)ob->data; + dataOk= ANIMDATA_HAS_KEYS(cu); + } + break; + default: /* --- other --- */ + dataOk= 0; + break; + } + + /* check if all bad (i.e. nothing to show) */ + if (!actOk && !keyOk && !dataOk && !matOk) + continue; + } + + /* since we're still here, this object should be usable */ + items += animdata_filter_dopesheet_ob(anim_data, ads, base, filter_mode); + } + } + + /* return the number of items in the list */ + return items; +} + +/* ----------- Public API --------------- */ + +/* This function filters the active data source to leave only animation channels suitable for + * usage by the caller. It will return the length of the list + * + * *anim_data: is a pointer to a ListBase, to which the filtered animation channels + * will be placed for use. + * filter_mode: how should the data be filtered - bitmapping accessed flags + */ +int ANIM_animdata_filter (bAnimContext *ac, ListBase *anim_data, int filter_mode, void *data, short datatype) +{ + int items = 0; + + /* only filter data if there's somewhere to put it */ + if (data && anim_data) { + bAnimListElem *ale, *next; + Object *obact= (ac) ? ac->obact : NULL; + + /* firstly filter the data */ + switch (datatype) { + case ANIMCONT_ACTION: + items= animdata_filter_action(anim_data, data, filter_mode, NULL, ANIMTYPE_NONE, (ID *)obact); + break; + + case ANIMCONT_SHAPEKEY: + items= animdata_filter_shapekey(anim_data, data, filter_mode, NULL, ANIMTYPE_NONE, (ID *)obact); + break; + + case ANIMCONT_GPENCIL: + //items= animdata_filter_gpencil(anim_data, data, filter_mode); + break; + + case ANIMCONT_DOPESHEET: + case ANIMCONT_FCURVES: + case ANIMCONT_DRIVERS: + items= animdata_filter_dopesheet(anim_data, data, filter_mode); + break; + } + + /* remove any weedy entries */ + // XXX this is weedy code! + for (ale= anim_data->first; ale; ale= next) { + next= ale->next; + + if (ale->type == ANIMTYPE_NONE) { + items--; + BLI_freelinkN(anim_data, ale); + } + } + } + + /* return the number of items in the list */ + return items; +} + +/* ************************************************************ */ |