[Merged by Bors] - Split bevy_hierarchy out from bevy_transform

crates/bevy_gltf/Cargo.toml

@@ -14,6 +14,7 @@ bevy_app = { path = "../bevy_app", version = "0.6.0" }
 bevy_asset = { path = "../bevy_asset", version = "0.6.0" }
 bevy_core = { path = "../bevy_core", version = "0.6.0" }
 bevy_ecs = { path = "../bevy_ecs", version = "0.6.0" }
+bevy_hierarchy = { path = "../bevy_hierarchy", version = "0.6.0" }
 bevy_pbr = { path = "../bevy_pbr", version = "0.6.0" }
 bevy_reflect = { path = "../bevy_reflect", version = "0.6.0", features = ["bevy"] }
 bevy_render = { path = "../bevy_render", version = "0.6.0" }

crates/bevy_gltf/src/loader.rs

@@ -4,6 +4,7 @@ use bevy_asset::{
 };
 use bevy_core::Name;
 use bevy_ecs::world::World;
+use bevy_hierarchy::{BuildWorldChildren, WorldChildBuilder};
 use bevy_log::warn;
 use bevy_math::{Mat4, Vec3};
 use bevy_pbr::{
@@ -24,11 +25,8 @@ use bevy_render::{
  view::VisibleEntities,
 };
 use bevy_scene::Scene;
-use bevy_transform::{
- hierarchy::{BuildWorldChildren, WorldChildBuilder},
- prelude::Transform,
- TransformBundle,
-};
+use bevy_transform::{components::Transform, TransformBundle};
+
 use bevy_utils::{HashMap, HashSet};
 use gltf::{
  mesh::Mode,

crates/bevy_hierarchy/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "bevy_hierarchy"
+version = "0.6.0"
+edition = "2021"
+description = "Provides hierarchy functionality for Bevy Engine"
+homepage = "https://bevyengine.org"
+repository = "https://github.com/bevyengine/bevy"
+license = "MIT OR Apache-2.0"
+keywords = ["bevy"]
+
+[dependencies]
+# bevy
+bevy_app = { path = "../bevy_app", version = "0.6.0" }
+bevy_ecs = { path = "../bevy_ecs", version = "0.6.0", features = ["bevy_reflect"] }
+bevy_reflect = { path = "../bevy_reflect", version = "0.6.0", features = ["bevy"] }
+bevy_utils = { path = "../bevy_utils", version = "0.6.0" }
+
+# other
+smallvec = { version = "1.6", features = ["serde", "union", "const_generics"] }

crates/bevy_hierarchy/src/components/mod.rs

@@ -0,0 +1,5 @@
+mod children;
+mod parent;
+
+pub use children::Children;
+pub use parent::{Parent, PreviousParent};

crates/bevy_transform/src/hierarchy/hierarchy.rs → crates/bevy_hierarchy/src/hierarchy.rs

@@ -116,7 +116,7 @@ mod tests {
  };
 
  use super::DespawnRecursiveExt;
- use crate::{components::Children, hierarchy::BuildChildren};
+ use crate::{child_builder::BuildChildren, components::Children};
 
  #[derive(Component, Clone, Copy, PartialEq, Eq, Ord, PartialOrd, Debug)]
  struct Idx(u32);

crates/bevy_hierarchy/src/lib.rs

@@ -0,0 +1,53 @@
+#![warn(missing_docs)]
+//! `bevy_hierarchy` can be used to define hierarchies of entities.
+//!
+//! Most commonly, these hierarchies are used for inheriting `Transform` values
+//! from the [`Parent`] to its [`Children`].
+
+mod components;
+pub use components::*;
+
+mod hierarchy;
+pub use hierarchy::*;
+
+mod child_builder;
+pub use child_builder::*;
+
+mod systems;
+pub use systems::*;
+
+#[doc(hidden)]
+pub mod prelude {
+ #[doc(hidden)]
+ pub use crate::{child_builder::*, components::*, hierarchy::*, HierarchyPlugin};
+}
+
+use bevy_app::prelude::*;
+use bevy_ecs::prelude::*;
+
+/// The base plugin for handling [`Parent`] and [`Children`] components
+#[derive(Default)]
+pub struct HierarchyPlugin;
+
+/// Label enum for the systems relating to hierarchy upkeep
+#[derive(Debug, Hash, PartialEq, Eq, Clone, SystemLabel)]
+pub enum HierarchySystem {
+ /// Updates [`Parent`] when changes in the hierarchy occur
+ ParentUpdate,
+}
+
+impl Plugin for HierarchyPlugin {
+ fn build(&self, app: &mut App) {
+ app.register_type::<Children>()
+ .register_type::<Parent>()
+ .register_type::<PreviousParent>()
+ .add_startup_system_to_stage(
+ StartupStage::PostStartup,
+ parent_update_system.label(HierarchySystem::ParentUpdate),
+ )
+ .add_system_to_stage(
+ CoreStage::PostUpdate,
+ parent_update_system.label(HierarchySystem::ParentUpdate),
+ );
+ }
+}

crates/bevy_transform/src/hierarchy/hierarchy_maintenance_system.rs → crates/bevy_hierarchy/src/systems.rs

@@ -70,101 +70,3 @@ pub fn parent_update_system(
  commands.entity(*e).insert(Children::with(v));
  });
 }
