Add DisableGizmos

Author: tim-blackbird

crates/bevy_gizmos/src/lib.rs

@@ -38,7 +38,10 @@ use bevy_reflect::{
 };
 use bevy_render::{
     color::Color,
-    extract_component::{ComponentUniforms, DynamicUniformIndex, UniformComponentPlugin},
+    extract_component::{
+        ComponentUniforms, DynamicUniformIndex, ExtractComponent, ExtractComponentPlugin,
+        UniformComponentPlugin,
+    },
     primitives::Aabb,
     render_asset::{PrepareAssetError, RenderAsset, RenderAssetPlugin, RenderAssets},
     render_phase::{PhaseItem, RenderCommand, RenderCommandResult, TrackedRenderPass},
@@ -80,7 +83,10 @@ impl Plugin for GizmoPlugin {
 
         app.add_plugins(UniformComponentPlugin::<LineGizmoUniform>::default())
             .add_asset::<LineGizmo>()
-            .add_plugins(RenderAssetPlugin::<LineGizmo>::default())
+            .add_plugins((
+                RenderAssetPlugin::<LineGizmo>::default(),
+                ExtractComponentPlugin::<DisableGizmos>::default(),
+            ))
             .init_resource::<LineGizmoHandles>()
             .init_resource::<GizmoConfig>()
             .init_resource::<GizmoStorage>()
@@ -127,6 +133,10 @@ impl Plugin for GizmoPlugin {
     }
 }
 
+/// Cameras with this component will not render gizmos.
+#[derive(Component, Clone, ExtractComponent)]
+pub struct DisableGizmos;
+
 /// A [`Resource`] that stores configuration for gizmos.
 #[derive(Resource, Clone)]
 pub struct GizmoConfig {

crates/bevy_gizmos/src/pipeline_2d.rs

@@ -1,13 +1,14 @@
 use crate::{
-    line_gizmo_vertex_buffer_layouts, DrawLineGizmo, LineGizmo, LineGizmoUniformBindgroupLayout,
-    SetLineGizmoBindGroup, LINE_SHADER_HANDLE,
+    line_gizmo_vertex_buffer_layouts, DisableGizmos, DrawLineGizmo, LineGizmo,
+    LineGizmoUniformBindgroupLayout, SetLineGizmoBindGroup, LINE_SHADER_HANDLE,
 };
 use bevy_app::{App, Plugin};
 use bevy_asset::Handle;
 use bevy_core_pipeline::core_2d::Transparent2d;
 
 use bevy_ecs::{
     prelude::Entity,
+    query::Without,
     schedule::IntoSystemConfigs,
     system::{Query, Res, ResMut, Resource},
     world::{FromWorld, World},
@@ -133,7 +134,7 @@ fn queue_line_gizmos_2d(
     msaa: Res<Msaa>,
     line_gizmos: Query<(Entity, &Handle<LineGizmo>)>,
     line_gizmo_assets: Res<RenderAssets<LineGizmo>>,
-    mut views: Query<(&ExtractedView, &mut RenderPhase<Transparent2d>)>,
+    mut views: Query<(&ExtractedView, &mut RenderPhase<Transparent2d>), Without<DisableGizmos>>,
 ) {
     let draw_function = draw_functions.read().get_id::<DrawLineGizmo2d>().unwrap();
 

crates/bevy_gizmos/src/pipeline_3d.rs

@@ -1,5 +1,5 @@
 use crate::{
-    line_gizmo_vertex_buffer_layouts, DrawLineGizmo, GizmoConfig, LineGizmo,
+    line_gizmo_vertex_buffer_layouts, DisableGizmos, DrawLineGizmo, GizmoConfig, LineGizmo,
     LineGizmoUniformBindgroupLayout, SetLineGizmoBindGroup, LINE_SHADER_HANDLE,
 };
 use bevy_app::{App, Plugin};
@@ -8,6 +8,7 @@ use bevy_core_pipeline::core_3d::Transparent3d;
 
 use bevy_ecs::{
     prelude::Entity,
+    query::Without,
     schedule::IntoSystemConfigs,
     system::{Query, Res, ResMut, Resource},
     world::{FromWorld, World},
@@ -159,7 +160,7 @@ fn queue_line_gizmos_3d(
     config: Res<GizmoConfig>,
     line_gizmos: Query<(Entity, &Handle<LineGizmo>)>,
     line_gizmo_assets: Res<RenderAssets<LineGizmo>>,
-    mut views: Query<(&ExtractedView, &mut RenderPhase<Transparent3d>)>,
+    mut views: Query<(&ExtractedView, &mut RenderPhase<Transparent3d>), Without<DisableGizmos>>,
 ) {
     let draw_function = draw_functions.read().get_id::<DrawLineGizmo3d>().unwrap();