Add OutlineGizmoPlugin and integrate outline gizmo functionality #195

jbuehler23 · 2025-06-03T18:45:01Z

First cut at getting an Outline Gizmo working - very rough, and highly WIP while learning the ins and outs of bevy and the repo :)

My first thoughts are that it seems incredibly verbose to create a toggle which is updated by some "listener".

It would be nice if this block could be heavily simplified:

parent
        .spawn((
            Node {
                position_type: PositionType::Absolute,
                top: Val::Px(10.0),
                left: Val::Px(10.0),
                width: Val::Px(120.0),
                height: Val::Px(30.0),
                align_items: AlignItems::Center,
                justify_content: JustifyContent::Center,
                ..default()
            },
            BackgroundColor(Color::srgb(0.2, 0.2, 0.2)),
        ))
        .with_children(|parent| {
            parent.spawn((
                Text::new(""),
                GizmoToggleText,
            ));
        })
        .observe(|_trigger: Trigger<Pointer<Click>>, mut show_outlines: ResMut<ShowOutlines>| {
            show_outlines.0 = !show_outlines.0;
        });

// System to update the button text when ShowOutlines changes
fn update_gizmo_toggle_text(
    show_outlines: Res<ShowOutlines>,
    mut query: Query<&mut Text, With<GizmoToggleText>>,
) {
    if show_outlines.is_changed() {
        for mut text in &mut query {
            text.0 = if show_outlines.0 { "Hide Outlines".into() } else { "Show Outlines".into() };
        }
    }
}

into something with a more simplified callback structure.

This is also a first step toward the Milestone Issue we have here: #197

Also adds documentation outlined in #207 to give new devs help when trying compile/run changes locally

Screenshot of toggle button working on the editor locally :)

alice-i-cecile

I'm happy with the code here: verbose but clear. Toss in a screenshot to the PR description and I'll merge this for you.

jbuehler23 · 2025-06-04T18:11:33Z

I actually can’t get the toggle to display in the pane. Could use some advice on here if possible?

alice-i-cecile · 2025-06-08T02:05:49Z

I generally set up my IDE to format on save to reduce the CI headaches while working on Rust projects :)

…_gizmo, and lib modules

also add documentation about compiling the editor locally and running with local changes

jbuehler23 · 2025-06-11T15:37:07Z

@alice-i-cecile think this is ready to be merged now - i've also mentioned #207 in this one - not sure if that autolinks the Issue to this PR though (ie, once merged, will it close that Issue?)

…editor_prototypes into add-ui-outlines

Constanze3 · 2025-06-11T16:43:21Z

bevy_editor_panes/bevy_3d_viewport/src/outline_gizmo.rs

+    }
+}
+
+// Marker component for selected entities


There already is a SelectedEntity resource defined in bevy_editor_core, you should not define your own component.

done - i've added bevy_editor_core to the cargo.toml for bevy_3d_viewport

Constanze3 · 2025-06-11T16:44:27Z

bevy_editor_panes/bevy_3d_viewport/src/outline_gizmo.rs

+                top: Val::Px(20.0),
+                right: Val::Px(20.0),
+                width: Val::Px(150.0),
+                height: Val::Px(15.0),


The height of this button is smaller than the text inside which is not very pleasing to look at.

yes, i've fixed thisi by making the font smaller for now

Constanze3 · 2025-06-11T16:45:19Z

bevy_editor_panes/bevy_3d_viewport/src/outline_gizmo.rs

