Code cleanup - Remove/update outdated comments and whitespace tweaks
authorJoshua Leung <aligorith@gmail.com>
Sun, 16 Sep 2012 11:19:36 +0000 (11:19 +0000)
committerJoshua Leung <aligorith@gmail.com>
Sun, 16 Sep 2012 11:19:36 +0000 (11:19 +0000)
source/blender/editors/animation/anim_channels_defines.c
source/blender/editors/animation/anim_deps.c
source/blender/editors/animation/anim_filter.c

index 4c244899205f9c52a0dbef43eea30b94aad6dee0..3f42f7e962b1a799a13054fea8958f39fee82c41 100644 (file)
@@ -84,6 +84,7 @@
 /* size of indent steps */
 #define INDENT_STEP_SIZE    7
 
+/* size of string buffers used for animation channel displayed names */
 #define ANIM_CHAN_NAME_SIZE 256
 
 /* get the pointer used for some flag */
@@ -292,7 +293,7 @@ static short acf_nodetree_rootType_offset(bNodeTree *ntree)
                }
        }
        
-       // unknown
+       /* unknown */
        return 0;
 }
 
@@ -422,7 +423,7 @@ static void acf_summary_name(bAnimListElem *UNUSED(ale), char *name)
                BLI_strncpy(name, "DopeSheet Summary", ANIM_CHAN_NAME_SIZE);
 }
 
-// TODO: this is really a temp icon I think
+// FIXME: this is really a temp icon I think
 static int acf_summary_icon(bAnimListElem *UNUSED(ale))
 {
        return ICON_BORDERMOVE;
@@ -601,7 +602,6 @@ static int acf_object_icon(bAnimListElem *ale)
        Object *ob = base->object;
        
        /* icon depends on object-type */
-
        switch (ob->type) {
                case OB_LAMP:
                        return ICON_OUTLINER_OB_LAMP;
@@ -628,7 +628,6 @@ static int acf_object_icon(bAnimListElem *ale)
                default:
                        return ICON_OBJECT_DATA;
        }
-       
 }
 
 /* name for object */
