Add per-entity colored wireframes by UberLambda · Pull Request #3677 · bevyengine/bevy

UberLambda · 2022-01-14T21:12:28Z

Objective

This branch adds per-entity-colored wireframes to WireframePlugin.
This feature is mostly useful for debugging; for instance, think of differently-colored selection wireframes in an editor.

Solution

The Wireframe component now has a color: Color field, which defaults to white.
If present, this sets the color of the wirefame for that specific entity only.
For the "global" wireframe setting, the default color can now be set in the WireframeConfig.
Wireframe colors have precedence over the WireframeConfig one.
The colors are stored in a DynamicUniformVec on GPU. They are extracted from Wireframe components (and the WireframeConfig) by a system in the RenderApp.
Finally, the wireframe sample has been modified to document these new capabilities.

crates/bevy_pbr/src/wireframe.rs

alice-i-cecile

Just a couple of nits. The examples are good, the code is clear and the functionality is lovely. Thanks!

crates/bevy_pbr/src/wireframe.rs

alice-i-cecile

Looks great. We can quibble over the pub-ness, but I'm otherwise very happy with this PR.

IceSentry · 2022-05-02T02:10:48Z

@UberLambda Could you rebase this PR, I was about to make a PR with exactly this feature. The code looks good to me, but there are conflicts.

UberLambda · 2022-05-02T11:26:55Z

@IceSentry Rebased, it seems to work + it passes tests (locally) 👀

crates/bevy_pbr/src/wireframe.rs

examples/3d/wireframe.rs

crates/bevy_pbr/src/wireframe.rs

alice-i-cecile

Left some feedback about doc comments that I'd like to see cleaned up before we merge :)

crates/bevy_pbr/src/wireframe.rs

alice-i-cecile · 2022-05-02T12:46:48Z

I like the new Option<Color> change a lot. Nice work!

examples/3d/wireframe.rs

IceSentry · 2022-05-02T14:23:12Z

About the overloaded use of global. I somewhat agree with that, but debug_wireframes doesn't feel like a better alternative. Wireframes are already a debugging tool and this name doesn't really imply that it's going to show wireframes on everything.

Maybe something like all_meshes or enable_all could be clearer about what it does.

UberLambda · 2022-05-02T14:27:51Z

About the overloaded use of global. I somewhat agree with that, but debug_wireframes doesn't feel like a better alternative. Wireframes are already a debugging tool and this name doesn't really imply that it's going to show wireframes on everything.

Maybe something like all_meshes or enable_all could be clearer about what it does.

Maybe on_all_meshes?

IceSentry · 2022-05-02T14:35:07Z

on_all_meshes is fine too

superdump

Resolve the conflicts and switch to ExtractComponentPlugin for the Wireframe component extraction and we can get this merged.

crates/bevy_pbr/src/wireframe.rs

UberLambda · 2022-05-15T20:03:57Z

Done, I think? (I did not have much time for this in the past week)

inodentry · 2022-05-16T17:30:04Z

I suggest making wireframe color a separate component from the toggle to enable/disable it. This would allow entities to specify their preferred wireframe color in general, even when wireframe is off (useful for when controlling the wireframe globally via the resource).

alice-i-cecile · 2022-05-17T03:34:04Z

I'd like to block on @inodentry's comment above. @UberLambda can you make that change when you have time? I did a full review pass on stream today and was very keen on this functionality and the quality of the work.

Separate Wireframe from WireframeColor

UberLambda · 2022-05-17T20:13:42Z

