review

Co-Authored-By: Robert Swain <[email protected]>

Author: mockersf

CREDITS.md

@@ -21,3 +21,5 @@
 * Ground tile from [Kenney's Tower Defense Kit](https://www.kenney.nl/assets/tower-defense-kit) (CC0 1.0 Universal)
 * Game icons from [Kenney's Game Icons](https://www.kenney.nl/assets/game-icons) (CC0 1.0 Universal)
 * Space ships from [Kenny's Simple Space Kit](https://www.kenney.nl/assets/simple-space) (CC0 1.0 Universal)
+* glTF animated triangle from [glTF Sample Models](https://github.com/KhronosGroup/glTF-Sample-Models/tree/master/2.0/AnimatedTriangle) (CC0 1.0 Universal)
+* glTF box animated from [glTF Sample Models](https://github.com/KhronosGroup/glTF-Sample-Models/tree/master/2.0/BoxAnimated) ([CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) - by [Cesium](https://cesium.com))

crates/bevy_gltf/src/lib.rs

@@ -1,5 +1,5 @@
 use bevy_ecs::{prelude::Component, reflect::ReflectComponent};
-use bevy_math::{Vec3, Vec4};
+use bevy_math::{Quat, Vec3, Vec4};
 use bevy_utils::HashMap;
 
 mod loader;
@@ -70,7 +70,7 @@ pub struct GltfPrimitive {
     pub material: Option<Handle<StandardMaterial>>,
 }
 
-/// Part of a [`GltfNodeAnimation`], interpolation method for an animation.
+/// Interpolation method for an animation. Part of a [`GltfNodeAnimation`].
 #[derive(Clone, Debug)]
 pub enum GltfAnimationInterpolation {
     Linear,
@@ -97,7 +97,7 @@ pub struct GltfAnimation {
 /// Key frames of an animation.
 #[derive(Clone, Debug)]
 pub enum GltfNodeAnimationKeyframes {
-    Rotation(Vec<Vec4>),
+    Rotation(Vec<Quat>),
     Translation(Vec<Vec3>),
     Scale(Vec<Vec3>),
 }

crates/bevy_gltf/src/loader.rs

@@ -5,7 +5,7 @@ use bevy_asset::{
 use bevy_core::Name;
 use bevy_ecs::world::World;
 use bevy_log::warn;
-use bevy_math::{Mat4, Vec3, Vec4};
+use bevy_math::{Mat4, Quat, Vec3, Vec4};
 use bevy_pbr::{
     AlphaMode, DirectionalLight, DirectionalLightBundle, PbrBundle, PointLight, PointLightBundle,
     StandardMaterial,
@@ -62,6 +62,8 @@ pub enum GltfError {
     ImageError(#[from] TextureError),
     #[error("failed to load an asset path: {0}")]
     AssetIoError(#[from] AssetIoError),
+    #[error("Missing sampler for animation {0}")]
+    MissingAnimationSampler(usize),
 }
 
 /// Loads glTF files with all of their data as their corresponding bevy representations.
@@ -137,7 +139,8 @@ async fn load_gltf<'a, 'b>(
                     }
                 }
             } else {
-                panic!("animations without a sampler input are not supported");
+                warn!("animations without a sampler input are not supported");
+                return Err(GltfError::MissingAnimationSampler(animation.index()));
             };
 
             let keyframes = if let Some(outputs) = reader.read_outputs() {
@@ -147,7 +150,7 @@ async fn load_gltf<'a, 'b>(
                     }
                     gltf::animation::util::ReadOutputs::Rotations(rots) => {
                         GltfNodeAnimationKeyframes::Rotation(
-                            rots.into_f32().map(Vec4::from).collect(),
+                            rots.into_f32().map(Quat::from_array).collect(),
                         )
                     }
                     gltf::animation::util::ReadOutputs::Scales(scale) => {
@@ -159,7 +162,8 @@ async fn load_gltf<'a, 'b>(
                     }
                 }
             } else {
-                panic!("animations without a sampler output are not supported");
+                warn!("animations without a sampler output are not supported");
+                return Err(GltfError::MissingAnimationSampler(animation.index()));
             };
 
             gltf_animation

examples/3d/load_gltf_animation.rs

@@ -24,20 +24,35 @@ fn main() {
         .run();
 }
 
-const ANIMATIONS: [(&str, Transform, f32); 3] = [
-    (
-        // Model being loaded
+struct Example {
+    model_name: &'static str,
+    camera_transform: Transform,
+    speed: f32,
+}
+impl Example {
+    const fn new(model_name: &'static str, camera_transform: Transform, speed: f32) -> Self {
+        Self {
+            model_name,
+            camera_transform,
+            speed,
+        }
+    }
+}
+
+// const ANIMATIONS: [(&str, Transform, f32); 3] = [
+const ANIMATIONS: [Example; 3] = [
+    // https://github.com/KhronosGroup/glTF-Sample-Models/tree/master/2.0/AnimatedTriangle
+    Example::new(
         "models/animated/AnimatedTriangle.gltf",
-        // Position of the camera
         Transform {
             translation: const_vec3!([0.0, 0.0, 3.0]),
             rotation: const_quat!([0.0, 0.0, 0.0, 1.0]),
             scale: const_vec3!([1.0; 3]),
         },
-        // Speed of the animation
         0.12,
     ),
-    (
+    // https://github.com/KhronosGroup/glTF-Sample-Models/tree/master/2.0/BoxAnimated
+    Example::new(
         "models/animated/BoxAnimated.gltf",
         Transform {
             translation: const_vec3!([4.0, 2.0, 4.0]),
@@ -46,7 +61,7 @@ const ANIMATIONS: [(&str, Transform, f32); 3] = [
         },
         0.4,
     ),
-    (
+    Example::new(
         "models/animated/animations.gltf",
         Transform {
             translation: const_vec3!([-10.0, 5.0, -3.0]),
@@ -76,16 +91,17 @@ fn setup(
     // Insert a resource with the current scene information
     commands.insert_resource(CurrentScene {
         // Its instance id, to be able to check that it's loaded
-        instance_id: scene_spawner.spawn(asset_server.load(&format!("{}#Scene0", ANIMATIONS[0].0))),
+        instance_id: scene_spawner
+            .spawn(asset_server.load(&format!("{}#Scene0", ANIMATIONS[0].model_name))),
         // The handle to the first animation
-        animation: asset_server.load(&format!("{}#Animation0", ANIMATIONS[0].0)),
+        animation: asset_server.load(&format!("{}#Animation0", ANIMATIONS[0].model_name)),
         // The animation speed modifier
-        speed: ANIMATIONS[0].2,
+        speed: ANIMATIONS[0].speed,
     });
 
     // Add a camera
     commands.spawn_bundle(PerspectiveCameraBundle {
-        transform: ANIMATIONS[0].1,
+        transform: ANIMATIONS[0].camera_transform,
         ..Default::default()
     });
 
@@ -107,13 +123,14 @@ fn switch_scene(
 
     // Despawn the existing scene, then start loading the next one
     commands.entity(scene_root.single()).despawn_recursive();
-    current_scene.instance_id =
-        scene_spawner.spawn(asset_server.load(&format!("{}#Scene0", ANIMATIONS[*current].0)));
-    current_scene.animation = asset_server.load(&format!("{}#Animation0", ANIMATIONS[*current].0));
-    current_scene.speed = ANIMATIONS[*current].2;
+    current_scene.instance_id = scene_spawner
+        .spawn(asset_server.load(&format!("{}#Scene0", ANIMATIONS[*current].model_name)));
+    current_scene.animation =
+        asset_server.load(&format!("{}#Animation0", ANIMATIONS[*current].model_name));
+    current_scene.speed = ANIMATIONS[*current].speed;
 
     // Update the camera position
-    *camera.single_mut() = ANIMATIONS[*current].1;
+    *camera.single_mut() = ANIMATIONS[*current].camera_transform;
 
     // Reset the current animation
     commands.remove_resource::<CurrentAnimation>();