
# 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>
184 lines
5.8 KiB
Rust
184 lines
5.8 KiB
Rust
//! A 3d Scene with a button and playing sound.
|
|
|
|
use bevy::{
|
|
color::palettes::basic::*,
|
|
input::{gestures::RotationGesture, touch::TouchPhase},
|
|
prelude::*,
|
|
window::{AppLifecycle, WindowMode},
|
|
};
|
|
|
|
// the `bevy_main` proc_macro generates the required boilerplate for iOS and Android
|
|
#[bevy_main]
|
|
fn main() {
|
|
let mut app = App::new();
|
|
app.add_plugins(DefaultPlugins.set(WindowPlugin {
|
|
primary_window: Some(Window {
|
|
resizable: false,
|
|
mode: WindowMode::BorderlessFullscreen(MonitorSelection::Primary),
|
|
// on iOS, gestures must be enabled.
|
|
// This doesn't work on Android
|
|
recognize_rotation_gesture: true,
|
|
..default()
|
|
}),
|
|
..default()
|
|
}))
|
|
.add_systems(Startup, (setup_scene, setup_music))
|
|
.add_systems(Update, (touch_camera, button_handler, handle_lifetime))
|
|
.run();
|
|
}
|
|
|
|
fn touch_camera(
|
|
windows: Query<&Window>,
|
|
mut touches: EventReader<TouchInput>,
|
|
mut camera: Query<&mut Transform, With<Camera3d>>,
|
|
mut last_position: Local<Option<Vec2>>,
|
|
mut rotations: EventReader<RotationGesture>,
|
|
) {
|
|
let window = windows.single();
|
|
|
|
for touch in touches.read() {
|
|
if touch.phase == TouchPhase::Started {
|
|
*last_position = None;
|
|
}
|
|
if let Some(last_position) = *last_position {
|
|
let mut transform = camera.single_mut();
|
|
*transform = Transform::from_xyz(
|
|
transform.translation.x
|
|
+ (touch.position.x - last_position.x) / window.width() * 5.0,
|
|
transform.translation.y,
|
|
transform.translation.z
|
|
+ (touch.position.y - last_position.y) / window.height() * 5.0,
|
|
)
|
|
.looking_at(Vec3::ZERO, Vec3::Y);
|
|
}
|
|
*last_position = Some(touch.position);
|
|
}
|
|
// Rotation gestures only work on iOS
|
|
for rotation in rotations.read() {
|
|
let mut transform = camera.single_mut();
|
|
let forward = transform.forward();
|
|
transform.rotate_axis(forward, rotation.0 / 10.0);
|
|
}
|
|
}
|
|
|
|
/// set up a simple 3D scene
|
|
fn setup_scene(
|
|
mut commands: Commands,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<StandardMaterial>>,
|
|
) {
|
|
// plane
|
|
commands.spawn((
|
|
Mesh3d(meshes.add(Plane3d::default().mesh().size(5.0, 5.0))),
|
|
MeshMaterial3d(materials.add(Color::srgb(0.1, 0.2, 0.1))),
|
|
));
|
|
// cube
|
|
commands.spawn((
|
|
Mesh3d(meshes.add(Cuboid::default())),
|
|
MeshMaterial3d(materials.add(Color::srgb(0.5, 0.4, 0.3))),
|
|
Transform::from_xyz(0.0, 0.5, 0.0),
|
|
));
|
|
// sphere
|
|
commands.spawn((
|
|
Mesh3d(meshes.add(Sphere::new(0.5).mesh().ico(4).unwrap())),
|
|
MeshMaterial3d(materials.add(Color::srgb(0.1, 0.4, 0.8))),
|
|
Transform::from_xyz(1.5, 1.5, 1.5),
|
|
));
|
|
// light
|
|
commands.spawn((
|
|
PointLight {
|
|
intensity: 1_000_000.0,
|
|
// Shadows makes some Android devices segfault, this is under investigation
|
|
// https://github.com/bevyengine/bevy/issues/8214
|
|
#[cfg(not(target_os = "android"))]
|
|
shadows_enabled: true,
|
|
..default()
|
|
},
|
|
Transform::from_xyz(4.0, 8.0, 4.0),
|
|
));
|
|
// camera
|
|
commands.spawn(Camera3dBundle {
|
|
transform: Transform::from_xyz(-2.0, 2.5, 5.0).looking_at(Vec3::ZERO, Vec3::Y),
|
|
// MSAA makes some Android devices panic, this is under investigation
|
|
// https://github.com/bevyengine/bevy/issues/8229
|
|
#[cfg(target_os = "android")]
|
|
msaa: Msaa::Off,
|
|
..default()
|
|
});
|
|
|
|
// Test ui
|
|
commands
|
|
.spawn(ButtonBundle {
|
|
style: Style {
|
|
justify_content: JustifyContent::Center,
|
|
align_items: AlignItems::Center,
|
|
position_type: PositionType::Absolute,
|
|
left: Val::Px(50.0),
|
|
right: Val::Px(50.0),
|
|
bottom: Val::Px(50.0),
|
|
..default()
|
|
},
|
|
..default()
|
|
})
|
|
.with_children(|b| {
|
|
b.spawn(
|
|
TextBundle::from_section(
|
|
"Test Button",
|
|
TextStyle {
|
|
font_size: 30.0,
|
|
color: Color::BLACK,
|
|
..default()
|
|
},
|
|
)
|
|
.with_text_justify(JustifyText::Center),
|
|
);
|
|
});
|
|
}
|
|
|
|
fn button_handler(
|
|
mut interaction_query: Query<
|
|
(&Interaction, &mut BackgroundColor),
|
|
(Changed<Interaction>, With<Button>),
|
|
>,
|
|
) {
|
|
for (interaction, mut color) in &mut interaction_query {
|
|
match *interaction {
|
|
Interaction::Pressed => {
|
|
*color = BLUE.into();
|
|
}
|
|
Interaction::Hovered => {
|
|
*color = GRAY.into();
|
|
}
|
|
Interaction::None => {
|
|
*color = WHITE.into();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
fn setup_music(asset_server: Res<AssetServer>, mut commands: Commands) {
|
|
commands.spawn(AudioBundle {
|
|
source: asset_server.load("sounds/Windless Slopes.ogg"),
|
|
settings: PlaybackSettings::LOOP,
|
|
});
|
|
}
|
|
|
|
// Pause audio when app goes into background and resume when it returns.
|
|
// This is handled by the OS on iOS, but not on Android.
|
|
fn handle_lifetime(
|
|
mut lifecycle_events: EventReader<AppLifecycle>,
|
|
music_controller: Query<&AudioSink>,
|
|
) {
|
|
let Ok(music_controller) = music_controller.get_single() else {
|
|
return;
|
|
};
|
|
|
|
for event in lifecycle_events.read() {
|
|
match event {
|
|
AppLifecycle::Idle | AppLifecycle::WillSuspend | AppLifecycle::WillResume => {}
|
|
AppLifecycle::Suspended => music_controller.pause(),
|
|
AppLifecycle::Running => music_controller.play(),
|
|
}
|
|
}
|
|
}
|