forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Rename push children to add children (#15196)

Browse Source 
# Objective

- Makes naming between add_child and add_children more consistent
- Fixes #15101 

## Solution

renamed push_children to add_children

## Testing

- Did you test these changes? If so, how?
Ran tests + grep search for any instance of `push_child`

- Are there any parts that need more testing?

- How can other people (reviewers) test your changes? Is there anything
specific they need to know?

- If relevant, what platforms did you test these changes on, and are
there any important ones you can't test?
ran tests on WSL2

---

## Migration Guide

> This section is optional. If there are no breaking changes, you can
delete this section.

- If this PR is a breaking change (relative to the last release of
Bevy), describe how a user might need to migrate their code to support
these changes

rename any use of `push_children()` to the updated `add_children()`
This commit is contained in:
Taylor Neal 2024-09-17 09:16:04 +10:00 committed by GitHub
parent 522d82b21a
commit 23a77ca5eb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 79 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
crates/bevy_hierarchy/src/child_builder.rs
View File

@ -19,7 +19,7 @@ fn push_events(world: &mut World, events: impl IntoIterator<Item = HierarchyEven
/// Adds `child` to `parent`'s [`Children`], without checking if it is already present there.
///
/// This might cause unexpected results when removing duplicate children.
fn push_child_unchecked(world: &mut World, parent: Entity, child: Entity) {
fn add_child_unchecked(world: &mut World, parent: Entity, child: Entity) {
let mut parent = world.entity_mut(parent);
if let Some(mut children) = parent.get_mut::<Children>() {
children.0.push(child);
@ -161,14 +161,14 @@ fn clear_children(parent: Entity, world: &mut World) {
/// Command that adds a child to an entity.
#[derive(Debug)]
pub struct PushChild {
pub struct AddChild {
/// Parent entity to add the child to.
pub parent: Entity,
/// Child entity to add.
pub child: Entity,
}
impl Command for PushChild {
impl Command for AddChild {
fn apply(self, world: &mut World) {
world.entity_mut(self.parent).add_child(self.child);
}
@ -192,14 +192,14 @@ impl Command for InsertChildren {
/// Command that pushes children to the end of the entity's [`Children`].
#[derive(Debug)]
pub struct PushChildren {
pub struct AddChildren {
parent: Entity,
children: SmallVec<[Entity; 8]>,
}
impl Command for PushChildren {
impl Command for AddChildren {
fn apply(self, world: &mut World) {
world.entity_mut(self.parent).push_children(&self.children);
world.entity_mut(self.parent).add_children(&self.children);
}
}
@ -236,7 +236,7 @@ pub struct ReplaceChildren {
impl Command for ReplaceChildren {
fn apply(self, world: &mut World) {
clear_children(self.parent, world);
world.entity_mut(self.parent).push_children(&self.children);
world.entity_mut(self.parent).add_children(&self.children);
}
}
@ -276,7 +276,7 @@ impl Command for RemoveParent {
/// ```
pub struct ChildBuilder<'a> {
commands: Commands<'a, 'a>,
push_children: PushChildren,
add_children: AddChildren,
}
/// Trait for building children entities and adding them to a parent entity. This is used in
@ -313,18 +313,18 @@ impl ChildBuild for ChildBuilder<'_> {
fn spawn(&mut self, bundle: impl Bundle) -> EntityCommands {
let e = self.commands.spawn(bundle);
self.push_children.children.push(e.id());
self.add_children.children.push(e.id());
e
}
fn spawn_empty(&mut self) -> EntityCommands {
let e = self.commands.spawn_empty();
self.push_children.children.push(e.id());
self.add_children.children.push(e.id());
e
}
fn parent_entity(&self) -> Entity {
self.push_children.parent
self.add_children.parent
}
fn add_command<C: Command>(&mut self, command: C) -> &mut Self {
@ -362,7 +362,7 @@ pub trait BuildChildren {
/// # Panics
///
/// Panics if any of the children are the same as the parent.
fn push_children(&mut self, children: &[Entity]) -> &mut Self;
fn add_children(&mut self, children: &[Entity]) -> &mut Self;
/// Inserts children at the given index.
///
@ -428,14 +428,14 @@ impl BuildChildren for EntityCommands<'_> {
let parent = self.id();
let mut builder = ChildBuilder {
commands: self.commands(),
push_children: PushChildren {
add_children: AddChildren {
children: SmallVec::default(),
parent,
},
};
spawn_children(&mut builder);
let children = builder.push_children;
let children = builder.add_children;
if children.children.contains(&parent) {
panic!("Entity cannot be a child of itself.");
}
@ -446,16 +446,16 @@ impl BuildChildren for EntityCommands<'_> {
fn with_child<B: Bundle>(&mut self, bundle: B) -> &mut Self {
let parent = self.id();
let child = self.commands().spawn(bundle).id();
self.commands().add(PushChild { parent, child });
self.commands().add(AddChild { parent, child });
self
}
fn push_children(&mut self, children: &[Entity]) -> &mut Self {
fn add_children(&mut self, children: &[Entity]) -> &mut Self {
let parent = self.id();
if children.contains(&parent) {
panic!("Cannot push entity as a child of itself.");
}
self.commands().add(PushChildren {
self.commands().add(AddChildren {
children: SmallVec::from(children),
parent,
});
@ -489,7 +489,7 @@ impl BuildChildren for EntityCommands<'_> {
if child == parent {
panic!("Cannot add entity as a child of itself.");
}
self.commands().add(PushChild { child, parent });
self.commands().add(AddChild { child, parent });
self
}
@ -516,7 +516,7 @@ impl BuildChildren for EntityCommands<'_> {
if child == parent {
panic!("Cannot set parent to itself");
}
self.commands().add(PushChild { child, parent });
self.commands().add(AddChild { child, parent });
self
}
@ -539,7 +539,7 @@ impl ChildBuild for WorldChildBuilder<'_> {
fn spawn(&mut self, bundle: impl Bundle) -> EntityWorldMut {
let entity = self.world.spawn((bundle, Parent(self.parent))).id();
push_child_unchecked(self.world, self.parent, entity);
add_child_unchecked(self.world, self.parent, entity);
push_events(
self.world,
[HierarchyEvent::ChildAdded {
@ -552,7 +552,7 @@ impl ChildBuild for WorldChildBuilder<'_> {
fn spawn_empty(&mut self) -> EntityWorldMut {
let entity = self.world.spawn(Parent(self.parent)).id();
push_child_unchecked(self.world, self.parent, entity);
add_child_unchecked(self.world, self.parent, entity);
push_events(
self.world,
[HierarchyEvent::ChildAdded {
@ -613,7 +613,7 @@ impl BuildChildren for EntityWorldMut<'_> {
self
}
fn push_children(&mut self, children: &[Entity]) -> &mut Self {
fn add_children(&mut self, children: &[Entity]) -> &mut Self {
if children.is_empty() {
return self;
}
@ -691,7 +691,7 @@ impl BuildChildren for EntityWorldMut<'_> {
}
fn replace_children(&mut self, children: &[Entity]) -> &mut Self {
self.clear_children().push_children(children)
self.clear_children().add_children(children)
}
}
@ -838,7 +838,7 @@ mod tests {
let [a, b, c] = std::array::from_fn(|_| world.spawn_empty().id());
world.entity_mut(a).push_children(&[b, c]);
world.entity_mut(a).add_children(&[b, c]);
world.entity_mut(b).remove_parent();
assert_parent(world, b, None);
@ -920,7 +920,7 @@ mod tests {
let mut queue = CommandQueue::default();
{
let mut commands = Commands::new(&mut queue, &world);
commands.entity(entities[0]).push_children(&entities[1..3]);
commands.entity(entities[0]).add_children(&entities[1..3]);
}
queue.apply(&mut world);
@ -981,7 +981,7 @@ mod tests {
let mut queue = CommandQueue::default();
{
let mut commands = Commands::new(&mut queue, &world);
commands.entity(entities[0]).push_children(&entities[1..3]);
commands.entity(entities[0]).add_children(&entities[1..3]);
}
queue.apply(&mut world);
@ -1019,7 +1019,7 @@ mod tests {
let mut queue = CommandQueue::default();
{
let mut commands = Commands::new(&mut queue, &world);
commands.entity(entities[0]).push_children(&entities[1..3]);
commands.entity(entities[0]).add_children(&entities[1..3]);
}
queue.apply(&mut world);
@ -1060,7 +1060,7 @@ mod tests {
.spawn_batch(vec![C(1), C(2), C(3), C(4), C(5)])
.collect::<Vec<Entity>>();
world.entity_mut(entities[0]).push_children(&entities[1..3]);
world.entity_mut(entities[0]).add_children(&entities[1..3]);
let parent = entities[0];
let child1 = entities[1];
@ -1103,7 +1103,7 @@ mod tests {
.spawn_batch(vec![C(1), C(2), C(3)])
.collect::<Vec<Entity>>();
world.entity_mut(entities[0]).push_children(&entities[1..3]);
world.entity_mut(entities[0]).add_children(&entities[1..3]);
let parent = entities[0];
let child1 = entities[1];
@ -1130,7 +1130,7 @@ mod tests {
.spawn_batch(vec![C(1), C(2), C(3), C(4), C(5)])
.collect::<Vec<Entity>>();
world.entity_mut(entities[0]).push_children(&entities[1..3]);
world.entity_mut(entities[0]).add_children(&entities[1..3]);
let parent = entities[0];
let child1 = entities[1];
@ -1170,15 +1170,15 @@ mod tests {
let parent2 = entities[1];
let child = entities[2];
// push child into parent1
world.entity_mut(parent1).push_children(&[child]);
// add child into parent1
world.entity_mut(parent1).add_children(&[child]);
assert_eq!(
world.get::<Children>(parent1).unwrap().0.as_slice(),
&[child]
);
// move only child from parent1 with `push_children`
world.entity_mut(parent2).push_children(&[child]);
// move only child from parent1 with `add_children`
world.entity_mut(parent2).add_children(&[child]);
assert!(world.get::<Children>(parent1).is_none());
// move only child from parent2 with `insert_children`
@ -1204,10 +1204,10 @@ mod tests {
let mut queue = CommandQueue::default();
// push child into parent1
// add child into parent1
{
let mut commands = Commands::new(&mut queue, &world);
commands.entity(parent1).push_children(&[child]);
commands.entity(parent1).add_children(&[child]);
queue.apply(&mut world);
}
assert_eq!(
@ -1215,10 +1215,10 @@ mod tests {
&[child]
);
// move only child from parent1 with `push_children`
// move only child from parent1 with `add_children`
{
let mut commands = Commands::new(&mut queue, &world);
commands.entity(parent2).push_children(&[child]);
commands.entity(parent2).add_children(&[child]);
queue.apply(&mut world);
}
assert!(world.get::<Children>(parent1).is_none());
@ -1249,20 +1249,20 @@ mod tests {
}
#[test]
fn regression_push_children_same_archetype() {
fn regression_add_children_same_archetype() {
let mut world = World::new();
let child = world.spawn_empty().id();
world.spawn_empty().push_children(&[child]);
world.spawn_empty().add_children(&[child]);
}
#[test]
fn push_children_idempotent() {
fn add_children_idempotent() {
let mut world = World::new();
let child = world.spawn_empty().id();
let parent = world
.spawn_empty()
.push_children(&[child])
.push_children(&[child])
.add_children(&[child])
.add_children(&[child])
.id();
let mut query = world.query::<&Children>();
@ -1271,9 +1271,9 @@ mod tests {
}
#[test]
fn push_children_does_not_insert_empty_children() {
fn add_children_does_not_insert_empty_children() {
let mut world = World::new();
let parent = world.spawn_empty().push_children(&[]).id();
let parent = world.spawn_empty().add_children(&[]).id();
let mut query = world.query::<&Children>();
let children = query.get(&world, parent);

8
crates/bevy_hierarchy/src/query_extension.rs
View File

@ -172,8 +172,8 @@ mod tests {
let [a, b, c, d] = std::array::from_fn(|i| world.spawn(A(i)).id());
world.entity_mut(a).push_children(&[b, c]);
world.entity_mut(c).push_children(&[d]);
world.entity_mut(a).add_children(&[b, c]);
world.entity_mut(c).add_children(&[d]);
let mut system_state = SystemState::<(Query<&Children>, Query<&A>)>::new(world);
let (children_query, a_query) = system_state.get(world);
@ -191,8 +191,8 @@ mod tests {
let [a, b, c] = std::array::from_fn(|i| world.spawn(A(i)).id());
world.entity_mut(a).push_children(&[b]);
world.entity_mut(b).push_children(&[c]);
world.entity_mut(a).add_children(&[b]);
world.entity_mut(b).add_children(&[c]);
let mut system_state = SystemState::<(Query<&Parent>, Query<&A>)>::new(world);
let (parent_query, a_query) = system_state.get(world);

26
crates/bevy_render/src/view/visibility/mod.rs
View File

@ -565,13 +565,13 @@ mod test {
app.world_mut()
.entity_mut(root1)
.push_children(&[root1_child1, root1_child2]);
.add_children(&[root1_child1, root1_child2]);
app.world_mut()
.entity_mut(root1_child1)
.push_children(&[root1_child1_grandchild1]);
.add_children(&[root1_child1_grandchild1]);
app.world_mut()
.entity_mut(root1_child2)
.push_children(&[root1_child2_grandchild1]);
.add_children(&[root1_child2_grandchild1]);
let root2 = app.world_mut().spawn(VisibilityBundle::default()).id();
let root2_child1 = app.world_mut().spawn(VisibilityBundle::default()).id();
@ -584,13 +584,13 @@ mod test {
app.world_mut()
.entity_mut(root2)
.push_children(&[root2_child1, root2_child2]);
.add_children(&[root2_child1, root2_child2]);
app.world_mut()
.entity_mut(root2_child1)
.push_children(&[root2_child1_grandchild1]);
.add_children(&[root2_child1_grandchild1]);
app.world_mut()
.entity_mut(root2_child2)
.push_children(&[root2_child2_grandchild1]);
.add_children(&[root2_child2_grandchild1]);
app.update();
@ -662,13 +662,13 @@ mod test {
app.world_mut()
.entity_mut(root1)
.push_children(&[root1_child1, root1_child2]);
.add_children(&[root1_child1, root1_child2]);
app.world_mut()
.entity_mut(root1_child1)
.push_children(&[root1_child1_grandchild1]);
.add_children(&[root1_child1_grandchild1]);
app.world_mut()
.entity_mut(root1_child2)
.push_children(&[root1_child2_grandchild1]);
.add_children(&[root1_child2_grandchild1]);
app.update();
@ -714,13 +714,13 @@ mod test {
let id1 = world.spawn(VisibilityBundle::default()).id();
let id2 = world.spawn(VisibilityBundle::default()).id();
world.entity_mut(id1).push_children(&[id2]);
world.entity_mut(id1).add_children(&[id2]);
let id3 = world.spawn(visibility_bundle(Visibility::Hidden)).id();
world.entity_mut(id2).push_children(&[id3]);
world.entity_mut(id2).add_children(&[id3]);
let id4 = world.spawn(VisibilityBundle::default()).id();
world.entity_mut(id3).push_children(&[id4]);
world.entity_mut(id3).add_children(&[id4]);
// Test the hierarchy.
@ -787,7 +787,7 @@ mod test {
let parent = world.spawn(()).id();
let child = world.spawn(VisibilityBundle::default()).id();
world.entity_mut(parent).push_children(&[child]);
world.entity_mut(parent).add_children(&[child]);
schedule.run(&mut world);
world.clear_trackers();

6
crates/bevy_scene/src/dynamic_scene.rs
View File

@ -213,7 +213,7 @@ mod tests {
use bevy_ecs::reflect::{ReflectMapEntitiesResource, ReflectResource};
use bevy_ecs::system::Resource;
use bevy_ecs::{reflect::AppTypeRegistry, world::Command, world::World};
use bevy_hierarchy::{Parent, PushChild};
use bevy_hierarchy::{AddChild, Parent};
use bevy_reflect::Reflect;
use crate::dynamic_scene_builder::DynamicSceneBuilder;
@ -284,7 +284,7 @@ mod tests {
.register::<Parent>();
let original_parent_entity = world.spawn_empty().id();
let original_child_entity = world.spawn_empty().id();
PushChild {
AddChild {
parent: original_parent_entity,
child: original_child_entity,
}
@ -305,7 +305,7 @@ mod tests {
// We then add the parent from the scene as a child of the original child
// Hierarchy should look like:
// Original Parent <- Original Child <- Scene Parent <- Scene Child
PushChild {
AddChild {
parent: original_child_entity,
child: from_scene_parent_entity,
}

4
crates/bevy_scene/src/scene_spawner.rs
View File

@ -8,7 +8,7 @@ use bevy_ecs::{
system::Resource,
world::{Command, Mut, World},
};
use bevy_hierarchy::{BuildChildren, DespawnRecursiveExt, Parent, PushChild};
use bevy_hierarchy::{AddChild, BuildChildren, DespawnRecursiveExt, Parent};
use bevy_utils::{tracing::error, HashMap, HashSet};
use thiserror::Error;
use uuid::Uuid;
@ -380,7 +380,7 @@ impl SceneSpawner {
// this case shouldn't happen anyway
.unwrap_or(true)
{
PushChild {
AddChild {
parent,
child: entity,
}

14
crates/bevy_transform/src/commands.rs
View File

@ -7,22 +7,22 @@ use bevy_ecs::{
system::EntityCommands,
world::{Command, EntityWorldMut, World},
};
use bevy_hierarchy::{PushChild, RemoveParent};
use bevy_hierarchy::{AddChild, RemoveParent};
/// Command similar to [`PushChild`], but updating the child transform to keep
/// Command similar to [`AddChild`], but updating the child transform to keep
/// it at the same [`GlobalTransform`].
///
/// You most likely want to use [`BuildChildrenTransformExt::set_parent_in_place`]
/// method on [`EntityCommands`] instead.
pub struct PushChildInPlace {
pub struct AddChildInPlace {
/// Parent entity to add the child to.
pub parent: Entity,
/// Child entity to add.
pub child: Entity,
}
impl Command for PushChildInPlace {
impl Command for AddChildInPlace {
fn apply(self, world: &mut World) {
let hierarchy_command = PushChild {
let hierarchy_command = AddChild {
child: self.child,
parent: self.parent,
};
@ -91,7 +91,7 @@ pub trait BuildChildrenTransformExt {
impl BuildChildrenTransformExt for EntityCommands<'_> {
fn set_parent_in_place(&mut self, parent: Entity) -> &mut Self {
let child = self.id();
self.commands().add(PushChildInPlace { child, parent });
self.commands().add(AddChildInPlace { child, parent });
self
}
@ -105,7 +105,7 @@ impl BuildChildrenTransformExt for EntityCommands<'_> {
impl BuildChildrenTransformExt for EntityWorldMut<'_> {
fn set_parent_in_place(&mut self, parent: Entity) -> &mut Self {
let child = self.id();
self.world_scope(|world| PushChildInPlace { child, parent }.apply(world));
self.world_scope(|world| AddChildInPlace { child, parent }.apply(world));
self
}

2
crates/bevy_transform/src/systems.rs
View File

@ -477,7 +477,7 @@ mod test {
app.world_mut()
.spawn(TransformBundle::IDENTITY)
.push_children(&[child]);
.add_children(&[child]);
std::mem::swap(
&mut *app.world_mut().get_mut::<Parent>(child).unwrap(),
&mut *temp.get_mut::<Parent>(grandchild).unwrap(),

2
examples/animation/custom_skinned_mesh.rs
View File

@ -140,7 +140,7 @@ fn setup(
.id();
// Set joint_1 as a child of joint_0.
commands.entity(joint_0).push_children(&[joint_1]);
commands.entity(joint_0).add_children(&[joint_1]);
// Each joint in this vector corresponds to each inverse bindpose matrix in `SkinnedMeshInverseBindposes`.
let joint_entities = vec![joint_0, joint_1];

4
examples/ui/borders.rs
View File

@ -176,7 +176,7 @@ fn setup(mut commands: Commands) {
},
..Default::default()
})
.push_children(&[border_node, label_node])
.add_children(&[border_node, label_node])
.id();
commands.entity(root).add_child(container);
}
@ -245,7 +245,7 @@ fn setup(mut commands: Commands) {
},
..Default::default()
})
.push_children(&[border_node, label_node])
.add_children(&[border_node, label_node])
.id();
commands.entity(root_rounded).add_child(container);
}

2
examples/ui/text_debug.rs
View File

@ -229,7 +229,7 @@ fn infotext_system(mut commands: Commands, asset_server: Res<AssetServer>) {
commands
.entity(root_uinode)
.push_children(&[left_column, right_column]);
.add_children(&[left_column, right_column]);
}
fn change_text_system(