ba5e71f53d
Fixes #17412 ## Objective `Parent` uses the "has a X" naming convention. There is increasing sentiment that we should use the "is a X" naming convention for relationships (following #17398). This leaves `Children` as-is because there is prevailing sentiment that `Children` is clearer than `ParentOf` in many cases (especially when treating it like a collection). This renames `Parent` to `ChildOf`. This is just the implementation PR. To discuss the path forward, do so in #17412. ## Migration Guide - The `Parent` component has been renamed to `ChildOf`.
81 lines
3.5 KiB
Rust
81 lines
3.5 KiB
Rust
//! Extension to [`EntityCommands`] to modify [`bevy_ecs::hierarchy`] hierarchies.
|
|
//! while preserving [`GlobalTransform`].
|
|
|
|
use crate::prelude::{GlobalTransform, Transform};
|
|
use bevy_ecs::{entity::Entity, hierarchy::ChildOf, system::EntityCommands, world::EntityWorldMut};
|
|
|
|
/// Collection of methods similar to the built-in parenting methods on [`EntityWorldMut`] and [`EntityCommands`], but preserving each
|
|
/// entity's [`GlobalTransform`].
|
|
pub trait BuildChildrenTransformExt {
|
|
/// Change this entity's parent while preserving this entity's [`GlobalTransform`]
|
|
/// by updating its [`Transform`].
|
|
///
|
|
/// Insert the [`ChildOf`] component directly if you don't want to also update the [`Transform`].
|
|
///
|
|
/// Note that both the hierarchy and transform updates will only execute
|
|
/// the next time commands are applied
|
|
/// (during [`ApplyDeferred`](bevy_ecs::schedule::ApplyDeferred)).
|
|
fn set_parent_in_place(&mut self, parent: Entity) -> &mut Self;
|
|
|
|
/// Make this entity parentless while preserving this entity's [`GlobalTransform`]
|
|
/// by updating its [`Transform`] to be equal to its current [`GlobalTransform`].
|
|
///
|
|
/// See [`EntityWorldMut::remove_parent`] or [`EntityCommands::remove_parent`] for a method that doesn't update the [`Transform`].
|
|
///
|
|
/// Note that both the hierarchy and transform updates will only execute
|
|
/// the next time commands are applied
|
|
/// (during [`ApplyDeferred`](bevy_ecs::schedule::ApplyDeferred)).
|
|
fn remove_parent_in_place(&mut self) -> &mut Self;
|
|
}
|
|
|
|
impl BuildChildrenTransformExt for EntityCommands<'_> {
|
|
fn set_parent_in_place(&mut self, parent: Entity) -> &mut Self {
|
|
self.queue(move |mut entity: EntityWorldMut| {
|
|
entity.set_parent_in_place(parent);
|
|
})
|
|
}
|
|
|
|
fn remove_parent_in_place(&mut self) -> &mut Self {
|
|
self.queue(move |mut entity: EntityWorldMut| {
|
|
entity.remove_parent_in_place();
|
|
})
|
|
}
|
|
}
|
|
|
|
impl BuildChildrenTransformExt for EntityWorldMut<'_> {
|
|
fn set_parent_in_place(&mut self, parent: Entity) -> &mut Self {
|
|
let child = self.id();
|
|
self.world_scope(|world| {
|
|
world.entity_mut(parent).add_child(child);
|
|
// FIXME: Replace this closure with a `try` block. See: https://github.com/rust-lang/rust/issues/31436.
|
|
let mut update_transform = || {
|
|
let parent = *world.get_entity(parent).ok()?.get::<GlobalTransform>()?;
|
|
let child_global = *world.get_entity(child).ok()?.get::<GlobalTransform>()?;
|
|
let mut child_entity = world.get_entity_mut(child).ok()?;
|
|
let mut child = child_entity.get_mut::<Transform>()?;
|
|
*child = child_global.reparented_to(&parent);
|
|
Some(())
|
|
};
|
|
update_transform();
|
|
});
|
|
self
|
|
}
|
|
|
|
fn remove_parent_in_place(&mut self) -> &mut Self {
|
|
let child = self.id();
|
|
self.world_scope(|world| {
|
|
world.entity_mut(child).remove::<ChildOf>();
|
|
// FIXME: Replace this closure with a `try` block. See: https://github.com/rust-lang/rust/issues/31436.
|
|
let mut update_transform = || {
|
|
let child_global = *world.get_entity(child).ok()?.get::<GlobalTransform>()?;
|
|
let mut child_entity = world.get_entity_mut(child).ok()?;
|
|
let mut child = child_entity.get_mut::<Transform>()?;
|
|
*child = child_global.compute_transform();
|
|
Some(())
|
|
};
|
|
update_transform();
|
|
});
|
|
self
|
|
}
|
|
}
|