[Merged by Bors] - Add 3d shapes example #4613

rparrett · 2022-04-27T14:57:10Z

Objective

As requested here: [Merged by Bors] - Fix torus normals #4520 (comment)
Make it easier to spot issues with built-in shapes

Solution

3d_shapes_proc_sm.mp4

Add an example showcasing the built-in 3d shapes with lighting/shadows
Rotate objects in such a way that all faces are seen by the camera
Add a UV debug texture

Discussion

I'm not sure if this is what @alice-i-cecile had in mind, but I adapted the little "torus playground" from the issue linked above to include all built-in shapes.

This exact arrangement might not be particularly scalable if many more shapes are added. Maybe a slow camera pan, or cycling with the keyboard or on a timer, or a sidebar with buttons would work better. If one of the latter options is used, options for showing wireframes or computed flat normals might add some additional utility.

Ideally, I think we'd have a better way of visualizing normals.

Happy to rework this or close it if there's not a consensus around it being useful.

DJMcNab · 2022-04-27T15:00:58Z

Is it possible/feasible to generate the uv_debug texture programmatically?

151kB isn't bad, but it's best not to add more 'large textures' to the git history if we can avoid it.

That being said, we have all of https://github.com/bevyengine/bevy/tree/328c26d02c50de0bc77f0d24a376f43ba89517b1/assets/models/FlightHelmet, so maybe that ship has sailed?

rparrett · 2022-04-27T15:15:33Z

Is it possible/feasible to generate the uv_debug texture programmatically?

151kB isn't bad, but it's best not to add more 'large textures' to the git history if we can avoid it.

That being said, we have all of https://github.com/bevyengine/bevy/tree/328c26d02c50de0bc77f0d24a376f43ba89517b1/assets/models/FlightHelmet, so maybe that ship has sailed?

Good point. I processed the texture with tinypng and it ended up at 39k. But I'd also prefer not to add textures to the repo. At the very least, a 512x512 version would probably be just as functional.

alice-i-cecile · 2022-04-27T16:57:44Z

This is exactly what I had in mind, thank you! I would also prefer if we can generate the textures programmatically, but if it's only a single reused texture it's not as bad as I was initially concerned.

This is also quite nice as a learning example: it's simple, idiomatic code that showcases the different shapes and basics of 3D.

examples/README.md

alice-i-cecile · 2022-04-27T20:08:28Z

Could you update the PR description with a fresh clip of the example with the new texture?

rparrett · 2022-04-27T20:25:49Z

I replaced the texture with generated pattern that's equivalent to the previous texture without the text, arrows, and small grid.

Could you update the PR description with a fresh clip of the example with the new texture?

Done.

Nilirad · 2022-04-27T20:42:28Z

It would be actually useful to have a in-engine, procedurally generated placeholder texture for 3D meshes. Many engines do that for missing textures.

alice-i-cecile · 2022-04-27T21:54:42Z

It would be actually useful to have a in-engine, procedurally generated placeholder texture for 3D meshes. Many engines do that for missing textures.

Agreed. Maybe we should move your texture snippet into one of our rendering crates, and then just use the public API?

Nilirad

Some opinions:

I think it's better to rename the example to 3d_shapes, since in future we'll probably also have an example for 2D shapes.
It should have a doc comment at the top briefly describing the example as specified in Module-style doc strings for examples #3951
A doc comment specifying the role of the Shape component wouldn't be bad.

examples/README.md

examples/3d/shapes.rs

rparrett · 2022-04-28T13:56:11Z

Agreed. Maybe we should move your texture snippet into one of our rendering crates, and then just use the public API?

I'm a bit hesitant to push this PR that far into "non-triviality" but I'd be pretty excited to work on procedural debug textures with some guidance from folks who have a better idea of

Where that code should live
What sorts of simple texture(s) would actually be useful

I think it's better to rename the example to 3d_shapes, since in future we'll probably also have an example for 2D shapes.

Sounds good to me if others are on board.

