diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..8ec23a9f --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +target/ +Cargo.lock + +.vs* +.DS_Store \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 00000000..b0f6908c --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,33 @@ +[package] +name = "bevy_hanabi" +version = "0.0.1" +authors = ["Jerome Humbert "] +edition = "2021" +description = "Hanabi particle system plugin for the Bevy game engine" +repository = "https://github.com/djeedai/bevy_extra" +homepage = "https://github.com/djeedai/bevy_extra/tree/main/crates/bevy_hanabi" +documentation = "https://docs.rs/bevy_hanabi" +keywords = ["bevy", "particle-system", "particles", "vfx"] +license = "MIT OR Apache-2.0" +readme = "README.md" + +[dependencies] +bytemuck = "1.5" +rand = "0.8" +serde = { version = "1.0", features = ["derive"] } +anyhow = "1.0" +ron = "0.7" +bitflags = "1.3" + +[dependencies.bevy] +version = "0.6" +default-features = false +features = [ "render" ] + +[[example]] +name = "spawn" +required-features = [ "bevy/bevy_winit", "bevy/png" ] + +[workspace] +resolver = "2" +members = ["."] diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..52cc45d6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,6 @@ +Hanabi is dual-licensed under either + +* MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT) +* Apache License, Version 2.0 (LICENSE-APACHE2 or http://www.apache.org/licenses/LICENSE-2.0) + +at your option. \ No newline at end of file diff --git a/LICENSE-APACHE2 b/LICENSE-APACHE2 new file mode 100644 index 00000000..10450495 --- /dev/null +++ b/LICENSE-APACHE2 @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright (c) 2021 Jerome Humbert + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 00000000..537fab66 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Jerome Humbert + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..7f3b0f70 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# Bevy Hanabi + +[![License: MIT or Apache 2.0](https://img.shields.io/badge/License-MIT%20or%20Apache2-yellow.svg)](./LICENSE) [![Doc](https://docs.rs/bevy_hanabi/badge.svg)](https://docs.rs/bevy_hanabi) [![Crate](https://img.shields.io/crates/v/bevy_hanabi.svg)](https://crates.io/crates/bevy_hanabi) + +Hanabi — a particle system plugin for the Bevy game engine. + +## Usage + +This plugin is only compatible with the `main` branch of Bevy (post-`0.5` version, with new renderer). + +### System setup + +Add the Hanabi plugin to your app: + +```rust +App::default() + .add_default_plugins() + .add_plugin(HanabiPlugin) + .run(); +``` + +### Add a particles effect + +TODO; this library is under development... + +## Examples + +See the [`examples/`](https://github.com/djeedai/bevy_extra/tree/main/bevy_hanabi/examples) folder. + +## Feature List + +- Spawn + - [x] Constant rate + - [ ] Burst + - [ ] Repeated burst +- Initialize + - [ ] Constant position + - [ ] Position over shape + - [ ] cube + - [ ] sphere + - [ ] cone + - [ ] plane + - [ ] generic mesh / point cloud (?) + - [ ] Random position offset + - [ ] Constant velocity + - [ ] Random velocity + - [ ] Constant color + - [ ] Random color +- Update + - [ ] Verlet motion integration + - [ ] Apply forces + - [ ] Constant + - [ ] Bounded (AABB, etc.) + - [ ] Lifetime + - [ ] Size change over lifetime + - [ ] Color change over lifetime + - [ ] Face camera + - [ ] Face constant direction +- Render + - [ ] Quad (sprite) + - [ ] Generic 3D mesh \ No newline at end of file diff --git a/assets/cloud.png b/assets/cloud.png new file mode 100644 index 00000000..dfc128c3 Binary files /dev/null and b/assets/cloud.png differ diff --git a/examples/spawn.rs b/examples/spawn.rs new file mode 100644 index 00000000..285e12bc --- /dev/null +++ b/examples/spawn.rs @@ -0,0 +1,165 @@ +#![allow(unused_imports)] + +use bevy::{ + prelude::*, + render::{ + mesh::shape::Cube, + options::WgpuOptions, + render_resource::{Extent3d, TextureDimension, TextureFormat, WgpuFeatures}, + }, +}; +use rand::prelude::*; +use std::f32::consts::PI; + +use bevy_hanabi::*; + +fn main() -> Result<(), Box> { + let mut options = WgpuOptions::default(); + options + .features + .set(WgpuFeatures::VERTEX_WRITABLE_STORAGE, true); + // options + // .features + // .set(WgpuFeatures::MAPPABLE_PRIMARY_BUFFERS, false); + // println!("wgpu options: {:?}", options.features); + App::default() + .insert_resource(options) + .insert_resource(bevy::log::LogSettings { + level: bevy::log::Level::WARN, + filter: "bevy_hanabi=debug,spawn=trace".to_string(), + }) + .add_plugins(DefaultPlugins) + .add_plugin(HanabiPlugin) + .add_startup_system(setup) + .add_system(update) + .run(); + + Ok(()) +} + +fn setup( + asset_server: Res, + mut commands: Commands, + mut effects: ResMut>, + //mut images: ResMut>, + mut meshes: ResMut>, + mut materials: ResMut>, +) { + let mut camera = PerspectiveCameraBundle::new_3d(); + //let mut camera = OrthographicCameraBundle::new_2d(); + camera.transform.translation = Vec3::new(0.0, 0.0, 100.0); + commands.spawn_bundle(camera); + + let texture_handle: Handle = asset_server.load("cloud.png"); + + // let data: &[u8] = &[255u8; 4]; + // let image: Handle = images.add(Image::new_fill( + // Extent3d::default(), + // TextureDimension::D2, + // data, + // TextureFormat::Rgba8Unorm, + // )); + + let mut gradient = Gradient::new(); + gradient.add_key(0.0, Vec4::splat(1.0)); + gradient.add_key(0.1, Vec4::new(1.0, 1.0, 0.0, 1.0)); + gradient.add_key(0.4, Vec4::new(1.0, 0.0, 0.0, 1.0)); + gradient.add_key(1.0, Vec4::splat(0.0)); + + let effect = effects.add( + EffectAsset { + name: "MyEffect".to_string(), + capacity: 32768, + spawner: Spawner::new(SpawnMode::Rate(Value::Single(500.))), + render_layout: Default::default(), + } + .with(ParticleTextureModifier { + texture: texture_handle.clone(), + }) + .with(ColorOverLifetimeModifier { gradient }), + ); + + commands + .spawn() + //.insert(image) + .insert_bundle(ParticleEffectBundle::new(effect.clone())) + .with_children(|p| { + p.spawn().insert_bundle(PbrBundle { + mesh: meshes.add(Mesh::from(Cube { size: 1.0 })), + material: materials.add(Color::RED.into()), + ..Default::default() + }); + }); + + commands + .spawn() + //.insert(image) + .insert_bundle(ParticleEffectBundle::new(effect.clone())) + .with_children(|p| { + p.spawn().insert_bundle(PbrBundle { + mesh: meshes.add(Mesh::from(Cube { size: 1.0 })), + material: materials.add(Color::RED.into()), + ..Default::default() + }); + }); +} + +/// Calculate a position over a Lemniscate of Bernoulli curve ("infinite symbol"). +/// +/// The fractional part of `time` determines the parametric position over the curve. +/// The `radius` of the Lemniscate curve is the distance from the center to the edge +/// of any of the left or right loops. The curve loops extend from -X to +X. +fn lemniscate(time: f32, radius: f32) -> Vec2 { + // The Lemniscate is defined in polar coordinates by the equation r² = a² ⨯ cos(2θ), + // where a is the radius of the Lemniscate (distance from origin to loop edge). + // This equation is defined only for values of θ in the [-π/4:π/4] range. Each value + // yields two possible values for r, one positive and one negative, corresponding to + // the two loops of the Lemniscates (left and right). + // So we solve for θ ∈ [-π/4:π/4], and make θ vary back and forth in the [-π/4:π/4] + // range. Then depending on the direction we flip the sign of r. This produces a + // continuous parametrization of the curve. + + const TWO_PI: f32 = PI * 2.0; + const PI_OVER_4: f32 = PI / 4.0; + + // Scale the parametric position over the curve to the [0:2*π] range + let theta = time.fract() * TWO_PI; + + // This variant produces a linear parametrization of theta (triangular signal). Because + // the parameter r changes much faster around 0 when solving the polar equation, this makes + // the position "go faster" around the center, which is generally not wanted. + // let (theta, sign) = if theta <= PI_OVER_2 { + // (theta - PI_OVER_4, 1.0) + // } else { + // (3.0 * PI_OVER_4 - theta, -1.0) + // }; + + // That alternative variant "slows down" the parametric position around zero by converting + // the linear θ variations with a sine function, making it move slower around the edges ±π/4 + // where r tends to zero. This does not produce an exact constant speed, but is visually close. + let sign = theta.cos().signum(); + let theta = theta.sin() * PI_OVER_4; + + // Solve the polar equation to build the parametric position + let r2 = radius * radius * (theta * 2.0).cos(); + let r = r2.sqrt().copysign(sign); + + // Convert to cartesian coordinates + let x = r * theta.cos(); + let y = r * theta.sin(); + Vec2::new(x, y) +} + +fn update(time: Res