Add window drag move and drag resize without decoration example. #15814

shanecelis · 2024-10-10T08:27:47Z

Objective

Add an example for the new drag move and drag resize introduced by PR #15674 and fix #15734.

Solution

I created an example that allows the user to exercise drag move and drag resize separately. The user can also choose what direction the resize works in.

Name

The example is called window_drag_move. Happy to have that bikeshedded.

Contentious Refactor?

This PR removed the ResizeDirection enumeration in favor of using CompassOctant which had the same variants. Perhaps this is contentious.

Unsafe?

In PR #15674 I mentioned that start_drag_move() and start_drag_resize()'s requirement to only be called in the presence of a left-click looks like a compiler-unenforceable contract that can cause intermittent panics when not observed, so perhaps the functions should be marked them unsafe. I have not made that change here since I didn't see a clear consensus on that.

Testing

I exercised this on x86 macOS. However, winit for macOS does not support drag resize. It reports a good error when start_drag_resize() is called. I'd like to see it tested on Windows and Linux.

Showcase

Example window_drag_move shows how to drag or resize a window without decoration.

Add docs.

alice-i-cecile · 2024-10-10T14:14:54Z

@IsseW can I get your review here?

IsseW · 2024-10-10T16:10:50Z

@IsseW can I get your review here?

I can review tomorrow!

shanecelis · 2024-10-10T21:05:48Z

Re: unsafe

I've submitted a PR to winit so it may not panic in the future when a left-click event isn't present, which I'd then be satisfied without any unsafe markers on the functions.

IsseW

I think this looks good, just one comment about a newline.

IsseW · 2024-10-11T18:19:41Z

Cargo.toml

@@ -2934,6 +2934,7 @@ name = "window_fallthrough"
 path = "examples/ui/window_fallthrough.rs"
 doc-scrape-examples = true

+


Was this added by mistake?

Yes, that was a mistake. Will fix.

IsseW · 2024-10-11T18:20:49Z

crates/bevy_window/src/window.rs