alice-i-cecile · 2022-04-28T18:08:07Z

I like the example rename for sure :)

I think we should move forward with the current approach to texturing now, and then create a new issue for debug textures, noting that we should migrate the texture found in this example to there.

Nilirad

Just an optional nitpick on the filename. In any case, I approve.

Nilirad · 2022-05-01T10:38:20Z

Cargo.toml

@@ -200,6 +200,10 @@ path = "examples/3d/pbr.rs"
 name = "shadow_biases"
 path = "examples/3d/shadow_biases.rs"

+[[example]]
+name = "3d_shapes"
+path = "examples/3d/shapes.rs"


Suggested change

path = "examples/3d/shapes.rs"

path = "examples/3d/3d_shapes.rs"

The problem with this is that if a user sees in the file tree shapes.rs thinks that the example name is shapes.

Remember to rename the file and change the reference to the README if you accept this.

alice-i-cecile · 2022-05-02T11:59:30Z

bors r+

@alice-i-cecile

# Objective - As requested here: #4520 (comment) - Make it easier to spot issues with built-in shapes ## Solution https://user-images.githubusercontent.com/200550/165624709-c40dfe7e-0e1e-4bd3-ae52-8ae66888c171.mp4 - Add an example showcasing the built-in 3d shapes with lighting/shadows - Rotate objects in such a way that all faces are seen by the camera - Add a UV debug texture ## Discussion I'm not sure if this is what @alice-i-cecile had in mind, but I adapted the little "torus playground" from the issue linked above to include all built-in shapes. This exact arrangement might not be particularly scalable if many more shapes are added. Maybe a slow camera pan, or cycling with the keyboard or on a timer, or a sidebar with buttons would work better. If one of the latter options is used, options for showing wireframes or computed flat normals might add some additional utility. Ideally, I think we'd have a better way of visualizing normals. Happy to rework this or close it if there's not a consensus around it being useful.

bors · 2022-05-02T12:21:55Z

This PR was included in a batch that was canceled, it will be automatically retried

@alice-i-cecile

# Objective - As requested here: #4520 (comment) - Make it easier to spot issues with built-in shapes ## Solution https://user-images.githubusercontent.com/200550/165624709-c40dfe7e-0e1e-4bd3-ae52-8ae66888c171.mp4 - Add an example showcasing the built-in 3d shapes with lighting/shadows - Rotate objects in such a way that all faces are seen by the camera - Add a UV debug texture ## Discussion I'm not sure if this is what @alice-i-cecile had in mind, but I adapted the little "torus playground" from the issue linked above to include all built-in shapes. This exact arrangement might not be particularly scalable if many more shapes are added. Maybe a slow camera pan, or cycling with the keyboard or on a timer, or a sidebar with buttons would work better. If one of the latter options is used, options for showing wireframes or computed flat normals might add some additional utility. Ideally, I think we'd have a better way of visualizing normals. Happy to rework this or close it if there's not a consensus around it being useful.

bors · 2022-05-02T12:41:32Z

Build failed (retrying...):

build (stable, macos-latest)

@alice-i-cecile

# Objective - As requested here: #4520 (comment) - Make it easier to spot issues with built-in shapes ## Solution https://user-images.githubusercontent.com/200550/165624709-c40dfe7e-0e1e-4bd3-ae52-8ae66888c171.mp4 - Add an example showcasing the built-in 3d shapes with lighting/shadows - Rotate objects in such a way that all faces are seen by the camera - Add a UV debug texture ## Discussion I'm not sure if this is what @alice-i-cecile had in mind, but I adapted the little "torus playground" from the issue linked above to include all built-in shapes. This exact arrangement might not be particularly scalable if many more shapes are added. Maybe a slow camera pan, or cycling with the keyboard or on a timer, or a sidebar with buttons would work better. If one of the latter options is used, options for showing wireframes or computed flat normals might add some additional utility. Ideally, I think we'd have a better way of visualizing normals. Happy to rework this or close it if there's not a consensus around it being useful.

