Animation: Graph Editor Handle Selection #108142
@ -193,6 +193,12 @@ class GRAPH_MT_select(Menu):
|
||||
props.extend = False
|
||||
props.mode = 'RIGHT'
|
||||
|
||||
layout.separator()
|
||||
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
|
||||
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")
|
||||
layout.operator("graph.select_less")
|
||||
|
@ -74,6 +74,14 @@ enum eGraphKeys_LeftRightSelect_Mode {
|
||||
GRAPHKEYS_LRSEL_RIGHT,
|
||||
};
|
||||
|
||||
/* Defines for handle selection. */
|
||||
cgtinker marked this conversation as resolved
Outdated
|
||||
enum eGraphKey_HandleSelect_Side {
|
||||
cgtinker marked this conversation as resolved
Outdated
Sybren A. Stüvel
commented
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 */
|
||||
enum eGraphKeys_ColumnSelect_Mode {
|
||||
GRAPHKEYS_COLUMNSEL_KEYS = 0,
|
||||
@ -124,6 +132,7 @@ void GRAPH_OT_sound_bake(struct wmOperatorType *ot);
|
||||
void GRAPH_OT_smooth(struct wmOperatorType *ot);
|
||||
void GRAPH_OT_euler_filter(struct wmOperatorType *ot);
|
||||
|
||||
void GRAPH_OT_select_handles(struct wmOperatorType *ot);
|
||||
void GRAPH_OT_handle_type(struct wmOperatorType *ot);
|
||||
void GRAPH_OT_interpolation_type(struct wmOperatorType *ot);
|
||||
void GRAPH_OT_extrapolation_type(struct wmOperatorType *ot);
|
||||
|
@ -443,6 +443,8 @@ void graphedit_operatortypes(void)
|
||||
WM_operatortype_append(GRAPH_OT_select_less);
|
||||
WM_operatortype_append(GRAPH_OT_select_leftright);
|
||||
|
||||
WM_operatortype_append(GRAPH_OT_select_handles);
|
||||
|
||||
/* editing */
|
||||
WM_operatortype_append(GRAPH_OT_snap);
|
||||
WM_operatortype_append(GRAPH_OT_equalize_handles);
|
||||
|
@ -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"
|
||||
@ -2035,3 +2038,172 @@ void GRAPH_OT_clickselect(wmOperatorType *ot)
|
||||
}
|
||||
|
||||
/** \} */
|
||||
/* Handle selection */
|
||||
|
||||
cgtinker marked this conversation as resolved
Outdated
Sybren A. Stüvel
commented
Just for consistency, rename Just for consistency, rename `GRAPHKEYS_HANDLESEL_LR` to `GRAPHKEYS_HANDLESEL_BOTH`.
|
||||
/* Defines for handle select tool. */
|
||||
cgtinker marked this conversation as resolved
Outdated
why is the option to select both handles called "CHECK" 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
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?
|
||||
static const EnumPropertyItem prop_graphkeys_leftright_handle_select_types[] = {
|
||||
{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},
|
||||
};
|
||||
|
||||
static short bezt_sel_left_handles(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
|
||||
{
|
||||
if (BEZT_ISSEL_ANY(bezt)) {
|
||||
BEZT_SEL_IDX(bezt, 0);
|
||||
BEZT_DESEL_IDX(bezt, 2);
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
static short bezt_sel_right_handles(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
|
||||
{
|
||||
if (BEZT_ISSEL_ANY(bezt)) {
|
||||
BEZT_DESEL_IDX(bezt, 0);
|
||||
BEZT_SEL_IDX(bezt, 2);
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
static short bezt_sel_both_handles(KeyframeEditData *UNUSED(ked), BezTriple *bezt)
|
||||
{
|
||||
if (BEZT_ISSEL_ANY(bezt)) {
|
||||
BEZT_SEL_IDX(bezt, 0);
|
||||
BEZT_SEL_IDX(bezt, 2);
|
||||
}
|
||||
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
Remove the 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
|
||||
}
|
||||
cgtinker marked this conversation as resolved
Outdated
I meant add a comment that this is an enum and which it is. also I am not sure we are supposed to use comments with // 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
Nope, see https://wiki.blender.org/wiki/Style_Guide/C_Cpp#Comments Also, why use 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
Yeah it should be > 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
It's not a good idea to have negated booleans (i.e. 'enable to disable' style ones). Just use 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)) {
|
||||
BEZT_DESEL_IDX(bezt, 1);
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
cgtinker marked this conversation as resolved
Sybren A. Stüvel
commented
Add Add `BLI_assert(ale->type, ANIMTYPE_FCURVE)` before the cast, just to have a little extra check that the cast is actually valid.
|
||||
|
||||
/*
|
||||
* 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
|
||||
const bool deselect_keyframe)
|
||||
cgtinker marked this conversation as resolved
Outdated
so far i've only seen 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
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. */
|
||||
if (fcu->bezt == NULL) {
|
||||
continue;
|
||||
}
|
||||
switch (mode) {
|
||||
case GRAPHKEYS_HANDLESEL_BOTH: {
|
||||
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, bezt_sel_both_handles, NULL);
|
||||
break;
|
||||
}
|
||||
case GRAPHKEYS_HANDLESEL_R: {
|
||||
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, bezt_sel_right_handles, NULL);
|
||||
break;
|
||||
}
|
||||
case GRAPHKEYS_HANDLESEL_L: {
|
||||
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, bezt_sel_left_handles, NULL);
|
||||
break;
|
||||
cgtinker marked this conversation as resolved
Outdated
i think calling the variable also 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
These variables can be These variables can be `const`.
|
||||
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, bezt_sel_keys, NULL);
|
||||
}
|
||||
}
|
||||
if (deselect_keyframe && (mode != GRAPHKEYS_HANDLESEL_KEY)) {
|
||||
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, bezt_desel_keys, NULL);
|
||||
}
|
||||
}
|
||||
|
||||
/* Cleanup */
|
||||
ANIM_animdata_freelist(&anim_data);
|
||||
}
|
||||
|
||||
static int graphkeys_select_handles_exec(bContext *C, wmOperator *op)
|
||||
{
|
||||
bAnimContext ac;
|
||||
|
||||
/* Get editor data. */
|
||||
if (ANIM_animdata_get_context(C, &ac) == 0) {
|
||||
return OPERATOR_CANCELLED;
|
||||
}
|
||||
|
||||
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
you don't need to assign the RNA_def to anything now I didn't know the operator type had a prop. And I am not sure what it is used for. 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
It's documented as:
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.
|
||||
graph_keys_select_handles(&ac, leftright, deselect_keyframe);
|
||||
cgtinker marked this conversation as resolved
Outdated
|
||||
|
||||
/* Set notifier that keyframe selection has changed. */
|
||||
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_SELECTED, NULL);
|
||||
|
||||
cgtinker marked this conversation as resolved
Sybren A. Stüvel
commented
"Select handles based on selection" is too vague. "Select handles based on selection" is too vague.
|
||||
return OPERATOR_FINISHED;
|
||||
cgtinker marked this conversation as resolved
Outdated
Sybren A. Stüvel
commented
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 = "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;
|
||||
|
||||
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");
|
||||
}
|
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