feat: 4d gaussians

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # contributing to bevy_gaussian_splatting
 
-![alt text](docs/notferris2.webp)
+![alt text](docs/assets/notferris2.webp)
 
 thank you for your interest in contributing to `bevy_gaussian_splatting`! contributions of all forms are welcome and appreciated. this includes code contributions, bug reports, documentation, or any other form of support.
 

README.md

@@ -2,16 +2,14 @@
 
 [![test](https://github.com/mosure/bevy_gaussian_splatting/workflows/test/badge.svg)](https://github.com/Mosure/bevy_gaussian_splatting/actions?query=workflow%3Atest)
 [![GitHub License](https://img.shields.io/github/license/mosure/bevy_gaussian_splatting)](https://raw.githubusercontent.com/mosure/bevy_gaussian_splatting/main/LICENSE)
-[![GitHub Last Commit](https://img.shields.io/github/last-commit/mosure/bevy_gaussian_splatting)](https://github.com/mosure/bevy_gaussian_splatting)
 [![GitHub Releases](https://img.shields.io/github/v/release/mosure/bevy_gaussian_splatting?include_prereleases&sort=semver)](https://github.com/mosure/bevy_gaussian_splatting/releases)
 [![GitHub Issues](https://img.shields.io/github/issues/mosure/bevy_gaussian_splatting)](https://github.com/mosure/bevy_gaussian_splatting/issues)
-[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/mosure/bevy_gaussian_splatting.svg)](http://isitmaintained.com/project/mosure/bevy_gaussian_splatting)
 [![crates.io](https://img.shields.io/crates/v/bevy_gaussian_splatting.svg)](https://crates.io/crates/bevy_gaussian_splatting)
 
 bevy gaussian splatting render pipeline plugin. view the [live demo](https://mosure.github.io/bevy_gaussian_splatting/index.html?arg1=cactus.gcloud)
 
-![Alt text](docs/bevy_gaussian_splatting_demo.webp)
-![Alt text](docs/go.gif)
+![alt text](docs/assets/bevy_gaussian_splatting_demo.webp)
+![alt text](docs/assets/go.gif)
 
 
 ## capabilities
@@ -69,45 +67,24 @@ fn setup_gaussian_cloud(
 - aabb vs. obb gaussian comparison via `cargo run --bin compare_aabb_obb`
 
 
+### creating gaussian clouds
+
+- [X] 3d gaussian clouds: [gaussian-splatting](https://github.com/graphdeco-inria/gaussian-splatting)
+- [X] 4d gaussian clouds: [4d-gaussian-splatting](https://fudan-zvg.github.io/4d-gaussian-splatting/)
+- [ ] edge-device training pipeline: [burn_gaussian_splatting](https://github.com/mosure/burn_gaussian_splatting)
+
+
 ## compatible bevy versions
 
 | `bevy_gaussian_splatting` | `bevy` |
 | :--                       | :--    |
 | `0.4 - 1.0`               | `0.12` |
 | `0.1 - 0.3`               | `0.11` |
 
+
+## analytics
+![Alt](https://repobeats.axiom.co/api/embed/4f273f05f00ec57e90be34727e85952039e1a712.svg "analytics")
+
+
 ## projects using this plugin
 - [kitt2](https://github.com/cs50victor/kitt2)
-
-# credits
-
-- [4d gaussians](https://github.com/hustvl/4DGaussians)
-- [4d-gaussian-splatting](https://fudan-zvg.github.io/4d-gaussian-splatting/)
-- [bevy](https://github.com/bevyengine/bevy)
-- [bevy-hanabi](https://github.com/djeedai/bevy_hanabi)
-- [d3ga](https://zielon.github.io/d3ga/)
-- [deformable-3d-gaussians](https://github.com/ingra14m/Deformable-3D-Gaussians)
-- [diff-gaussian-rasterization](https://github.com/graphdeco-inria/diff-gaussian-rasterization)
-- [dreamgaussian](https://github.com/dreamgaussian/dreamgaussian)
-- [dynamic-3d-gaussians](https://github.com/JonathonLuiten/Dynamic3DGaussians)
-- [ewa splatting](https://www.cs.umd.edu/~zwicker/publications/EWASplatting-TVCG02.pdf)
-- [gaussian-grouping](https://github.com/lkeab/gaussian-grouping)
-- [gaussian-splatting](https://github.com/graphdeco-inria/gaussian-splatting)
-- [gaussian-splatting-viewer](https://github.com/limacv/GaussianSplattingViewer/tree/main)
-- [gaussian-splatting-web](https://github.com/cvlab-epfl/gaussian-splatting-web)
-- [gir](https://3dgir.github.io/)
-- [making gaussian splats smaller](https://aras-p.info/blog/2023/09/13/Making-Gaussian-Splats-smaller/)
-- [masked-spacetime-hashing](https://github.com/masked-spacetime-hashing/msth)
-- [onesweep](https://arxiv.org/ftp/arxiv/papers/2206/2206.01784.pdf)
-- [pasture](https://github.com/Mortano/pasture)
-- [phys-gaussian](https://xpandora.github.io/PhysGaussian/)
-- [point-visualizer](https://github.com/mosure/point-visualizer)
-- [rusty-automata](https://github.com/mosure/rusty-automata)
-- [scaffold-gs](https://city-super.github.io/scaffold-gs/)
-- [shader-one-sweep](https://github.com/b0nes164/ShaderOneSweep)
-- [spacetime-gaussians](https://github.com/oppo-us-research/SpacetimeGaussians)
-- [splat](https://github.com/antimatter15/splat)
-- [splatter](https://github.com/Lichtso/splatter)
-- [sturdy-dollop](https://github.com/mosure/sturdy-dollop)
-- [sugar](https://github.com/Anttwo/SuGaR)
-- [taichi_3d_gaussian_splatting](https://github.com/wanmeihuali/taichi_3d_gaussian_splatting)

benches/io.rs

@@ -8,7 +8,7 @@ use criterion::{
 
 use bevy_gaussian_splatting::{
     Gaussian,
-    GaussianCloud,
+    Cloud,
     io::codec::GaussianCloudCodec,
     random_gaussians,
 };
@@ -33,7 +33,7 @@ fn gaussian_cloud_decode_benchmark(c: &mut Criterion) {
                 let gaussians = random_gaussians(*count);
                 let bytes = gaussians.encode();
 
-                b.iter(|| GaussianCloud::decode(bytes.as_slice()));
+                b.iter(|| Cloud::decode(bytes.as_slice()));
             },
         );
     }

docs/CREDITS.md

@@ -0,0 +1,32 @@
+# bevy_gaussian_splatting credits
+
+- [4d gaussians](https://github.com/hustvl/4DGaussians)
+- [4d-gaussian-splatting](https://fudan-zvg.github.io/4d-gaussian-splatting/)
+- [bevy](https://github.com/bevyengine/bevy)
+- [bevy-hanabi](https://github.com/djeedai/bevy_hanabi)
+- [d3ga](https://zielon.github.io/d3ga/)
+- [deformable-3d-gaussians](https://github.com/ingra14m/Deformable-3D-Gaussians)
+- [diff-gaussian-rasterization](https://github.com/graphdeco-inria/diff-gaussian-rasterization)
+- [dreamgaussian](https://github.com/dreamgaussian/dreamgaussian)
+- [dynamic-3d-gaussians](https://github.com/JonathonLuiten/Dynamic3DGaussians)
+- [ewa splatting](https://www.cs.umd.edu/~zwicker/publications/EWASplatting-TVCG02.pdf)
+- [gaussian-grouping](https://github.com/lkeab/gaussian-grouping)
+- [gaussian-splatting](https://github.com/graphdeco-inria/gaussian-splatting)
+- [gaussian-splatting-viewer](https://github.com/limacv/GaussianSplattingViewer/tree/main)
+- [gaussian-splatting-web](https://github.com/cvlab-epfl/gaussian-splatting-web)
+- [gir](https://3dgir.github.io/)
+- [making gaussian splats smaller](https://aras-p.info/blog/2023/09/13/Making-Gaussian-Splats-smaller/)
+- [masked-spacetime-hashing](https://github.com/masked-spacetime-hashing/msth)
+- [onesweep](https://arxiv.org/ftp/arxiv/papers/2206/2206.01784.pdf)
+- [pasture](https://github.com/Mortano/pasture)
+- [phys-gaussian](https://xpandora.github.io/PhysGaussian/)
+- [point-visualizer](https://github.com/mosure/point-visualizer)
+- [rusty-automata](https://github.com/mosure/rusty-automata)
+- [scaffold-gs](https://city-super.github.io/scaffold-gs/)
+- [shader-one-sweep](https://github.com/b0nes164/ShaderOneSweep)
+- [spacetime-gaussians](https://github.com/oppo-us-research/SpacetimeGaussians)
+- [splat](https://github.com/antimatter15/splat)
+- [splatter](https://github.com/Lichtso/splatter)
+- [sturdy-dollop](https://github.com/mosure/sturdy-dollop)
+- [sugar](https://github.com/Anttwo/SuGaR)
+- [taichi_3d_gaussian_splatting](https://github.com/wanmeihuali/taichi_3d_gaussian_splatting)

examples/headless.rs

@@ -16,7 +16,7 @@ use bevy_panorbit_camera::{
 };
 
 use bevy_gaussian_splatting::{
-    GaussianCloud,
+    Cloud,
     GaussianSplattingBundle,
     GaussianSplattingPlugin,
     random_gaussians,
@@ -369,12 +369,12 @@ fn setup_gaussian_cloud(
     mut commands: Commands,
     asset_server: Res<AssetServer>,
     gaussian_splatting_viewer: Res<GaussianSplattingViewer>,
-    mut gaussian_assets: ResMut<Assets<GaussianCloud>>,
+    mut gaussian_assets: ResMut<Assets<Cloud>>,
     mut scene_controller: ResMut<frame_capture::scene::SceneController>,
     mut images: ResMut<Assets<Image>>,
     render_device: Res<RenderDevice>,
 ) {
-    let cloud: Handle<GaussianCloud>;
+    let cloud: Handle<Cloud>;
 
     if gaussian_splatting_viewer.gaussian_count > 0 {
         println!("generating {} gaussians", gaussian_splatting_viewer.gaussian_count);
@@ -383,7 +383,7 @@ fn setup_gaussian_cloud(
         println!("loading {}", gaussian_splatting_viewer.input_file);
         cloud = asset_server.load(&gaussian_splatting_viewer.input_file);
     } else {
-        cloud = gaussian_assets.add(GaussianCloud::test_model());
+        cloud = gaussian_assets.add(Cloud::test_model());
     }
 
     let render_target = frame_capture::scene::setup_render_target(