glizmos

Author: atlv24

crates/bevy_gizmos/Cargo.toml

@@ -8,6 +8,9 @@ repository = "https://github.com/bevyengine/bevy"
 license = "MIT OR Apache-2.0"
 keywords = ["bevy"]
 
+[features]
+global_gizmos = []
+
 [dependencies]
 # Bevy
 bevy_app = { path = "../bevy_app", version = "0.18.0-dev" }

crates/bevy_gizmos/src/global.rs

@@ -0,0 +1,68 @@
+use std::sync::Mutex;
+
+use bevy_app::{App, Last, Plugin};
+use bevy_ecs::schedule::IntoScheduleConfigs;
+
+use crate::{
+    config::DefaultGizmoConfigGroup,
+    gizmos::{GizmoBuffer, Gizmos},
+    GizmoMeshSystems,
+};
+
+static GLOBAL_GIZMO: Mutex<GizmoBuffer<DefaultGizmoConfigGroup, ()>> =
+    Mutex::new(GizmoBuffer::new());
+
+/// Lets you use bevy gizmos outside of systems.
+pub struct GlobalGizmosPlugin;
+
+impl Plugin for GlobalGizmosPlugin {
+    fn build(&self, app: &mut App) {
+        app.add_systems(Last, flush_global_gizmos.before(GizmoMeshSystems));
+    }
+}
+
+fn flush_global_gizmos(mut gizmos: Gizmos) {
+    let mut buffer = GizmoBuffer::new();
+    {
+        core::mem::swap(&mut buffer, &mut GLOBAL_GIZMO.lock().unwrap());
+    }
+    gizmos.strip_positions.extend(buffer.strip_positions);
+    gizmos.strip_colors.extend(buffer.strip_colors);
+    gizmos.list_positions.extend(buffer.list_positions);
+    gizmos.list_colors.extend(buffer.list_colors);
+}
+
+/// A global gizmo context for use outside of bevy systems.
+///
+/// # Example
+/// ```
+/// # use bevy_gizmos::prelude::*;
+/// # use bevy_math::prelude::*;
+/// # use bevy_color::palettes::basic::WHITE;
+/// fn draw() {
+///     gizmo().sphere(Isometry3d::IDENTITY, 0.5, WHITE);
+/// }
+/// ```
+pub fn gizmo() -> impl core::ops::DerefMut<Target = GizmoBuffer<DefaultGizmoConfigGroup, ()>> {
+    GlobalGizmos {
+        guard: GLOBAL_GIZMO.lock().unwrap(),
+    }
+}
+
+struct GlobalGizmos<'a> {
+    guard: std::sync::MutexGuard<'a, GizmoBuffer<DefaultGizmoConfigGroup, ()>>,
+}
+
+impl<'a> core::ops::Deref for GlobalGizmos<'a> {
+    type Target = GizmoBuffer<DefaultGizmoConfigGroup, ()>;
+
+    fn deref(&self) -> &Self::Target {
+        &self.guard
+    }
+}
+
+impl<'a> core::ops::DerefMut for GlobalGizmos<'a> {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.guard
+    }
+}

crates/bevy_gizmos/src/lib.rs

@@ -30,6 +30,8 @@ pub mod config;
 pub mod cross;
 pub mod curves;
 pub mod gizmos;
+#[cfg(feature = "global_gizmos")]
+mod global;
 pub mod grid;
 pub mod primitives;
 pub mod retained;
@@ -45,6 +47,8 @@ pub mod prelude {
     #[doc(hidden)]
     pub use crate::aabb::{AabbGizmoConfigGroup, ShowAabbGizmo};
 
+    #[cfg(feature = "global_gizmos")]
+    pub use crate::global::gizmo;
     #[doc(hidden)]
     pub use crate::{
         config::{
@@ -94,6 +98,9 @@ impl Plugin for GizmoPlugin {
 
         app.add_plugins(aabb::AabbGizmoPlugin);
 
+        #[cfg(feature = "global_gizmos")]
+        app.add_plugins(global::GlobalGizmosPlugin);
+
         #[cfg(feature = "bevy_light")]
         app.add_plugins(LightGizmoPlugin);
     }