Merge 9c7dfb5c76 into 9b50d77790

The fewer traits the better. This does add a little bit of a weirdness where it's unclear that some components should implement this, however in those cases, users can always fallback to manually dealing with GltfRefMap.

crates/bevy_gltf_component_refs/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "bevy_gltf_component_refs"
+version = "0.1.0"
+authors = ["Mark 'kaosat-dev' Moissette"]
+description = "Allows you to add reference components inside gltf files to relate components to each other on the Bevy side."
+homepage = "https://github.com/kaosat-dev/Blender_bevy_components_workflow"
+repository = "https://github.com/kaosat-dev/Blender_bevy_components_workflow"
+keywords = ["gamedev", "bevy", "assets", "gltf", "components"]
+categories = ["game-development"]
+edition = "2021"
+license = "MIT OR Apache-2.0"
+
+[lints]
+workspace = true
+
+[dependencies]
+bevy = { version = "0.13", default-features = false, features = ["bevy_scene"] }
+bevy_gltf_components = { version = "0.5", path = "../bevy_gltf_components" }
+
+[dev-dependencies]
+bevy = { version = "0.13", default-features = false, features = [
+  "dynamic_linking",
+] }

crates/bevy_gltf_component_refs/LICENSE.md

@@ -0,0 +1,4 @@
+This crate is available under either:
+
+* The [MIT License](./LICENSE_MIT)
+* The [Apache License, Version 2.0](./LICENSE_APACHE)

crates/bevy_gltf_component_refs/LICENSE_APACHE.md

@@ -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 [2023] [Mark "kaosat-dev" Moissette]
+
+   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.

crates/bevy_gltf_component_refs/LICENSE_MIT.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mark "kaosat-dev" Moissette
+
+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.

crates/bevy_gltf_component_refs/src/lib.rs

