Fix issues with mouse cursor position when editing nodes #7014

vitvakatu · 2023-06-12T10:40:43Z

Pull Request Description

The issue was in the code for hiding/showing the node label. When showing it for the first time, the position of the label was updated only in the next frame, so the whole calculation was incorrect.

It is fixed using the DETACHED scene layer to hide the label when needed. Its position is always correct.

2023-06-12.14-42-45.mp4

Important Notes

I added a bit of additional code to ensure we always use the correct layer. The label is a complicated entity, as it lives in different layers in different application states. Also, I removed the code for setting the initial layer from the init method, as it seems unused.

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

The documentation has been updated, if necessary.
Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
All code follows the
Scala,
Java,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.
All code has been tested:
- Unit tests have been written where possible.
- If GUI codebase was changed, the GUI was tested when built using ./run ide build.

farmaazon · 2023-06-12T11:51:30Z

app/gui/view/graph-editor/src/component/node/input/area.rs

+        *self.label_layer.borrow_mut() = layer.downgrade();
+        // We're taking extra measures to ensure that the actual layer of the label will be updated
+        // even if it is already displayed. It should be unnecessary with the current
+        // implementation. See [`Self::show_edit_mode_label`] and [`Self::hide_edit_mode_label`].


It should be unnecessary with the current implementation.

I don't understand this. If it's unnecessary, why do we do this?

Well, we have no control over when the set_label_layer method will be called from outside of this component, and technically it can happen when we already have the label visible. As far as I understand the code, it shouldn't happen, but one can refactor it in the future and accidentally change the behavior. So it is just a preventative measure.

I think the docs rephrased this way would be more understandable to me:

Currently, we never sets label layer when it's already displayed, but - as `set_label_layer` is a public method of this component - we're taking extra measures.

Adam asked a question because the comment in the code is confusing. I see that the code did not change (the docs are not improved / expanded) and it is still confusing, so the question was not addressed yet. The comment is also very confusing to me – if it "should be unnecessary with the current implementation", it should not be there.

You have full control of if the set_label_layer will be called from outside of this component – the method is private, so it will not be called from outside.

I don't think we should include "dead code" that does nothing and is there just in case someone refactors code without thinking about the logic. This makes the whole code hard to understand and follow. In the future, when browsing this code, I would probably spend a lot of time trying to understand why edit_mode_label_displayed is needed and why we are managing this state, thinking that probably this solves some issue. If it is not needed, lets not add it :)

You have full control of if the set_label_layer will be called from outside of this component – the method is private, so it will not be called from outside.

This is not true, it is called from the public method of view.

Github have fooled me. I actually added a comment yesterday, but it was kept in a pending state, and I didn't notice.

Now it should be visible. I proposed an alternative comment. Check @wdanilo if it's ok to you.

Thank you, I like your proposal.

kazcw · 2023-06-12T20:25:24Z

QA: 🟢

wdanilo · 2023-06-12T21:26:48Z

CHANGELOG.md

@@ -183,6 +183,7 @@
  execution failed][6918].
 - [Performance and readability of documentation panel was improved][6893]. The
  documentation is now split into separate pages, which are much smaller.
+- [Fixed cursor position when ctrl-clicking the node][7014].


These are user-facing logs. Users reading them should understand what changed without the need to click something and without prior knowledge. Telling "fixed cursor position" does not really explain what changed to the reader. I'd be thankful If you could expand that a little bit.

wdanilo · 2023-06-12T21:34:33Z

app/gui/view/graph-editor/src/component/node/input/area.rs

+        *self.label_layer.borrow_mut() = layer.downgrade();
+        // We're taking extra measures to ensure that the actual layer of the label will be updated
+        // even if it is already displayed. It should be unnecessary with the current
+        // implementation. See [`Self::show_edit_mode_label`] and [`Self::hide_edit_mode_label`].


Adam asked a question because the comment in the code is confusing. I see that the code did not change (the docs are not improved / expanded) and it is still confusing, so the question was not addressed yet. The comment is also very confusing to me – if it "should be unnecessary with the current implementation", it should not be there.

You have full control of if the set_label_layer will be called from outside of this component – the method is private, so it will not be called from outside.