-#[cfg(test)]
-mod test {
- use bevy_ecs::{
- schedule::{Schedule, Stage, SystemStage},
- system::CommandQueue,
- world::World,
- };
-
- use super::*;
- use crate::{hierarchy::BuildChildren, transform_propagate_system::transform_propagate_system};
-
- #[test]
- fn correct_children() {
- let mut world = World::default();
-
- let mut update_stage = SystemStage::parallel();
- update_stage.add_system(parent_update_system);
- update_stage.add_system(transform_propagate_system);
-
- let mut schedule = Schedule::default();
- schedule.add_stage("update", update_stage);
-
- // Add parent entities
- let mut command_queue = CommandQueue::default();
- let mut commands = Commands::new(&mut command_queue, &world);
- let mut children = Vec::new();
- let parent = commands
- .spawn()
- .insert(Transform::from_xyz(1.0, 0.0, 0.0))
- .id();
- commands.entity(parent).with_children(|parent| {
- children.push(
- parent
- .spawn()
- .insert(Transform::from_xyz(0.0, 2.0, 0.0))
- .id(),
- );
- children.push(
- parent
- .spawn()
- .insert(Transform::from_xyz(0.0, 3.0, 0.0))
- .id(),
- );
- });
- command_queue.apply(&mut world);
- schedule.run(&mut world);
-
- assert_eq!(
- world
- .get::<Children>(parent)
- .unwrap()
- .0
- .iter()
- .cloned()
- .collect::<Vec<_>>(),
- children,
- );
-
- // Parent `e1` to `e2`.
- (*world.get_mut::<Parent>(children[0]).unwrap()).0 = children[1];
-
- schedule.run(&mut world);
-
- assert_eq!(
- world
- .get::<Children>(parent)
- .unwrap()
- .iter()
- .cloned()
- .collect::<Vec<_>>(),
- vec![children[1]]
- );
-
- assert_eq!(
- world
- .get::<Children>(children[1])
- .unwrap()
- .iter()
- .cloned()
- .collect::<Vec<_>>(),
- vec![children[0]]
- );
-
- assert!(world.despawn(children[0]));
-
- schedule.run(&mut world);
-
- assert_eq!(
- world
- .get::<Children>(parent)
- .unwrap()
- .iter()
- .cloned()
- .collect::<Vec<_>>(),
- vec![children[1]]
- );
- }
-}

crates/bevy_internal/Cargo.toml

@@ -56,6 +56,7 @@ bevy_core = { path = "../bevy_core", version = "0.6.0" }
 bevy_derive = { path = "../bevy_derive", version = "0.6.0" }
 bevy_diagnostic = { path = "../bevy_diagnostic", version = "0.6.0" }
 bevy_ecs = { path = "../bevy_ecs", version = "0.6.0" }
