Split OrthographicProjection::default into 2d & 3d (Adopted)

crates/bevy_core_pipeline/src/core_2d/camera_2d.rs

@@ -23,10 +23,6 @@ pub struct Camera2d;
 pub struct Camera2dBundle {
  pub camera: Camera,
  pub camera_render_graph: CameraRenderGraph,
- /// Note: default value for `OrthographicProjection.near` is `0.0`
- /// which makes objects on the screen plane invisible to 2D camera.
- /// `Camera2dBundle::default()` sets `near` to negative value,
- /// so be careful when initializing this field manually.
  pub projection: OrthographicProjection,
  pub visible_entities: VisibleEntities,
  pub frustum: Frustum,
@@ -41,11 +37,7 @@ pub struct Camera2dBundle {
 
 impl Default for Camera2dBundle {
  fn default() -> Self {
- let projection = OrthographicProjection {
- far: 1000.,
- near: -1000.,
- ..Default::default()
- };
+ let projection = OrthographicProjection::default_2d();
  let transform = Transform::default();
  let frustum = projection.compute_frustum(&GlobalTransform::from(transform));
  Self {
@@ -77,7 +69,7 @@ impl Camera2dBundle {
  // the camera's translation by far and use a right handed coordinate system
  let projection = OrthographicProjection {
  far,
- ..Default::default()
+ ..OrthographicProjection::default_2d()
  };
  let transform = Transform::from_xyz(0.0, 0.0, far - 0.1);
  let frustum = projection.compute_frustum(&GlobalTransform::from(transform));

crates/bevy_dev_tools/src/ui_debug_overlay/mod.rs

@@ -92,7 +92,7 @@ fn update_debug_camera(
  projection: OrthographicProjection {
  far: 1000.0,
  viewport_origin: Vec2::new(0.0, 0.0),
- ..default()
+ ..OrthographicProjection::default_3d()
  },
  camera: Camera {
  order: LAYOUT_DEBUG_CAMERA_ORDER,

crates/bevy_gltf/src/loader.rs

@@ -1256,7 +1256,7 @@ fn load_node(
  far: orthographic.zfar(),
  scaling_mode: ScalingMode::FixedHorizontal(1.0),
  scale: xmag,
- ..Default::default()
+ ..OrthographicProjection::default_3d()
  };
 
  Projection::Orthographic(orthographic_projection)

crates/bevy_render/src/camera/projection.rs

@@ -237,7 +237,7 @@ impl Default for PerspectiveProjection {
 /// # use bevy_render::camera::{OrthographicProjection, Projection, ScalingMode};
 /// let projection = Projection::Orthographic(OrthographicProjection {
 /// scaling_mode: ScalingMode::FixedVertical(2.0),
-/// ..OrthographicProjection::default()
+/// ..OrthographicProjection::default_2d()
 /// });
 /// ```
 #[derive(Debug, Clone, Copy, Reflect, Serialize, Deserialize)]
@@ -334,11 +334,11 @@ impl DivAssign<f32> for ScalingMode {
 /// # use bevy_render::camera::{OrthographicProjection, Projection, ScalingMode};
 /// let projection = Projection::Orthographic(OrthographicProjection {
 /// scaling_mode: ScalingMode::WindowSize(100.0),
-/// ..OrthographicProjection::default()
+/// ..OrthographicProjection::default_2d()
 /// });
 /// ```
 #[derive(Component, Debug, Clone, Reflect)]
-#[reflect(Component, Default)]
+#[reflect(Component)]
 pub struct OrthographicProjection {
  /// The distance of the near clipping plane in world units.
  ///
@@ -479,8 +479,29 @@ impl CameraProjection for OrthographicProjection {
  }
 }
 
-impl Default for OrthographicProjection {
- fn default() -> Self {
+impl FromWorld for OrthographicProjection {
+ fn from_world(_world: &mut World) -> Self {
+ OrthographicProjection::default_3d()
+ }
+}
+
+impl OrthographicProjection {
+ /// Returns the default orthographic projection in a 2d context.
+ ///
+ /// The near plane is set to a negative value so that the camera can still
+ /// render the scene when using positive z coordinates for foreground elements.
+ pub fn default_2d() -> Self {
+ OrthographicProjection {
+ near: -1000.0,
+ ..OrthographicProjection::default_3d()
+ }
+ }
+
+ /// Returns the default orthographic projection in a 3d context.
+ ///
+ /// The near plane is set to 0.0 so that the camera doesn't render
+ /// objects that are behind it.
+ pub fn default_3d() -> Self {
  OrthographicProjection {
  scale: 1.0,
  near: 0.0,

examples/3d/orthographic.rs

@@ -20,7 +20,7 @@ fn setup(
  projection: OrthographicProjection {
  // 6 world units per window height.
  scaling_mode: ScalingMode::FixedVertical(6.0),
- ..default()
+ ..OrthographicProjection::default_3d()
  }
  .into(),
  transform: Transform::from_xyz(5.0, 5.0, 5.0).looking_at(Vec3::ZERO, Vec3::Y),

examples/3d/pbr.rs

@@ -121,7 +121,7 @@ fn setup(
  transform: Transform::from_xyz(0.0, 0.0, 8.0).looking_at(Vec3::default(), Vec3::Y),
  projection: OrthographicProjection {
  scale: 0.01,
- ..default()
+ ..OrthographicProjection::default_3d()
  }
  .into(),
  ..default()

examples/stress_tests/many_lights.rs

@@ -96,7 +96,7 @@ fn setup(
  projection: OrthographicProjection {
  scale: 20.0,
  scaling_mode: ScalingMode::FixedHorizontal(1.0),
- ..default()
+ ..OrthographicProjection::default_3d()
  }
  .into(),
  ..default()