Align Scene::write_to_world_with to match DynamicScene::write_to_world_with
#13714
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alice-i-cecile
approved these changes
Jun 6, 2024
alice-i-cecile
added
C-Code-Quality
|
It looks like your PR is a breaking change, but you didn't provide a migration guide. Could you add some context on what users should update when this change get released in a new version of Bevy? |
|
At some point it might make sense to use a trait to capture the API of these two types like we do in bevy_color: their type signatures should generally line up. |
alice-i-cecile
added
S-Needs-Review
…into scene-write-to-world
|
@alice-i-cecile Any chance this makes it for 0.14? Or are things locked in place with the release candidate out now? |
|
If you can convince others that this is relatively important, we will be able to cherrypick this up until 0.14.0 itself is released. |
NthTensor
approved these changes
Jun 9, 2024
NthTensor
added
S-Ready-For-Final-Review
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 10, 2024
…orld_with` (#13714) # Objective `Scene` and `DynamicScene` work with `InstanceInfo` at different levels of abstraction - `Scene::write_to_world_with` returns an `InstanceInfo` whereas `DynamicScene::write_to_world_with` returns `()`. Instances are created one level higher at the `SceneSpawner` API level. - `DynamicScene::write_to_world_with` takes the `entity_map` as an argument whereas the `Scene` version is less flexible and creates a new one for you. No reason this needs to be the case. ## Solution I propose changing `Scene::write_to_world_with` to match the API we have for `DynamicScene`. Returning the `InstanceInfo` as we do today just seems like a leaky abstraction - it's only used in `spawn_sync_internal`. Being able to pass in an entity_map gives you more flexibility with how you write entities to a world. This also moves `InstanceInfo` out of `Scene` which is cleaner conceptually. If someone wants to work with instances then they should work with `SceneSpawner` - I see `write_to_world_with` as a lower-level API to be used with exclusive world access. ## Testing Code is just shifting things around. ## Changelog Changed `Scene::write_to_world_with` to take `entity_map` as an argument and no longer return an `InstanceInfo` ## Migration Guide `Scene::write_to_world_with` no longer returns an `InstanceInfo`. Before ```rust scene.write_to_world_with(world, ®istry) ``` After ```rust let mut entity_map = EntityHashMap::default(); scene.write_to_world_with(world, &mut entity_map, ®istry) ```
|
This broke |
alice-i-cecile
pushed a commit
to alice-i-cecile/bevy
that referenced
this pull request
Jun 10, 2024
…ite_to_world_with` (bevyengine#13714)" This reverts commit 1f61c26.
alice-i-cecile
pushed a commit
to Kurble/bevy
that referenced
this pull request
Jul 15, 2024
…orld_with` (bevyengine#13855) # Objective Fixes a regression in [previously merged but then reverted pr](bevyengine#13714) that aligns lower-level `Scene` API with that in `DynamicScene`. Please look at the original pr for more details. The problem was `spawn_sync_internal` is used in `spawn_queued_scenes`. Since instance creation was moved up a level we need to make sure we add a specific instance to `SceneSpawner::spawned_instances` when using `spawn_sync_internal` (just like we do for `DynamicScene`). Please look at the last commit when reviewing. ## Testing `alien_cake_addict` and `deferred_rendering` examples look as expected. ## Changelog Changed `Scene::write_to_world_with` to take `entity_map` as an argument and no longer return an `InstanceInfo` ## Migration Guide `Scene::write_to_world_with` no longer returns an `InstanceInfo`. Before ```rust scene.write_to_world_with(world, ®istry) ``` After ```rust let mut entity_map = EntityHashMap::default(); scene.write_to_world_with(world, &mut entity_map, ®istry) ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
SceneandDynamicScenework withInstanceInfoat different levels of abstractionScene::write_to_world_withreturns anInstanceInfowhereasDynamicScene::write_to_world_withreturns(). Instances are created one level higher at theSceneSpawnerAPI level.DynamicScene::write_to_world_withtakes theentity_mapas an argument whereas theSceneversion is less flexible and creates a new one for you. No reason this needs to be the case.Solution
I propose changing
Scene::write_to_world_withto match the API we have forDynamicScene. Returning theInstanceInfoas we do today just seems like a leaky abstraction - it's only used inspawn_sync_internal. Being able to pass in an entity_map gives you more flexibility with how you write entities to a world.This also moves
InstanceInfoout ofScenewhich is cleaner conceptually. If someone wants to work with instances then they should work withSceneSpawner- I seewrite_to_world_withas a lower-level API to be used with exclusive world access.Testing
Code is just shifting things around.
Changelog
Changed
Scene::write_to_world_withto takeentity_mapas an argument and no longer return anInstanceInfoMigration Guide
Scene::write_to_world_withno longer returns anInstanceInfo.Before
After