mirror of
https://github.com/bevyengine/bevy
synced 2024-12-21 18:43:07 +00:00
abf12f3b3b
Links in the api docs are nice. I noticed that there were several places where structs / functions and other things were referenced in the docs, but weren't linked. I added the links where possible / logical. --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> Co-authored-by: François <mockersf@gmail.com>
103 lines
4.2 KiB
Rust
103 lines
4.2 KiB
Rust
//! Extension to [`EntityCommands`] to modify [`bevy_hierarchy`] hierarchies
|
|
//! while preserving [`GlobalTransform`].
|
|
|
|
use bevy_ecs::{prelude::Entity, system::Command, system::EntityCommands, world::World};
|
|
use bevy_hierarchy::{AddChild, RemoveParent};
|
|
|
|
#[cfg(doc)]
|
|
use bevy_hierarchy::BuildChildren;
|
|
|
|
use crate::{GlobalTransform, Transform};
|
|
|
|
/// 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 AddChildInPlace {
|
|
/// Parent entity to add the child to.
|
|
pub parent: Entity,
|
|
/// Child entity to add.
|
|
pub child: Entity,
|
|
}
|
|
impl Command for AddChildInPlace {
|
|
fn write(self, world: &mut World) {
|
|
let hierarchy_command = AddChild {
|
|
child: self.child,
|
|
parent: self.parent,
|
|
};
|
|
hierarchy_command.write(world);
|
|
// 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(self.parent)?.get::<GlobalTransform>()?;
|
|
let child_global = *world.get_entity(self.child)?.get::<GlobalTransform>()?;
|
|
let mut child_entity = world.get_entity_mut(self.child)?;
|
|
let mut child = child_entity.get_mut::<Transform>()?;
|
|
*child = child_global.reparented_to(&parent);
|
|
Some(())
|
|
};
|
|
update_transform();
|
|
}
|
|
}
|
|
/// Command similar to [`RemoveParent`], but updating the child transform to keep
|
|
/// it at the same [`GlobalTransform`].
|
|
///
|
|
/// You most likely want to use [`BuildChildrenTransformExt::remove_parent_in_place`]
|
|
/// method on [`EntityCommands`] instead.
|
|
pub struct RemoveParentInPlace {
|
|
/// [`Entity`] whose parent must be removed.
|
|
pub child: Entity,
|
|
}
|
|
impl Command for RemoveParentInPlace {
|
|
fn write(self, world: &mut World) {
|
|
let hierarchy_command = RemoveParent { child: self.child };
|
|
hierarchy_command.write(world);
|
|
// 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(self.child)?.get::<GlobalTransform>()?;
|
|
let mut child_entity = world.get_entity_mut(self.child)?;
|
|
let mut child = child_entity.get_mut::<Transform>()?;
|
|
*child = child_global.compute_transform();
|
|
Some(())
|
|
};
|
|
update_transform();
|
|
}
|
|
}
|
|
/// Collection of methods similar to [`BuildChildren`], but preserving each
|
|
/// entity's [`GlobalTransform`].
|
|
pub trait BuildChildrenTransformExt {
|
|
/// Change this entity's parent while preserving this entity's [`GlobalTransform`]
|
|
/// by updating its [`Transform`].
|
|
///
|
|
/// See [`BuildChildren::set_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 [`apply_system_buffers`](bevy_ecs::schedule::apply_system_buffers)).
|
|
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 [`BuildChildren::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 [`apply_system_buffers`](bevy_ecs::schedule::apply_system_buffers)).
|
|
fn remove_parent_in_place(&mut self) -> &mut Self;
|
|
}
|
|
impl<'w, 's, 'a> BuildChildrenTransformExt for EntityCommands<'w, 's, 'a> {
|
|
fn remove_parent_in_place(&mut self) -> &mut Self {
|
|
let child = self.id();
|
|
self.commands().add(RemoveParentInPlace { child });
|
|
self
|
|
}
|
|
|
|
fn set_parent_in_place(&mut self, parent: Entity) -> &mut Self {
|
|
let child = self.id();
|
|
self.commands().add(AddChildInPlace { child, parent });
|
|
self
|
|
}
|
|
}
|