mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 15:14:50 +00:00
01aedc8431
# Objective Now that we can consolidate Bundles and Components under a single insert (thanks to #2975 and #6039), almost 100% of world spawns now look like `world.spawn().insert((Some, Tuple, Here))`. Spawning an entity without any components is an extremely uncommon pattern, so it makes sense to give spawn the "first class" ergonomic api. This consolidated api should be made consistent across all spawn apis (such as World and Commands). ## Solution All `spawn` apis (`World::spawn`, `Commands:;spawn`, `ChildBuilder::spawn`, and `WorldChildBuilder::spawn`) now accept a bundle as input: ```rust // before: commands .spawn() .insert((A, B, C)); world .spawn() .insert((A, B, C); // after commands.spawn((A, B, C)); world.spawn((A, B, C)); ``` All existing instances of `spawn_bundle` have been deprecated in favor of the new `spawn` api. A new `spawn_empty` has been added, replacing the old `spawn` api. By allowing `world.spawn(some_bundle)` to replace `world.spawn().insert(some_bundle)`, this opened the door to removing the initial entity allocation in the "empty" archetype / table done in `spawn()` (and subsequent move to the actual archetype in `.insert(some_bundle)`). This improves spawn performance by over 10%: ![image](https://user-images.githubusercontent.com/2694663/191627587-4ab2f949-4ccd-4231-80eb-80dd4d9ad6b9.png) To take this measurement, I added a new `world_spawn` benchmark. Unfortunately, optimizing `Commands::spawn` is slightly less trivial, as Commands expose the Entity id of spawned entities prior to actually spawning. Doing the optimization would (naively) require assurances that the `spawn(some_bundle)` command is applied before all other commands involving the entity (which would not necessarily be true, if memory serves). Optimizing `Commands::spawn` this way does feel possible, but it will require careful thought (and maybe some additional checks), which deserves its own PR. For now, it has the same performance characteristics of the current `Commands::spawn_bundle` on main. **Note that 99% of this PR is simple renames and refactors. The only code that needs careful scrutiny is the new `World::spawn()` impl, which is relatively straightforward, but it has some new unsafe code (which re-uses battle tested BundlerSpawner code path).** --- ## Changelog - All `spawn` apis (`World::spawn`, `Commands:;spawn`, `ChildBuilder::spawn`, and `WorldChildBuilder::spawn`) now accept a bundle as input - All instances of `spawn_bundle` have been deprecated in favor of the new `spawn` api - World and Commands now have `spawn_empty()`, which is equivalent to the old `spawn()` behavior. ## Migration Guide ```rust // Old (0.8): commands .spawn() .insert_bundle((A, B, C)); // New (0.9) commands.spawn((A, B, C)); // Old (0.8): commands.spawn_bundle((A, B, C)); // New (0.9) commands.spawn((A, B, C)); // Old (0.8): let entity = commands.spawn().id(); // New (0.9) let entity = commands.spawn_empty().id(); // Old (0.8) let entity = world.spawn().id(); // New (0.9) let entity = world.spawn_empty(); ```
274 lines
7.9 KiB
Rust
274 lines
7.9 KiB
Rust
//! Loads animations from a skinned glTF, spawns many of them, and plays the
|
|
//! animation to stress test skinned meshes.
|
|
|
|
use std::f32::consts::PI;
|
|
|
|
use bevy::{
|
|
diagnostic::{FrameTimeDiagnosticsPlugin, LogDiagnosticsPlugin},
|
|
prelude::*,
|
|
window::PresentMode,
|
|
};
|
|
|
|
#[derive(Resource)]
|
|
struct Foxes {
|
|
count: usize,
|
|
speed: f32,
|
|
moving: bool,
|
|
}
|
|
|
|
fn main() {
|
|
App::new()
|
|
.insert_resource(WindowDescriptor {
|
|
title: "🦊🦊🦊 Many Foxes! 🦊🦊🦊".to_string(),
|
|
present_mode: PresentMode::AutoNoVsync,
|
|
..default()
|
|
})
|
|
.add_plugins(DefaultPlugins)
|
|
.add_plugin(FrameTimeDiagnosticsPlugin)
|
|
.add_plugin(LogDiagnosticsPlugin::default())
|
|
.insert_resource(Foxes {
|
|
count: std::env::args()
|
|
.nth(1)
|
|
.map_or(1000, |s| s.parse::<usize>().unwrap()),
|
|
speed: 2.0,
|
|
moving: true,
|
|
})
|
|
.insert_resource(AmbientLight {
|
|
color: Color::WHITE,
|
|
brightness: 1.0,
|
|
})
|
|
.add_startup_system(setup)
|
|
.add_system(setup_scene_once_loaded)
|
|
.add_system(keyboard_animation_control)
|
|
.add_system(update_fox_rings.after(keyboard_animation_control))
|
|
.run();
|
|
}
|
|
|
|
#[derive(Resource)]
|
|
struct Animations(Vec<Handle<AnimationClip>>);
|
|
|
|
const RING_SPACING: f32 = 2.0;
|
|
const FOX_SPACING: f32 = 2.0;
|
|
|
|
#[derive(Component, Clone, Copy)]
|
|
enum RotationDirection {
|
|
CounterClockwise,
|
|
Clockwise,
|
|
}
|
|
|
|
impl RotationDirection {
|
|
fn sign(&self) -> f32 {
|
|
match self {
|
|
RotationDirection::CounterClockwise => 1.0,
|
|
RotationDirection::Clockwise => -1.0,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Component)]
|
|
struct Ring {
|
|
radius: f32,
|
|
}
|
|
|
|
fn setup(
|
|
mut commands: Commands,
|
|
asset_server: Res<AssetServer>,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<StandardMaterial>>,
|
|
foxes: Res<Foxes>,
|
|
) {
|
|
warn!(include_str!("warning_string.txt"));
|
|
|
|
// Insert a resource with the current scene information
|
|
commands.insert_resource(Animations(vec![
|
|
asset_server.load("models/animated/Fox.glb#Animation2"),
|
|
asset_server.load("models/animated/Fox.glb#Animation1"),
|
|
asset_server.load("models/animated/Fox.glb#Animation0"),
|
|
]));
|
|
|
|
// Foxes
|
|
// Concentric rings of foxes, running in opposite directions. The rings are spaced at 2m radius intervals.
|
|
// The foxes in each ring are spaced at least 2m apart around its circumference.'
|
|
|
|
// NOTE: This fox model faces +z
|
|
let fox_handle = asset_server.load("models/animated/Fox.glb#Scene0");
|
|
|
|
let ring_directions = [
|
|
(
|
|
Quat::from_rotation_y(PI),
|
|
RotationDirection::CounterClockwise,
|
|
),
|
|
(Quat::IDENTITY, RotationDirection::Clockwise),
|
|
];
|
|
|
|
let mut ring_index = 0;
|
|
let mut radius = RING_SPACING;
|
|
let mut foxes_remaining = foxes.count;
|
|
|
|
info!("Spawning {} foxes...", foxes.count);
|
|
|
|
while foxes_remaining > 0 {
|
|
let (base_rotation, ring_direction) = ring_directions[ring_index % 2];
|
|
let ring_parent = commands
|
|
.spawn((
|
|
Transform::default(),
|
|
GlobalTransform::default(),
|
|
Visibility::default(),
|
|
ComputedVisibility::default(),
|
|
ring_direction,
|
|
Ring { radius },
|
|
))
|
|
.id();
|
|
|
|
let circumference = PI * 2. * radius;
|
|
let foxes_in_ring = ((circumference / FOX_SPACING) as usize).min(foxes_remaining);
|
|
let fox_spacing_angle = circumference / (foxes_in_ring as f32 * radius);
|
|
|
|
for fox_i in 0..foxes_in_ring {
|
|
let fox_angle = fox_i as f32 * fox_spacing_angle;
|
|
let (s, c) = fox_angle.sin_cos();
|
|
let (x, z) = (radius * c, radius * s);
|
|
|
|
commands.entity(ring_parent).with_children(|builder| {
|
|
builder.spawn(SceneBundle {
|
|
scene: fox_handle.clone(),
|
|
transform: Transform::from_xyz(x as f32, 0.0, z as f32)
|
|
.with_scale(Vec3::splat(0.01))
|
|
.with_rotation(base_rotation * Quat::from_rotation_y(-fox_angle)),
|
|
..default()
|
|
});
|
|
});
|
|
}
|
|
|
|
foxes_remaining -= foxes_in_ring;
|
|
radius += RING_SPACING;
|
|
ring_index += 1;
|
|
}
|
|
|
|
// Camera
|
|
let zoom = 0.8;
|
|
let translation = Vec3::new(
|
|
radius * 1.25 * zoom,
|
|
radius * 0.5 * zoom,
|
|
radius * 1.5 * zoom,
|
|
);
|
|
commands.spawn(Camera3dBundle {
|
|
transform: Transform::from_translation(translation)
|
|
.looking_at(0.2 * Vec3::new(translation.x, 0.0, translation.z), Vec3::Y),
|
|
..default()
|
|
});
|
|
|
|
// Plane
|
|
commands.spawn(PbrBundle {
|
|
mesh: meshes.add(Mesh::from(shape::Plane { size: 500000.0 })),
|
|
material: materials.add(Color::rgb(0.3, 0.5, 0.3).into()),
|
|
..default()
|
|
});
|
|
|
|
// Light
|
|
commands.spawn(DirectionalLightBundle {
|
|
transform: Transform::from_rotation(Quat::from_euler(EulerRot::ZYX, 0.0, 1.0, -PI / 4.)),
|
|
directional_light: DirectionalLight {
|
|
shadows_enabled: true,
|
|
..default()
|
|
},
|
|
..default()
|
|
});
|
|
|
|
println!("Animation controls:");
|
|
println!(" - spacebar: play / pause");
|
|
println!(" - arrow up / down: speed up / slow down animation playback");
|
|
println!(" - arrow left / right: seek backward / forward");
|
|
println!(" - return: change animation");
|
|
}
|
|
|
|
// Once the scene is loaded, start the animation
|
|
fn setup_scene_once_loaded(
|
|
animations: Res<Animations>,
|
|
foxes: Res<Foxes>,
|
|
mut player: Query<&mut AnimationPlayer>,
|
|
mut done: Local<bool>,
|
|
) {
|
|
if !*done && player.iter().len() == foxes.count {
|
|
for mut player in &mut player {
|
|
player.play(animations.0[0].clone_weak()).repeat();
|
|
}
|
|
*done = true;
|
|
}
|
|
}
|
|
|
|
fn update_fox_rings(
|
|
time: Res<Time>,
|
|
foxes: Res<Foxes>,
|
|
mut rings: Query<(&Ring, &RotationDirection, &mut Transform)>,
|
|
) {
|
|
if !foxes.moving {
|
|
return;
|
|
}
|
|
|
|
let dt = time.delta_seconds();
|
|
for (ring, rotation_direction, mut transform) in &mut rings {
|
|
let angular_velocity = foxes.speed / ring.radius;
|
|
transform.rotate_y(rotation_direction.sign() * angular_velocity * dt);
|
|
}
|
|
}
|
|
|
|
fn keyboard_animation_control(
|
|
keyboard_input: Res<Input<KeyCode>>,
|
|
mut animation_player: Query<&mut AnimationPlayer>,
|
|
animations: Res<Animations>,
|
|
mut current_animation: Local<usize>,
|
|
mut foxes: ResMut<Foxes>,
|
|
) {
|
|
if keyboard_input.just_pressed(KeyCode::Space) {
|
|
foxes.moving = !foxes.moving;
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Up) {
|
|
foxes.speed *= 1.25;
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Down) {
|
|
foxes.speed *= 0.8;
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Return) {
|
|
*current_animation = (*current_animation + 1) % animations.0.len();
|
|
}
|
|
|
|
for mut player in &mut animation_player {
|
|
if keyboard_input.just_pressed(KeyCode::Space) {
|
|
if player.is_paused() {
|
|
player.resume();
|
|
} else {
|
|
player.pause();
|
|
}
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Up) {
|
|
let speed = player.speed();
|
|
player.set_speed(speed * 1.25);
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Down) {
|
|
let speed = player.speed();
|
|
player.set_speed(speed * 0.8);
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Left) {
|
|
let elapsed = player.elapsed();
|
|
player.set_elapsed(elapsed - 0.1);
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Right) {
|
|
let elapsed = player.elapsed();
|
|
player.set_elapsed(elapsed + 0.1);
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Return) {
|
|
player
|
|
.play(animations.0[*current_animation].clone_weak())
|
|
.repeat();
|
|
}
|
|
}
|
|
}
|