User UI camera control #5252

nicopap · 2022-07-08T17:21:14Z

Objective

Enable user manipulation of UI camera.

Fixes UI camera flexibility regression #5242
Supersedes Add component to control UI camera position #5243
Depends on (the two first commits of this PR) UI render layers #5414

Solution

Add user control of UI cameras

Add fields to UiCameraConfig to control the UI camera scale and
position.

Fixes #5242. It is again possible to manipulate the ui camera.

An alternative design was considered, where instead of having a
component that controls all of the UI camera settings, the component
would only hold an Entity referencing another camera.

That design was abandoned in favor of the current one because the
viewport is tightly bound to the "actual" camera the UI camera is
attached to. So it would be awkward to maintain independently two
different cameras.

Changelog

Add position, scale and window_origin fields to UiCameraConfig to enable
manipulating the position of the attached UI camera.
Add UI Camera control example
Fix UI focus not working properly with moving cameras

Migration Guide

Instead of spawning an individual ui camera with UiCameraBundle
and manipulating its OrthographicProjection and GlobalTransform,
add a UiCameraConfig component to your viewport camera, and
use its field to change the ui camera position
Use the UiCameraProjection component to access the UI camera's projection.

alice-i-cecile · 2022-07-08T17:22:43Z

Sibling to #5114 and #4007.

alice-i-cecile · 2022-07-20T14:19:13Z

@IceSentry @superdump, I think this is a serious enough breakage that we should try to get this reviewed and merged for 0.8

nicopap · 2022-07-20T14:23:32Z

I'd also like to get cart's input on it. Since from reading the code it gave out the impression he had something in mind.

crates/bevy_ui/src/entity.rs

alice-i-cecile · 2022-07-20T14:51:12Z

crates/bevy_ui/src/render/mod.rs

