2.5 - Added descriptions to all Animation Editor operators
authorJoshua Leung <aligorith@gmail.com>
Sat, 11 Jul 2009 10:20:48 +0000 (10:20 +0000)
committerJoshua Leung <aligorith@gmail.com>
Sat, 11 Jul 2009 10:20:48 +0000 (10:20 +0000)
DopeSheet and Graph Editor operators were missing these, since many of these operators were written before that field was added.
NLA Editor's operators already have them.

source/blender/editors/animation/anim_channels.c
source/blender/editors/mesh/meshtools.c
source/blender/editors/space_action/action_edit.c
source/blender/editors/space_action/action_select.c
source/blender/editors/space_graph/graph_edit.c
source/blender/editors/space_graph/graph_header.c
source/blender/editors/space_graph/graph_select.c

index 5c31d00770509fb7b294d412905a49fe106ee6ed..6cb00f9285b7c47a68b8c9ee461aa455df29655c 100644 (file)
@@ -799,6 +799,7 @@ void ANIM_OT_channels_delete (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Delete Channels";
        ot->idname= "ANIM_OT_channels_delete";
+       ot->description= "Delete all selected animation channels.";
        
        /* api callbacks */
        ot->exec= animchannels_delete_exec;
@@ -869,6 +870,7 @@ void ANIM_OT_channels_visibility_toggle (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Toggle Visibility";
        ot->idname= "ANIM_OT_channels_visibility_toggle";
+       ot->description= "Toggle visibility in Graph Editor of all selected animation channels.";
        
        /* api callbacks */
        ot->exec= animchannels_visibility_toggle_exec;
@@ -1134,6 +1136,7 @@ void ANIM_OT_channels_setting_enable (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Enable Channel Setting";
        ot->idname= "ANIM_OT_channels_setting_enable";
+       ot->description= "Enable specified setting on all selected animation channels.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1155,6 +1158,7 @@ void ANIM_OT_channels_setting_disable (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Disable Channel Setting";
        ot->idname= "ANIM_OT_channels_setting_disable";
+       ot->description= "Disable specified setting on all selected animation channels.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1176,6 +1180,7 @@ void ANIM_OT_channels_setting_toggle (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Toggle Channel Setting";
        ot->idname= "ANIM_OT_channels_setting_toggle";
+       ot->description= "Toggle specified setting on all selected animation channels.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1198,6 +1203,7 @@ void ANIM_OT_channels_editable_toggle (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Toggle Channel Editability";
        ot->idname= "ANIM_OT_channels_editable_toggle";
+       ot->description= "Toggle editability of selected channels.";
        
        /* api callbacks */
        ot->exec= animchannels_setflag_exec;
@@ -1242,6 +1248,7 @@ void ANIM_OT_channels_expand (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Expand Channels";
        ot->idname= "ANIM_OT_channels_expand";
+       ot->description= "Expand (i.e. open) all selected expandable animation channels.";
        
        /* api callbacks */
        ot->exec= animchannels_expand_exec;
@@ -1283,6 +1290,7 @@ void ANIM_OT_channels_collapse (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Collapse Channels";
        ot->idname= "ANIM_OT_channels_collapse";
+       ot->description= "Collapse (i.e. close) all selected expandable animation channels.";
        
        /* api callbacks */
        ot->exec= animchannels_collapse_exec;
@@ -1322,6 +1330,7 @@ void ANIM_OT_channels_select_all_toggle (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Select All";
        ot->idname= "ANIM_OT_channels_select_all_toggle";
+       ot->description= "Toggle selection of all animation channels.";
        
        /* api callbacks */
        ot->exec= animchannels_deselectall_exec;
@@ -1451,6 +1460,7 @@ void ANIM_OT_channels_select_border(wmOperatorType *ot)
        /* identifiers */
        ot->name= "Border Select";
        ot->idname= "ANIM_OT_channels_select_border";
+       ot->description= "Select all animation channels within the specified region.";
        
        /* api callbacks */
        ot->invoke= WM_border_select_invoke;
@@ -1857,6 +1867,7 @@ void ANIM_OT_channels_click (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Mouse Click on Channels";
        ot->idname= "ANIM_OT_channels_click";
+       ot->description= "Handle mouse-clicks over animation channels.";
        
        /* api callbacks */
        ot->invoke= animchannels_mouseclick_invoke;
index f8f0030b2588530d283d65725d42526086fb5a9b..df3e2a5685cd845c1b1ba443fdc5407d500084f8 100644 (file)
@@ -105,6 +105,11 @@ static int pupmenu() {return 0;}
 
 /* join selected meshes into the active mesh, context sensitive
 return 0 if no join is made (error) and 1 of the join is done */
+
+// XXX NOTE to whoever ports this:
+//     Check the version of this code in the animsys2 branch, which has been nicely commented,
+//     but more importantly has proper support for handling meshes with shapekeys (instead of lamely bailing out)!
+// -- Aligorith, July 2009
 int join_mesh(Scene *scene, View3D *v3d, wmOperator *op)
 {
        Base *base, *nextb;
index 8d2d342e28ab73b15c6a6ea3ba517466109c4855..d4709e94e5e111b2994cf73515f4c77ea9b2cd09 100644 (file)
@@ -101,7 +101,7 @@ static void get_keyframe_extents (bAnimContext *ac, float *min, float *max)
        int filter;
        
        /* get data to filter, from Action or Dopesheet */
-       filter= (ANIMFILTER_VISIBLE | ANIMFILTER_SEL | ANIMFILTER_FOREDIT | ANIMFILTER_CURVESONLY);
+       filter= (ANIMFILTER_VISIBLE | ANIMFILTER_SEL | ANIMFILTER_CURVESONLY);
        ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
        
        /* set large values to try to override */
@@ -178,6 +178,7 @@ void ACT_OT_previewrange_set (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Auto-Set Preview Range";
        ot->idname= "ACT_OT_previewrange_set";
+       ot->description= "Set Preview Range based on extents of selected Keyframes.";
        
        /* api callbacks */
        ot->exec= actkeys_previewrange_exec;
@@ -225,6 +226,7 @@ void ACT_OT_view_all (wmOperatorType *ot)
        /* identifiers */
        ot->name= "View All";
        ot->idname= "ACT_OT_view_all";
+       ot->description= "Reset viewable area to show full keyframe range.";
        
        /* api callbacks */
        ot->exec= actkeys_viewall_exec;
@@ -309,6 +311,7 @@ void ACT_OT_copy (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Copy Keyframes";
        ot->idname= "ACT_OT_copy";
+       ot->description= "Copy selected keyframes to the copy/paste buffer.";
        
        /* api callbacks */
        ot->exec= actkeys_copy_exec;
@@ -353,6 +356,7 @@ void ACT_OT_paste (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Paste Keyframes";
        ot->idname= "ACT_OT_paste";
+       ot->description= "Paste keyframes from copy/paste buffer for the selected channels, starting on the current frame.";
        
        /* api callbacks */
        ot->exec= actkeys_paste_exec;
@@ -449,6 +453,7 @@ void ACT_OT_insert_keyframe (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Insert Keyframes";
        ot->idname= "ACT_OT_insert_keyframe";
+       ot->description= "Insert keyframes for the specified channels.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -526,6 +531,7 @@ void ACT_OT_duplicate (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Duplicate Keyframes";
        ot->idname= "ACT_OT_duplicate";
+       ot->description= "Make a copy of all selected keyframes.";
        
        /* api callbacks */
        ot->invoke= actkeys_duplicate_invoke;
@@ -593,6 +599,7 @@ void ACT_OT_delete (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Delete Keyframes";
        ot->idname= "ACT_OT_delete";
+       ot->description= "Remove all selected keyframes.";
        
        /* api callbacks */
        ot->invoke= WM_operator_confirm;
@@ -656,6 +663,7 @@ void ACT_OT_clean (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Clean Keyframes";
        ot->idname= "ACT_OT_clean";
+       ot->description= "Simplify F-Curves by removing closely spaced keyframes.";
        
        /* api callbacks */
        //ot->invoke=  // XXX we need that number popup for this! 
@@ -780,6 +788,7 @@ void ACT_OT_sample (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Sample Keyframes";
        ot->idname= "ACT_OT_sample";
+       ot->description= "Add keyframes on every frame between the selected keyframes.";
        
        /* api callbacks */
        ot->exec= actkeys_sample_exec;
@@ -855,6 +864,7 @@ void ACT_OT_extrapolation_type (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Set Keyframe Extrapolation";
        ot->idname= "ACT_OT_extrapolation_type";
+       ot->description= "Set extrapolation mode for selected F-Curves.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -925,6 +935,7 @@ void ACT_OT_interpolation_type (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Set Keyframe Interpolation";
        ot->idname= "ACT_OT_interpolation_type";
+       ot->description= "Set interpolation mode for the F-Curve segments starting from the selected keyframes.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1013,6 +1024,7 @@ void ACT_OT_handle_type (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Set Keyframe Handle Type";
        ot->idname= "ACT_OT_handle_type";
+       ot->description= "Set type of handle for selected keyframes.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1082,6 +1094,7 @@ void ACT_OT_frame_jump (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Jump to Frame";
        ot->idname= "ACT_OT_frame_jump";
+       ot->description= "Set the current frame to the average frame of the selected keyframes.";
        
        /* api callbacks */
        ot->exec= actkeys_framejump_exec;
@@ -1177,6 +1190,7 @@ void ACT_OT_snap (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Snap Keys";
        ot->idname= "ACT_OT_snap";
+       ot->description= "Snap selected keyframes to the times specified.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1293,6 +1307,7 @@ void ACT_OT_mirror (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Mirror Keys";
        ot->idname= "ACT_OT_mirror";
+       ot->description= "Flip selected keyframes over the selected mirror line.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
index d9e6bb10cebeec7457f11691291482223c0417aa..ef1b392815d62d00a31c4c759ce85ff621560a73 100644 (file)
@@ -185,6 +185,7 @@ void ACT_OT_select_all_toggle (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Select All";
        ot->idname= "ACT_OT_select_all_toggle";
+       ot->description= "Toggle selection of all keyframes.";
        
        /* api callbacks */
        ot->exec= actkeys_deselectall_exec;
@@ -348,6 +349,7 @@ void ACT_OT_select_border(wmOperatorType *ot)
        /* identifiers */
        ot->name= "Border Select";
        ot->idname= "ACT_OT_select_border";
+       ot->description= "Select all keyframes within the specified region.";
        
        /* api callbacks */
        ot->invoke= WM_border_select_invoke;
@@ -565,6 +567,7 @@ void ACT_OT_select_column (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Select All";
        ot->idname= "ACT_OT_select_column";
+       ot->description= "Select all keyframes on the specified frame(s).";
        
        /* api callbacks */
        ot->exec= actkeys_columnselect_exec;
@@ -969,6 +972,7 @@ void ACT_OT_clickselect (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Mouse Select Keys";
        ot->idname= "ACT_OT_clickselect";
+       ot->description= "Select keyframes by clicking on them.";
        
        /* api callbacks - absolutely no exec() this yet... */
        ot->invoke= actkeys_clickselect_invoke;
index 1837b6d4ecd64f038345a94ebccf61c301e6650f..d11ceac32648c0a39db7c75fadf063f39d5b4cd8 100644 (file)
@@ -103,7 +103,7 @@ void get_graph_keyframe_extents (bAnimContext *ac, float *xmin, float *xmax, flo
        int filter;
        
        /* get data to filter, from Dopesheet */
-       filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_FOREDIT | ANIMFILTER_CURVESONLY);
+       filter= (ANIMFILTER_VISIBLE | ANIMFILTER_CURVEVISIBLE | ANIMFILTER_CURVESONLY);
        ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
        
        /* set large values to try to override */
@@ -234,6 +234,7 @@ void GRAPH_OT_view_all (wmOperatorType *ot)
        /* identifiers */
        ot->name= "View All";
        ot->idname= "GRAPH_OT_view_all";
+       ot->description= "Reset viewable area to show full keyframe range.";
        
        /* api callbacks */
        ot->exec= graphkeys_viewall_exec;
@@ -485,6 +486,7 @@ void GRAPH_OT_insert_keyframe (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Insert Keyframes";
        ot->idname= "GRAPH_OT_insert_keyframe";
+       ot->description= "Insert keyframes for the specified channels.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -572,6 +574,7 @@ void GRAPH_OT_click_insert (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Click-Insert Keyframes";
        ot->idname= "GRAPH_OT_click_insert";
+       ot->description= "Insert new keyframe at the cursor position for the active F-Curve.";
        
        /* api callbacks */
        ot->invoke= graphkeys_click_insert_invoke;
@@ -653,6 +656,7 @@ void GRAPH_OT_copy (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Copy Keyframes";
        ot->idname= "GRAPH_OT_copy";
+       ot->description= "Copy selected keyframes to the copy/paste buffer.";
        
        /* api callbacks */
        ot->exec= graphkeys_copy_exec;
@@ -692,6 +696,7 @@ void GRAPH_OT_paste (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Paste Keyframes";
        ot->idname= "GRAPH_OT_paste";
+       ot->description= "Paste keyframes from copy/paste buffer for the selected channels, starting on the current frame.";
        
        /* api callbacks */
        ot->exec= graphkeys_paste_exec;
@@ -759,6 +764,7 @@ void GRAPH_OT_duplicate (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Duplicate Keyframes";
        ot->idname= "GRAPH_OT_duplicate";
+       ot->description= "Make a copy of all selected keyframes.";
        
        /* api callbacks */
        ot->invoke= graphkeys_duplicate_invoke;
@@ -820,6 +826,7 @@ void GRAPH_OT_delete (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Delete Keyframes";
        ot->idname= "GRAPH_OT_delete";
+       ot->description= "Remove all selected keyframes.";
        
        /* api callbacks */
        ot->invoke= WM_operator_confirm;
@@ -881,6 +888,7 @@ void GRAPH_OT_clean (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Clean Keyframes";
        ot->idname= "GRAPH_OT_clean";
+       ot->description= "Simplify F-Curves by removing closely spaced keyframes.";
        
        /* api callbacks */
        //ot->invoke=  // XXX we need that number popup for this! 
@@ -963,6 +971,7 @@ void GRAPH_OT_bake (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Bake Curve";
        ot->idname= "GRAPH_OT_bake";
+       ot->description= "Bake selected F-Curves to a set of sampled points defining a similar curve.";
        
        /* api callbacks */
        ot->invoke= WM_operator_confirm; // FIXME...
@@ -1089,6 +1098,7 @@ void GRAPH_OT_sample (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Sample Keyframes";
        ot->idname= "GRAPH_OT_sample";
+       ot->description= "Add keyframes on every frame between the selected keyframes.";
        
        /* api callbacks */
        ot->exec= graphkeys_sample_exec;
@@ -1163,6 +1173,7 @@ void GRAPH_OT_extrapolation_type (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Set Keyframe Extrapolation";
        ot->idname= "GRAPH_OT_extrapolation_type";
+       ot->description= "Set extrapolation mode for selected F-Curves.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1231,6 +1242,7 @@ void GRAPH_OT_interpolation_type (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Set Keyframe Interpolation";
        ot->idname= "GRAPH_OT_interpolation_type";
+       ot->description= "Set interpolation mode for the F-Curve segments starting from the selected keyframes.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1318,6 +1330,7 @@ void GRAPH_OT_handletype (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Set Keyframe Handle Type";
        ot->idname= "GRAPH_OT_handletype";
+       ot->description= "Set type of handle for selected keyframes.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1473,6 +1486,7 @@ void GRAPH_OT_frame_jump (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Jump to Frame";
        ot->idname= "GRAPH_OT_frame_jump";
+       ot->description= "Set the current frame to the average frame of the selected keyframes.";
        
        /* api callbacks */
        ot->exec= graphkeys_framejump_exec;
@@ -1564,6 +1578,7 @@ void GRAPH_OT_snap (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Snap Keys";
        ot->idname= "GRAPH_OT_snap";
+       ot->description= "Snap selected keyframes to the times specified.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1675,6 +1690,7 @@ void GRAPH_OT_mirror (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Mirror Keys";
        ot->idname= "GRAPH_OT_mirror";
+       ot->description= "Flip selected keyframes over the selected mirror line.";
        
        /* api callbacks */
        ot->invoke= WM_menu_invoke;
@@ -1729,6 +1745,7 @@ void GRAPH_OT_smooth (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Smooth Keys";
        ot->idname= "GRAPH_OT_smooth";
+       ot->description= "Apply weighted moving means to make selected F-Curves less bumpy.";
        
        /* api callbacks */
        ot->exec= graphkeys_smooth_exec;
@@ -1820,6 +1837,7 @@ void GRAPH_OT_fmodifier_add (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Add F-Curve Modifier";
        ot->idname= "GRAPH_OT_fmodifier_add";
+       ot->description= "Add F-Modifiers to the selected F-Curves.";
        
        /* api callbacks */
        ot->invoke= graph_fmodifier_add_invoke;
index 05d9b2f7e6cb7e9208f939d763922d8d74286bab..eeede3ae95bac53e8a7b9ffe59779ba661be0ec4 100644 (file)
@@ -219,6 +219,7 @@ static void graph_editmenu(bContext *C, uiLayout *layout, void *arg_unused)
        
        uiItemO(layout, NULL, 0, "GRAPH_OT_clean");
        uiItemO(layout, NULL, 0, "GRAPH_OT_sample");
+       uiItemO(layout, NULL, 0, "GRAPH_OT_bake");
        
        uiItemS(layout);
        
index a78cacb42ef397e0e133ab10e3c2e8916d016a78..c4885d095ed70b22441d8f73e9b60fa6af4e9c50 100644 (file)
@@ -179,6 +179,7 @@ void GRAPH_OT_select_all_toggle (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Select All";
        ot->idname= "GRAPH_OT_select_all_toggle";
+       ot->description= "Toggle selection of all keyframes.";
        
        /* api callbacks */
        ot->exec= graphkeys_deselectall_exec;
@@ -313,6 +314,7 @@ void GRAPH_OT_select_border(wmOperatorType *ot)
        /* identifiers */
        ot->name= "Border Select";
        ot->idname= "GRAPH_OT_select_border";
+       ot->description= "Select all keyframes within the specified region.";
        
        /* api callbacks */
        ot->invoke= WM_border_select_invoke;
@@ -506,6 +508,7 @@ void GRAPH_OT_select_column (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Select All";
        ot->idname= "GRAPH_OT_select_column";
+       ot->description= "Select all keyframes on the specified frame(s).";
        
        /* api callbacks */
        ot->exec= graphkeys_columnselect_exec;
@@ -926,6 +929,7 @@ void GRAPH_OT_clickselect (wmOperatorType *ot)
        /* identifiers */
        ot->name= "Mouse Select Keys";
        ot->idname= "GRAPH_OT_clickselect";
+       ot->description= "Select keyframes by clicking on them.";
        
        /* api callbacks */
        ot->invoke= graphkeys_clickselect_invoke;