Moved examples to top level

demo is also now the bevy example
urholaukkarinen · Apr 5, 2024 · 1c93811 · 1c93811
1 parent 9b9b450
commit 1c93811
Show file tree

Hide file tree

Showing 21 changed files with 35 additions and 130 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["crates/*"]
+members = ["crates/*", "examples/*"]
 
 [workspace.package]
 version = "0.1.0"
@@ -12,10 +12,9 @@ repository = "https://github.com/urholaukkarinen/transform-gizmo"
 authors = ["Urho Laukkarinen <[email protected]>"]
 
 [workspace.dependencies]
-transform-gizmo = { path = "crates/transform-gizmo", default-features = false }
-transform-gizmo-egui = { path = "crates/transform-gizmo-egui", default-features = false }
-transform-gizmo-bevy = { path = "crates/transform-gizmo-bevy", default-features = false }
-transform-gizmo-demo = { path = "crates/transform-gizmo-demo", default-features = false }
+transform-gizmo = { path = "crates/transform-gizmo" }
+transform-gizmo-egui = { path = "crates/transform-gizmo-egui" }
+transform-gizmo-bevy = { path = "crates/transform-gizmo-bevy" }
 
 egui = "0.27.2"
 eframe = "0.27.2"

diff --git a/README.md b/README.md
@@ -29,12 +29,6 @@ information about user interaction, in the form of `GizmoInteraction`.
 For rendering the gizmo, `Gizmo::draw` provides vertices in viewport coordinates that can be easily rendered
 with your favorite graphics APIs.
 
-## Demo
-
-For a more complete example, see the online demo at <https://urholaukkarinen.github.io/transform-gizmo/>.
-
-The demo sources can be found at <https://github.com/urholaukkarinen/transform-gizmo/blob/main/crates/transform-gizmo-demo/src/main.rs>.
-
 ## Other
 
 The gizmo exposes matrices and vectors as [mint](https://github.com/kvark/mint) types, which means it is easy to use with matrix types from various crates

diff --git a/crates/transform-gizmo-bevy/examples/bevy.rs b/crates/transform-gizmo-bevy/examples/bevy.rs
diff --git a/crates/transform-gizmo-demo/.gitignore b/crates/transform-gizmo-demo/.gitignore
diff --git a/crates/transform-gizmo-demo/crate.png b/crates/transform-gizmo-demo/crate.png
diff --git a/crates/transform-gizmo/src/lib.rs b/crates/transform-gizmo/src/lib.rs
@@ -18,7 +18,7 @@
 //! with your favorite graphics APIs.
 //!
 //! For a more complete example, see the online demo at <https://urholaukkarinen.github.io/transform-gizmo/>.
-//! The demo sources can be found at <https://github.com/urholaukkarinen/transform-gizmo/blob/main/crates/transform-gizmo-demo/src/main.rs>.
+//! The demo sources can be found at <https://github.com/urholaukkarinen/transform-gizmo/blob/main/examples/bevy/src/main.rs>.
 //! ```
 
 mod shape;

diff --git a/docs/bevy-example.js b/docs/bevy-example.js
diff --git a/docs/bevy-example_bg.wasm b/docs/bevy-example_bg.wasm
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1 @@
+<title>transform-gizmo demo</title><style>html{touch-action:manipulation}body,canvas,html{margin:0!important;padding:0!important;height:100%!important;width:100%!important;overflow:hidden;background:black;z-index:0}canvas{outline:none;display:block;position:absolute;top:0%;left:50%;transform:translate(-50%,0%)}</style><script type=module>import a,*as b from"/bevy-example.js";a(`/bevy-example_bg.wasm`);window.wasmBindings=b</script><base href=/><link as=fetch crossorigin href=/bevy-example_bg.wasm integrity=sha384-6Z-SFN6kAgL5W3NCtJ7RqA9nD8_l2w1hxCKpL31AvyOqE4EMrTdglfKmKt-KNNO2 rel=preload type=application/wasm><link crossorigin href=/bevy-example.js integrity=sha384-8IAkFedG4DooakeSIaa7WF3mzHDL32PU-TojrUtEWAND2K62-AwdQhSAZBbCAImk rel=modulepreload></head><body oncontextmenu="return false;"></body></html>
diff --git a/crates/transform-gizmo-demo/Cargo.toml → examples/bevy/Cargo.toml b/crates/transform-gizmo-demo/Cargo.toml → examples/bevy/Cargo.toml
@@ -1,17 +1,16 @@
 [package]
-name = "transform-gizmo-demo"
-description = "demo app for transform-gizmo"
-
+name = "bevy-example"
 version.workspace = true
-authors.workspace = true
+rust-version.workspace = true
 edition.workspace = true
 license.workspace = true
 homepage.workspace = true
 repository.workspace = true
+authors.workspace = true
+publish = false
 
 [dependencies]
 transform-gizmo-bevy.workspace = true
-transform-gizmo-egui.workspace = true
 
 bevy.workspace = true
 bevy_infinite_grid = { git = "https://github.com/XYCaptain/bevy_infinite_grid.git", rev = "1e5259a52a7dfaca65402c2c57c1d81c2bc443e9" }

diff --git a/crates/transform-gizmo-demo/Trunk.toml → examples/bevy/Trunk.toml b/crates/transform-gizmo-demo/Trunk.toml → examples/bevy/Trunk.toml
diff --git a/crates/transform-gizmo-demo/index.html → examples/bevy/index.html b/crates/transform-gizmo-demo/index.html → examples/bevy/index.html
@@ -31,7 +31,7 @@
         }
     </style>
 
