Skip to content

Commit

Permalink
Add Mesh transformation (#11454)
Browse files Browse the repository at this point in the history
# Objective

It can sometimes be useful to transform actual `Mesh` data without
needing to change the `Transform` of an entity. For example, one might
want to spawn a circle mesh facing up instead of facing Z, or to spawn a
mesh slightly offset without needing child entities.

## Solution

Add `transform_by` and `transformed_by` methods to `Mesh`. They take a
`Transform` and apply the translation, rotation, and scale to vertex
positions, and the rotation to normals and tangents.

In the `load_gltf` example, with this system:

```rust
fn transform(time: Res<Time>, mut q: Query<&mut Handle<Mesh>>, mut meshes: ResMut<Assets<Mesh>>) {
    let sin = 0.0025 * time.elapsed_seconds().sin();

    for mesh_handle in &mut q {
        if let Some(mesh) = meshes.get_mut(mesh_handle.clone_weak()) {
            let transform =
                Transform::from_rotation(Quat::from_rotation_y(0.75 * time.delta_seconds()))
                    .with_scale(Vec3::splat(1.0 + sin));
            mesh.transform_by(transform);
        }
    }
}
```

it looks like this:


https://github.com/bevyengine/bevy/assets/57632562/60432456-6d28-4d06-9c94-2f4148f5acd5
  • Loading branch information
Jondolf authored Jan 29, 2024
1 parent 9256749 commit 70f7d95
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions crates/bevy_render/src/mesh/mesh/mod.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
mod conversions;
pub mod skinning;
use bevy_transform::components::Transform;
pub use wgpu::PrimitiveTopology;

use crate::{
Expand Down Expand Up @@ -561,6 +562,60 @@ impl Mesh {
Ok(self)
}

/// Transforms the vertex positions, normals, and tangents of the mesh by the given [`Transform`].
pub fn transformed_by(mut self, transform: Transform) -> Self {
self.transform_by(transform);
self
}

/// Transforms the vertex positions, normals, and tangents of the mesh in place by the given [`Transform`].
pub fn transform_by(&mut self, transform: Transform) {
// Needed when transforming normals and tangents
let covector_scale = transform.scale.yzx() * transform.scale.zxy();

debug_assert!(
covector_scale != Vec3::ZERO,
"mesh transform scale cannot be zero on more than one axis"
);

if let Some(VertexAttributeValues::Float32x3(ref mut positions)) =
self.attribute_mut(Mesh::ATTRIBUTE_POSITION)
{
// Apply scale, rotation, and translation to vertex positions
positions
.iter_mut()
.for_each(|pos| *pos = transform.transform_point(Vec3::from_slice(pos)).to_array());
}

// No need to transform normals or tangents if rotation is near identity and scale is uniform
if transform.rotation.is_near_identity()
&& transform.scale.x == transform.scale.y
&& transform.scale.y == transform.scale.z
{
return;
}

if let Some(VertexAttributeValues::Float32x3(ref mut normals)) =
self.attribute_mut(Mesh::ATTRIBUTE_NORMAL)
{
// Transform normals, taking into account non-uniform scaling and rotation
normals.iter_mut().for_each(|normal| {
let scaled_normal = Vec3::from_slice(normal) * covector_scale;
*normal = (transform.rotation * scaled_normal.normalize_or_zero()).to_array();
});
}

if let Some(VertexAttributeValues::Float32x3(ref mut tangents)) =
self.attribute_mut(Mesh::ATTRIBUTE_TANGENT)
{
// Transform tangents, taking into account non-uniform scaling and rotation
tangents.iter_mut().for_each(|tangent| {
let scaled_tangent = Vec3::from_slice(tangent) * covector_scale;
*tangent = (transform.rotation * scaled_tangent.normalize_or_zero()).to_array();
});
}
}

/// Compute the Axis-Aligned Bounding Box of the mesh vertices in model space
///
/// Returns `None` if `self` doesn't have [`Mesh::ATTRIBUTE_POSITION`] of
Expand Down Expand Up @@ -646,6 +701,14 @@ impl Mesh {
}
}

impl core::ops::Mul<Mesh> for Transform {
type Output = Mesh;

fn mul(self, rhs: Mesh) -> Self::Output {
rhs.transformed_by(self)
}
}

#[derive(Debug, Clone)]
pub struct MeshVertexAttribute {
/// The friendly name of the vertex attribute
Expand Down

0 comments on commit 70f7d95

Please sign in to comment.