blender/blender
154
489
Fork 724
Code Issues 6.7k Pull Requests 889 Projects 18 Wiki Activity

Animation: Graph Editor Handle Selection #108142

Closed
Denys Hsu wants to merge 3 commits from cgtinker/blender:select_handles_patch into main
pull from: cgtinker/blender:select_handles_patch
merge into: blender:main

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.
Conversation 6 Commits 3 Files Changed 4 +67 -21
3 changed files with 67 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 4870e67ee5 - Show all commits

1
scripts/startup/bl_ui/space_graph.py
View File

@ -197,6 +197,7 @@ class GRAPH_MT_select(Menu):
layout.operator("graph.select_handles", text="Select Handles").mode = 'BOTH'
layout.operator("graph.select_handles", text="Select Handles Left").mode = 'LEFT'
cgtinker marked this conversation as resolved Outdated
Christoph Lendenfeld commented 2023-06-16 09:23:35 +02:00
Outdated
Review
Copy Link

I think we should add separate entries for "select left handles" and "select right handles"
this makes it a lot more discoverable for artists and they can easily assign a hotkey by right clicking the menu entry

I think we should add separate entries for "select left handles" and "select right handles" this makes it a lot more discoverable for artists and they can easily assign a hotkey by right clicking the menu entry
layout.operator("graph.select_handles", text="Select Handles Right").mode = 'RIGHT'
layout.operator("graph.select_handles", text="Select Keyframes").mode = 'KEY'
layout.separator()
layout.operator("graph.select_more")

5
source/blender/editors/space_graph/graph_intern.h
View File

@ -75,10 +75,11 @@ enum eGraphKeys_LeftRightSelect_Mode {
};
/* Defines for handle selection. */
cgtinker marked this conversation as resolved Outdated
Christoph Lendenfeld commented 2023-06-16 09:29:41 +02:00
Outdated
Review
Copy Link

comments end with a "."

