mirror of
https://github.com/bevyengine/bevy
synced 2024-11-15 09:27:41 +00:00
54006b107b
# Objective A big step in the migration to required components: meshes and materials! ## Solution As per the [selected proposal](https://hackmd.io/@bevy/required_components/%2Fj9-PnF-2QKK0on1KQ29UWQ): - Deprecate `MaterialMesh2dBundle`, `MaterialMeshBundle`, and `PbrBundle`. - Add `Mesh2d` and `Mesh3d` components, which wrap a `Handle<Mesh>`. - Add `MeshMaterial2d<M: Material2d>` and `MeshMaterial3d<M: Material>`, which wrap a `Handle<M>`. - Meshes *without* a mesh material should be rendered with a default material. The existence of a material is determined by `HasMaterial2d`/`HasMaterial3d`, which is required by `MeshMaterial2d`/`MeshMaterial3d`. This gets around problems with the generics. Previously: ```rust commands.spawn(MaterialMesh2dBundle { mesh: meshes.add(Circle::new(100.0)).into(), material: materials.add(Color::srgb(7.5, 0.0, 7.5)), transform: Transform::from_translation(Vec3::new(-200., 0., 0.)), ..default() }); ``` Now: ```rust commands.spawn(( Mesh2d(meshes.add(Circle::new(100.0))), MeshMaterial2d(materials.add(Color::srgb(7.5, 0.0, 7.5))), Transform::from_translation(Vec3::new(-200., 0., 0.)), )); ``` If the mesh material is missing, previously nothing was rendered. Now, it renders a white default `ColorMaterial` in 2D and a `StandardMaterial` in 3D (this can be overridden). Below, only every other entity has a material: ![Näyttökuva 2024-09-29 181746](https://github.com/user-attachments/assets/5c8be029-d2fe-4b8c-ae89-17a72ff82c9a) ![Näyttökuva 2024-09-29 181918](https://github.com/user-attachments/assets/58adbc55-5a1e-4c7d-a2c7-ed456227b909) Why white? This is still open for discussion, but I think white makes sense for a *default* material, while *invalid* asset handles pointing to nothing should have something like a pink material to indicate that something is broken (I don't handle that in this PR yet). This is kind of a mix of Godot and Unity: Godot just renders a white material for non-existent materials, while Unity renders nothing when no materials exist, but renders pink for invalid materials. I can also change the default material to pink if that is preferable though. ## Testing I ran some 2D and 3D examples to test if anything changed visually. I have not tested all examples or features yet however. If anyone wants to test more extensively, it would be appreciated! ## Implementation Notes - The relationship between `bevy_render` and `bevy_pbr` is weird here. `bevy_render` needs `Mesh3d` for its own systems, but `bevy_pbr` has all of the material logic, and `bevy_render` doesn't depend on it. I feel like the two crates should be refactored in some way, but I think that's out of scope for this PR. - I didn't migrate meshlets to required components yet. That can probably be done in a follow-up, as this is already a huge PR. - It is becoming increasingly clear to me that we really, *really* want to disallow raw asset handles as components. They caused me a *ton* of headache here already, and it took me a long time to find every place that queried for them or inserted them directly on entities, since there were no compiler errors for it. If we don't remove the `Component` derive, I expect raw asset handles to be a *huge* footgun for users as we transition to wrapper components, especially as handles as components have been the norm so far. I personally consider this to be a blocker for 0.15: we need to migrate to wrapper components for asset handles everywhere, and remove the `Component` derive. Also see https://github.com/bevyengine/bevy/issues/14124. --- ## Migration Guide Asset handles for meshes and mesh materials must now be wrapped in the `Mesh2d` and `MeshMaterial2d` or `Mesh3d` and `MeshMaterial3d` components for 2D and 3D respectively. Raw handles as components no longer render meshes. Additionally, `MaterialMesh2dBundle`, `MaterialMeshBundle`, and `PbrBundle` have been deprecated. Instead, use the mesh and material components directly. Previously: ```rust commands.spawn(MaterialMesh2dBundle { mesh: meshes.add(Circle::new(100.0)).into(), material: materials.add(Color::srgb(7.5, 0.0, 7.5)), transform: Transform::from_translation(Vec3::new(-200., 0., 0.)), ..default() }); ``` Now: ```rust commands.spawn(( Mesh2d(meshes.add(Circle::new(100.0))), MeshMaterial2d(materials.add(Color::srgb(7.5, 0.0, 7.5))), Transform::from_translation(Vec3::new(-200., 0., 0.)), )); ``` If the mesh material is missing, a white default material is now used. Previously, nothing was rendered if the material was missing. The `WithMesh2d` and `WithMesh3d` query filter type aliases have also been removed. Simply use `With<Mesh2d>` or `With<Mesh3d>`. --------- Co-authored-by: Tim Blackbird <justthecooldude@gmail.com> Co-authored-by: Carter Anderson <mcanders1@gmail.com>
203 lines
6 KiB
Rust
203 lines
6 KiB
Rust
//! Illustrates spot lights.
|
|
|
|
use std::f32::consts::*;
|
|
|
|
use bevy::{
|
|
color::palettes::basic::{MAROON, RED},
|
|
math::ops,
|
|
pbr::NotShadowCaster,
|
|
prelude::*,
|
|
};
|
|
use rand::{Rng, SeedableRng};
|
|
use rand_chacha::ChaCha8Rng;
|
|
|
|
const INSTRUCTIONS: &str = "\
|
|
Controls
|
|
--------
|
|
Horizontal Movement: WASD
|
|
Vertical Movement: Space and Shift
|
|
Rotate Camera: Left and Right Arrows";
|
|
|
|
fn main() {
|
|
App::new()
|
|
.insert_resource(AmbientLight {
|
|
brightness: 20.0,
|
|
..default()
|
|
})
|
|
.add_plugins(DefaultPlugins)
|
|
.add_systems(Startup, setup)
|
|
.add_systems(Update, (light_sway, movement, rotation))
|
|
.run();
|
|
}
|
|
|
|
#[derive(Component)]
|
|
struct Movable;
|
|
|
|
/// set up a simple 3D scene
|
|
fn setup(
|
|
mut commands: Commands,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<StandardMaterial>>,
|
|
) {
|
|
// ground plane
|
|
commands.spawn((
|
|
Mesh3d(meshes.add(Plane3d::default().mesh().size(100.0, 100.0))),
|
|
MeshMaterial3d(materials.add(Color::WHITE)),
|
|
Movable,
|
|
));
|
|
|
|
// cubes
|
|
|
|
// We're seeding the PRNG here to make this example deterministic for testing purposes.
|
|
// This isn't strictly required in practical use unless you need your app to be deterministic.
|
|
let mut rng = ChaCha8Rng::seed_from_u64(19878367467713);
|
|
let cube_mesh = meshes.add(Cuboid::new(0.5, 0.5, 0.5));
|
|
let blue = materials.add(Color::srgb_u8(124, 144, 255));
|
|
|
|
commands.spawn_batch(
|
|
std::iter::repeat_with(move || {
|
|
let x = rng.gen_range(-5.0..5.0);
|
|
let y = rng.gen_range(0.0..3.0);
|
|
let z = rng.gen_range(-5.0..5.0);
|
|
|
|
(
|
|
Mesh3d(cube_mesh.clone()),
|
|
MeshMaterial3d(blue.clone()),
|
|
Transform::from_xyz(x, y, z),
|
|
Movable,
|
|
)
|
|
})
|
|
.take(40),
|
|
);
|
|
|
|
let sphere_mesh = meshes.add(Sphere::new(0.05).mesh().uv(32, 18));
|
|
let sphere_mesh_direction = meshes.add(Sphere::new(0.1).mesh().uv(32, 18));
|
|
let red_emissive = materials.add(StandardMaterial {
|
|
base_color: RED.into(),
|
|
emissive: LinearRgba::new(1.0, 0.0, 0.0, 0.0),
|
|
..default()
|
|
});
|
|
let maroon_emissive = materials.add(StandardMaterial {
|
|
base_color: MAROON.into(),
|
|
emissive: LinearRgba::new(0.369, 0.0, 0.0, 0.0),
|
|
..default()
|
|
});
|
|
|
|
for x in 0..4 {
|
|
for z in 0..4 {
|
|
let x = x as f32 - 2.0;
|
|
let z = z as f32 - 2.0;
|
|
// red spot_light
|
|
commands
|
|
.spawn((
|
|
SpotLight {
|
|
intensity: 40_000.0, // lumens
|
|
color: Color::WHITE,
|
|
shadows_enabled: true,
|
|
inner_angle: PI / 4.0 * 0.85,
|
|
outer_angle: PI / 4.0,
|
|
..default()
|
|
},
|
|
Transform::from_xyz(1.0 + x, 2.0, z)
|
|
.looking_at(Vec3::new(1.0 + x, 0.0, z), Vec3::X),
|
|
))
|
|
.with_children(|builder| {
|
|
builder.spawn((
|
|
Mesh3d(sphere_mesh.clone()),
|
|
MeshMaterial3d(red_emissive.clone()),
|
|
));
|
|
builder.spawn((
|
|
Mesh3d(sphere_mesh_direction.clone()),
|
|
MeshMaterial3d(maroon_emissive.clone()),
|
|
Transform::from_translation(Vec3::Z * -0.1),
|
|
NotShadowCaster,
|
|
));
|
|
});
|
|
}
|
|
}
|
|
|
|
// camera
|
|
commands.spawn(Camera3dBundle {
|
|
camera: Camera {
|
|
hdr: true,
|
|
..default()
|
|
},
|
|
transform: Transform::from_xyz(-4.0, 5.0, 10.0).looking_at(Vec3::ZERO, Vec3::Y),
|
|
..default()
|
|
});
|
|
|
|
commands.spawn(
|
|
TextBundle::from_section(INSTRUCTIONS, TextStyle::default()).with_style(Style {
|
|
position_type: PositionType::Absolute,
|
|
top: Val::Px(12.0),
|
|
left: Val::Px(12.0),
|
|
..default()
|
|
}),
|
|
);
|
|
}
|
|
|
|
fn light_sway(time: Res<Time>, mut query: Query<(&mut Transform, &mut SpotLight)>) {
|
|
for (mut transform, mut angles) in query.iter_mut() {
|
|
transform.rotation = Quat::from_euler(
|
|
EulerRot::XYZ,
|
|
-FRAC_PI_2 + ops::sin(time.elapsed_seconds() * 0.67 * 3.0) * 0.5,
|
|
ops::sin(time.elapsed_seconds() * 3.0) * 0.5,
|
|
0.0,
|
|
);
|
|
let angle = (ops::sin(time.elapsed_seconds() * 1.2) + 1.0) * (FRAC_PI_4 - 0.1);
|
|
angles.inner_angle = angle * 0.8;
|
|
angles.outer_angle = angle;
|
|
}
|
|
}
|
|
|
|
fn movement(
|
|
input: Res<ButtonInput<KeyCode>>,
|
|
time: Res<Time>,
|
|
mut query: Query<&mut Transform, With<Movable>>,
|
|
) {
|
|
// Calculate translation to move the cubes and ground plane
|
|
let mut translation = Vec3::ZERO;
|
|
|
|
// Horizontal forward and backward movement
|
|
if input.pressed(KeyCode::KeyW) {
|
|
translation.z += 1.0;
|
|
} else if input.pressed(KeyCode::KeyS) {
|
|
translation.z -= 1.0;
|
|
}
|
|
|
|
// Horizontal left and right movement
|
|
if input.pressed(KeyCode::KeyA) {
|
|
translation.x += 1.0;
|
|
} else if input.pressed(KeyCode::KeyD) {
|
|
translation.x -= 1.0;
|
|
}
|
|
|
|
// Vertical movement
|
|
if input.pressed(KeyCode::ShiftLeft) {
|
|
translation.y += 1.0;
|
|
} else if input.pressed(KeyCode::Space) {
|
|
translation.y -= 1.0;
|
|
}
|
|
|
|
translation *= 2.0 * time.delta_seconds();
|
|
|
|
// Apply translation
|
|
for mut transform in &mut query {
|
|
transform.translation += translation;
|
|
}
|
|
}
|
|
|
|
fn rotation(
|
|
mut query: Query<&mut Transform, With<Camera>>,
|
|
input: Res<ButtonInput<KeyCode>>,
|
|
time: Res<Time>,
|
|
) {
|
|
let mut transform = query.single_mut();
|
|
let delta = time.delta_seconds();
|
|
|
|
if input.pressed(KeyCode::ArrowLeft) {
|
|
transform.rotate_around(Vec3::ZERO, Quat::from_rotation_y(delta));
|
|
} else if input.pressed(KeyCode::ArrowRight) {
|
|
transform.rotate_around(Vec3::ZERO, Quat::from_rotation_y(-delta));
|
|
}
|
|
}
|