-#[derive(Component)]
-pub struct DefaultCameraView(pub Entity);
+#[derive(Component, Debug)]
+pub struct UiCamera {


Docs needed.

crates/bevy_ui/src/render/mod.rs

alice-i-cecile · 2022-07-20T14:54:12Z

examples/window/multiple_windows.rs

            ..default()
-        },
+        })
+        .insert(UiCameraConfig {


This part of the example is unclear, and needs more comments.

We can also probably shorten it now that #5343 has merged!

alice-i-cecile · 2022-07-20T14:54:49Z

examples/ui/ui.rs

@@ -309,6 +316,31 @@ struct ScrollingList {
    position: f32,
 }

+fn change_ui_camera(


IMO we should have this in its own example. I don't like how big this example is to begin with; let's not make it worse.

Sure thing, the off_screen_focusables from ui-navigation seems like a perfect fit, and would help lower the size of the rfc41 PR too.

IceSentry · 2022-07-20T15:50:57Z

I feel like this should be split in 2 PR. I like the render layer idea, but I don't like the config part because of the pub projection.

nicopap · 2022-07-20T16:36:38Z

@IceSentry said:

I feel like this should be split in 2 PR. I like the render layer idea, but I don't like the config part because of the pub projection.

Indeed. In insight, it's quite obvious those are two different features.

The RenderLayer addition however, leaves #5242 unsolved. I agree the pub projection is questionable, and I've spent a some time (let's be honest, few minutes) thinking about it.

The thing is, you need access to the UI projection for a lot of reasons (navigation is one of them).

Here is a different proposition: have a UiProjection component which public API provide read-only access to the projection, have a system to update it based on the associated camera and the config. I'm still very annoyed by that solution, because you then have to add systems relying on the projection to a specific stage and make sure they run .after the ui projection update system.

But the one I provided here suffers from the same issue, so maybe it's OK?

alice-i-cecile · 2022-07-20T17:10:11Z

Mhmm. I think we split this, merge the RenderLayers part ASAP, and then chew on the config in this PR.

nicopap · 2022-07-20T19:20:29Z

Mhmm. I think we split this, merge the RenderLayers part ASAP, and then chew on the config in this PR.

Can do, ready tomorrow. But if it doesn't fix #5242 There is no reason for it to be a priority anymore.

This enables having different UI per camera. With bevyengine#5225, this enables having different interactive UIs per window. Although, to properly complete this, the focus system will need to account for RenderLayer of UI nodes.

Add fields to UiCameraConfig to control the UI camera scale and window_origin. Fixes bevyengine#5242. It is again possible to manipulate the ui camera. An alternative design was considered, where instead of having a component that controls all of the UI camera settings, the component would only hold an Entity referencing another camera. That design was abandoned in favor of the current one because the viewport is tightly bound to the "actual" camera the UI camera is attached to. So it would be awkward to maintain independently two different cameras.

nicopap · 2022-07-21T14:18:13Z

I created a separate PR for the RenderLayers, see #5414. Note that this PR still contains all the commits from #5414, so I expect this PR to be reviewed later on.

As it was added in bevyengine#5252

nicopap · 2022-09-25T11:28:20Z

This PR is not fully addressed by #5892, but I think it should be the direction forward, thus superseding this PR.

nicopap mentioned this pull request Jul 8, 2022

Add component to control UI camera position #5243

Closed

alice-i-cecile added C-Enhancement A new feature A-Rendering Drawing game state to the screen A-UI Graphical user interfaces, styles, layouts, and widgets labels Jul 8, 2022

nicopap force-pushed the multi-uicam-target branch from abea0a4 to 3b603cb Compare July 8, 2022 18:15

nicopap marked this pull request as ready for review July 8, 2022 18:16

nicopap mentioned this pull request Jul 9, 2022

[Merged by Bors] - Add stress test for many ui elements #5253

Closed

nicopap force-pushed the multi-uicam-target branch from 3b603cb to 3072955 Compare July 9, 2022 17:38

nicopap force-pushed the multi-uicam-target branch from 3072955 to 00655b2 Compare July 19, 2022 14:07

alice-i-cecile added this to the Bevy 0.8 milestone Jul 20, 2022

alice-i-cecile requested review from cart, superdump and IceSentry July 20, 2022 14:48

alice-i-cecile reviewed Jul 20, 2022

View reviewed changes

crates/bevy_ui/src/entity.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Jul 20, 2022

View reviewed changes

crates/bevy_ui/src/render/mod.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Jul 20, 2022

View reviewed changes

alice-i-cecile removed this from the Bevy 0.8 milestone Jul 20, 2022

nicopap force-pushed the multi-uicam-target branch from 387e95f to be9d099 Compare July 21, 2022 10:09

nicopap marked this pull request as draft July 21, 2022 10:09

nicopap added 2 commits July 21, 2022 13:46

Add RenderLayer support to UI cameras

d5ee6b4

This enables having different UI per camera. With bevyengine#5225, this enables having different interactive UIs per window. Although, to properly complete this, the focus system will need to account for RenderLayer of UI nodes.

Update Node ComputedVisibility based on UI RenderLayers

17153b6

nicopap force-pushed the multi-uicam-target branch from be9d099 to 60c29b8 Compare July 21, 2022 11:52

Add user control of UI camera position

f4d5a7c

nicopap changed the title ~~User UI camera control & UI element layer support~~ User UI camera control Jul 21, 2022

nicopap added 3 commits July 21, 2022 15:01

Add UI Camera control example

bbcb385

Update focus system to handle moving UI cameras

90d4cb8

nicopap force-pushed the multi-uicam-target branch from 60c29b8 to 90d4cb8 Compare July 21, 2022 14:07

nicopap marked this pull request as ready for review July 21, 2022 14:15

nicopap marked this pull request as draft July 21, 2022 14:16

nicopap added a commit to nicopap/bevy that referenced this pull request Jul 21, 2022

Remove off_screen_focusables example

3681229

As it was added in bevyengine#5252

alice-i-cecile added the S-Blocked This cannot move forward until something else changes label Jul 21, 2022

nicopap mentioned this pull request Jul 21, 2022

UI render layers #5414

Closed

nicopap added a commit to nicopap/bevy that referenced this pull request Jul 22, 2022

Remove off_screen_focusables example

66ad1bd

As it was added in bevyengine#5252

nicopap added a commit to nicopap/bevy that referenced this pull request Jul 31, 2022

Remove off_screen_focusables example

9746d14

As it was added in bevyengine#5252

nicopap removed the S-Blocked This cannot move forward until something else changes label Aug 7, 2022

nicopap added a commit to nicopap/bevy that referenced this pull request Aug 9, 2022

Remove off_screen_focusables example

3508895

As it was added in bevyengine#5252

nicopap added a commit to nicopap/bevy that referenced this pull request Aug 18, 2022

Remove off_screen_focusables example

e4a40f3

As it was added in bevyengine#5252

nicopap added a commit to nicopap/bevy that referenced this pull request Sep 4, 2022

Remove off_screen_focusables example

719b29b

As it was added in bevyengine#5252

nicopap closed this Sep 25, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User UI camera control #5252

User UI camera control #5252

nicopap commented Jul 8, 2022 •

edited

Loading

alice-i-cecile commented Jul 8, 2022

alice-i-cecile commented Jul 20, 2022

nicopap commented Jul 20, 2022

alice-i-cecile Jul 20, 2022

alice-i-cecile Jul 20, 2022

alice-i-cecile Jul 20, 2022

nicopap Jul 20, 2022

IceSentry commented Jul 20, 2022

nicopap commented Jul 20, 2022

alice-i-cecile commented Jul 20, 2022

nicopap commented Jul 20, 2022 •

edited

Loading

nicopap commented Jul 21, 2022 •

edited

Loading

nicopap commented Sep 25, 2022

User UI camera control #5252

User UI camera control #5252

Conversation

nicopap commented Jul 8, 2022 • edited Loading

Objective

Solution

Add user control of UI cameras

Changelog

Migration Guide

alice-i-cecile commented Jul 8, 2022

alice-i-cecile commented Jul 20, 2022

nicopap commented Jul 20, 2022

alice-i-cecile Jul 20, 2022

Choose a reason for hiding this comment

alice-i-cecile Jul 20, 2022

Choose a reason for hiding this comment

alice-i-cecile Jul 20, 2022

Choose a reason for hiding this comment

nicopap Jul 20, 2022

Choose a reason for hiding this comment

IceSentry commented Jul 20, 2022

nicopap commented Jul 20, 2022

alice-i-cecile commented Jul 20, 2022

nicopap commented Jul 20, 2022 • edited Loading

nicopap commented Jul 21, 2022 • edited Loading

nicopap commented Sep 25, 2022

nicopap commented Jul 8, 2022 •

edited

Loading

nicopap commented Jul 20, 2022 •

edited

Loading

nicopap commented Jul 21, 2022 •

edited

Loading