Skip to content

Commit b17d542

Browse files
nicopapnicopap
committed
Initial commit
0 parents  commit b17d542

File tree

10 files changed

+967
-0
lines changed

10 files changed

+967
-0
lines changed

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/target
2+
/Cargo.lock

‎Cargo.toml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[package]
2+
name = "bevy_mod_component_mirror"
3+
authors = ["Nicola Papale"]
4+
description = "A bevy plugin to mirror components"
5+
license = "MIT OR Apache-2.0"
6+
readme = "Readme.md"
7+
keywords = ["bevy", "rapier", "bevy-inspector-egui"]
8+
categories = ["game-development"]
9+
repository = "https://github.com/nicopap/bevy_mod_component_mirror"
10+
exclude = ["assets", ".github"]
11+
version = "0.1.0"
12+
edition = "2021"
13+
14+
[features]
15+
rapier = ["bevy_rapier3d"]
16+
default = ["rapier"]
17+
18+
[dependencies]
19+
bevy_rapier3d = { version = "0.20.0", optional = true }
20+
bevy = { version = "0.9.0", default-features = false }

‎Readme.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Bevy Component Mirrors
2+
3+
[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)
4+
[![Latest version](https://img.shields.io/crates/v/bevy_mod_component_mirror.svg)](https://crates.io/crates/bevy_mod_component_mirror)
5+
[![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](./LICENSE)
6+
[![Documentation](https://docs.rs/bevy_mod_component_mirror/badge.svg)](https://docs.rs/bevy_mod_component_mirror/)
7+
8+
A third party crate to mirror `Component` values.
9+
10+
By default, it also provides a set of bevy `Component`s
11+
mirroring the values of [`bevy_rapier`] `Component`s.
12+
(Currently only `bevy_rapier3d`, PRs welcome!)
13+
Since some of [`bevy_rapier`] `Component`s do not implement `Reflect`,
14+
they may be harder to work with.
15+
This crate is especially useful with [`bevy-inspector-egui`],
16+
it will allow you to edit rapier values at run time,
17+
so you don't have to restart your game repetitively
18+
to find the right physics parameters.
19+
20+
## Usage
21+
22+
1. Add this crate as a dependency to your `Cargo.toml`.
23+
24+
```toml
25+
[dependencies]
26+
bevy_mod_component_mirror = "<current version>"
27+
```
28+
29+
2. Add `RapierMirrorsPlugins` to your app
30+
31+
```rust
32+
use bevy_mod_component_mirror::RapierMirrorsPlugins;
33+
34+
# fn main() {
35+
# let mut app = bevy::prelude::App::new();
36+
app
37+
// Notice v the plural
38+
.add_plugins(RapierMirrorsPlugins);
39+
# }
40+
```
41+
42+
That's it! Now every `Entity` with the following rapier (**3d**) components
43+
will automatically have an equivalent `XyzMirror` component that automatically
44+
syncs its value with it.
45+
46+
- `ImpulseJoint`
47+
- `Collider` (**warning: some collider shape will panic!**)
48+
- `ColliderMassProperties`
49+
- `AdditionalMassProperties`
50+
51+
### Implement your own mirrors
52+
53+
If you wish to mirror other components, you need to do the following:
54+
55+
- Create a `Component` (eg: `ForeignMirror`)
56+
- Implement the `Mirror` trait for that component.
57+
- Implement `From<&'a Foreign> for ForeignMirror`
58+
- Add `MirrorPlugin::<ForeignMirror, Foreign>::new()` to your `app`
59+
60+
```rust
61+
use bevy_mod_component_mirror::{Mirror, MirrorPlugin};
62+
use bevy::prelude::*;
63+
64+
# mod foreign_crate {
65+
# use super::*;
66+
# #[derive(Component)]
67+
# pub struct Foreign; impl Foreign {
68+
# pub fn set_length(&mut self, value: f32) {}
69+
# pub fn length(&self) -> f32 { 0.0 }
70+
# }}
71+
use foreign_crate::Foreign;
72+
73+
// Component: required because you want it to be a component
74+
// Reflect: this let `MirrorPlugin` register the `Mirror` type itself
75+
#[derive(Component, Reflect)]
76+
pub struct ForeignMirror {
77+
inner: f32,
78+
}
79+
80+
// Foreign → ForeignMirror
81+
impl<'a> From<&'a Foreign> for ForeignMirror {
82+
fn from(value: &'a Foreign) -> Self {
83+
ForeignMirror {
84+
inner: value.length(),
85+
}
86+
}
87+
}
88+
// ForeignMirror → Foreign
89+
impl Mirror<Foreign> for ForeignMirror {
90+
fn apply(&self, value: &mut Foreign) {
91+
value.set_length(self.inner);
92+
}
93+
}
94+
95+
fn main() {
96+
let mut app = App::new();
97+
app.add_plugin(MirrorPlugin::<Foreign, ForeignMirror>::new());
98+
}
99+
100+
```
101+
102+
103+
### Features
104+
105+
If you don't need the definitions for the rapier components
106+
but still wish to use the mirror plugin,
107+
you can disable the rapier components with:
108+
109+
```toml
110+
[dependencies]
111+
bevy_mod_component_mirror = { version = "<fill in>", default-features = false }
112+
```
113+
114+
## Version matrix
115+
116+
117+
| bevy | bevy_rapier3d | bevy_mod_component_mirror |
118+
|------|---------------|---------------------------|
119+
| 0.9 | 0.20.0 | 0.1.0 |
120+
121+
## License
122+
123+
Copyright © 2022 Nicola Papale
124+
125+
This software is licensed under either MIT or Apache 2.0 at your leisure. See
126+
licenses directory for details.
127+
128+
[`bevy_rapier`]: https://lib.rs/crates/bevy_rapier3d
129+
[`bevy-inspector-egui`]: https://lib.rs/crates/bevy-inspector-egui
130+

‎licenses/LICENSE-APACHE

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎licenses/LICENSE-MIT

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
bevy_mod_component_mirror (c) Nicola Papale 2023
2+
MIT License
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in all
12+
copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20+
SOFTWARE.

‎src/lib.rs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#![doc = include_str!("../Readme.md")]
2+
3+
mod mirror;
4+
5+
/// Rapier mirror definitions.
6+
#[cfg(feature = "rapier")]
7+
pub mod rapier_mirrors;
8+
9+
#[cfg(feature = "rapier")]
10+
pub use rapier_mirrors::RapierMirrorsPlugins;
11+
12+
pub use mirror::{Mirror, MirrorPlugin, MirrorSystems};

0 commit comments

Comments
 (0)