0.3.0

Author: LiamGallagher737

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+> Dates are formatted as DD.MM.YYYY
+
+## Version 0.3.0 (18.01.2023)
+
+### Added
+
+- Hover gizmo interactions
+
+### Changed
+
+- Much simpler API
+- Updated example
+- Entire backend
+
+### Fixed
+
+- Framerate was being limited to ~60
+- Gizmo flickering

Cargo.toml

@@ -1,19 +1,13 @@
 [package]
 name = "bevy_mod_gizmos"
+version = "0.3.0"
 description = "Visual gizmos to aid with development and debugging in Bevy"
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/LiamGallagher737/bevy_gizmos"
 readme = "README.md"
-version = "0.2.0"
 edition = "2021"
 exclude = [".github/"]
 
-[workspace]
-members = [
-    "examples/*",
-]
-
 [dependencies]
 bevy = "0.9"
-bevy_mod_picking = "0.10"
 lazy_static = "1.4"

README.md

@@ -5,7 +5,7 @@
 Visual gizmos to aid with development and debugging in [Bevy](https://bevyengine.org/)
 
 [<img alt="bevy tracking" src="https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue?style=for-the-badge" height="24">](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)
-[<img alt="build status" src="https://img.shields.io/github/workflow/status/LiamGallagher737/bevy_mod_gizmos/CI/main?style=for-the-badge" height="24">](https://github.com/LiamGallagher737/bevy_mod_gizmos/actions)
+[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/LiamGallagher737/bevy_mod_gizmos/rust.yml?branch=main&style=for-the-badge" height="24">](https://github.com/LiamGallagher737/bevy_mod_gizmos/actions)
 [<img alt="github" src="https://img.shields.io/badge/github-bevy__mod__gizmos-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="24">](https://github.com/LiamGallagher737/bevy_mod_gizmos)
 [<img alt="crates.io" src="https://img.shields.io/crates/v/bevy_mod_gizmos.svg?style=for-the-badge&color=fc8d62&logo=rust" height="24">](https://crates.io/crates/bevy_mod_gizmos)
 [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-bevy__mod__gizmos-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="24">](https://docs.rs/bevy_mod_gizmos)
@@ -18,7 +18,7 @@ Visual gizmos to aid with development and debugging in [Bevy](https://bevyengine
 
 Add the following to your `Cargo.toml`
 ```toml
-bevy_mod_gizmos = "0.2.0"
+bevy_mod_gizmos = "0.3.0"
 ```
 
 Add this to any file you want to use gizmos in
@@ -46,7 +46,7 @@ opt-level = 3
 
 # Demo
 
-This exampels showcases all built-in gizmmo types and interactions. Click on a gizmo and it will print to the console its name.
+This examples showcases all built-in gizmo types and interactions. Click on a gizmo and it will print to the console its name.
 
 ```
 cargo run --example demo 
@@ -56,53 +56,47 @@ cargo run --example demo
 
 # Usage
 
-Render a single gizmo
+Draw a single gizmo
 ```rs
 draw_gizmo(gizmo);
 ```
 
-Render multiple gizmos and a connecting line
+Draw multiple gizmos
 ```rs
-draw_gizmos(vec![gizmo, gizmo, gizmo], true);
+draw_gizmos(vec![gizmo, gizmo, gizmo]);
 ```
 
-Render a line
+Draw multiple gizmos and a connecting line
 ```rs
-draw_line(points, color);
+draw_gizmos_with_line(vec![gizmo, gizmo, gizmo]);
 ```
 
-
-
-# Gizmos
-
+Draw a line
 ```rs
-Gizmo::sphere(position, size, color)
-```
-```rs
-Gizmo::cube(position, size, color)
-```
-```rs
-Gizmo::cubiod(position, scale, color)
-```
-```rs
-Gizmo::capsule(position, width, height, color)
+draw_line(points, color);
 ```
+
+Draw a closed line
 ```rs
-Gizmo::torus(position, size, color)
+draw_closed_line(points, color);
 ```
+
+
+
+# Interactions
+
 ```rs
-Gizmo::new(position, scale, color, mesh_handle)
+Gizmo::new(translation, size, color).on_click(|| println!("Clicked!"))
+Gizmo::new(translation, size, color).on_hover(|| println!("Hovered!"))
 ```
 
-[More Info](https://docs.rs/bevy_mod_gizmos/latest/bevy_mod_gizmos/gizmo/struct.Gizmo.html)
-
 
 
 # Bevy Tracking
 
 |Bevy|bevy_mod_gizmos|
 |---|---|
-|0.9|0.2.0|
+|0.9|0.3.0|
 |0.7|0.1.1|
 
 
@@ -116,6 +110,4 @@ All code in this repository is dual-licensed under either:
 
 at your option. This means you can select the license you prefer! This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are [very good reasons](https://github.com/bevyengine/bevy/issues/2373) to include both.
 
-Unless you explicitly state otherwise, any contribution intentionally submitted
-for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
-additional terms or conditions.
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

examples/demo.rs

@@ -9,51 +9,38 @@ fn main() {
         .add_plugin(GizmosPlugin)
 
         .add_startup_system(setup)
-        .add_system(move_entities)
-        .add_system(gizmos)
+        .add_system(update)
+
+        .add_plugin(bevy::diagnostic::LogDiagnosticsPlugin::default())
+        .add_plugin(bevy::diagnostic::EntityCountDiagnosticsPlugin::default())
 
         .run();
 }
 
-fn gizmos(query: Query<&Transform, Without<Camera>>) {
-    let positions: Vec<Vec3> = query.iter().map(|t| t.translation).collect();
-    draw_gizmos(
-        vec![
-            Gizmo::sphere(positions[0], 1.0, Color::GREEN).on_click(|_| println!("Clicked Sphere")),
-            Gizmo::cube(positions[1], 1.0, Color::RED).on_click(|_| println!("Clicked Cube")),
-            Gizmo::cubiod(positions[2], Vec3::new(1.0, 0.5, 1.5), Color::BLUE)
-                .on_click(|_| println!("Clicked Cubiod")),
-            Gizmo::capsule(positions[3], 1.0, 1.5, Color::ORANGE)
-                .on_click(|_| println!("Clicked Capsule")),
-            Gizmo::torus(positions[4], 1.0, Color::YELLOW).on_click(|_| println!("Clicked Torus")),
-        ],
-        false, // Draw a line?
-    );
-}
-
 fn setup(mut commands: Commands) {
-    // Spawn camera
-    let cam_transform = Transform::from_xyz(4.0, 5.0, 8.0);
+    println!("Trying hoering and clicking the center gizmo");
+
+    let cam_transform = Transform::from_xyz(0.0, 0.0, 8.0);
     commands.spawn((
         Camera3dBundle {
-            transform: cam_transform.looking_at([4.0, 0.0, 0.0].into(), Vec3::Y),
+            transform: cam_transform.looking_at(Vec3::ZERO, Vec3::Y),
             ..Default::default()
         },
-        GizmoInteractionCamera::default(),
+        GizmoInteractionCamera,
     ));
-
-    // Create one entity for each gizmo type
-    for i in 0..5 {
-        commands.spawn(TransformBundle::from_transform(Transform::from_xyz(
-            i as f32 * 2.0,
-            0.0,
-            0.0,
-        )));
-    }
 }
 
-fn move_entities(mut query: Query<&mut Transform, Without<Camera>>, time: Res<Time>) {
-    for (i, mut transform) in query.iter_mut().enumerate() {
-        transform.translation.y = (time.elapsed_seconds() + i as f32).sin();
-    }
+fn update() {
+    draw_gizmo(
+        Gizmo::new(Vec3::ZERO, 1.0, Color::WHITE)
+            .on_click(|| println!("Clicked!"))
+            .on_hover(|| println!("Hovered")),
+    );
+
+    draw_gizmos_with_line(vec![
+        (Vec3::new(2.0, 2.0, 0.0), 0.5),
+        (Vec3::new(-2.0, 2.0, 0.0), 0.25),
+        (Vec3::new(-2.0, -2.0, 0.0), 0.75),
+        (Vec3::new(2.0, -2.0, 0.0), 1.0),
+    ]);
 }

src/api.rs

@@ -0,0 +1,49 @@
+use crate::{
+    spawning::{GIZMO_SPAWN_BUFFER, LINE_SPAWN_BUFFER},
+    Gizmo, Line,
+};
+use bevy::prelude::*;
+
+/// Draw a single gizmo, it takes anything that implements `Into<Gizmo>`
+pub fn draw_gizmo<G: Into<Gizmo>>(gizmo: G) {
+    if let Ok(mut gizmos) = GIZMO_SPAWN_BUFFER.write() {
+        gizmos.push(gizmo.into());
+    }
+}
+
+/// Draw multiple gizmos, it takes a vec of anything that implements `Into<Gizmo>`
+pub fn draw_gizmos<G: Into<Gizmo>>(gizmos: Vec<G>) {
+    if let Ok(mut gizmos_buf) = GIZMO_SPAWN_BUFFER.write() {
+        for gizmo in gizmos {
+            gizmos_buf.push(gizmo.into());
+        }
+    }
+}
+
+/// Draw multiple gizmos with a connecting line, it takes a vec of anything that implements `Into<Gizmo>`
+pub fn draw_gizmos_with_line<G: Into<Gizmo>>(mut gizmos: Vec<G>) {
+    let gizmos: Vec<Gizmo> = gizmos.drain(..).map(|g| g.into()).collect();
+    draw_line(
+        gizmos.iter().map(|g| g.translation).collect(),
+        gizmos[0].color,
+    );
+    draw_gizmos(gizmos);
+}
+
+/// Draw a line, it takes a vec of Vec3 points and a color
+pub fn draw_line(points: Vec<Vec3>, color: Color) {
+    if let Ok(mut lines) = LINE_SPAWN_BUFFER.write() {
+        lines.push(Line::new(points, color));
+    }
+}
+
+/// Draw a closed line, it takes a vec of Vec3 points and a color
+pub fn draw_closed_line(mut points: Vec<Vec3>, color: Color) {
+    if points.is_empty() {
+        return;
+    }
+    points.push(points[0]);
+    if let Ok(mut lines) = LINE_SPAWN_BUFFER.write() {
+        lines.push(Line::new(points, color));
+    }
+}