bors · 2022-05-02T13:58:14Z

Pull request successfully merged into main.

Build succeeded:

@alice-i-cecile

# Objective - As requested here: bevyengine#4520 (comment) - Make it easier to spot issues with built-in shapes ## Solution https://user-images.githubusercontent.com/200550/165624709-c40dfe7e-0e1e-4bd3-ae52-8ae66888c171.mp4 - Add an example showcasing the built-in 3d shapes with lighting/shadows - Rotate objects in such a way that all faces are seen by the camera - Add a UV debug texture ## Discussion I'm not sure if this is what @alice-i-cecile had in mind, but I adapted the little "torus playground" from the issue linked above to include all built-in shapes. This exact arrangement might not be particularly scalable if many more shapes are added. Maybe a slow camera pan, or cycling with the keyboard or on a timer, or a sidebar with buttons would work better. If one of the latter options is used, options for showing wireframes or computed flat normals might add some additional utility. Ideally, I think we'd have a better way of visualizing normals. Happy to rework this or close it if there's not a consensus around it being useful.

@Nilirad

# Objective I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency. Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list because the names are very prominent. This also helps out when fuzzy-searching the codebase for these files. ## Solution Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example. ## Notes @Nilirad proposed this in #4613 (comment) but it had slipped away from my brain at that time.

@Nilirad

# Objective I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency. Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list because the names are very prominent. This also helps out when fuzzy-searching the codebase for these files. ## Solution Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example. ## Notes @Nilirad proposed this in #4613 (comment) but it had slipped away from my brain at that time.

@Nilirad

# Objective I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency. Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list because the names are very prominent. This also helps out when fuzzy-searching the codebase for these files. ## Solution Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example. ## Notes @Nilirad proposed this in #4613 (comment) but it had slipped away from my brain at that time.

@Nilirad

# Objective I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency. Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list because the names are very prominent. This also helps out when fuzzy-searching the codebase for these files. ## Solution Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example. ## Notes @Nilirad proposed this in bevyengine#4613 (comment) but it had slipped away from my brain at that time.

@Nilirad

# Objective I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency. Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list because the names are very prominent. This also helps out when fuzzy-searching the codebase for these files. ## Solution Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example. ## Notes @Nilirad proposed this in bevyengine#4613 (comment) but it had slipped away from my brain at that time.

@Nilirad

# Objective I was about to submit a PR to add these two examples to `bevy-website` and re-discovered the inconsistency. Although it's not a major issue on the website where only the filenames are shown, this would help to visually distinguish the two examples in the list because the names are very prominent. This also helps out when fuzzy-searching the codebase for these files. ## Solution Rename `shapes` to `2d_shapes`. Now the filename matches the example name, and the naming structure matches the 3d example. ## Notes @Nilirad proposed this in bevyengine#4613 (comment) but it had slipped away from my brain at that time.

@alice-i-cecile

# Objective - As requested here: bevyengine#4520 (comment) - Make it easier to spot issues with built-in shapes ## Solution https://user-images.githubusercontent.com/200550/165624709-c40dfe7e-0e1e-4bd3-ae52-8ae66888c171.mp4 - Add an example showcasing the built-in 3d shapes with lighting/shadows - Rotate objects in such a way that all faces are seen by the camera - Add a UV debug texture ## Discussion I'm not sure if this is what @alice-i-cecile had in mind, but I adapted the little "torus playground" from the issue linked above to include all built-in shapes. This exact arrangement might not be particularly scalable if many more shapes are added. Maybe a slow camera pan, or cycling with the keyboard or on a timer, or a sidebar with buttons would work better. If one of the latter options is used, options for showing wireframes or computed flat normals might add some additional utility. Ideally, I think we'd have a better way of visualizing normals. Happy to rework this or close it if there's not a consensus around it being useful.

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

rparrett added 2 commits April 27, 2022 08:10

Add 3d shapes example

7df6f69

Add shapes example to README

ac22413

rparrett force-pushed the 3d-shapes-example branch from a462f9b to ac22413 Compare April 27, 2022 15:13

