bevy/examples/3d/manual_gltf_animation_player.rs

use bevy::{
    core::FixedTimestep,
    gltf::*,
    math::{const_quat, const_vec3},
    prelude::*,
    scene::InstanceId,
};

/// This illustrates loading animations from GLTF files and manually playing them.
/// Note that a higher level animation api is in the works. This exists to illustrate how to
/// read and build a custom GLTF animator, not to illustrate a final Bevy animation api.
fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .insert_resource(AmbientLight {
            color: Color::WHITE,
            brightness: 1.0,
        })
        .add_startup_system(setup)
        .add_system_set(
            SystemSet::new()
                .with_run_criteria(FixedTimestep::step(10.0))
                .with_system(switch_scene),
        )
        .add_system(setup_scene_once_loaded)
        .add_system(gltf_animation_driver)
        .run();
}

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",
        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]),
        },
        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]),
            rotation: const_quat!([-0.08, 0.38, 0.03, 0.92]),
            scale: const_vec3!([1.0; 3]),
        },
        0.4,
    ),
    Example::new(
        "models/animated/animations.gltf",
        Transform {
            translation: const_vec3!([-10.0, 5.0, -3.0]),
            rotation: const_quat!([0.16, 0.69, 0.16, -0.69]),
            scale: const_vec3!([1.0; 3]),
        },
        2.5,
    ),
];

struct CurrentScene {
    instance_id: InstanceId,
    animation: Handle<GltfAnimation>,
    speed: f32,
}

struct CurrentAnimation {
    start_time: f64,
    animation: GltfAnimation,
}

fn setup(
    mut commands: Commands,
    asset_server: Res<AssetServer>,
    mut scene_spawner: ResMut<SceneSpawner>,
) {
    // 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].model_name))),
        // The handle to the first animation
        animation: asset_server.load(&format!("{}#Animation0", ANIMATIONS[0].model_name)),
        // The animation speed modifier
        speed: ANIMATIONS[0].speed,
    });

    // Add a camera
    commands.spawn_bundle(PerspectiveCameraBundle {
        transform: ANIMATIONS[0].camera_transform,
        ..Default::default()
    });

    // Add a directional light
    commands.spawn_bundle(DirectionalLightBundle::default());
}

// Switch the scene to the next one every 10 seconds
fn switch_scene(
    mut commands: Commands,
    scene_root: Query<Entity, (Without<Camera>, Without<DirectionalLight>, Without<Parent>)>,
    mut camera: Query<&mut Transform, With<Camera>>,
    mut current: Local<usize>,
    mut current_scene: ResMut<CurrentScene>,
    asset_server: Res<AssetServer>,
    mut scene_spawner: ResMut<SceneSpawner>,
) {
    *current = (*current + 1) % ANIMATIONS.len();

    // 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].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].camera_transform;

    // Reset the current animation
    commands.remove_resource::<CurrentAnimation>();
}

// Setup the scene for animation once it is loaded, by adding the animation to a resource with
// the start time.
fn setup_scene_once_loaded(
    mut commands: Commands,
    scene_spawner: Res<SceneSpawner>,
    current_scene: Res<CurrentScene>,
    time: Res<Time>,
    mut done: Local<bool>,
    animations: Res<Assets<GltfAnimation>>,
) {
    // If the current scene resource has changed, start waiting for it to be loaded
    if current_scene.is_changed() {
        *done = false;
    }
    // Once the scene and the animation are loaded, start the animation
    if !*done && scene_spawner.instance_is_ready(current_scene.instance_id) {
        if let Some(animation) = animations.get(&current_scene.animation) {
            *done = true;
            commands.insert_resource(CurrentAnimation {
                start_time: time.seconds_since_startup(),
                animation: animation.clone(),
            })
        }
    }
}

// This animation driver is not made to work in the general case. It will work with only one
// animation per scene, and will ignore the specified interpolation method to only do linear.
fn gltf_animation_driver(
    mut animated: Query<(&mut Transform, &GltfAnimatedNode)>,
    current_animation: Option<Res<CurrentAnimation>>,
    current_scene: Res<CurrentScene>,
    time: Res<Time>,
) {
    if let Some(current_animation) = current_animation {
        let elapsed = (time.seconds_since_startup() - current_animation.start_time) as f32
            * current_scene.speed;
        for (mut transform, node) in animated.iter_mut() {
            let node_animations = current_animation
                .animation
                .node_animations
                .get(&node.index)
                .unwrap();
            for node_animation in node_animations.iter() {
                let mut keyframe_timestamps = node_animation.keyframe_timestamps.iter().enumerate();
                let mut step_start = keyframe_timestamps.next().unwrap();
                if elapsed < *step_start.1 {
                    continue;
                }
                for next in keyframe_timestamps {
                    if *next.1 > elapsed {
                        break;
                    }
                    step_start = next;
                }
                if step_start.0 == node_animation.keyframe_timestamps.len() - 1 {
                    continue;
                }

                let step_end = node_animation.keyframe_timestamps[step_start.0 + 1];
                let lerp = (elapsed - *step_start.1) / (step_end - step_start.1);
                match &node_animation.keyframes {
                    GltfNodeAnimationKeyframes::Rotation(keyframes) => {
                        let rot_start = keyframes[step_start.0];
                        let mut rot_end = keyframes[step_start.0 + 1];
                        if rot_end.dot(rot_start) < 0.0 {
                            rot_end = -rot_end;
                        }
                        let result = Quat::from_array(rot_start.normalize().into())
                            .slerp(Quat::from_array(rot_end.normalize().into()), lerp);
                        transform.rotation = result;
                    }
                    GltfNodeAnimationKeyframes::Translation(keyframes) => {
                        let translation_start = keyframes[step_start.0];
                        let translation_end = keyframes[step_start.0 + 1];
                        let result = translation_start.lerp(translation_end, lerp);
                        transform.translation = result;
                    }
                    GltfNodeAnimationKeyframes::Scale(keyframes) => {
                        let scale_start = keyframes[step_start.0];
                        let scale_end = keyframes[step_start.0 + 1];
                        let result = scale_start.lerp(scale_end, lerp);
                        transform.scale = result;
                    }
                }
            }
        }
    }
}