+bevy_hierarchy = { path = "../bevy_hierarchy", version = "0.6.0" }
 bevy_input = { path = "../bevy_input", version = "0.6.0" }
 bevy_log = { path = "../bevy_log", version = "0.6.0" }
 bevy_math = { path = "../bevy_math", version = "0.6.0" }

crates/bevy_internal/src/default_plugins.rs

@@ -4,6 +4,7 @@ use bevy_app::{PluginGroup, PluginGroupBuilder};
 /// * [`LogPlugin`](bevy_log::LogPlugin)
 /// * [`CorePlugin`](bevy_core::CorePlugin)
 /// * [`TransformPlugin`](bevy_transform::TransformPlugin)
+/// * [`HierarchyPlugin`](bevy_hierarchy::HierarchyPlugin)
 /// * [`DiagnosticsPlugin`](bevy_diagnostic::DiagnosticsPlugin)
 /// * [`InputPlugin`](bevy_input::InputPlugin)
 /// * [`WindowPlugin`](bevy_window::WindowPlugin)
@@ -27,6 +28,7 @@ impl PluginGroup for DefaultPlugins {
  group.add(bevy_log::LogPlugin::default());
  group.add(bevy_core::CorePlugin::default());
  group.add(bevy_transform::TransformPlugin::default());
+ group.add(bevy_hierarchy::HierarchyPlugin::default());
  group.add(bevy_diagnostic::DiagnosticsPlugin::default());
  group.add(bevy_input::InputPlugin::default());
  group.add(bevy_window::WindowPlugin::default());

crates/bevy_internal/src/lib.rs

@@ -65,6 +65,11 @@ pub mod tasks {
  pub use bevy_tasks::*;
 }
 
+pub mod hierarchy {
+ //! Entity hierarchies and property inheritance
+ pub use bevy_hierarchy::*;
+}
+
 pub mod transform {
  //! Local and global transforms (e.g. translation, scale, rotation).
  pub use bevy_transform::*;

crates/bevy_internal/src/prelude.rs

@@ -1,7 +1,7 @@
 #[doc(hidden)]
 pub use crate::{
- app::prelude::*, asset::prelude::*, core::prelude::*, ecs::prelude::*, input::prelude::*,
- log::prelude::*, math::prelude::*, reflect::prelude::*, scene::prelude::*,
+ app::prelude::*, asset::prelude::*, core::prelude::*, ecs::prelude::*, hierarchy::prelude::*,
+ input::prelude::*, log::prelude::*, math::prelude::*, reflect::prelude::*, scene::prelude::*,
  transform::prelude::*, utils::prelude::*, window::prelude::*, DefaultPlugins, MinimalPlugins,
 };
 

crates/bevy_render/src/view/visibility/mod.rs

@@ -6,7 +6,8 @@ use bevy_app::{CoreStage, Plugin};
 use bevy_asset::{Assets, Handle};
 use bevy_ecs::prelude::*;
 use bevy_reflect::Reflect;
-use bevy_transform::{components::GlobalTransform, TransformSystem};
+use bevy_transform::components::GlobalTransform;
+use bevy_transform::TransformSystem;
 
 use crate::{
  camera::{Camera, CameraProjection, OrthographicProjection, PerspectiveProjection},

crates/bevy_scene/Cargo.toml

@@ -14,7 +14,7 @@ bevy_app = { path = "../bevy_app", version = "0.6.0" }
 bevy_asset = { path = "../bevy_asset", version = "0.6.0" }
 bevy_ecs = { path = "../bevy_ecs", version = "0.6.0" }
 bevy_reflect = { path = "../bevy_reflect", version = "0.6.0", features = ["bevy"] }
-bevy_transform = { path = "../bevy_transform", version = "0.6.0" }
+bevy_hierarchy = { path = "../bevy_hierarchy", version = "0.6.0" }
 bevy_utils = { path = "../bevy_utils", version = "0.6.0" }
 
 # other

crates/bevy_scene/src/command.rs

@@ -4,7 +4,7 @@ use bevy_ecs::{
  system::{Command, Commands},
  world::World,
 };
-use bevy_transform::hierarchy::ChildBuilder;
+use bevy_hierarchy::ChildBuilder;
 
 use crate::{Scene, SceneSpawner};
 

crates/bevy_scene/src/scene_spawner.rs

@@ -7,8 +7,8 @@ use bevy_ecs::{
  system::Command,
  world::{Mut, World},
 };
+use bevy_hierarchy::{AddChild, Parent};
 use bevy_reflect::TypeRegistryArc;
-use bevy_transform::{hierarchy::AddChild, prelude::Parent};
 use bevy_utils::{tracing::error, HashMap};
 use thiserror::Error;
 use uuid::Uuid;

crates/bevy_transform/Cargo.toml

@@ -2,7 +2,7 @@
 name = "bevy_transform"
 version = "0.6.0"
 edition = "2021"
-description = "Provides hierarchy and transform functionality for Bevy Engine"
+description = "Provides transform functionality for Bevy Engine"
 homepage = "https://bevyengine.org"
 repository = "https://github.com/bevyengine/bevy"
 license = "MIT OR Apache-2.0"
@@ -12,9 +12,6 @@ keywords = ["bevy"]
 # bevy
 bevy_app = { path = "../bevy_app", version = "0.6.0" }
 bevy_ecs = { path = "../bevy_ecs", version = "0.6.0", features = ["bevy_reflect"] }
+bevy_hierarchy = { path = "../bevy_hierarchy", version = "0.6.0"}
 bevy_math = { path = "../bevy_math", version = "0.6.0" }
 bevy_reflect = { path = "../bevy_reflect", version = "0.6.0", features = ["bevy"] }
-bevy_utils = { path = "../bevy_utils", version = "0.6.0" }
-
-# other
-smallvec = { version = "1.6", features = ["serde", "union", "const_generics"] }

crates/bevy_transform/src/components/global_transform.rs

@@ -14,12 +14,12 @@ use std::ops::Mul;
 /// ## [`Transform`] and [`GlobalTransform`]
 ///
 /// [`Transform`] is the position of an entity relative to its parent position, or the reference
-/// frame if it doesn't have a [`Parent`](super::Parent).
+/// frame if it doesn't have a [`Parent`](bevy_hierarchy::Parent).
 ///
 /// [`GlobalTransform`] is the position of an entity relative to the reference frame.
 ///
 /// [`GlobalTransform`] is updated from [`Transform`] in the system
-/// [`transform_propagate_system`](crate::transform_propagate_system::transform_propagate_system).
+/// [`transform_propagate_system`](crate::transform_propagate_system).
 ///
 /// This system runs in stage [`CoreStage::PostUpdate`](crate::CoreStage::PostUpdate). If you
 /// update the[`Transform`] of an entity in this stage or after, you will notice a 1 frame lag

crates/bevy_transform/src/components/mod.rs

@@ -1,9 +1,5 @@
-mod children;
 mod global_transform;
-mod parent;
 mod transform;
 
-pub use children::Children;
 pub use global_transform::*;
-pub use parent::{Parent, PreviousParent};
 pub use transform::*;

crates/bevy_transform/src/components/transform.rs

@@ -15,12 +15,12 @@ use std::ops::Mul;
 /// ## [`Transform`] and [`GlobalTransform`]
 ///
 /// [`Transform`] is the position of an entity relative to its parent position, or the reference
-/// frame if it doesn't have a [`Parent`](super::Parent).
+/// frame if it doesn't have a [`Parent`](bevy_hierarchy::Parent).
 ///
 /// [`GlobalTransform`] is the position of an entity relative to the reference frame.
 ///
 /// [`GlobalTransform`] is updated from [`Transform`] in the system
-/// [`transform_propagate_system`](crate::transform_propagate_system::transform_propagate_system).
+/// [`transform_propagate_system`](crate::transform_propagate_system).
 ///
 /// This system runs in stage [`CoreStage::PostUpdate`](crate::CoreStage::PostUpdate). If you
 /// update the[`Transform`] of an entity in this stage or after, you will notice a 1 frame lag