-    <link data-trunk rel="rust" href="Cargo.toml" data-wasm-opt="z" data-bin="transform-gizmo-demo" />
+    <link data-trunk rel="rust" href="Cargo.toml" data-wasm-opt="z" data-bin="bevy-example" />
 
     <!-- this is the base url relative to which other urls will be constructed. trunk will insert this from the public-url option -->
     <base data-trunk-public-url />

diff --git a/crates/transform-gizmo-demo/src/camera.rs → examples/bevy/src/camera.rs b/crates/transform-gizmo-demo/src/camera.rs → examples/bevy/src/camera.rs
@@ -2,6 +2,7 @@ use bevy::input::mouse::{MouseMotion, MouseWheel};
 use bevy::math::vec2;
 use bevy::prelude::*;
 
+/// https://bevy-cheatbook.github.io/cookbook/pan-orbit-camera.html
 pub struct PanOrbitCameraPlugin;
 impl Plugin for PanOrbitCameraPlugin {
     fn build(&self, app: &mut App) {

diff --git a/crates/transform-gizmo-demo/src/grid.rs → examples/bevy/src/grid.rs b/crates/transform-gizmo-demo/src/grid.rs → examples/bevy/src/grid.rs
diff --git a/crates/transform-gizmo-demo/src/gui.rs → examples/bevy/src/gui.rs b/crates/transform-gizmo-demo/src/gui.rs → examples/bevy/src/gui.rs
@@ -170,7 +170,7 @@ fn draw_options(ui: &mut egui::Ui, gizmo_options: &mut GizmoOptions) {
     ui.separator();
 
     ui.with_layout(Layout::bottom_up(egui::Align::Center), |ui| {
-        egui::Hyperlink::from_label_and_url("(source code)", "https://github.com/urholaukkarinen/transform-gizmo/blob/main/crates/transform-gizmo-demo/src/main.rs").ui(ui);
+        egui::Hyperlink::from_label_and_url("(source code)", "https://github.com/urholaukkarinen/transform-gizmo/blob/main/examples/bevy/src/main.rs").ui(ui);
 
         ui.label("Move and rotate the camera using the middle and right mouse buttons");
         ui.label("Toggle gizmo snapping with left ctrl & shift");

diff --git a/crates/transform-gizmo-demo/src/main.rs → examples/bevy/src/main.rs b/crates/transform-gizmo-demo/src/main.rs → examples/bevy/src/main.rs
diff --git a/crates/transform-gizmo-demo/src/picking.rs → examples/bevy/src/picking.rs b/crates/transform-gizmo-demo/src/picking.rs → examples/bevy/src/picking.rs
@@ -5,7 +5,9 @@ use bevy_mod_picking::{
 };
 use transform_gizmo_bevy::GizmoTarget;
 
+/// Integrates picking with gizmo and highlighting.
 pub struct PickingPlugin;
+
 impl Plugin for PickingPlugin {
     fn build(&self, app: &mut bevy::prelude::App) {
         app.add_plugins(DefaultPickingPlugins.build())

diff --git a/crates/transform-gizmo-demo/src/scene.rs → examples/bevy/src/scene.rs b/crates/transform-gizmo-demo/src/scene.rs → examples/bevy/src/scene.rs
@@ -7,6 +7,7 @@ use transform_gizmo_bevy::GizmoCamera;
 use crate::camera::PanOrbitCamera;
 
 pub struct ScenePlugin;
+
 impl Plugin for ScenePlugin {
     fn build(&self, app: &mut bevy::prelude::App) {
         app.add_systems(Startup, setup_scene);

diff --git a/examples/egui/Cargo.toml b/examples/egui/Cargo.toml
@@ -0,0 +1,17 @@
+[package]
+name = "egui-example"
+version.workspace = true
+rust-version.workspace = true
+edition.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+authors.workspace = true
+publish = false
+
+[dependencies]
+transform-gizmo-egui.workspace = true
+eframe.workspace = true
+
+[lints]
+workspace = true
diff --git a/crates/transform-gizmo-egui/examples/egui.rs → examples/egui/src/main.rs b/crates/transform-gizmo-egui/examples/egui.rs → examples/egui/src/main.rs
@@ -1,5 +1,5 @@
 use eframe::{egui, NativeOptions};
-use transform_gizmo::math::DQuat;
+use transform_gizmo_egui::math::DQuat;
 use transform_gizmo_egui::{
     math::{DMat4, DVec3},
     *,

diff --git a/scripts/build_demo_web.sh b/scripts/build_demo_web.sh
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<title>transform-gizmo demo</title><style>html{touch-action:manipulation}body,canvas,html{margin:0!important;padding:0!important;height:100%!important;width:100%!important;overflow:hidden;background:black;z-index:0}canvas{outline:none;display:block;position:absolute;top:0%;left:50%;transform:translate(-50%,0%)}</style><script type=module>import a,*as b from"/bevy-example.js";a(`/bevy-example_bg.wasm`);window.wasmBindings=b</script><base href=/><link as=fetch crossorigin href=/bevy-example_bg.wasm integrity=sha384-6Z-SFN6kAgL5W3NCtJ7RqA9nD8_l2w1hxCKpL31AvyOqE4EMrTdglfKmKt-KNNO2 rel=preload type=application/wasm><link crossorigin href=/bevy-example.js integrity=sha384-8IAkFedG4DooakeSIaa7WF3mzHDL32PU-TojrUtEWAND2K62-AwdQhSAZBbCAImk rel=modulepreload></head><body oncontextmenu="return false;"></body></html>