comments end with a "."
enum eGraphKey_HandleSelect_Mode {
GRAPHKEYS_HANDLESEL_LR = 0,
enum eGraphKey_HandleSelect_Side {
cgtinker marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2023-06-22 17:16:44 +02:00
Outdated
Review
Copy Link

I think 'side' would be a better noun than 'mode' here. IMO the 'mode' should also include whether the keys themselves are selected/deselected or not, which is not part of this enum.

I think 'side' would be a better noun than 'mode' here. IMO the 'mode' should also include whether the keys themselves are selected/deselected or not, which is not part of this enum.
GRAPHKEYS_HANDLESEL_BOTH = 0,
GRAPHKEYS_HANDLESEL_L,
GRAPHKEYS_HANDLESEL_R,
GRAPHKEYS_HANDLESEL_KEY,
};
/* defines for column-select mode */

82
source/blender/editors/space_graph/graph_select.c
View File

@ -29,6 +29,9 @@
#include "BKE_fcurve.h"
#include "BKE_nla.h"
#include "UI_interface.h"
#include "UI_resources.h"
#include "UI_view2d.h"
#include "ED_anim_api.h"
@ -2039,9 +2042,10 @@ void GRAPH_OT_clickselect(wmOperatorType *ot)
cgtinker marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2023-06-22 17:09:13 +02:00
Outdated
Review
Copy Link

Just for consistency, rename GRAPHKEYS_HANDLESEL_LR to GRAPHKEYS_HANDLESEL_BOTH.

Just for consistency, rename `GRAPHKEYS_HANDLESEL_LR` to `GRAPHKEYS_HANDLESEL_BOTH`.
/* Defines for handle select tool. */
cgtinker marked this conversation as resolved Outdated
Christoph Lendenfeld commented 2023-06-16 09:55:47 +02:00
Outdated
Review
Copy Link

why is the option to select both handles called "CHECK"
"BOTH" would make more sense to me but maybe I am missing something

Also check the code style for the comment above. Comments should start with a capital letter and end with a "."

why is the option to select both handles called "CHECK" "BOTH" would make more sense to me but maybe I am missing something Also check the code style for the comment above. Comments should start with a capital letter and end with a "."
Denys Hsu commented 2023-06-16 11:33:09 +02:00
Outdated
Review
Copy Link

I think I copied an existing enum and modified it back then, there is no checking. In the 'C' scripts are lots of comments that don't follow this convention which is misleading, probably it would be good to create a small formatter to fix them?

I think I copied an existing enum and modified it back then, there is no checking. In the 'C' scripts are lots of comments that don't follow this convention which is misleading, probably it would be good to create a small formatter to fix them?
Christoph Lendenfeld commented 2023-06-16 12:51:34 +02:00
Outdated
Review
Copy Link

yeah there is quite a bit of old comments floating around that need cleaning up

yeah there is quite a bit of old comments floating around that need cleaning up
static const EnumPropertyItem prop_graphkeys_leftright_handle_select_types[] = {
{GRAPHKEYS_HANDLESEL_LR, "BOTH", 0, "Select Both Handles", ""},
{GRAPHKEYS_HANDLESEL_BOTH, "BOTH", 0, "Select Both Handles", ""},
{GRAPHKEYS_HANDLESEL_L, "LEFT", 0, "Select Left Handles", ""},
{GRAPHKEYS_HANDLESEL_R, "RIGHT", 0, "Select Right Handles", ""},
{GRAPHKEYS_HANDLESEL_KEY, "KEY", 0, "Select Keyframes", ""},
{0, NULL, 0, NULL, NULL},
cgtinker marked this conversation as resolved
Christoph Lendenfeld commented 2023-06-16 09:51:49 +02:00
Review
Copy Link

make that KeyframeEditData *UNUSED(ked) for all those functions
This removes the warning you get when compiling

make that `KeyframeEditData *UNUSED(ked)` for all those functions This removes the warning you get when compiling
};
@ -2072,6 +2076,16 @@ static short bezt_sel_both_handles(KeyframeEditData *UNUSED(ked), BezTriple *bez
return 0;
}
static short bezt_sel_keys(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
{
if (BEZT_ISSEL_ANY(bezt)) {
BEZT_DESEL_IDX(bezt, 0);
BEZT_SEL_IDX(bezt, 1);
cgtinker marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2023-06-22 17:11:43 +02:00
Outdated
Review
Copy Link

Remove the _de_, there are many more functions that are called 'select' but also allow deselecting.

Remove the `_de_`, there are many more functions that are called 'select' but also allow deselecting.
BEZT_DESEL_IDX(bezt, 2);
cgtinker marked this conversation as resolved Outdated
Christoph Lendenfeld commented 2023-06-16 09:44:52 +02:00
Outdated
Review
Copy Link

leave a comment on what kind of enum short mode is
also can be const

leave a comment on what kind of enum `short mode` is also can be const
}
cgtinker marked this conversation as resolved Outdated
Christoph Lendenfeld commented 2023-06-21 15:40:00 +02:00
Outdated
Review
Copy Link

I meant add a comment that this is an enum and which it is.
e.g. enum eGraphKey_HandleSelect_Mode

also I am not sure we are supposed to use comments with //
sybren can elaborate on that

I meant add a comment that this is an enum and which it is. e.g. `enum eGraphKey_HandleSelect_Mode` also I am not sure we are supposed to use comments with // sybren can elaborate on that
Sybren A. Stüvel commented 2023-06-22 17:11:18 +02:00
Outdated
Review
Copy Link

Nope, see https://wiki.blender.org/wiki/Style_Guide/C_Cpp#Comments

Also, why use short here at all? IMO it should just be enum eGraphKey_HandleSelect_Mode mode.

Nope, see https://wiki.blender.org/wiki/Style_Guide/C_Cpp#Comments Also, why use `short` here at all? IMO it should just be `enum eGraphKey_HandleSelect_Mode mode`.
Denys Hsu commented 2023-06-23 10:46:09 +02:00
Outdated
Review
Copy Link

Also, why use short here at all? IMO it should just be enum eGraphKey_HandleSelect_Mode mode.

Yeah it should be eGraphKey_HandleSelect_Mode, will change that. Within the file all functions use a short instead of the enum prop, thought that had a reason and followed the "convention".

> Also, why use `short` here at all? IMO it should just be `enum eGraphKey_HandleSelect_Mode mode`. Yeah it should be `eGraphKey_HandleSelect_Mode`, will change that. Within the file all functions use a `short` instead of the enum prop, thought that had a reason and followed the "convention".
return 0;
cgtinker marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2023-06-22 17:15:53 +02:00
Outdated
Review
Copy Link

It's not a good idea to have negated booleans (i.e. 'enable to disable' style ones). Just use const bool select.

Having said that, looking at the code this does something else than I expected, so definitely add a comment above the function that explains what the parameters do.

It's not a good idea to have negated booleans (i.e. 'enable to disable' style ones). Just use `const bool select`. Having said that, looking at the code this does something else than I expected, so definitely add a comment above the function that explains what the parameters do.
}
static short bezt_desel_keys(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
{
if (BEZT_ISSEL_ANY(bezt)) {
@ -2080,18 +2094,24 @@ static short bezt_desel_keys(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
return 0;
}
cgtinker marked this conversation as resolved
Sybren A. Stüvel commented 2023-06-22 17:14:09 +02:00
Review
Copy Link

Add BLI_assert(ale->type, ANIMTYPE_FCURVE) before the cast, just to have a little extra check that the cast is actually valid.

Add `BLI_assert(ale->type, ANIMTYPE_FCURVE)` before the cast, just to have a little extra check that the cast is actually valid.
cgtinker marked this conversation as resolved
Christoph Lendenfeld commented 2023-06-16 09:38:25 +02:00
Review
Copy Link

this can be LISTBASE_FOREACH(bAnimListElem *, ale, &anim_data)
you then also don't need to have bAnimListElem *ale; before

this can be `LISTBASE_FOREACH(bAnimListElem *, ale, &anim_data)` you then also don't need to have `bAnimListElem *ale;` before
static void graphkeys_de_select_handles(
bAnimContext *ac,
const short mode, // prop_graphkeys_leftright_handle_select_types
const bool deselect_keyframe)
/*
* Select keyframe handles left/right/both or keys based on the given selection.
*
* mode: Determines which handles to select - left, right, or both.
* deselect_keyframe: Specifies whether keyframes should be deselected (true) or if the current
* selection should be preserved (false).
*/
static void graph_keys_select_handles(bAnimContext *ac,
const enum eGraphKey_HandleSelect_Side mode,
cgtinker marked this conversation as resolved Outdated
Christoph Lendenfeld commented 2023-06-16 09:53:34 +02:00
Outdated
Review
Copy Link

I did a test and you can just pass NULL instead of &ked since you are not doing anything with ked afterwards

I did a test and you can just pass `NULL` instead of `&ked` since you are not doing anything with `ked` afterwards
const bool deselect_keyframe)
cgtinker marked this conversation as resolved Outdated
Christoph Lendenfeld commented 2023-06-16 09:41:12 +02:00
Outdated
Review
Copy Link

so far i've only seen break within the curly bracket block
but I am not sure if this is convention or not. Something to check with sybren

so far i've only seen `break` within the curly bracket block but I am not sure if this is convention or not. Something to check with sybren
Denys Hsu commented 2023-06-16 12:01:38 +02:00
Outdated
Review
Copy Link

Afaik it does not change anything, I just put them inside

Afaik it does not change anything, I just put them inside
{
ListBase anim_data = {NULL, NULL};
const int filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FCURVESONLY |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
LISTBASE_FOREACH (bAnimListElem *, ale, &anim_data) {
BLI_assert(ale->type & ANIMTYPE_FCURVE);
FCurve *fcu = (FCurve *)ale->key_data;
/* Only continue if F-Curve has keyframes. */
@ -2099,7 +2119,7 @@ static void graphkeys_de_select_handles(
continue;
}
switch (mode) {
case GRAPHKEYS_HANDLESEL_LR: {
case GRAPHKEYS_HANDLESEL_BOTH: {
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, bezt_sel_both_handles, NULL);
break;
}
@ -2111,8 +2131,11 @@ static void graphkeys_de_select_handles(
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, bezt_sel_left_handles, NULL);
break;
cgtinker marked this conversation as resolved Outdated
Christoph Lendenfeld commented 2023-06-16 09:35:59 +02:00
Outdated
Review
Copy Link

i think calling the variable also mode would be clearer
and desel_kf should be deselect_keyframe. in general we try to avoid abbreviations these days to make the code more readable.

i think calling the variable also `mode` would be clearer and `desel_kf` should be `deselect_keyframe`. in general we try to avoid abbreviations these days to make the code more readable.
}
case GRAPHKEYS_HANDLESEL_KEY: {
cgtinker marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2023-06-22 17:18:04 +02:00
Outdated
Review
Copy Link

These variables can be const.

These variables can be `const`.
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, bezt_sel_keys, NULL);
}
}
if (deselect_keyframe) {
if (deselect_keyframe && (mode != GRAPHKEYS_HANDLESEL_KEY)) {
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, bezt_desel_keys, NULL);
}
}
@ -2130,10 +2153,10 @@ static int graphkeys_select_handles_exec(bContext *C, wmOperator *op)
return OPERATOR_CANCELLED;
}
short leftright = RNA_enum_get(op->ptr, "mode");
bool deselect_keyframe = RNA_boolean_get(op->ptr, "deselect_keyframe");
const short leftright = RNA_enum_get(op->ptr, "mode");
const bool deselect_keyframe = RNA_boolean_get(op->ptr, "deselect_keyframe");
/* Perform selection changes. */
cgtinker marked this conversation as resolved
Christoph Lendenfeld commented 2023-06-21 15:41:37 +02:00
Review
Copy Link

you don't need to assign the RNA_def to anything
so it can just be RNA_def... instead of ot->prop = RNA_def

now I didn't know the operator type had a prop. And I am not sure what it is used for.
Maybe also something for sybren to clear up

you don't need to assign the RNA_def to anything so it can just be `RNA_def...` instead of `ot->prop = RNA_def` now I didn't know the operator type had a prop. And I am not sure what it is used for. Maybe also something for sybren to clear up
Sybren A. Stüvel commented 2023-06-22 17:20:11 +02:00
Review
Copy Link

It's documented as:

  /**
   * Default rna property to use for generic invoke functions.
   * menus, enum search... etc. Example: Enum 'type' for a Delete menu.
   *
   * When assigned a string/number property,
   * immediately edit the value when used in a popup. see: #UI_BUT_ACTIVATE_ON_INIT.
   */
  PropertyRNA *prop;

So this means that it can be used for certain interactions as a special property.

@ChrisLend is right in that here the assignment is unnecessary. And if there is a property that should be marked as that special one property, it should only be assigned once, and not assigned and then immediately be overwritten again.

It's documented as: ```c /** * Default rna property to use for generic invoke functions. * menus, enum search... etc. Example: Enum 'type' for a Delete menu. * * When assigned a string/number property, * immediately edit the value when used in a popup. see: #UI_BUT_ACTIVATE_ON_INIT. */ PropertyRNA *prop; ``` So this means that it can be used for certain interactions as a special property. @ChrisLend is right in that here the assignment is unnecessary. And if there is a property that should be marked as that special one property, it should only be assigned once, and not assigned and then immediately be overwritten again.
graphkeys_de_select_handles(&ac, leftright, deselect_keyframe);
graph_keys_select_handles(&ac, leftright, deselect_keyframe);
cgtinker marked this conversation as resolved Outdated
Christoph Lendenfeld commented 2023-06-16 09:51:10 +02:00
Outdated
Review
Copy Link

you don't need to assign the RNA_def functions to anything
that way you can also remove PropertyRNA *prop; for which I get an unused warning anyway

you don't need to assign the `RNA_def` functions to anything that way you can also remove `PropertyRNA *prop;` for which I get an unused warning anyway
/* Set notifier that keyframe selection has changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_SELECTED, NULL);
@ -2141,25 +2164,46 @@ static int graphkeys_select_handles_exec(bContext *C, wmOperator *op)
return OPERATOR_FINISHED;
cgtinker marked this conversation as resolved Outdated
Sybren A. Stüvel commented 2023-06-22 17:20:30 +02:00
Outdated
Review
Copy Link

This should have a tooltip that explains what it does.

This should have a tooltip that explains what it does.
}
static void graphkeys_select_handles_ui(bContext *UNUSED(C), wmOperator *op)
{
uiLayout *layout = op->layout;
uiLayout *row;
bool keyframe_selection = RNA_enum_get(op->ptr, "mode") == GRAPHKEYS_HANDLESEL_KEY;
row = uiLayoutRow(layout, false);
uiItemR(row, op->ptr, "mode", 0, NULL, ICON_NONE);
if (!keyframe_selection) {
uiItemR(layout, op->ptr, "deselect_keyframe", 0, NULL, ICON_NONE);
}
}
void GRAPH_OT_select_handles(wmOperatorType *ot)
{
/* identifiers */
ot->name = "Select Handles";
ot->idname = "GRAPH_OT_select_handles";
ot->description = "(De)Select handles of based on the active selection";
ot->description = "Select keyframe handles left/right/both or keys based on the given selection";
/* callbacks */
ot->poll = graphop_visible_keyframes_poll;
ot->exec = graphkeys_select_handles_exec;
ot->ui = graphkeys_select_handles_ui;
/* flags */
ot->flag = OPTYPE_UNDO | OPTYPE_REGISTER;
ot->prop = RNA_def_enum(ot->srna,
"mode",
prop_graphkeys_leftright_handle_select_types,
GRAPHKEYS_HANDLESEL_LR,
"Mode",
"(De)Select handles based on selection");
ot->prop = RNA_def_boolean(ot->srna, "deselect_keyframe", 1, "Deselect Keyframes", "");
RNA_def_enum(
ot->srna,
"mode",
prop_graphkeys_leftright_handle_select_types,
GRAPHKEYS_HANDLESEL_BOTH,
"Mode",
"Selects corresponding keyframe handles (left, right, both or keys) based on the given "
"selection");
RNA_def_boolean(ot->srna,
"deselect_keyframe",
1,
"Deselect Keyframes",
"Deselect keyframes or preserve the given keyframe selection");
}