egui-gizmo -> transform-gizmo

.github/workflows/rust.yml

@@ -13,6 +13,9 @@ jobs:
         with:
           toolchain: 1.72.0
 
+      - name: install dependencies
+        run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
+
       - name: cache
         uses: Swatinem/rust-cache@v2
 

.gitignore

@@ -1,4 +1,5 @@
 /target
 Cargo.lock
 /.idea
+/.vscode
 .DS_Store

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contribution guidelines
+
+Thank you for considering to contribute!
+
+## Filing an issue
+
+If you encounter an issue or have a feature request, you can [open an issue](https://github.com/urholaukkarinen/transform-gizmo/issues/new/choose) for it.
+
+Before opening an issue, check that there is not already a similar issue created by someone else.
+
+## Opening a pull request
+
+For things such as tiny bug fixes or version bumps, feel free to open a pull request without creating an issue first.
+
+For larger changes, please file an issue first.
+
+Keep pull requests focused. Avoid including multiple unrelated changes in the same pull request.

Cargo.toml

@@ -1,32 +1,37 @@
-[package]
-name = "egui-gizmo"
-version = "0.16.2"
-authors = ["Urho Laukkarinen <[email protected]>"]
-edition = "2021"
+[workspace]
+resolver = "2"
+members = ["crates/*", "examples/*"]
 
-license-file = "LICENSE"
-readme = "README.md"
-description = "3d transform gizmo for the egui library"
-homepage = "https://github.com/urholaukkarinen/egui-gizmo"
-repository = "https://github.com/urholaukkarinen/egui-gizmo"
-categories = ["gui", "game-development", "game-engines"]
-keywords = ["egui", "gizmo"]
-exclude = ["/docs"]
+[workspace.package]
+version = "0.1.0"
+rust-version = "1.77.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+homepage = "https://github.com/urholaukkarinen/transform-gizmo"
+repository = "https://github.com/urholaukkarinen/transform-gizmo"
+authors = ["Urho Laukkarinen <[email protected]>"]
 
-[workspace]
-members = ["demo"]
+[workspace.dependencies]
+transform-gizmo = { path = "crates/transform-gizmo" }
+transform-gizmo-egui = { path = "crates/transform-gizmo-egui" }
+transform-gizmo-bevy = { path = "crates/transform-gizmo-bevy" }
 
-[dependencies]
-egui = "0.26.2"
-glam = { version = "0.25.0", features = ["mint"] }
+egui = "0.27.2"
+eframe = "0.27.2"
+emath = "0.27.2"
+epaint = "0.27.2"
+ecolor = "0.27.2"
+glam = { version = "0.27.0", features = ["mint"] }
 mint = "0.5"
+enum_dispatch = "0.3.12"
+ahash = "0.8.7"
+enumset = "1.1.3"
+bevy = "0.13"
+bevy_math = { version = "0.13", features = ["mint"] }
 
 [profile.release]
 opt-level = "s"
-lto = "thin"
-
-[lints]
-workspace = true
+panic = "abort"
 
 [workspace.lints.rust]
 elided_lifetimes_in_paths = "allow"
@@ -152,7 +157,7 @@ transmute_ptr_to_ptr = "deny"
 tuple_array_conversions = "deny"
 unchecked_duration_subtraction = "deny"
 unimplemented = "deny"
-uninlined_format_args = "deny"
+uninlined_format_args = "allow"
 unnecessary_box_returns = "deny"
 unnecessary_safety_comment = "deny"
 unnecessary_safety_doc = "deny"
@@ -177,5 +182,3 @@ unwrap_used = "allow"
 wildcard_imports = "allow"
 large-types-passed-by-value = "allow"
 needless-pass-by-value = "allow"
-needless_pass_by_ref_mut = "allow"
-redundant_pub_crate = "allow"

LICENSE-APACHE

@@ -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 [yyyy] [name of copyright owner]
+
+   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.

LICENSE → LICENSE-MIT

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Urho Laukkarinen
+Copyright (c) 2024 Urho Laukkarinen <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,33 +1,44 @@
-# egui-gizmo
+# transform-gizmo
 
-[![Latest version](https://img.shields.io/crates/v/egui-gizmo.svg)](https://crates.io/crates/egui-gizmo)
-[![Documentation](https://docs.rs/egui-gizmo/badge.svg)](https://docs.rs/egui-gizmo)
-![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
+[![Latest version](https://img.shields.io/crates/v/transform-gizmo.svg)](https://crates.io/crates/transform-gizmo)
+[![Documentation](https://docs.rs/transform-gizmo/badge.svg)](https://docs.rs/transform-gizmo)
+[![MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/urholaukkarinen/transform-gizmo/blob/main/LICENSE-MIT)
+[![Apache](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/urholaukkarinen/transform-gizmo/blob/main/LICENSE-APACHE)
 
-3d transformation gizmo built on top of the [egui](https://github.com/emilk/egui) library.
+`transform-gizmo` is a framework-agnostic Rust crate that provides a feature-rich and customizable 3D transformation gizmo for manipulating the position, rotation and scale of 3D entities.
 
-[Try it out in a web demo](https://urholaukkarinen.github.io/egui-gizmo/)
+[Try it out in a web demo](https://urholaukkarinen.github.io/transform-gizmo/)
 
-![Rotation](media/rotation.png)
-![Translation](media/translation.png)
-![Scale](media/scale.png)
+![All modes](media/all_modes.png)
 
 ## Usage
 
-```rust 
-let gizmo = Gizmo::new("My gizmo")
-    .view_matrix(view_matrix)
-    .projection_matrix(projection_matrix)
-    .model_matrix(model_matrix)
-    .mode(GizmoMode::Rotate);
+### Bevy
 
-if let Some(response) = gizmo.interact(ui) {
-    model_matrix = response.transform();
-}
-```
+[`transform-gizmo-bevy`](https://docs.rs/transform-gizmo-bevy) provides a Plugin for easy integration into the [Bevy Engine](https://bevyengine.org/).
 
-For a more complete example, see the [demo source code](demo/src/main.rs).
+### Egui
 
-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
+[`transform-gizmo-egui`](https://docs.rs/transform-gizmo-egui) enables you to use the Gizmo wherever [Egui](https://github.com/emilk/egui) is used.
+
+### Other
+
+For interacting with the gizmo, all you will need to do is give `Gizmo::update` sufficient
+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.
+
+## Other
+
+The gizmo exposes mathematical types as [mint](https://github.com/kvark/mint) types, which means it is easy to use with types from various crates
 such as [nalgebra](https://github.com/dimforge/nalgebra), [glam](https://github.com/bitshifter/glam-rs)
 and [cgmath](https://github.com/rustgd/cgmath). You may need to enable a `mint` feature, depending on the math library.
+
+## License
+
+This crate is dual licensed under MIT and Apache 2.0.
+
+## Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)