@@ -0,0 +1,177 @@
+use bevy::{
+    app::{App, Plugin},
+    ecs::{
+        component::Component,
+        entity::Entity,
+        query::With,
+        reflect::ReflectComponent,
+        schedule::{IntoSystemConfigs, IntoSystemSetConfigs, SystemSet},
+        system::{Commands, Query, Res, ResMut, Resource, SystemParam},
+    },
+    hierarchy::{HierarchyQueryExt, Parent},
+    log::warn,
+    prelude::Update,
+    reflect::{Reflect, TypePath},
+    scene::SceneInstance,
+    utils::HashMap,
+};
+use bevy_gltf_components::GltfComponentsSet;
+use std::marker::PhantomData;
+
+/// Plugin for keeping the GltfRefMap in sync.
+pub struct GltfRefMapPlugin;
+
+impl Plugin for GltfRefMapPlugin {
+    fn build(&self, app: &mut App) {
+        app.register_type::<GltfRefTarget>()
+            .init_resource::<GltfRefMap>()
+            .configure_sets(
+                Update,
+                (GltfRefsSet::CreateRefMap, GltfRefsSet::ResolveRefs)
+                    .chain()
+                    .after(GltfComponentsSet::Injection),
+            )
+            .add_systems(
+                Update,
+                GltfRefMap::create_ref_map.in_set(GltfRefsSet::CreateRefMap),
+            );
+    }
+}
+
+#[derive(SystemSet, Debug, Hash, PartialEq, Eq, Clone)]
+/// SystemSet to order your systems based on when references are resolved.
+pub enum GltfRefsSet {
+    /// Systems that create the [`GltfRefMap`] for that frame.
+    CreateRefMap,
+    /// Systems that resolve references using the [`GltfRefMap`]. For types that
+    /// need to have references manually resolved, prefer to put their systems
+    /// here.
+    ResolveRefs,
+}
+
+#[derive(Component, Reflect)]
+#[reflect(Component)]
+struct GltfRefTarget(String);
+
+/// A map of references for Gltf instances.
+#[derive(Resource, Default)]
+pub struct GltfRefMap(HashMap<Entity, HashMap<String, Entity>>);
+
+impl GltfRefMap {
+    /// Gets an entity given its `gltf_root` and `ref_name`. A reference is
+    /// only valid on the same frame that the Gltf is spawned in. In other
+    /// words, after that same frame, any references on `gltf_root` will return
+    /// None.
+    pub fn get_ref(&self, gltf_root: Entity, ref_name: &String) -> Option<Entity> {
+        self.0.get(&gltf_root)?.get(ref_name).copied()
+    }
+
+    fn create_ref_map(
+        ref_targets: Query<(Entity, &GltfRefTarget)>,
+        gltf_for_entity: GltfForEntity,
+        mut ref_map: ResMut<GltfRefMap>,
+        mut commands: Commands,
+    ) {
+        ref_map.0.clear();
+
+        for (entity, ref_target) in ref_targets.iter() {
+            commands.entity(entity).remove::<GltfRefTarget>();
+            let Some(gltf_root) = gltf_for_entity.find_gltf_root(entity) else {
+                warn!("Entity {entity:?} is not part of a Gltf but contains a GltfRefTarget (target={}).", ref_target.0);
+                continue;
+            };
+            ref_map
+                .0
+                .entry(gltf_root)
+                .or_default()
+                .insert(ref_target.0.clone(), entity);
+        }
+    }
+}
+
+#[derive(Component, Reflect)]
+#[reflect(Component)]
+struct GltfRef<T: Component> {
+    target: String,
+    #[reflect(ignore)]
+    _marker: PhantomData<T>,
+}
+
+impl<T: Component> GltfRef<T>
+where
+    Entity: Into<T>,
+{
+    fn system(
+        refs: Query<(Entity, &Self)>,
+        gltf_for_entity: GltfForEntity,
+        ref_map: Res<GltfRefMap>,
+        mut commands: Commands,
+    ) {
+        for (entity, gltf_ref) in refs.iter() {
+            commands.entity(entity).remove::<Self>();
+            let Some(gltf_root) = gltf_for_entity.find_gltf_root(entity) else {
+                warn!("GltfRef should only be on descendants of a Gltf.");
+                continue;
+            };
+
+            match ref_map.get_ref(gltf_root, &gltf_ref.target) {
+                Some(target) => {
+                    commands.entity(entity).insert(Into::<T>::into(target));
+                }
+                None => {
+                    warn!(
+                        "Entity {entity:?} attempted to reference '{}' in gltf {gltf_root:?}",
+                        &gltf_ref.target
+                    );
+                }
+            }
+        }
+    }
+}
+
+/// Plugin for automatically converting [`GltfRef`]s into their corresponding
+/// `T`.
+pub struct GltfRefPlugin<T: Component + TypePath>(PhantomData<T>);
+
+impl<T: Component + TypePath> Plugin for GltfRefPlugin<T>
+where
+    Entity: Into<T>,
+{
+    fn build(&self, app: &mut App) {
+        app.register_type::<GltfRef<T>>().add_systems(
+            Update,
+            GltfRef::<T>::system.in_set(GltfRefsSet::ResolveRefs),
+        );
+    }
+}
+
+// Manual implementation of Default for GltfRefPlugin to avoid `Default` trait
+// bounds on `T`.
+impl<T: Component + TypePath> Default for GltfRefPlugin<T>
+where
+    Entity: Into<T>,
+{
+    fn default() -> Self {
+        Self(Default::default())
+    }
+}
+
+/// SystemParam to find the Gltf that an entity belongs to.
+#[derive(SystemParam)]
+pub struct GltfForEntity<'w, 's> {
+    gltfs: Query<'w, 's, (), With<SceneInstance>>,
+    hierarchy: Query<'w, 's, &'static Parent>,
+}
+
+impl<'w, 's> GltfForEntity<'w, 's> {
+    /// Finds the Gltf root for `entity`. Returns None if `entity` does not
+    /// belong to a Gltf.
+    pub fn find_gltf_root(&self, entity: Entity) -> Option<Entity> {
+        for entity in std::iter::once(entity).chain(self.hierarchy.iter_ancestors(entity)) {
+            if self.gltfs.contains(entity) {
+                return Some(entity);
+            }
+        }
+        None
+    }
+}