+    }
+}
+
+pub fn spawn_gizmo_toggle_ui(mut commands: Commands) {


This should be only a temporary solution, it would be better to have a menu to manage which gizmo types are visible just like other game engines.

i agree with this - but beyond the scope of this PR. I just wanted to add something quick and dirty to show that we can add the outlines

Constanze3 · 2025-06-11T16:46:02Z

crates/bevy_editor/src/lib.rs

-        project::update_project_info();
-
+        // project::update_project_info();
+        println!("Loading Bevy Editor");


You should rather use info!.

Constanze3 · 2025-06-11T16:46:48Z

crates/bevy_editor/src/lib.rs

-        },
-        Transform::default().looking_to(Vec3::NEG_ONE, Vec3::Y),
-    ));
+fn load_example_scene(mut commands: Commands, asset_server: Res<AssetServer>) {


This will crash the editor when it is not run as the example. This should be somehow integrated into the example code instead.

yes, i've removed this for now

Constanze3 · 2025-06-11T17:14:45Z

crates/bevy_editor_launcher/assets/example/scene.scn.ron

This is an invalid scene!

i've removed loading this for now

…ctedEntity struct, remove example scene loading, and fix "Show Outlines" button

jbuehler23 · 2025-06-12T05:55:48Z

@Constanze3 Thanks for the constructive review! This was so helpful, and I've made those changes you've recommended. I've also removed the example scene loading for now, until we come up with a more elegant solution.

Constanze3 · 2025-06-12T07:45:15Z

crates/bevy_editor/src/lib.rs

@@ -46,8 +46,8 @@ pub struct EditorPlugin;
 impl Plugin for EditorPlugin {
    fn build(&self, bevy_app: &mut BevyApp) {
        // Update/register this project to the editor project list
-        project::update_project_info();
-
+        // project::update_project_info();


Was this commented out intentionally?

oh strange, that must've been an accident on my end - apols

Constanze3 · 2025-06-12T07:48:15Z

crates/bevy_editor_core/src/lib.rs

@@ -14,7 +14,7 @@ impl Plugin for EditorCorePlugin {
 }

 /// The currently selected entity in the scene.
-#[derive(Resource, Default, Reflect)]
+#[derive(Component, Resource, Default, Reflect)]


This is not how you should do this. This should not be a component.

Instead in your gizmo system you should have a query: Query<&Transform> and also grab selected_entity: Res<SelectedEntity> and then use query.get(selected_entity.0) to get the transform of the selected entity.

Done! Thanks for the tip

…te gizmo color logic - also reverts Component derive from SelectedEntity

jbuehler23 added 2 commits June 3, 2025 19:44

Add OutlineGizmoPlugin and integrate outline gizmo functionality

824a3dc

cargo format

f8dcb80

alice-i-cecile reviewed Jun 4, 2025

View reviewed changes

alice-i-cecile added the C-Feature Make something new possible label Jun 4, 2025

jbuehler23 added this to the Stage 1 (Standalone Read-Only Editor) milestone Jun 6, 2025

jbuehler23 added the S-Needs-Investigation This issue requires detective work to figure out what's going wrong label Jun 6, 2025

jbuehler23 added 3 commits June 6, 2025 20:24

Refactor outline gizmo UI spawning and update plugin system integration

de5a01d

Remove unused function import from outline_gizmo in 3D viewport module

84b4a1b

Merge branch 'main' into add-ui-outlines

5c35ea9

jbuehler23 added 4 commits June 9, 2025 14:41

Refactor outline_gizmo system setup and add example scene asset

4190c0b

Add debug print statements in View Gizmo and Bevy Editor setup

f4521b6

Replace println! with info! for better logging in outline_gizmo, view…

39a025d

…_gizmo, and lib modules

Adjust UI layout in spawn_gizmo_toggle_ui and add example scene asset

4d84a97

also add documentation about compiling the editor locally and running with local changes

Merge branch 'main' into add-ui-outlines

886bf9b

jbuehler23 linked an issue Jun 11, 2025 that may be closed by this pull request

Document run steps to get editor changes built and compiled locally #207

Closed

jbuehler23 added 2 commits June 11, 2025 17:00

Remove VSCode launch configuration file

a74f54a

Merge branch 'add-ui-outlines' of https://github.com/bevyengine/bevy_…

cb5a7f5

…editor_prototypes into add-ui-outlines

Constanze3 suggested changes Jun 11, 2025

View reviewed changes

Constanze3 reviewed Jun 11, 2025

View reviewed changes

alice-i-cecile added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Needs-Investigation This issue requires detective work to figure out what's going wrong labels Jun 12, 2025

jbuehler23 added 2 commits June 12, 2025 06:53

Add missing workspace dependency for bevy_editor_core and update Sele…

d13350f

…ctedEntity struct, remove example scene loading, and fix "Show Outlines" button

Merge branch 'main' into add-ui-outlines

695b242

Remove unused import of TextStyles in outline_gizmo.rs

51e864b

Constanze3 suggested changes Jun 12, 2025

View reviewed changes

Refactor outline_gizmo_system to use SelectedEntity resource and upda…

77c8721

…te gizmo color logic - also reverts Component derive from SelectedEntity

Constanze3 approved these changes Jun 12, 2025

View reviewed changes

jbuehler23 added S-Ready-For-Final-Review This PR is ready to be merged. Go for it! and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Jun 12, 2025

jbuehler23 added this pull request to the merge queue Jun 12, 2025

Merged via the queue into main with commit 5dcfd5e Jun 12, 2025
6 checks passed

Add OutlineGizmoPlugin and integrate outline gizmo functionality #195

Add OutlineGizmoPlugin and integrate outline gizmo functionality #195

Uh oh!

Conversation

jbuehler23 commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

jbuehler23 commented Jun 4, 2025

Uh oh!

alice-i-cecile commented Jun 8, 2025

Uh oh!

jbuehler23 commented Jun 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jbuehler23 commented Jun 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jbuehler23 commented Jun 3, 2025 •

edited

Loading