mockersf added C-Examples An addition or correction to our examples and removed S-Needs-Triage This issue needs to be labelled labels Apr 27, 2022

alice-i-cecile added the A-Rendering Drawing game state to the screen label Apr 27, 2022

alice-i-cecile reviewed Apr 27, 2022

View reviewed changes

examples/README.md Outdated Show resolved Hide resolved

rparrett force-pushed the 3d-shapes-example branch from 530b13e to 6c63573 Compare April 27, 2022 20:02

Ditch the texture

be509bd

rparrett force-pushed the 3d-shapes-example branch from 6c63573 to be509bd Compare April 27, 2022 20:03

Clippy

aa0baa9

Nilirad reviewed Apr 28, 2022

View reviewed changes

examples/README.md Outdated Show resolved Hide resolved

rparrett added 2 commits April 28, 2022 06:29

Re-adjust example description

1c9c069

Add some comments

9737886

Nilirad reviewed Apr 28, 2022

View reviewed changes

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

Fix non-doc comment that should be doc comment

df0d47c

Use less potentially ambiguous example name

d848ba7

alice-i-cecile approved these changes Apr 28, 2022

View reviewed changes

Nilirad mentioned this pull request May 1, 2022

Placeholder textures #4637

Open

Nilirad approved these changes May 1, 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 1, 2022

bors bot changed the title ~~Add 3d shapes example~~ [Merged by Bors] - Add 3d shapes example May 2, 2022

bors bot closed this May 2, 2022

rparrett mentioned this pull request Sep 24, 2022

[Merged by Bors] - Rename shapes examples for consistency #6082

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - Add 3d shapes example #4613

[Merged by Bors] - Add 3d shapes example #4613

rparrett commented Apr 27, 2022 •

edited

Loading

DJMcNab commented Apr 27, 2022

rparrett commented Apr 27, 2022 •

edited

Loading

alice-i-cecile commented Apr 27, 2022 •

edited

Loading

alice-i-cecile commented Apr 27, 2022

rparrett commented Apr 27, 2022

Nilirad commented Apr 27, 2022

alice-i-cecile commented Apr 27, 2022

Nilirad left a comment •

edited

Loading

rparrett commented Apr 28, 2022 •

edited

Loading

alice-i-cecile commented Apr 28, 2022

Nilirad left a comment

Nilirad May 1, 2022

alice-i-cecile commented May 2, 2022

bors bot commented May 2, 2022

bors bot commented May 2, 2022

bors bot commented May 2, 2022

	path = "examples/3d/shapes.rs"
	path = "examples/3d/3d_shapes.rs"

[Merged by Bors] - Add 3d shapes example #4613

[Merged by Bors] - Add 3d shapes example #4613

Conversation

rparrett commented Apr 27, 2022 • edited Loading

Objective

Solution

Discussion

DJMcNab commented Apr 27, 2022

rparrett commented Apr 27, 2022 • edited Loading

alice-i-cecile commented Apr 27, 2022 • edited Loading

alice-i-cecile commented Apr 27, 2022

rparrett commented Apr 27, 2022

Nilirad commented Apr 27, 2022

alice-i-cecile commented Apr 27, 2022

Nilirad left a comment • edited Loading

Choose a reason for hiding this comment

rparrett commented Apr 28, 2022 • edited Loading

alice-i-cecile commented Apr 28, 2022

Nilirad left a comment

Choose a reason for hiding this comment

Nilirad May 1, 2022

Choose a reason for hiding this comment

alice-i-cecile commented May 2, 2022

bors bot commented May 2, 2022

bors bot commented May 2, 2022

bors bot commented May 2, 2022

rparrett commented Apr 27, 2022 •

edited

Loading

rparrett commented Apr 27, 2022 •

edited

Loading

alice-i-cecile commented Apr 27, 2022 •

edited

Loading

Nilirad left a comment •

edited

Loading

rparrett commented Apr 28, 2022 •

edited

Loading