Skip to content

Commit

Permalink
Added links from transform examples to doc (bevyengine#1934)
Browse files Browse the repository at this point in the history
  • Loading branch information
bwhitt7 committed Sep 16, 2022
1 parent 503c2a9 commit 142c0c0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions crates/bevy_transform/src/components/global_transform.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ 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.
///
/// Example: [transform](https://github.com/bevyengine/bevy/blob/latest/examples/transforms/transform.rs),
#[derive(Component, Debug, PartialEq, Clone, Copy, Reflect)]
#[reflect(Component, PartialEq)]
pub struct GlobalTransform(Affine3A);
Expand Down
8 changes: 8 additions & 0 deletions crates/bevy_transform/src/components/transform.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ 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](https://github.com/bevyengine/bevy/blob/latest/examples/transforms/transform.rs), [global_vs_local_translation.rs](https://github.com/bevyengine/bevy/blob/latest/examples/transforms/global_vs_local_translation.rs)
#[derive(Component, Debug, PartialEq, Clone, Copy, Reflect)]
#[reflect(Component, Default, PartialEq)]
pub struct Transform {
Expand All @@ -34,6 +36,8 @@ pub struct Transform {
/// Rotation of the entity.
pub rotation: Quat,
/// Scale of the entity.
///
/// Example: [scale](https://github.com/bevyengine/bevy/blob/latest/examples/transforms/scale.rs)
pub scale: Vec3,
}

Expand All @@ -48,6 +52,8 @@ impl Transform {
/// Creates a new [`Transform`] at the position `(x, y, z)`. In 2d, the `z` component
/// is used for z-ordering elements: higher `z`-value will be in front of lower
/// `z`-value.
///
/// Example: [translations](https://github.com/bevyengine/bevy/blob/latest/examples/transforms/translation.rs)
#[inline]
pub const fn from_xyz(x: f32, y: f32, z: f32) -> Self {
Self::from_translation(Vec3::new(x, y, z))
Expand Down Expand Up @@ -201,6 +207,8 @@ 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.
///
/// Example: [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;
Expand Down

0 comments on commit 142c0c0

Please sign in to comment.