d7080369a7
# Objective - Bevy currently has lot of invalid intra-doc links, let's fix them! - Also make CI test them, to avoid future regressions. - Helps with #1983 (but doesn't fix it, as there could still be explicit links to docs.rs that are broken) ## Solution - Make `cargo r -p ci -- doc-check` check fail on warnings (could also be changed to just some specific lints) - Manually fix all the warnings (note that in some cases it was unclear to me what the fix should have been, I'll try to highlight them in a self-review)
60 lines
2.2 KiB
Rust
60 lines
2.2 KiB
Rust
use bevy_ecs::bundle::Bundle;
|
|
|
|
use crate::prelude::{GlobalTransform, Transform};
|
|
|
|
/// A [`Bundle`] of the [`Transform`] and [`GlobalTransform`]
|
|
/// [`Component`](bevy_ecs::component::Component)s, which describe the position of an entity.
|
|
///
|
|
/// * To place or move an entity, you should set its [`Transform`].
|
|
/// * To get the global transform of an entity, you should get its [`GlobalTransform`].
|
|
/// * For transform hierarchies to work correctly, you must have both a [`Transform`] and a [`GlobalTransform`].
|
|
/// * You may use the [`TransformBundle`] to guarantee this.
|
|
///
|
|
/// ## [`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.
|
|
///
|
|
/// [`GlobalTransform`] is the position of an entity relative to the reference frame.
|
|
///
|
|
/// [`GlobalTransform`] is updated from [`Transform`] by systems in the system set
|
|
/// [`TransformPropagate`](crate::TransformSystem::TransformPropagate).
|
|
///
|
|
/// This system runs during [`PostUpdate`](bevy_app::PostUpdate). If you
|
|
/// update the [`Transform`] of an entity in this schedule or after, you will notice a 1 frame lag
|
|
/// before the [`GlobalTransform`] is updated.
|
|
#[derive(Clone, Copy, Debug, Default, Bundle)]
|
|
pub struct TransformBundle {
|
|
/// The transform of the entity.
|
|
pub local: Transform,
|
|
/// The global transform of the entity.
|
|
pub global: GlobalTransform,
|
|
}
|
|
|
|
impl TransformBundle {
|
|
/// An identity [`TransformBundle`] with no translation, rotation, and a scale of 1 on all axes.
|
|
pub const IDENTITY: Self = TransformBundle {
|
|
local: Transform::IDENTITY,
|
|
global: GlobalTransform::IDENTITY,
|
|
};
|
|
|
|
/// Creates a new [`TransformBundle`] from a [`Transform`].
|
|
///
|
|
/// This initializes [`GlobalTransform`] as identity, to be updated later by the
|
|
/// [`bevy_app::PostUpdate`] schedule.
|
|
#[inline]
|
|
pub const fn from_transform(transform: Transform) -> Self {
|
|
TransformBundle {
|
|
local: transform,
|
|
..Self::IDENTITY
|
|
}
|
|
}
|
|
}
|
|
|
|
impl From<Transform> for TransformBundle {
|
|
#[inline]
|
|
fn from(transform: Transform) -> Self {
|
|
Self::from_transform(transform)
|
|
}
|
|
}
|