
# 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:   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>
141 lines
4.1 KiB
Rust
141 lines
4.1 KiB
Rust
//! This example showcases a 2D top-down camera with smooth player tracking.
|
|
//!
|
|
//! ## Controls
|
|
//!
|
|
//! | Key Binding | Action |
|
|
//! |:---------------------|:--------------|
|
|
//! | `W` | Move up |
|
|
//! | `S` | Move down |
|
|
//! | `A` | Move left |
|
|
//! | `D` | Move right |
|
|
|
|
use bevy::{core_pipeline::bloom::Bloom, prelude::*};
|
|
|
|
/// Player movement speed factor.
|
|
const PLAYER_SPEED: f32 = 100.;
|
|
|
|
/// How quickly should the camera snap to the desired location.
|
|
const CAMERA_DECAY_RATE: f32 = 2.;
|
|
|
|
#[derive(Component)]
|
|
struct Player;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.add_systems(Startup, (setup_scene, setup_instructions, setup_camera))
|
|
.add_systems(Update, (move_player, update_camera).chain())
|
|
.run();
|
|
}
|
|
|
|
fn setup_scene(
|
|
mut commands: Commands,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<ColorMaterial>>,
|
|
) {
|
|
// World where we move the player
|
|
commands.spawn((
|
|
Mesh2d(meshes.add(Rectangle::new(1000., 700.))),
|
|
MeshMaterial2d(materials.add(Color::srgb(0.2, 0.2, 0.3))),
|
|
));
|
|
|
|
// Player
|
|
commands.spawn((
|
|
Player,
|
|
Mesh2d(meshes.add(Circle::new(25.))),
|
|
MeshMaterial2d(materials.add(Color::srgb(6.25, 9.4, 9.1))), // RGB values exceed 1 to achieve a bright color for the bloom effect
|
|
Transform::from_xyz(0., 0., 2.),
|
|
));
|
|
}
|
|
|
|
fn setup_instructions(mut commands: Commands) {
|
|
commands.spawn(
|
|
TextBundle::from_section(
|
|
"Move the light with WASD.\nThe camera will smoothly track the light.",
|
|
TextStyle::default(),
|
|
)
|
|
.with_style(Style {
|
|
position_type: PositionType::Absolute,
|
|
bottom: Val::Px(12.0),
|
|
left: Val::Px(12.0),
|
|
..default()
|
|
}),
|
|
);
|
|
}
|
|
|
|
fn setup_camera(mut commands: Commands) {
|
|
commands.spawn((
|
|
Camera2dBundle {
|
|
camera: Camera {
|
|
hdr: true, // HDR is required for the bloom effect
|
|
..default()
|
|
},
|
|
..default()
|
|
},
|
|
Bloom::NATURAL,
|
|
));
|
|
}
|
|
|
|
/// Update the camera position by tracking the player.
|
|
fn update_camera(
|
|
mut camera: Query<&mut Transform, (With<Camera2d>, Without<Player>)>,
|
|
player: Query<&Transform, (With<Player>, Without<Camera2d>)>,
|
|
time: Res<Time>,
|
|
) {
|
|
let Ok(mut camera) = camera.get_single_mut() else {
|
|
return;
|
|
};
|
|
|
|
let Ok(player) = player.get_single() else {
|
|
return;
|
|
};
|
|
|
|
let Vec3 { x, y, .. } = player.translation;
|
|
let direction = Vec3::new(x, y, camera.translation.z);
|
|
|
|
// Applies a smooth effect to camera movement using stable interpolation
|
|
// between the camera position and the player position on the x and y axes.
|
|
camera
|
|
.translation
|
|
.smooth_nudge(&direction, CAMERA_DECAY_RATE, time.delta_seconds());
|
|
}
|
|
|
|
/// Update the player position with keyboard inputs.
|
|
/// Note that the approach used here is for demonstration purposes only,
|
|
/// as the point of this example is to showcase the camera tracking feature.
|
|
///
|
|
/// A more robust solution for player movement can be found in `examples/movement/physics_in_fixed_timestep.rs`.
|
|
fn move_player(
|
|
mut player: Query<&mut Transform, With<Player>>,
|
|
time: Res<Time>,
|
|
kb_input: Res<ButtonInput<KeyCode>>,
|
|
) {
|
|
let Ok(mut player) = player.get_single_mut() else {
|
|
return;
|
|
};
|
|
|
|
let mut direction = Vec2::ZERO;
|
|
|
|
if kb_input.pressed(KeyCode::KeyW) {
|
|
direction.y += 1.;
|
|
}
|
|
|
|
if kb_input.pressed(KeyCode::KeyS) {
|
|
direction.y -= 1.;
|
|
}
|
|
|
|
if kb_input.pressed(KeyCode::KeyA) {
|
|
direction.x -= 1.;
|
|
}
|
|
|
|
if kb_input.pressed(KeyCode::KeyD) {
|
|
direction.x += 1.;
|
|
}
|
|
|
|
// Progressively update the player's position over time. Normalize the
|
|
// direction vector to prevent it from exceeding a magnitude of 1 when
|
|
// moving diagonally.
|
|
let move_delta = direction.normalize_or_zero() * PLAYER_SPEED * time.delta_seconds();
|
|
player.translation += move_delta.extend(0.);
|
|
}
|