Implement methods to list all components and all resources (Rebase of PR #3012) #4955

KevinKeyser · 2022-06-07T04:14:15Z

Objective

Take over and Rebase Pull Request Implement methods to list all components and all resources #3012
- Fixes Simple methods to list all components and all resources #3007
- Simplify debugging by allowing iteration over all Components and Resources registered in a World.

Solution

Rename Components into WorldData to reflect that it stores metadata both on Components and Resources. Also rename ComponentId to DataId, ComponentInfo to DataInfo and ComponentDescriptor to DataDescriptor
implement IntoIterator for WorldData to iterate over all components and resources
create a new Components system descriptor and implement IntoIterator to iterate over all components
create a new Resources system descriptor and implement IntoIterator to iterate over all resources

Changelog

struct ComponentId -> struct DataId
struct Components -> struct WorldData
- Components::components -> WorldData::data
struct ComponentInfo -> struct DataInfo
struct ComponentDescriptor -> struct DataDescriptor

This allows iteration over all `Component`s registered in a world by implementing `IntoIterator` for the `Components` type.

the Components struct was not just storing metadata on components, but also on resources. WorldData is a new umbrella term for components and resources. also rename the following: `ComponentId` -> `DataId` `ComponentInfo` -> `DataInfo` `ComponentDescriptor` -> `DataDescriptor`

These can be used in systems to get an overview over all available Components and Resources.

Co-authored-by: MinerSebas <[email protected]>

alice-i-cecile · 2022-06-07T04:19:41Z

My instinct is that we should merge #4809 first, which should simplify the implementation here significantly. @james7132, are you in agreement?

jakobhellermann · 2022-06-07T07:04:47Z

For what it's worth you can iterate over all component infos already:

bevy/crates/bevy_ecs/src/component.rs

Line 401 in 7317473

pub fn iter(&self) -> impl Iterator<Item = &ComponentInfo> + '_ {

(it will include both components and resources).

To find all resource component IDs you can just the components in the resource archetype, something like world.archetypes().resource().components().

targrub · 2022-10-08T16:16:34Z

@KevinKeyser Is this a dead PR at this point?

alice-i-cecile

I like the ComponentId -> DataId change: I think it's genuinely correct and clearer. Resources having a ComponentId is always baffling. However it makes this PR much harder to review, and should be its own PR.

alice-i-cecile · 2023-01-08T21:26:51Z

crates/bevy_ecs/src/system/mod.rs

+    fn iterate_resources() {
+        let mut world = World::default();
+        world.insert_resource(Vec::<String>::new());
+        world.insert_resource(42usize);


These will have to be redone to account for the opt-in Resource trait.

alice-i-cecile · 2023-01-08T21:27:30Z

crates/bevy_ecs/src/system/mod.rs

+    }
+
+    #[test]
+    fn remove_tracking() {


Suggested change

fn remove_tracking() {

fn removal_tracking() {

Just to reduce diff noise.

alice-i-cecile

This is quite nice: I really like how much clearer DataId and WorldData are. If you rebase this and get CI passing I'd be happy to see this merged basically as is.

alice-i-cecile · 2023-09-11T15:58:27Z

@KevinKeyser I still really like this work, but at this point it's going to be easier to remake this PR than to solve merge conflicts. I'm going to Adopt-Me to this PR, but feel free to adopt it yourself if you'd like!

Adamkob12 · 2024-02-06T20:39:17Z

I'd like to pick this up soon.

AustinHellerRepo · 2024-03-30T22:38:06Z

crates/bevy_ecs/src/system/system_param.rs


 /// The [`SystemParamState`] of [`Components`].
 #[doc(hidden)]
 pub struct ComponentsState;

 // SAFE: no component value access
-unsafe impl SystemParamState for ComponentsState {
+unsafe impl<'a> SystemParamState for ComponentsState {


Probably trivial, but is this explicit lifetime required?

AustinHellerRepo · 2024-03-30T22:43:21Z

crates/bevy_ecs/src/world/mod.rs

-            };
+        let component_id = if let Some(component_id) = self.data.get_resource_id(TypeId::of::<R>())
+        {
+            component_id


Should this be resource_id or data_id (as well as in other related functions)?

AustinHellerRepo · 2024-03-30T22:54:10Z

I'm hoping that this PR will help permit me to more easily serialize specific components (when I only have the name) of an entity as well as overwrite the state of a component by deserializing a previous state's String into the component.
If this is now possible with these changes, would it be possible to get a unit test or example included in this PR?
If that is out of scope for these changes, any help with this task would be greatly appreciated. Thank you.

Edit: I can get a Ptr to the component, but it might be a type that contain pointers to the heap (with data that I also want to serialize). I'm hoping that there's a way to apply the TypeId and Ptr with serde (or by some other means) in such a way that I can get back all of the data pertaining to the component. I also need to be able to do the reverse to overwrite the component state.

alice-i-cecile · 2024-03-31T12:46:57Z

@matiqo15, this seems really useful for bevyengine/rfcs#77. Perhaps we should re-adopt it and get the basic form merged?

matiqo15 · 2024-03-31T13:44:42Z

@matiqo15, this seems really useful for bevyengine/rfcs#77. Perhaps we should re-adopt it and get the basic form merged?

Agree, this could help a lot

# Objective - Closes #12019 - Related to #4955 - Useful for dev_tools and networking ## Solution - Create `World::iter_resources()` and `World::iter_resources_mut()` --------- Co-authored-by: Alice Cecile <[email protected]> Co-authored-by: James Liu <[email protected]> Co-authored-by: Pablo Reinhardt <[email protected]>

# Objective - Closes bevyengine#12019 - Related to bevyengine#4955 - Useful for dev_tools and networking ## Solution - Create `World::iter_resources()` and `World::iter_resources_mut()` --------- Co-authored-by: Alice Cecile <[email protected]> Co-authored-by: James Liu <[email protected]> Co-authored-by: Pablo Reinhardt <[email protected]>

VitalyAnkh · 2024-09-20T09:24:32Z

@alice-i-cecile Now that #12829 has been merged, is this PR still necessary?

alice-i-cecile · 2024-09-20T14:57:41Z

It would still be nice to have something like this for components, but I'm going to close this out regardless.

sseemayer and others added 9 commits June 6, 2022 15:17

impl<'c> IntoIterator for &'c Components

301440f

This allows iteration over all `Component`s registered in a world by implementing `IntoIterator` for the `Components` type.

Update WorldData test to also show Resource iteration

b87682b

Implement Components and Resources system parameters

7822f25

These can be used in systems to get an overview over all available Components and Resources.

fix lints

ad0528b

Update crates/bevy_ecs/macros/src/lib.rs

1c44443

Co-authored-by: MinerSebas <[email protected]>

Fix CI lint validation

1da2b76

Fix CI doc validation

97aa088

Fix documentation

01d1420

alice-i-cecile mentioned this pull request Jun 7, 2022

[Merged by Bors] - Extract Resources into their own dedicated storage #4809

Closed

alice-i-cecile added A-ECS Entities, components, systems, and events C-Usability A targeted quality-of-life change that makes Bevy easier to use labels Jun 7, 2022

alice-i-cecile mentioned this pull request Jun 7, 2022

Implement methods to list all components and all resources #3012

Closed

4 tasks

Add WorldData.iter() back in as an alternative to into_iter()

85a59d9

alice-i-cecile requested changes Oct 10, 2022

View reviewed changes

james7132 self-requested a review October 19, 2022 09:20

alice-i-cecile reviewed Jan 8, 2023

View reviewed changes

alice-i-cecile approved these changes Jan 8, 2023

View reviewed changes

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

Adamkob12 mentioned this pull request Feb 7, 2024

Rename many types to better reflect their usability (in the context of Components and Resources) #11772

Closed

1 task

coreh mentioned this pull request Feb 21, 2024

Add World::iter_resources() and World::iter_resources_mut() methods #12019

Closed

AustinHellerRepo reviewed Mar 30, 2024

View reviewed changes

matiqo15 mentioned this pull request Apr 1, 2024

Add methods iter_resources and iter_resources_mut #12829

Merged

alice-i-cecile closed this Sep 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement methods to list all components and all resources (Rebase of PR #3012) #4955

Implement methods to list all components and all resources (Rebase of PR #3012) #4955

KevinKeyser commented Jun 7, 2022

alice-i-cecile commented Jun 7, 2022

jakobhellermann commented Jun 7, 2022

targrub commented Oct 8, 2022

alice-i-cecile left a comment •

edited

Loading

alice-i-cecile Jan 8, 2023

alice-i-cecile Jan 8, 2023

alice-i-cecile left a comment

alice-i-cecile commented Sep 11, 2023

Adamkob12 commented Feb 6, 2024

AustinHellerRepo Mar 30, 2024

AustinHellerRepo Mar 30, 2024 •

edited

Loading

AustinHellerRepo commented Mar 30, 2024 •

edited

Loading

alice-i-cecile commented Mar 31, 2024

matiqo15 commented Mar 31, 2024

VitalyAnkh commented Sep 20, 2024

alice-i-cecile commented Sep 20, 2024

Implement methods to list all components and all resources (Rebase of PR #3012) #4955

Implement methods to list all components and all resources (Rebase of PR #3012) #4955

Conversation

KevinKeyser commented Jun 7, 2022

Objective

Solution

Changelog

alice-i-cecile commented Jun 7, 2022

jakobhellermann commented Jun 7, 2022

targrub commented Oct 8, 2022

alice-i-cecile left a comment • edited Loading

Choose a reason for hiding this comment

alice-i-cecile Jan 8, 2023

Choose a reason for hiding this comment

alice-i-cecile Jan 8, 2023

Choose a reason for hiding this comment

alice-i-cecile left a comment

Choose a reason for hiding this comment

alice-i-cecile commented Sep 11, 2023

Adamkob12 commented Feb 6, 2024

AustinHellerRepo Mar 30, 2024

Choose a reason for hiding this comment

AustinHellerRepo Mar 30, 2024 • edited Loading

Choose a reason for hiding this comment

AustinHellerRepo commented Mar 30, 2024 • edited Loading

alice-i-cecile commented Mar 31, 2024

matiqo15 commented Mar 31, 2024

VitalyAnkh commented Sep 20, 2024

alice-i-cecile commented Sep 20, 2024

alice-i-cecile left a comment •

edited

Loading

AustinHellerRepo Mar 30, 2024 •

edited

Loading

AustinHellerRepo commented Mar 30, 2024 •

edited

Loading