[Merged by Bors] - bevy_scene: Stabilize entity order in DynamicSceneBuilder
#6382
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
MrGVSV
added
C-Usability
mockersf
approved these changes
Oct 26, 2022
Good point! However, my one question with that is: do we want entities to be ordered by ID or by insertion? I feel like insertion might be nicer since you could give it two entities tied to particular data or relationship, and get the same result— regardless of which one happened to spawn first. Although, for large groups of entities where order doesn't really matter, I suppose ordering by ID makes the output a little more readable (entity 1 always comes after entity 0)? Any thoughts on this? |
|
My feeling is that by ID is simpler and more repeatable. It also serves as a nice little checksum. |
Makes sense. I'll push the Otherwise, this should be good to go! |
MrGVSV
force-pushed
the
scene-stable-entity-order
branch
from
aa7ce23 to
b7fb9aa
Compare
alice-i-cecile
added
the
S-Ready-For-Final-Review
bors bot
pushed a commit
that referenced
this pull request
Oct 27, 2022
# Objective Currently, `DynamicSceneBuilder` keeps track of entities via a `HashMap`. This has an unintended side-effect in that, when building the full `DynamicScene`, we aren't guaranteed any particular order. In other words, inserting Entity A then Entity B can result in either `[A, B]` or `[B, A]`. This can be rather annoying when running tests on scenes generated via the builder as it will work sometimes but not other times. There's also the potential that this might unnecessarily clutter up VCS diffs for scene files (assuming they had an intentional order). ## Solution Store `DynamicSceneBuilder`'s entities in a `Vec` rather than a `HashMap`. --- ## Changelog * Stablized entity order in `DynamicSceneBuilder` (0.9.0-dev)
bors
bot
changed the title
DynamicSceneBuilderDynamicSceneBuilder
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Oct 28, 2022
…ne#6382) # Objective Currently, `DynamicSceneBuilder` keeps track of entities via a `HashMap`. This has an unintended side-effect in that, when building the full `DynamicScene`, we aren't guaranteed any particular order. In other words, inserting Entity A then Entity B can result in either `[A, B]` or `[B, A]`. This can be rather annoying when running tests on scenes generated via the builder as it will work sometimes but not other times. There's also the potential that this might unnecessarily clutter up VCS diffs for scene files (assuming they had an intentional order). ## Solution Store `DynamicSceneBuilder`'s entities in a `Vec` rather than a `HashMap`. --- ## Changelog * Stablized entity order in `DynamicSceneBuilder` (0.9.0-dev)
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
…ne#6382) # Objective Currently, `DynamicSceneBuilder` keeps track of entities via a `HashMap`. This has an unintended side-effect in that, when building the full `DynamicScene`, we aren't guaranteed any particular order. In other words, inserting Entity A then Entity B can result in either `[A, B]` or `[B, A]`. This can be rather annoying when running tests on scenes generated via the builder as it will work sometimes but not other times. There's also the potential that this might unnecessarily clutter up VCS diffs for scene files (assuming they had an intentional order). ## Solution Store `DynamicSceneBuilder`'s entities in a `Vec` rather than a `HashMap`. --- ## Changelog * Stablized entity order in `DynamicSceneBuilder` (0.9.0-dev)
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
Currently,
DynamicSceneBuilderkeeps track of entities via aHashMap. This has an unintended side-effect in that, when building the fullDynamicScene, we aren't guaranteed any particular order.In other words, inserting Entity A then Entity B can result in either
[A, B]or[B, A]. This can be rather annoying when running tests on scenes generated via the builder as it will work sometimes but not other times. There's also the potential that this might unnecessarily clutter up VCS diffs for scene files (assuming they had an intentional order).Solution
Store
DynamicSceneBuilder's entities in aVecrather than aHashMap.Changelog
DynamicSceneBuilder(0.9.0-dev)