# Objective Yet another PR for migrating stuff to required components. This time, cameras! ## Solution As per the [selected proposal](https://hackmd.io/tsYID4CGRiWxzsgawzxG_g#Combined-Proposal-1-Selected), deprecate `Camera2dBundle` and `Camera3dBundle` in favor of `Camera2d` and `Camera3d`. Adding a `Camera` without `Camera2d` or `Camera3d` now logs a warning, as suggested by Cart [on Discord](https://discord.com/channels/691052431525675048/1264881140007702558/1291506402832945273). I would personally like cameras to work a bit differently and be split into a few more components, to avoid some footguns and confusing semantics, but that is more controversial, and shouldn't block this core migration. ## Testing I ran a few 2D and 3D examples, and tried cameras with and without render graphs. --- ## Migration Guide `Camera2dBundle` and `Camera3dBundle` have been deprecated in favor of `Camera2d` and `Camera3d`. Inserting them will now also insert the other components required by them automatically.
		
			
				
	
	
		
			281 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			281 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
//! This example demonstrates Bevy's immediate mode drawing API intended for visual debugging.
 | 
						|
 | 
						|
#[path = "../helpers/camera_controller.rs"]
 | 
						|
mod camera_controller;
 | 
						|
 | 
						|
use bevy::{color::palettes::css::*, prelude::*};
 | 
						|
use camera_controller::{CameraController, CameraControllerPlugin};
 | 
						|
use std::f32::consts::PI;
 | 
						|
 | 
						|
fn main() {
 | 
						|
    App::new()
 | 
						|
        .add_plugins((DefaultPlugins, CameraControllerPlugin))
 | 
						|
        .init_gizmo_group::<MyRoundGizmos>()
 | 
						|
        .add_systems(Startup, setup)
 | 
						|
        .add_systems(Update, (draw_example_collection, update_config))
 | 
						|
        .run();
 | 
						|
}
 | 
						|
 | 
						|
// We can create our own gizmo config group!
 | 
						|
#[derive(Default, Reflect, GizmoConfigGroup)]
 | 
						|
struct MyRoundGizmos {}
 | 
						|
 | 
						|
fn setup(
 | 
						|
    mut commands: Commands,
 | 
						|
    mut meshes: ResMut<Assets<Mesh>>,
 | 
						|
    mut materials: ResMut<Assets<StandardMaterial>>,
 | 
						|
) {
 | 
						|
    commands.spawn((
 | 
						|
        Camera3d::default(),
 | 
						|
        Transform::from_xyz(0., 1.5, 6.).looking_at(Vec3::ZERO, Vec3::Y),
 | 
						|
        CameraController::default(),
 | 
						|
    ));
 | 
						|
    // plane
 | 
						|
    commands.spawn((
 | 
						|
        Mesh3d(meshes.add(Plane3d::default().mesh().size(5.0, 5.0))),
 | 
						|
        MeshMaterial3d(materials.add(Color::srgb(0.3, 0.5, 0.3))),
 | 
						|
    ));
 | 
						|
    // cube
 | 
						|
    commands.spawn((
 | 
						|
        Mesh3d(meshes.add(Cuboid::new(1.0, 1.0, 1.0))),
 | 
						|
        MeshMaterial3d(materials.add(Color::srgb(0.8, 0.7, 0.6))),
 | 
						|
        Transform::from_xyz(0.0, 0.5, 0.0),
 | 
						|
    ));
 | 
						|
    // light
 | 
						|
    commands.spawn((
 | 
						|
        PointLight {
 | 
						|
            shadows_enabled: true,
 | 
						|
            ..default()
 | 
						|
        },
 | 
						|
        Transform::from_xyz(4.0, 8.0, 4.0),
 | 
						|
    ));
 | 
						|
 | 
						|
    // example instructions
 | 
						|
    commands.spawn(
 | 
						|
        TextBundle::from_section(
 | 
						|
            "Press 'T' to toggle drawing gizmos on top of everything else in the scene\n\
 | 
						|
            Press 'P' to toggle perspective for line gizmos\n\
 | 
						|
            Hold 'Left' or 'Right' to change the line width of straight gizmos\n\
 | 
						|
            Hold 'Up' or 'Down' to change the line width of round gizmos\n\
 | 
						|
            Press '1' or '2' to toggle the visibility of straight gizmos or round gizmos\n\
 | 
						|
            Press 'B' to show all AABB boxes\n\
 | 
						|
            Press 'U' or 'I' to cycle through line styles for straight or round gizmos\n\
 | 
						|
            Press 'J' or 'K' to cycle through line joins for straight or round gizmos",
 | 
						|
            TextStyle::default(),
 | 
						|
        )
 | 
						|
        .with_style(Style {
 | 
						|
            position_type: PositionType::Absolute,
 | 
						|
            top: Val::Px(12.0),
 | 
						|
            left: Val::Px(12.0),
 | 
						|
            ..default()
 | 
						|
        }),
 | 
						|
    );
 | 
						|
}
 | 
						|
 | 
						|