I don't think we should include "dead code" that does nothing and is there just in case someone refactors code without thinking about the logic. This makes the whole code hard to understand and follow. In the future, when browsing this code, I would probably spend a lot of time trying to understand why edit_mode_label_displayed is needed and why we are managing this state, thinking that probably this solves some issue. If it is not needed, lets not add it :)

sylwiabr · 2023-06-15T08:10:11Z

@wdanilo can you re-review this?

xvcgreg · 2023-06-19T10:41:02Z

@vitvakatu What's the status here? It's 4 days old w/o any action.

vitvakatu · 2023-06-19T13:41:30Z

@xvcgreg blame engine CI on windows, I don't know what has happened to it. Restarting one more time...

wdanilo · 2023-06-19T13:53:52Z

@vitvakatu in case of random failures, ping me and I will merge it :)

Fix issues with mouse cursor position when editing nodes

cff29f6

vitvakatu self-assigned this Jun 12, 2023

vitvakatu added 2 commits June 12, 2023 14:45

Update changelog

74d8055

Merge branch 'develop' into wip/vitvakatu/ctrl-clicking-position

caa72c3

vitvakatu marked this pull request as ready for review June 12, 2023 10:45

vitvakatu requested review from MichaelMauderer, wdanilo, farmaazon and kazcw as code owners June 12, 2023 10:45

farmaazon approved these changes Jun 12, 2023

View reviewed changes

wdanilo requested changes Jun 12, 2023

View reviewed changes

Address review comments

673031e

vitvakatu requested a review from wdanilo June 13, 2023 12:33

wdanilo approved these changes Jun 15, 2023

View reviewed changes

farmaazon added the CI: Ready to merge This PR is eligible for automatic merge label Jun 15, 2023

Merge branch 'develop' into wip/vitvakatu/ctrl-clicking-position

cd1e370

wdanilo merged commit 20edc2d into develop Jun 19, 2023
23 of 25 checks passed

wdanilo deleted the wip/vitvakatu/ctrl-clicking-position branch June 19, 2023 13:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix issues with mouse cursor position when editing nodes #7014

Fix issues with mouse cursor position when editing nodes #7014

vitvakatu commented Jun 12, 2023 •

edited

Loading

farmaazon Jun 12, 2023

vitvakatu Jun 12, 2023

farmaazon Jun 12, 2023

wdanilo Jun 12, 2023 •

edited

Loading

vitvakatu Jun 13, 2023

farmaazon Jun 13, 2023 •

edited

Loading

vitvakatu Jun 13, 2023

kazcw commented Jun 12, 2023 •

edited

Loading

wdanilo Jun 12, 2023

wdanilo Jun 12, 2023 •

edited

Loading

sylwiabr commented Jun 15, 2023

xvcgreg commented Jun 19, 2023

vitvakatu commented Jun 19, 2023

wdanilo commented Jun 19, 2023

Fix issues with mouse cursor position when editing nodes #7014

Fix issues with mouse cursor position when editing nodes #7014

Conversation

vitvakatu commented Jun 12, 2023 • edited Loading

Pull Request Description

Important Notes

Checklist

farmaazon Jun 12, 2023

Choose a reason for hiding this comment

vitvakatu Jun 12, 2023

Choose a reason for hiding this comment

farmaazon Jun 12, 2023

Choose a reason for hiding this comment

wdanilo Jun 12, 2023 • edited Loading

Choose a reason for hiding this comment

vitvakatu Jun 13, 2023

Choose a reason for hiding this comment

farmaazon Jun 13, 2023 • edited Loading

Choose a reason for hiding this comment

vitvakatu Jun 13, 2023

Choose a reason for hiding this comment

kazcw commented Jun 12, 2023 • edited Loading

QA: 🟢

wdanilo Jun 12, 2023

Choose a reason for hiding this comment

wdanilo Jun 12, 2023 • edited Loading

Choose a reason for hiding this comment

sylwiabr commented Jun 15, 2023

xvcgreg commented Jun 19, 2023

vitvakatu commented Jun 19, 2023

wdanilo commented Jun 19, 2023

vitvakatu commented Jun 12, 2023 •

edited

Loading

wdanilo Jun 12, 2023 •

edited

Loading

farmaazon Jun 13, 2023 •

edited

Loading

kazcw commented Jun 12, 2023 •

edited

Loading

wdanilo Jun 12, 2023 •

edited

Loading