forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add note about rotations for Aabb3d (#12315)

Browse Source 
# Objective

Fixes #12310.

#11681 added transformations for bounding volumes, but I accidentally
only added a note in the docs about repeated rotations for `Aabb2d` and
not `Aabb3d`.

## Solution

Copy the docs over to `Aabb3d`.
This commit is contained in:
Joona Aalto 2024-03-05 19:22:53 +02:00 committed by GitHub
parent f5ab1040a5
commit 4bed1b2200
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
crates/bevy_math/src/bounding/bounded3d/mod.rs
View File

@ -150,6 +150,10 @@ impl BoundingVolume for Aabb3d {
/// Transforms the bounding volume by first rotating it around the origin and then applying a translation. /// Transforms the bounding volume by first rotating it around the origin and then applying a translation.
/// ///
/// The result is an Axis-Aligned Bounding Box that encompasses the rotated shape. /// The result is an Axis-Aligned Bounding Box that encompasses the rotated shape.
///
/// Note that the result may not be as tightly fitting as the original, and repeated rotations
/// can cause the AABB to grow indefinitely. Avoid applying multiple rotations to the same AABB,
/// and consider storing the original AABB and rotating that every time instead.
#[inline(always)] #[inline(always)]
fn transformed_by(mut self, translation: Self::Translation, rotation: Self::Rotation) -> Self { fn transformed_by(mut self, translation: Self::Translation, rotation: Self::Rotation) -> Self {
self.transform_by(translation, rotation); self.transform_by(translation, rotation);
@ -159,6 +163,10 @@ impl BoundingVolume for Aabb3d {
/// Transforms the bounding volume by first rotating it around the origin and then applying a translation. /// Transforms the bounding volume by first rotating it around the origin and then applying a translation.
/// ///
/// The result is an Axis-Aligned Bounding Box that encompasses the rotated shape. /// The result is an Axis-Aligned Bounding Box that encompasses the rotated shape.
///
/// Note that the result may not be as tightly fitting as the original, and repeated rotations
/// can cause the AABB to grow indefinitely. Avoid applying multiple rotations to the same AABB,
/// and consider storing the original AABB and rotating that every time instead.
#[inline(always)] #[inline(always)]
fn transform_by(&mut self, translation: Self::Translation, rotation: Self::Rotation) { fn transform_by(&mut self, translation: Self::Translation, rotation: Self::Rotation) {
self.rotate_by(rotation); self.rotate_by(rotation);
@ -174,6 +182,10 @@ impl BoundingVolume for Aabb3d {
/// Rotates the bounding volume around the origin by the given rotation. /// Rotates the bounding volume around the origin by the given rotation.
/// ///
/// The result is an Axis-Aligned Bounding Box that encompasses the rotated shape. /// The result is an Axis-Aligned Bounding Box that encompasses the rotated shape.
///
/// Note that the result may not be as tightly fitting as the original, and repeated rotations
/// can cause the AABB to grow indefinitely. Avoid applying multiple rotations to the same AABB,
/// and consider storing the original AABB and rotating that every time instead.
#[inline(always)] #[inline(always)]
fn rotated_by(mut self, rotation: Self::Rotation) -> Self { fn rotated_by(mut self, rotation: Self::Rotation) -> Self {
self.rotate_by(rotation); self.rotate_by(rotation);
@ -183,6 +195,10 @@ impl BoundingVolume for Aabb3d {
/// Rotates the bounding volume around the origin by the given rotation. /// Rotates the bounding volume around the origin by the given rotation.
/// ///
/// The result is an Axis-Aligned Bounding Box that encompasses the rotated shape. /// The result is an Axis-Aligned Bounding Box that encompasses the rotated shape.
///
/// Note that the result may not be as tightly fitting as the original, and repeated rotations
/// can cause the AABB to grow indefinitely. Avoid applying multiple rotations to the same AABB,
/// and consider storing the original AABB and rotating that every time instead.
#[inline(always)] #[inline(always)]
fn rotate_by(&mut self, rotation: Self::Rotation) { fn rotate_by(&mut self, rotation: Self::Rotation) {
let rot_mat = Mat3::from_quat(rotation); let rot_mat = Mat3::from_quat(rotation);