@@ -379,7 +379,7 @@ impl Window {
    ///
    /// There is no guarantee that this will work unless the left mouse button was
    /// pressed immediately before this function was called.
-    pub fn start_drag_resize(&mut self, direction: ResizeDirection) {
+    pub fn start_drag_resize(&mut self, direction: CompassOctant) {


I like this idea of using the existing CompassOctant 😄

MiniaczQ

Few naming nits, I like the example 👍
Works on Windows 11

One side question, would it be possible to call redraw while we're resizing, so window gets updated immediately, rather than just stretching until we're done?

MiniaczQ · 2024-10-13T18:19:57Z

examples/window/window_drag_move.rs

+    }
+}
+
+fn move_windows(


Suggested change

fn move_windows(

fn move_or_resize_window(

MiniaczQ · 2024-10-13T18:20:54Z

examples/window/window_drag_move.rs

+        for mut window in windows.iter_mut() {
+            match *action {
+                LeftClickAction::Nothing => (),
+                LeftClickAction::Drag => window.start_drag_move(),


Suggested change

LeftClickAction::Drag => window.start_drag_move(),

LeftClickAction::Move => window.start_drag_move(),

this would be more consistent with drag_move vs drag_resize

BenjaminBrienen

Only nits

BenjaminBrienen · 2024-10-13T18:34:30Z

examples/window/window_drag_move.rs

+//!
+//! When window decorations are not present, the user cannot drag the window.
+//! The `start_drag_move()` function will permit the application to make the
+//! window draggable. It does require that the left mouse button was pressed


is being pressed sounds better to me. Currently the tenses are conflicting.

BenjaminBrienen · 2024-10-13T18:35:02Z

examples/window/window_drag_move.rs

+//! When window decorations are not present, the user cannot drag the window.
+//! The `start_drag_move()` function will permit the application to make the
+//! window draggable. It does require that the left mouse button was pressed
+//! when it is called.


When (inconsistent capitalization with other comments)

I apologize. I don't quite follow this suggestion. I have rewritten that paragraph. Please see if your comment still applies.

alice-i-cecile · 2024-10-15T03:28:54Z

@shanecelis this needs minor changes following #15887.

shanecelis · 2024-10-15T03:37:10Z

Will do.

Some refactoring from feedback too.

shanecelis · 2024-10-15T07:57:07Z

Strange. CI failed, but the same command works on my M2 macOS. It complains about the UiTextWriter not being found, which is strange because many examples use that symbol.

MiniaczQ · 2024-10-15T13:12:35Z

Strange. CI failed, but the same command works on my M2 macOS. It complains about the UiTextWriter not being found, which is strange because many examples use that symbol.

It's TextUiWriter after #15887

shanecelis added 7 commits October 10, 2024 03:51

feature: Add window move resize example.

41311e6

refactor: Use CompassOctant not ResizeDirection.

e39fc92

Add docs.

refactor: Use new text span and writer APIs.

8a2eb58

chore: Removed unused variable.

5f4f0eb

doc: Fix wording.

853dcef

doc: Better description in cargo.toml.

9e8c891

doc: Build templated pages for examples.

5f4952a

alice-i-cecile added C-Examples An addition or correction to our examples A-Windowing Platform-agnostic interface layer to run your app in labels Oct 10, 2024

alice-i-cecile added D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Needs-Review Needs reviewer attention (from anyone!) to move forward S-Needs-Testing Testing must be done before this is safe to merge labels Oct 10, 2024

IsseW approved these changes Oct 11, 2024

View reviewed changes

alice-i-cecile added this to the 0.15 milestone Oct 11, 2024

excise: Remove errant newline.

c08e217

MiniaczQ approved these changes Oct 13, 2024

View reviewed changes

BenjaminBrienen approved these changes Oct 13, 2024

View reviewed changes

alice-i-cecile mentioned this pull request Oct 15, 2024

Call redraw while resizing windows #15915

Open

alice-i-cecile added this pull request to the merge queue Oct 15, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 15, 2024

doc: Take into account feedback.

0c37250

Some refactoring from feedback too.

alice-i-cecile and others added 2 commits October 15, 2024 10:10

Merge branch 'main' into window-move-resize-eg

d4c91b4

refactor: Use TextUiWriter.

e78bb49

alice-i-cecile added this pull request to the merge queue Oct 15, 2024

Merged via the queue into bevyengine:main with commit 5157fef Oct 15, 2024
32 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add window drag move and drag resize without decoration example. #15814

Add window drag move and drag resize without decoration example. #15814

shanecelis commented Oct 10, 2024 •

edited by alice-i-cecile

Loading

alice-i-cecile commented Oct 10, 2024

IsseW commented Oct 10, 2024

shanecelis commented Oct 10, 2024

IsseW left a comment

IsseW Oct 11, 2024

shanecelis Oct 11, 2024

IsseW Oct 11, 2024

MiniaczQ left a comment •

edited

Loading

MiniaczQ Oct 13, 2024 •

edited

Loading

MiniaczQ Oct 13, 2024

BenjaminBrienen left a comment

BenjaminBrienen Oct 13, 2024

BenjaminBrienen Oct 13, 2024

shanecelis Oct 15, 2024

alice-i-cecile commented Oct 15, 2024

shanecelis commented Oct 15, 2024

shanecelis commented Oct 15, 2024

MiniaczQ commented Oct 15, 2024

		@@ -2934,6 +2934,7 @@ name = "window_fallthrough"
		path = "examples/ui/window_fallthrough.rs"
		doc-scrape-examples = true

	LeftClickAction::Drag => window.start_drag_move(),
	LeftClickAction::Move => window.start_drag_move(),

Add window drag move and drag resize without decoration example. #15814

Add window drag move and drag resize without decoration example. #15814

Conversation

shanecelis commented Oct 10, 2024 • edited by alice-i-cecile Loading

Objective

Solution

Name

Contentious Refactor?

Unsafe?

Testing

Showcase

alice-i-cecile commented Oct 10, 2024

IsseW commented Oct 10, 2024

shanecelis commented Oct 10, 2024

IsseW left a comment

Choose a reason for hiding this comment

IsseW Oct 11, 2024

Choose a reason for hiding this comment

shanecelis Oct 11, 2024

Choose a reason for hiding this comment

IsseW Oct 11, 2024

Choose a reason for hiding this comment

MiniaczQ left a comment • edited Loading

Choose a reason for hiding this comment

MiniaczQ Oct 13, 2024 • edited Loading

Choose a reason for hiding this comment

MiniaczQ Oct 13, 2024

Choose a reason for hiding this comment

BenjaminBrienen left a comment

Choose a reason for hiding this comment

BenjaminBrienen Oct 13, 2024

Choose a reason for hiding this comment

BenjaminBrienen Oct 13, 2024

Choose a reason for hiding this comment

shanecelis Oct 15, 2024

Choose a reason for hiding this comment

alice-i-cecile commented Oct 15, 2024

shanecelis commented Oct 15, 2024

shanecelis commented Oct 15, 2024

MiniaczQ commented Oct 15, 2024

shanecelis commented Oct 10, 2024 •

edited by alice-i-cecile

Loading

MiniaczQ left a comment •

edited

Loading

MiniaczQ Oct 13, 2024 •

edited

Loading