fn draw_example_collection(
 | 
						|
    mut gizmos: Gizmos,
 | 
						|
    mut my_gizmos: Gizmos<MyRoundGizmos>,
 | 
						|
    time: Res<Time>,
 | 
						|
) {
 | 
						|
    gizmos.grid(
 | 
						|
        Isometry3d::from_rotation(Quat::from_rotation_x(PI / 2.)),
 | 
						|
        UVec2::splat(20),
 | 
						|
        Vec2::new(2., 2.),
 | 
						|
        // Light gray
 | 
						|
        LinearRgba::gray(0.65),
 | 
						|
    );
 | 
						|
    gizmos.grid(
 | 
						|
        Isometry3d::new(Vec3::ONE * 10.0, Quat::from_rotation_x(PI / 3. * 2.)),
 | 
						|
        UVec2::splat(20),
 | 
						|
        Vec2::new(2., 2.),
 | 
						|
        PURPLE,
 | 
						|
    );
 | 
						|
    gizmos.sphere(Isometry3d::from_translation(Vec3::ONE * 10.0), 1.0, PURPLE);
 | 
						|
 | 
						|
    gizmos
 | 
						|
        .primitive_3d(
 | 
						|
            &Plane3d {
 | 
						|
                normal: Dir3::Y,
 | 
						|
                half_size: Vec2::splat(1.0),
 | 
						|
            },
 | 
						|
            Isometry3d::new(
 | 
						|
                Vec3::ONE * 4.0 + Vec2::from(ops::sin_cos(time.elapsed_seconds())).extend(0.0),
 | 
						|
                Quat::from_rotation_x(PI / 2. + time.elapsed_seconds()),
 | 
						|
            ),
 | 
						|
            GREEN,
 | 
						|
        )
 | 
						|
        .cell_count(UVec2::new(5, 10))
 | 
						|
        .spacing(Vec2::new(0.2, 0.1));
 | 
						|
 | 
						|
    gizmos.cuboid(
 | 
						|
        Transform::from_translation(Vec3::Y * 0.5).with_scale(Vec3::splat(1.25)),
 | 
						|
        BLACK,
 | 
						|
    );
 | 
						|
    gizmos.rect(
 | 
						|
        Isometry3d::new(
 | 
						|
            Vec3::new(ops::cos(time.elapsed_seconds()) * 2.5, 1., 0.),
 | 
						|
            Quat::from_rotation_y(PI / 2.),
 | 
						|
        ),
 | 
						|
        Vec2::splat(2.),
 | 
						|
        LIME,
 | 
						|
    );
 | 
						|
 | 
						|
    gizmos.cross(
 | 
						|
        Isometry3d::from_translation(Vec3::new(-1., 1., 1.)),
 | 
						|
        0.5,
 | 
						|
        FUCHSIA,
 | 
						|
    );
 | 
						|
 | 
						|
    let domain = Interval::EVERYWHERE;
 | 
						|
    let curve = function_curve(domain, |t| {
 | 
						|
        (Vec2::from(ops::sin_cos(t * 10.0))).extend(t - 6.0)
 | 
						|
    });
 | 
						|
    let resolution = ((ops::sin(time.elapsed_seconds()) + 1.0) * 100.0) as usize;
 | 
						|
    let times_and_colors = (0..=resolution)
 | 
						|
        .map(|n| n as f32 / resolution as f32)
 | 
						|
        .map(|t| t * 5.0)
 | 
						|
        .map(|t| (t, TEAL.mix(&HOT_PINK, t / 5.0)));
 | 
						|
    gizmos.curve_gradient_3d(curve, times_and_colors);
 | 
						|
 | 
						|
    my_gizmos.sphere(
 | 
						|
        Isometry3d::from_translation(Vec3::new(1., 0.5, 0.)),
 | 
						|
        0.5,
 | 
						|
        RED,
 | 
						|
    );
 | 
						|
 | 
						|
    my_gizmos
 | 
						|
        .rounded_cuboid(
 | 
						|
            Isometry3d::from_translation(Vec3::new(-2.0, 0.75, -0.75)),
 | 
						|
            Vec3::splat(0.9),
 | 
						|
            TURQUOISE,
 | 
						|
        )
 | 
						|
        .edge_radius(0.1)
 | 
						|
        .arc_resolution(4);
 | 
						|
 | 
						|
    for y in [0., 0.5, 1.] {
 | 
						|
        gizmos.ray(
 | 
						|
            Vec3::new(1., y, 0.),
 | 
						|
            Vec3::new(-3., ops::sin(time.elapsed_seconds() * 3.), 0.),
 | 
						|
            BLUE,
 | 
						|
        );
 | 
						|
    }
 | 
						|
 | 
						|
    my_gizmos
 | 
						|
        .arc_3d(
 | 
						|
            180.0_f32.to_radians(),
 | 
						|
            0.2,
 | 
						|
            Isometry3d::new(
 | 
						|
                Vec3::ONE,
 | 
						|
                Quat::from_rotation_arc(Vec3::Y, Vec3::ONE.normalize()),
 | 
						|
            ),
 | 
						|
            ORANGE,
 | 
						|
        )
 | 
						|
        .resolution(10);
 | 
						|
 | 
						|
    // Circles have 32 line-segments by default.
 | 
						|
    my_gizmos.circle(
 | 
						|
        Isometry3d::from_rotation(Quat::from_rotation_arc(Vec3::Z, Vec3::Y)),
 | 
						|
        3.,
 | 
						|
        BLACK,
 | 
						|
    );
 | 
						|
    // You may want to increase this for larger circles or spheres.
 | 
						|
    my_gizmos
 | 
						|
        .circle(
 | 
						|
            Isometry3d::from_rotation(Quat::from_rotation_arc(Vec3::Z, Vec3::Y)),
 | 
						|
            3.1,
 | 
						|
            NAVY,
 | 
						|
        )
 | 
						|
        .resolution(64);
 | 
						|
    my_gizmos
 | 
						|
        .sphere(Isometry3d::IDENTITY, 3.2, BLACK)
 | 
						|
        .resolution(64);
 | 
						|
 | 
						|
    gizmos.arrow(Vec3::ZERO, Vec3::ONE * 1.5, YELLOW);
 | 
						|
 | 
						|
    // You can create more complex arrows using the arrow builder.
 | 
						|
    gizmos
 | 
						|
        .arrow(Vec3::new(2., 0., 2.), Vec3::new(2., 2., 2.), ORANGE_RED)
 | 
						|
        .with_double_end()
 | 
						|
        .with_tip_length(0.5);
 | 
						|
}
 | 
						|
 | 
						|
