Support canceling color-ramp editing with the Escape key #53756

New Issue

Campbell Barton · 2018-01-11T03:48:38+01:00

Campbell Barton commented

2018-01-11 03:48:38 +01:00

Most interactions in blender can be cancelled by pressing escape.

Try drag a slider, pressing escape resets it to the value before dragging.

This is not the case for the color-ramp:

Add a color ramp in the node editor: Add -> Converter -> Color Ramp
Click and drag the stops at either side.
Pressing escape does nothing.

This quick hack is to support escape to cancel the change (while dragging).

Most interactions in blender can be cancelled by pressing escape. Try drag a slider, pressing escape resets it to the value before dragging. This is not the case for the color-ramp: - Add a color ramp in the node editor: Add -> Converter -> Color Ramp - Click and drag the stops at either side. - Pressing escape does nothing. This quick hack is to support escape to cancel the change (while dragging).

Campbell Barton commented

2018-01-11 03:48:38 +01:00

Added subscriber: @ideasman42

Kevin Masson commented

2018-01-11 10:53:35 +01:00

Added subscriber: @oktomus-2

Kevin Masson self-assigned this 2018-01-11 10:53:35 +01:00

Kevin Masson commented

2018-01-11 10:53:35 +01:00

Hello, I will try to make this one in few days. This is my first contribution so if everyone wants to make it before me, just tell me :)

Campbell Barton commented

2018-01-11 13:17:57 +01:00

@oktomus-2, thanks for looking into this.
Note that we don't assign quick hacks to developers. If you're working on it - saying so is enough (having claimed but inactive tasks became a problem in the past).

@oktomus-2, thanks for looking into this. Note that we don't assign quick hacks to developers. If you're working on it - saying so is enough (having claimed but inactive tasks became a problem in the past).

Kevin Masson was unassigned by Campbell Barton

2018-01-11 13:18:08 +01:00

Kevin Masson commented

2018-01-11 15:17:09 +01:00

@ideasman42 Ok no problem.

Kevin Masson commented

2018-01-11 16:59:37 +01:00

Found how to cancel editing on color ramps. Now, I need to find out how to reset it to its default value.

Kevin Masson commented

2018-01-11 18:18:17 +01:00

I can't figure out where to look next, I am not comfortable enough with the ui event system.
Here is what I got so far:

After detecting an ESCAPE event, I tried to change the coloramp value by giving data->dragstartx:

else if (event->type == ESCKEY) {
    if (event->val == KM_PRESS) {
        if (ui_numedit_but_COLORBAND(but, data, data->dragstartx))
            ui_numedit_apply(C, block, but, data);
        data->cancel = true;
        data->escapecancel = true;
        button_activate_state(C, but, BUTTON_STATE_EXIT);
    }
}

But I think that ui_numedit_but_COLORBAND takes a mouse position and not a coloramp index. So it works but give weird results sometimes do to the calculation made inside the function. And I think that this way of resetting the ramp is wrong.

So I found this in ui_apply_but

if (data->cancel) {
    if (!data->applied)
        return;

    if (data->str) MEM_freeN(data->str);
    data->str = data->origstr;
    data->origstr = NULL;
    data->value = data->origvalue;
    copy_v3_v3(data->vec, data->origvec);
    data->coba = data->origcoba;
    // UNDO DATA HERE
    /* postpone clearing origdata */
}

But I don't know where I should initialize origcoba (which I added in the struct) ?

Can someone give me any advice ?

I can't figure out where to look next, I am not comfortable enough with the ui event system. Here is what I got so far: After detecting an ESCAPE event, I tried to change the coloramp value by giving `data->dragstartx`: ``` else if (event->type == ESCKEY) { if (event->val == KM_PRESS) { if (ui_numedit_but_COLORBAND(but, data, data->dragstartx)) ui_numedit_apply(C, block, but, data); data->cancel = true; data->escapecancel = true; button_activate_state(C, but, BUTTON_STATE_EXIT); } } ``` But I think that `ui_numedit_but_COLORBAND` takes a mouse position and not a coloramp index. So it works but give weird results sometimes do to the calculation made inside the function. And I think that this way of resetting the ramp is wrong. So I found this in `ui_apply_but` ``` if (data->cancel) { if (!data->applied) return; if (data->str) MEM_freeN(data->str); data->str = data->origstr; data->origstr = NULL; data->value = data->origvalue; copy_v3_v3(data->vec, data->origvec); data->coba = data->origcoba; // UNDO DATA HERE /* postpone clearing origdata */ } ``` But I don't know where I should initialize origcoba (which I added in the struct) ? Can someone give me any advice ?

Aakash commented

2018-01-11 19:38:45 +01:00

Added subscriber: @aakashkt0

Aakash commented

2018-01-11 19:38:45 +01:00

Hi, I too am looking in to getting my first commit to blender.
I hope it's not a problem if I too try the task along with @oktomus-2 .

Thanks.

Hi, I too am looking in to getting my first commit to blender. I hope it's not a problem if I too try the task along with @oktomus-2 . Thanks.

Kevin Masson commented

2018-01-12 09:18:12 +01:00

Works for me, if we can both understand how to fix this, that would be great :)

Aakash commented

2018-01-14 15:04:08 +01:00

Looks like you have solved it, time to learn from your code :D

Kevin Masson commented

2018-01-14 21:24:52 +01:00

In #53756#479154, @aakashkt0 wrote:
Looks like you have solved it, time to learn from your code :D

I suggest you to generate the Doxygen documentation, most of the code isn't documented but it's a great tool to see what structure is being used and all..

> In #53756#479154, @aakashkt0 wrote: > Looks like you have solved it, time to learn from your code :D I suggest you to generate the Doxygen documentation, most of the code isn't documented but it's a great tool to see what structure is being used and all..

Aakash commented

2018-01-15 06:43:47 +01:00

In #53756#479183, @oktomus-2 wrote:

In #53756#479154, @aakashkt0 wrote:
Looks like you have solved it, time to learn from your code :D

I suggest you to generate the Doxygen documentation, most of the code isn't documented but it's a great tool to see what structure is being used and all..

Thanks for the suggestion :)

> In #53756#479183, @oktomus-2 wrote: >> In #53756#479154, @aakashkt0 wrote: >> Looks like you have solved it, time to learn from your code :D > > I suggest you to generate the Doxygen documentation, most of the code isn't documented but it's a great tool to see what structure is being used and all.. Thanks for the suggestion :)

Campbell Barton commented

2018-01-16 02:27:40 +01:00

Changed status from 'Open' to: 'Resolved'

Campbell Barton closed this issue

2018-01-16 02:27:40 +01:00

Campbell Barton self-assigned this 2018-01-16 02:27:40 +01:00

Campbell Barton commented

2018-01-16 02:27:40 +01:00

Thanks for working on this, committed 6f45dea6ee

Thanks for working on this, committed 6f45dea6ee

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Support canceling color-ramp editing with the Escape key #53756