Done! (I like @inodentry's solution more than having an Optional in there, it was a bit awkward)

IceSentry · 2022-05-17T20:34:06Z

This is much better now, but next time, please make a separate commit. Rebasing is completely fine, but I would have liked seeing the diff between the previous version. Other than that, good job 👍

UberLambda · 2022-05-17T20:41:38Z

This is much better now, but next time, please make a separate commit. Rebasing is completely fine, but I would have liked seeing the diff between the previous version. Other than that, good job +1

Yeah, sorry - I had to get accustomed to the squash/rebase/squash dance lately 😅

IceSentry · 2022-07-10T02:36:04Z

@UberLambda could you rebase and fix the conflicts? Hopefully we can get this merged before 0.8

alice-i-cecile · 2022-07-10T22:51:23Z

I've spoken with the author; this needs to be adopted.

coreh · 2022-11-17T05:46:30Z

~~I can adopt this, if @UberLambda is still without bandwidth/availability to get this to the latest main.~~

~~How is this normally done? Via a new PR (since we can't push to their repo?)~~

EDIT: Duh, there's already another PR #5303. I can review it

alice-i-cecile · 2022-11-17T13:12:42Z

Closing in favor of #5303.

# Objective - Make the wireframe colors configurable at the global level and the single mesh level - Based on #5314 This video shows what happens when playing with various settings from the example https://github.com/bevyengine/bevy/assets/8348954/1ee9aee0-fab7-4da8-bc5d-8d0562bb34e6 ## Solution - Add a `color` field to the `WireframeMaterial` - Use a `WireframeColor` component to configure the color per entity - Add a `default_color` field to `WireframeConfig` for global wireframes or wireframes with no specified color. ## Notes - Most of the docs and the general idea for `WireframeColor` came from [UberLambda](https://github.com/UberLambda) in #3677 but the code ended up completely different so I created a separate branch. ~~I'm not sure how to correctly credit them on this PR.~~ (I re-created the commit but I added them as co-author in the commit message) ~~Closes #3677 ~~Closes #5301 ~~#5314 should be merged before this PR.~~

# Objective - Make the wireframe colors configurable at the global level and the single mesh level - Based on bevyengine#5314 This video shows what happens when playing with various settings from the example https://github.com/bevyengine/bevy/assets/8348954/1ee9aee0-fab7-4da8-bc5d-8d0562bb34e6 ## Solution - Add a `color` field to the `WireframeMaterial` - Use a `WireframeColor` component to configure the color per entity - Add a `default_color` field to `WireframeConfig` for global wireframes or wireframes with no specified color. ## Notes - Most of the docs and the general idea for `WireframeColor` came from [UberLambda](https://github.com/UberLambda) in bevyengine#3677 but the code ended up completely different so I created a separate branch. ~~I'm not sure how to correctly credit them on this PR.~~ (I re-created the commit but I added them as co-author in the commit message) ~~Closes bevyengine#3677 ~~Closes bevyengine#5301 ~~bevyengine#5314 should be merged before this PR.~~

github-actions bot added the S-Needs-Triage This issue needs to be labelled label Jan 14, 2022

MinerSebas reviewed Jan 14, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile added A-Rendering Drawing game state to the screen C-Feature A new feature, making something new possible C-Usability A targeted quality-of-life change that makes Bevy easier to use and removed S-Needs-Triage This issue needs to be labelled labels Jan 14, 2022

alice-i-cecile reviewed Jan 15, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile requested changes Jan 15, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile approved these changes Jan 15, 2022

View reviewed changes

alice-i-cecile approved these changes Jan 16, 2022

View reviewed changes

UberLambda force-pushed the colored_wireframe branch from 689922a to 6cbb184 Compare January 16, 2022 21:45

UberLambda force-pushed the colored_wireframe branch 2 times, most recently from de1f156 to e096e8e Compare May 2, 2022 11:26

alice-i-cecile requested a review from superdump May 2, 2022 11:37

alice-i-cecile reviewed May 2, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed May 2, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed May 2, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed May 2, 2022

View reviewed changes

examples/3d/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed May 2, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed May 2, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile requested changes May 2, 2022

View reviewed changes

alice-i-cecile reviewed May 2, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed May 2, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Show resolved Hide resolved

alice-i-cecile reviewed May 2, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Show resolved Hide resolved

alice-i-cecile reviewed May 2, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Show resolved Hide resolved

alice-i-cecile approved these changes May 2, 2022

View reviewed changes

alice-i-cecile requested a review from IceSentry May 2, 2022 12:49

IceSentry reviewed May 2, 2022

View reviewed changes

examples/3d/wireframe.rs Outdated Show resolved Hide resolved

IceSentry approved these changes May 2, 2022

View reviewed changes

alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label May 2, 2022

superdump requested changes May 5, 2022

View reviewed changes

crates/bevy_pbr/src/wireframe.rs Outdated Show resolved Hide resolved

UberLambda force-pushed the colored_wireframe branch from 299dee5 to 5e26fcb Compare May 15, 2022 19:54

alice-i-cecile removed the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label May 16, 2022

Add colored wireframes

4443213

Separate Wireframe from WireframeColor

UberLambda force-pushed the colored_wireframe branch from 5e26fcb to 4443213 Compare May 17, 2022 20:10

Fix doc

9d054e7

jack1232 mentioned this pull request May 21, 2022

wireframe not shown on the back of a surface #4819

Open

alice-i-cecile added the S-Adopt-Me The original PR author has no intent to complete this work. Pick me up! label Jul 10, 2022

IceSentry mentioned this pull request Jul 13, 2022

Configurable colors for wireframe #5303

Merged

alice-i-cecile closed this Nov 17, 2022

Uh oh!

Conversation

UberLambda commented Jan 14, 2022

Objective

Solution

Uh oh!

Uh oh!

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

IceSentry commented May 2, 2022

Uh oh!

UberLambda commented May 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alice-i-cecile commented May 2, 2022

Uh oh!

Uh oh!

IceSentry commented May 2, 2022

Uh oh!

UberLambda commented May 2, 2022

Uh oh!

IceSentry commented May 2, 2022

Uh oh!

superdump left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

UberLambda commented May 15, 2022

Uh oh!

inodentry commented May 16, 2022

Uh oh!

alice-i-cecile commented May 17, 2022

Uh oh!

UberLambda commented May 17, 2022

Uh oh!

IceSentry commented May 17, 2022

Uh oh!

UberLambda commented May 17, 2022

Uh oh!

IceSentry commented Jul 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alice-i-cecile commented Jul 10, 2022

Uh oh!

coreh commented Nov 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alice-i-cecile commented Nov 17, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

UberLambda commented May 2, 2022 •

edited

Loading

IceSentry commented Jul 10, 2022 •

edited

Loading

coreh commented Nov 17, 2022 •

edited

Loading