fn update_config(
 | 
						|
    mut config_store: ResMut<GizmoConfigStore>,
 | 
						|
    keyboard: Res<ButtonInput<KeyCode>>,
 | 
						|
    time: Res<Time>,
 | 
						|
) {
 | 
						|
    if keyboard.just_pressed(KeyCode::KeyT) {
 | 
						|
        for (_, config, _) in config_store.iter_mut() {
 | 
						|
            config.depth_bias = if config.depth_bias == 0. { -1. } else { 0. };
 | 
						|
        }
 | 
						|
    }
 | 
						|
    if keyboard.just_pressed(KeyCode::KeyP) {
 | 
						|
        for (_, config, _) in config_store.iter_mut() {
 | 
						|
            // Toggle line_perspective
 | 
						|
            config.line_perspective ^= true;
 | 
						|
            // Increase the line width when line_perspective is on
 | 
						|
            config.line_width *= if config.line_perspective { 5. } else { 1. / 5. };
 | 
						|
        }
 | 
						|
    }
 | 
						|
 | 
						|
    let (config, _) = config_store.config_mut::<DefaultGizmoConfigGroup>();
 | 
						|
    if keyboard.pressed(KeyCode::ArrowRight) {
 | 
						|
        config.line_width += 5. * time.delta_seconds();
 | 
						|
        config.line_width = config.line_width.clamp(0., 50.);
 | 
						|
    }
 | 
						|
    if keyboard.pressed(KeyCode::ArrowLeft) {
 | 
						|
        config.line_width -= 5. * time.delta_seconds();
 | 
						|
        config.line_width = config.line_width.clamp(0., 50.);
 | 
						|
    }
 | 
						|
    if keyboard.just_pressed(KeyCode::Digit1) {
 | 
						|
        config.enabled ^= true;
 | 
						|
    }
 | 
						|
    if keyboard.just_pressed(KeyCode::KeyU) {
 | 
						|
        config.line_style = match config.line_style {
 | 
						|
            GizmoLineStyle::Solid => GizmoLineStyle::Dotted,
 | 
						|
            _ => GizmoLineStyle::Solid,
 | 
						|
        };
 | 
						|
    }
 | 
						|
    if keyboard.just_pressed(KeyCode::KeyJ) {
 | 
						|
        config.line_joints = match config.line_joints {
 | 
						|
            GizmoLineJoint::Bevel => GizmoLineJoint::Miter,
 | 
						|
            GizmoLineJoint::Miter => GizmoLineJoint::Round(4),
 | 
						|
            GizmoLineJoint::Round(_) => GizmoLineJoint::None,
 | 
						|
            GizmoLineJoint::None => GizmoLineJoint::Bevel,
 | 
						|
        };
 | 
						|
    }
 | 
						|
 | 
						|
    let (my_config, _) = config_store.config_mut::<MyRoundGizmos>();
 | 
						|
    if keyboard.pressed(KeyCode::ArrowUp) {
 | 
						|
        my_config.line_width += 5. * time.delta_seconds();
 | 
						|
        my_config.line_width = my_config.line_width.clamp(0., 50.);
 | 
						|
    }
 | 
						|
    if keyboard.pressed(KeyCode::ArrowDown) {
 | 
						|
        my_config.line_width -= 5. * time.delta_seconds();
 | 
						|
        my_config.line_width = my_config.line_width.clamp(0., 50.);
 | 
						|
    }
 | 
						|
    if keyboard.just_pressed(KeyCode::Digit2) {
 | 
						|
        my_config.enabled ^= true;
 | 
						|
    }
 | 
						|
    if keyboard.just_pressed(KeyCode::KeyI) {
 | 
						|
        my_config.line_style = match my_config.line_style {
 | 
						|
            GizmoLineStyle::Solid => GizmoLineStyle::Dotted,
 | 
						|
            _ => GizmoLineStyle::Solid,
 | 
						|
        };
 | 
						|
    }
 | 
						|
    if keyboard.just_pressed(KeyCode::KeyK) {
 | 
						|
        my_config.line_joints = match my_config.line_joints {
 | 
						|
            GizmoLineJoint::Bevel => GizmoLineJoint::Miter,
 | 
						|
            GizmoLineJoint::Miter => GizmoLineJoint::Round(4),
 | 
						|
            GizmoLineJoint::Round(_) => GizmoLineJoint::None,
 | 
						|
            GizmoLineJoint::None => GizmoLineJoint::Bevel,
 | 
						|
        };
 | 
						|
    }
 | 
						|
 | 
						|
    if keyboard.just_pressed(KeyCode::KeyB) {
 | 
						|
        // AABB gizmos are normally only drawn on entities with a ShowAabbGizmo component
 | 
						|
        // We can change this behaviour in the configuration of AabbGizmoGroup
 | 
						|
        config_store.config_mut::<AabbGizmoConfigGroup>().1.draw_all ^= true;
 | 
						|
    }
 | 
						|
}
 |