basic visibility for retained gizmos

- set `Visibility` as a required component on `Gizmo` components in
  `GizmoRenderPlugin`
- update `extract_linegizmos` to take view visibility into account
- update the 3d_gizmos example to toggle visibility of the retained
  gizmo in the scene

investigating the feasibility of attaching an AABB to the gizmo for
better visibility testing

will build a `retained_gizmos` example to better demonstrate the
feature. it's kind of crammed into the current example code

Author: blamelessgames

crates/bevy_gizmos_render/src/lib.rs

@@ -25,6 +25,7 @@ mod pipeline_2d;
 mod pipeline_3d;
 
 use bevy_app::{App, Plugin};
+use bevy_camera::visibility::{add_visibility_class, Visibility, VisibilityClass};
 use bevy_ecs::{
     resource::Resource,
     schedule::{IntoScheduleConfigs, SystemSet},
@@ -67,6 +68,7 @@ use bevy_render::render_resource::{
 
 use bevy_gizmos::{
     config::{GizmoConfigStore, GizmoLineJoint},
+    prelude::Gizmo,
     GizmoAsset, GizmoHandles,
 };
 
@@ -112,6 +114,8 @@ impl Plugin for GizmoRenderPlugin {
         } else {
             tracing::warn!("bevy_render feature is enabled but RenderApp was not detected. Are you sure you loaded GizmoPlugin after RenderPlugin?");
         }
+
+        app.register_required_components::<Gizmo, Visibility>();
     }
 }
 

crates/bevy_gizmos_render/src/retained.rs

@@ -1,10 +1,13 @@
 //! This module is for 'retained' alternatives to the 'immediate mode' [`Gizmos`](bevy_gizmos::gizmos::Gizmos) system parameter.
 
 use crate::LineGizmoUniform;
-use bevy_camera::visibility::RenderLayers;
+use bevy_camera::visibility::{InheritedVisibility, RenderLayers, ViewVisibility};
 use bevy_gizmos::retained::Gizmo;
 use bevy_math::Affine3;
-use bevy_render::sync_world::{MainEntity, TemporaryRenderEntity};
+use bevy_render::{
+    sync_world::{MainEntity, TemporaryRenderEntity},
+    view,
+};
 use bevy_utils::once;
 use tracing::warn;
 use {
@@ -22,10 +25,24 @@ use bevy_gizmos::config::GizmoLineStyle;
 pub(crate) fn extract_linegizmos(
     mut commands: Commands,
     mut previous_len: Local<usize>,
-    query: Extract<Query<(Entity, &Gizmo, &GlobalTransform, Option<&RenderLayers>)>>,
+    query: Extract<
+        Query<(
+            Entity,
+            &Gizmo,
+            &GlobalTransform,
+            &InheritedVisibility,
+            &ViewVisibility,
+            Option<&RenderLayers>,
+        )>,
+    >,
 ) {
     let mut values = Vec::with_capacity(*previous_len);
-    for (entity, gizmo, transform, render_layers) in &query {
+    for (entity, gizmo, transform, visibility, view_visibility, render_layers) in &query {
+        println!("{visibility:?} {view_visibility:?}");
+        if !view_visibility.get() {
+            continue;
+        }
+
         let joints_resolution = if let GizmoLineJoint::Round(resolution) = gizmo.line_config.joints
         {
             resolution

examples/gizmos/3d_gizmos.rs

@@ -12,7 +12,14 @@ fn main() {
         .add_plugins((DefaultPlugins, FreeCameraPlugin))
         .init_gizmo_group::<MyRoundGizmos>()
         .add_systems(Startup, setup)
-        .add_systems(Update, (draw_example_collection, update_config))
+        .add_systems(
+            Update,
+            (
+                draw_example_collection,
+                update_config,
+                update_retained_gizmo_visibility,
+            ),
+        )
         .run();
 }
 
@@ -34,7 +41,7 @@ fn setup(
 
     // A sphere made out of 30_000 lines!
     gizmo
-        .sphere(Isometry3d::IDENTITY, 0.5, CRIMSON)
+        .sphere(Isometry3d::IDENTITY, 0.5, LIGHT_GOLDENROD_YELLOW)
         .resolution(30_000 / 3);
 
     commands.spawn((
@@ -82,6 +89,7 @@ fn setup(
             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 '3' to toggle the visibility of retained 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",
@@ -290,3 +298,14 @@ fn update_config(
         config_store.config_mut::<AabbGizmoConfigGroup>().1.draw_all ^= true;
     }
 }
+
+fn update_retained_gizmo_visibility(
+    keyboard: Res<ButtonInput<KeyCode>>,
+    mut gizmos: Query<&mut Visibility, With<Gizmo>>,
+) {
+    if keyboard.just_pressed(KeyCode::Digit3) {
+        for mut visibility in &mut gizmos {
+            visibility.toggle_inherited_hidden();
+        }
+    }
+}