diff --git a/crates/bevy_transform/src/components/global_transform.rs b/crates/bevy_transform/src/components/global_transform.rs index 66d2ea03fb7a5..627862d94b20b 100644 --- a/crates/bevy_transform/src/components/global_transform.rs +++ b/crates/bevy_transform/src/components/global_transform.rs @@ -25,6 +25,12 @@ use bevy_reflect::Reflect; /// 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 /// before the [`GlobalTransform`] is updated. +/// +/// # Examples +/// +/// - [`global_vs_local_translation`] +/// +/// [`global_vs_local_translation`]: https://github.com/bevyengine/bevy/blob/latest/examples/transforms/global_vs_local_translation.rs #[derive(Component, Debug, PartialEq, Clone, Copy, Reflect)] #[reflect(Component, PartialEq)] pub struct GlobalTransform(Affine3A); diff --git a/crates/bevy_transform/src/components/transform.rs b/crates/bevy_transform/src/components/transform.rs index 3920499622ae2..2aafd3ff2fd04 100644 --- a/crates/bevy_transform/src/components/transform.rs +++ b/crates/bevy_transform/src/components/transform.rs @@ -26,14 +26,34 @@ use std::ops::Mul; /// 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 /// before the [`GlobalTransform`] is updated. +/// +/// # Examples +/// +/// - [`transform`] +/// - [`global_vs_local_translation`] +/// +/// [`global_vs_local_translation`]: https://github.com/bevyengine/bevy/blob/latest/examples/transforms/global_vs_local_translation.rs +/// [`transform`]: https://github.com/bevyengine/bevy/blob/latest/examples/transforms/transform.rs #[derive(Component, Debug, PartialEq, Clone, Copy, Reflect)] #[reflect(Component, Default, PartialEq)] pub struct Transform { /// Position of the entity. In 2d, the last value of the `Vec3` is used for z-ordering. + /// + /// See the [`translations`] example for usage. + /// + /// [`translations`]: https://github.com/bevyengine/bevy/blob/latest/examples/transforms/translation.rs pub translation: Vec3, /// Rotation of the entity. + /// + /// See the [`3d_rotation`] example for usage. + /// + /// [`3d_rotation`]: https://github.com/bevyengine/bevy/blob/latest/examples/transforms/3d_rotation.rs pub rotation: Quat, /// Scale of the entity. + /// + /// See the [`scale`] example for usage. + /// + /// [`scale`]: https://github.com/bevyengine/bevy/blob/latest/examples/transforms/scale.rs pub scale: Vec3, } @@ -201,6 +221,12 @@ impl Transform { /// Rotates this [`Transform`] by the given rotation. /// /// If this [`Transform`] has a parent, the `rotation` is relative to the rotation of the parent. + /// + /// # Examples + /// + /// - [`3d_rotation`] + /// + /// [`3d_rotation`]: https://github.com/bevyengine/bevy/blob/latest/examples/transforms/3d_rotation.rs #[inline] pub fn rotate(&mut self, rotation: Quat) { self.rotation = rotation * self.rotation;