@@ -2178,7 +2177,7 @@ static int acf_dsspk_setting_flag(bAnimContext *UNUSED(ac), int setting, short *
 {
        /* clear extra return data first */
        *neg = 0;
-
+       
        switch (setting) {
                case ACHANNEL_SETTING_EXPAND: /* expanded */
                        return SPK_DS_EXPAND;
@@ -2202,10 +2201,10 @@ static int acf_dsspk_setting_flag(bAnimContext *UNUSED(ac), int setting, short *
 static void *acf_dsspk_setting_ptr(bAnimListElem *ale, int setting, short *type)
 {
        Speaker *spk = (Speaker *)ale->data;
-
+       
        /* clear extra return data first */
        *type = 0;
-
+       
        switch (setting) {
                case ACHANNEL_SETTING_EXPAND: /* expanded */
                        return GET_ACF_FLAG_PTR(spk->flag, type);
@@ -2477,7 +2476,7 @@ static int acf_gpl_setting_flag(bAnimContext *UNUSED(ac), int setting, short *ne
                        return GP_LAYER_HIDE;
                        
                case ACHANNEL_SETTING_PROTECT: /* protected */
-                       // *neg = 1; - if we change this to edtiability
+                       // *neg = 1; - if we change this to editability
                        return GP_LAYER_LOCKED;
                        
                default: /* unsupported */
@@ -2526,7 +2525,7 @@ static void acf_mask_color(bAnimContext *UNUSED(ac), bAnimListElem *UNUSED(ale),
 // TODO: just get this from RNA?
 static int acf_mask_icon(bAnimListElem *UNUSED(ale))
 {
-       return ICON_GREASEPENCIL; // MASK_TODO - need real icon
+       return ICON_MOD_MASK;
 }
 
 /* check if some setting exists for this channel */
@@ -2573,15 +2572,15 @@ static void *acf_mask_setting_ptr(bAnimListElem *ale, int UNUSED(setting), short
 /* mask datablock type define */
 static bAnimChannelType ACF_MASKDATA =
 {
-       "Mask Datablock",            /* type name */
+       "Mask Datablock",                /* type name */
        
        acf_mask_color,                  /* backdrop color */
-       acf_group_backdrop,             /* backdrop */
-       acf_generic_indention_0,        /* indent level */
-       acf_generic_group_offset,       /* offset */
+       acf_group_backdrop,              /* backdrop */
+       acf_generic_indention_0,         /* indent level */
+       acf_generic_group_offset,        /* offset */
        
-       acf_generic_idblock_name,       /* name */
-       acf_generic_idfill_nameprop,    /* name prop */
+       acf_generic_idblock_name,        /* name */
+       acf_generic_idfill_nameprop,     /* name prop */
        acf_mask_icon,                   /* icon */
        
        acf_mask_setting_valid,          /* has setting */
@@ -2642,7 +2641,7 @@ static int acf_masklay_setting_flag(bAnimContext *UNUSED(ac), int setting, short
 //                     return GP_LAYER_HIDE;
                
                case ACHANNEL_SETTING_PROTECT: /* protected */
-                       // *neg = 1; - if we change this to edtiability
+                       // *neg = 1; - if we change this to editability
                        return MASK_LAYERFLAG_LOCKED;
                
                default: /* unsupported */
@@ -2654,7 +2653,7 @@ static int acf_masklay_setting_flag(bAnimContext *UNUSED(ac), int setting, short
 static void *acf_masklay_setting_ptr(bAnimListElem *ale, int UNUSED(setting), short *type)
 {
        MaskLayer *masklay = (MaskLayer *)ale->data;
-
+       
        /* all flags are just in agrp->flag for now... */
        return GET_ACF_FLAG_PTR(masklay->flag, type);
 }
@@ -2662,20 +2661,20 @@ static void *acf_masklay_setting_ptr(bAnimListElem *ale, int UNUSED(setting), sh
 /* grease pencil layer type define */
 static bAnimChannelType ACF_MASKLAYER =
 {
-       "Mask Layer",                /* type name */
-
+       "Mask Layer",                   /* type name */
+       
        acf_generic_channel_color,      /* backdrop color */
        acf_generic_channel_backdrop,   /* backdrop */
        acf_generic_indention_flexible, /* indent level */
        acf_generic_group_offset,       /* offset */
-
-       acf_masklay_name,                   /* name */
-       acf_masklay_name_prop,              /* name prop */
+       
+       acf_masklay_name,               /* name */
+       acf_masklay_name_prop,          /* name prop */
        NULL,                           /* icon */
-
-       acf_masklay_setting_valid,          /* has setting */
-       acf_masklay_setting_flag,           /* flag for setting */
-       acf_masklay_setting_ptr             /* pointer for setting */
+       
+       acf_masklay_setting_valid,      /* has setting */
+       acf_masklay_setting_flag,       /* flag for setting */
+       acf_masklay_setting_ptr         /* pointer for setting */
 };
 
 
@@ -2776,7 +2775,7 @@ void ANIM_channel_debug_print_info(bAnimListElem *ale, short indent_level)
                        acf->name(ale, name);
                else
                        BLI_strncpy(name, "<No name>", sizeof(name));
-
+               
                /* print type name + ui name */
                printf("ChanType: <%s> Name: \"%s\"\n", acf->channel_type_name, name);
        }
@@ -2920,7 +2919,6 @@ void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, int setting,
 #define RENAME_TEXT_WIDTH 100
 
 /* Draw the given channel */
-// TODO: make this use UI controls for the buttons
 void ANIM_channel_draw(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc)
 {
        bAnimChannelType *acf = ANIM_channel_get_typeinfo(ale);
@@ -3010,20 +3008,20 @@ void ANIM_channel_draw(bAnimContext *ac, bAnimListElem *ale, float yminc, float
        /* TODO: when renaming, we might not want to draw this, especially if name happens to be longer than channel */
        if (acf->name) {
                char name[ANIM_CHAN_NAME_SIZE]; /* hopefully this will be enough! */
-
+               
                /* set text color */
                /* XXX: if active, highlight differently? */
                if (selected)
                        UI_ThemeColor(TH_TEXT_HI);
                else
                        UI_ThemeColor(TH_TEXT);
-
+               
                /* get name */
                acf->name(ale, name);
-
+               
                offset += 3;
                UI_DrawString(offset, ytext, name);
-
+               
                /* draw red underline if channel is disabled */
                if ((ale->type == ANIMTYPE_FCURVE) && (ale->flag & FCURVE_DISABLED)) {
                        /* FIXME: replace hardcoded color here, and check on extents! */
@@ -3153,7 +3151,6 @@ static void achannel_setting_rename_done_cb(bContext *C, void *ads_poin, void *U
        ads->renameIndex = 0;
        
        /* send notifiers */
-       // XXX: right notifier?
        WM_event_add_notifier(C, NC_ANIMATION | ND_ANIMCHAN | NA_RENAME, NULL);
 }
 
@@ -3437,7 +3434,6 @@ void ANIM_channel_draw_widgets(bContext *C, bAnimContext *ac, bAnimListElem *ale
        offset = 0;
        
        // TODO: when drawing sliders, make those draw instead of these toggles if not enough space
-       
        if (v2d) {
                short draw_sliders = 0;
                
index 6ce9fc638be5f70dfb4e7362360c214074e757a7..98071fafc1e783062b5ce99ae0c872b7c3e457b0 100644 (file)
@@ -142,7 +142,6 @@ static void animchan_sync_group(bAnimContext *ac, bAnimListElem *ale, bActionGro
                /* check if there are bones, and whether the name matches any 
                 * NOTE: this feature will only really work if groups by default contain the F-Curves for a single bone
                 */
-               // TODO: if bone gets renamed, it would be best to be able to rename the group
                if (ob->pose) {
                        bPoseChannel *pchan = BKE_pose_channel_find_name(ob->pose, agrp->name);
                        bArmature *arm = ob->data;
@@ -319,7 +318,6 @@ void ANIM_sync_animchannels_to_data(const bContext *C)
        FCurve *active_fcurve = NULL;
        
        /* get animation context info for filtering the channels */
-       // TODO: check on whether we need to set the area specially instead, since active area might not be ok?
        if (ANIM_animdata_get_context(C, &ac) == 0)
                return;
        
index 209414550e33ffd16bc45ec8a9805c895e09f0de..c246eb0cdf07de04d76159695ca2e79e4e97e412 100644 (file)
@@ -163,30 +163,30 @@ static short actedit_get_context(bAnimContext *ac, SpaceAction *saction)
                        
                        ac->mode = saction->mode;
                        return 1;
-
+               
                case SACTCONT_GPENCIL: /* Grease Pencil */ /* XXX review how this mode is handled... */
                        /* update scene-pointer (no need to check for pinning yet, as not implemented) */
                        saction->ads.source = (ID *)ac->scene;
-
+                       
                        ac->datatype = ANIMCONT_GPENCIL;
                        ac->data = &saction->ads;
-
+                       
                        ac->mode = saction->mode;
                        return 1;
-
-               case SACTCONT_MASK: /* Grease Pencil */ /* XXX review how this mode is handled... */
-                       /* update scene-pointer (no need to check for pinning yet, as not implemented) */
+                       
+               case SACTCONT_MASK: /* Mask */ /* XXX review how this mode is handled... */
 {
                        /* TODO, other methods to get the mask */
                        // Sequence *seq = BKE_sequencer_active_get(ac->scene);
                        //MovieClip *clip = ac->scene->clip;
 //                     struct Mask *mask = seq ? seq->mask : NULL;
-
+                       
+                       /* update scene-pointer (no need to check for pinning yet, as not implemented) */
                        saction->ads.source = (ID *)ac->scene;
-
+                       
                        ac->datatype = ANIMCONT_MASK;
                        ac->data = &saction->ads;
-
+                       
                        ac->mode = saction->mode;
                        return 1;
 }
@@ -688,12 +688,12 @@ static bAnimListElem *make_new_animlistelem(void *data, short datatype, ID *owne
                        {
                                Speaker *spk = (Speaker *)data;
                                AnimData *adt = spk->adt;
-
+                               
                                ale->flag = FILTER_SPK_OBJD(spk);
-
+                               
                                ale->key_data = (adt) ? adt->action : NULL;
                                ale->datatype = ALE_ACT;
-
+                               
                                ale->adt = BKE_animdata_from_id(data);
                        }
                        break;
@@ -824,18 +824,18 @@ static bAnimListElem *make_new_animlistelem(void *data, short datatype, ID *owne
                                ale->datatype = ALE_GPFRAME;
                        }
                        break;
-
+                       
                        case ANIMTYPE_MASKLAYER:
                        {
                                MaskLayer *masklay = (MaskLayer *)data;
-
+                               
                                ale->flag = masklay->flag;
-
+                               
                                ale->key_data = NULL;
                                ale->datatype = ALE_MASKLAY;
                        }
                        break;
-
+                       
                        case ANIMTYPE_NLATRACK:
                        {
                                NlaTrack *nlt = (NlaTrack *)data;
@@ -1138,7 +1138,6 @@ static size_t animfilter_action(bAnimContext *ac, ListBase *anim_data, bDopeShee
        /* don't include anything from this action if it is linked in from another file,
         * and we're getting stuff for editing...
         */
-       // TODO: need a way of tagging other channels that may also be affected...
        if ((filter_mode & ANIMFILTER_FOREDIT) && (act->id.lib))
                return 0;
                
@@ -1240,11 +1239,11 @@ static size_t animfilter_block_data(bAnimContext *ac, ListBase *anim_data, bDope
 {
        AnimData *adt = BKE_animdata_from_id(id);
        size_t items = 0;
-
+       
        /* image object datablocks have no anim-data so check for NULL */
        if (adt) {
                IdAdtTemplate *iat = (IdAdtTemplate *)id;
-
+               
                /* NOTE: this macro is used instead of inlining the logic here, since this sort of filtering is still needed
                 * in a few places in he rest of the code still - notably for the few cases where special mode-based
                 * different types of data expanders are required.
@@ -1265,7 +1264,7 @@ static size_t animfilter_block_data(bAnimContext *ac, ListBase *anim_data, bDope
                        }
                );
        }
-
+       
        return items;
 }
 
@@ -1283,7 +1282,6 @@ static size_t animdata_filter_shapekey(bAnimContext *ac, ListBase *anim_data, Ke
                /* loop through the channels adding ShapeKeys as appropriate */
                for (kb = key->block.first; kb; kb = kb->next) {
                        /* skip the first one, since that's the non-animatable basis */
-                       // XXX maybe in future this may become handy?
                        if (kb == key->block.first) continue;
                        
                        /* only work with this channel and its subchannels if it is editable */
@@ -1597,7 +1595,6 @@ static size_t animdata_filter_ds_material(bAnimContext *ac, ListBase *anim_data,
        /* did we find anything? */
        if (tmp_items) {
                /* include material-expand widget first */
-               // hmm... do we need to store the index of this material in the array anywhere?
                if (filter_mode & ANIMFILTER_LIST_CHANNELS) {
                        /* check if filtering by active status */
                        if (ANIMCHANNEL_ACTIVEOK(ma)) {
@@ -1809,11 +1806,11 @@ static size_t animdata_filter_ds_obdata(bAnimContext *ac, ListBase *anim_data, b
                        {
                                Lamp *la = ob->data;
                                bNodeTree *ntree = la->nodetree;
-
+                               
                                /* nodetree */
                                if ((ntree) && !(ads->filterflag & ADS_FILTER_NONTREE))
                                        tmp_items += animdata_filter_ds_nodetree(ac, &tmp_data, ads, &la->id, ntree, filter_mode);
-
+                               
                                /* textures */
                                if (!(ads->filterflag & ADS_FILTER_NOTEX))
                                        tmp_items += animdata_filter_ds_textures(ac, &tmp_data, ads, &la->id, filter_mode);
@@ -2277,7 +2274,7 @@ static size_t animdata_filter_animchan(bAnimContext *ac, ListBase *anim_data, bD
        size_t items = 0;
        
        /* data to filter depends on channel type */
-       // XXX: only common channel-types have been handled for now
+       /* NOTE: only common channel-types have been handled for now. More can be added as necessary */
        switch (channel->type) {
                case ANIMTYPE_SUMMARY:
                        items += animdata_filter_dopesheet(ac, anim_data, ads, filter_mode);
@@ -2290,6 +2287,10 @@ static size_t animdata_filter_animchan(bAnimContext *ac, ListBase *anim_data, bD
                case ANIMTYPE_OBJECT:
                        items += animdata_filter_dopesheet_ob(ac, anim_data, ads, channel->data, filter_mode);
                        break;
+                       
+               default:
+                       printf("ERROR: Unsupported channel type (%d) in animdata_filter_animchan()\n", channel->type);
+                       break;
        }
        
        return items;
@@ -2414,9 +2415,9 @@ size_t ANIM_animdata_filter(bAnimContext *ac, ListBase *anim_data, int filter_mo
                        }
                        break;
                                
-                       case ANIMCONT_FCURVES: /* Graph Editor -> FCurves/Animation Editing */
+                       case ANIMCONT_FCURVES: /* Graph Editor -> F-Curves/Animation Editing */
                        case ANIMCONT_DRIVERS: /* Graph Editor -> Drivers Editing */
-                       case ANIMCONT_NLA: /* NLA Editor */
+                       case ANIMCONT_NLA:     /* NLA Editor */
                        {
                                /* all of these editors use the basic DopeSheet data for filtering options, but don't have all the same features */
                                items = animdata_filter_dopesheet(ac, anim_data, data, filter_mode);