Initial Commit

10 files changed, 500 insertions, 0 deletions

diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
new file mode 100644
index 0000000..e38739d
--- /dev/null
+++ b/.github/workflows/rust.yml
@@ -0,0 +1,24 @@
+name: Rust
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install Dependencies
+      run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
+    - name: Build
+      run: cargo build --verbose
+    - name: Run tests
+      run: cargo test --verbose
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..ea8c4bf
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+/target
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..34d74f6
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,9 @@
+[package]
+name = "bevy_basic_interaction"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies.bevy]
+version = "0.14"
+default-features = false
+
diff --git a/LICENSE-0BSD b/LICENSE-0BSD
new file mode 100644
index 0000000..7a39b21
--- /dev/null
+++ b/LICENSE-0BSD
@@ -0,0 +1,5 @@
+Copyright (C) 2024 by Silas Bartha silas@exvacuum.dev
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..2ad6853
--- /dev/null
+++ b/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 2024 Silas Bartha
+
+   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 0000000..dcc255f
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Silas Bartha
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7c3de07
--- /dev/null
+++ b/README.md
@@ -0,0 +1,64 @@
+# bevy_basic_interaction
+
+![License](https://img.shields.io/badge/license-0BSD%2FMIT%2FApache-blue.svg)
+![Tag](https://img.shields.io/github/v/tag/exvacuum/bevy_basic_interaction)
+![Build](https://img.shields.io/github/actions/workflow/status/exvacuum/bevy_basic_interaction/rust.yml)
+
+This crate provides an `InteractionPlugin` which enables a basic interaction system.
+
+This plugin is mostly for my own internal use, but feel free to use it or contribute if you feel like it.
+
+## Compatibility
+
+| Crate Version | Bevy Version |
+|---            |---           |
+| 0.1           | 0.14         |
+
+## Installation
+
+If enough people (like literally 1 person) want this on crates.io I'll consider putting it up there, but for now just add the GitHub URL to your `Cargo.toml`:
+
+```toml
+[dependencies.bevy_basic_interaction]
+git = "https://github.com/exvacuum/bevy_basic_interaction"
+```
+
+## Usage
+
+This plugin works based on a system of `Interactor`s and `Interactable`s. `Interactor`s maintain a list of "target" `Interactable`s which are in range of the interactor (based on a maximum distance defined in the *interactable*). The user can invoke an `InteractorFiredEvent`, passing the `Entity` with an `Interactor` component on it, and the plugin will automatically determine which interactables to invoke a corresponding `InteractionEvent` for.
+
+In main function:
+```rs
+use bevy::prelude::*;
+use bevy_basic_interaction::InteractionPlugin;
+
+fn main() {
+    App::new()
+        // ...
+        .add_plugins(InteractionPlugin)
+        // ...
+        .run();
+}
+```
+
+Raising an interactor event (`entity` must be an entity with both an `Interactor` and a `GlobalTransform` component):
+```rs
+// ...
+event_writer.send(InteractorFiredEvent(entity));
+// ...
+```
+
+Handling an interaction event:
+```rs
+// ...
+for InteractionEvent { interactable, .. } in event_reader.read() {
+    let interactable = interactable_query.get(interactable).unwrap();
+    // Do something with interactable here...
+}
+// ...
+```
+
+## License
+
+This crate is licensed under your choice of 0BSD, Apache-2.0, or MIT license.
+
diff --git a/src/components.rs b/src/components.rs
new file mode 100644
index 0000000..1be2f2c
--- /dev/null
+++ b/src/components.rs
@@ -0,0 +1,46 @@
+//! Components used for interactions
+
+use bevy::{prelude::*, utils::HashSet};
+
+/// Component which enables an entity to request interactions.
+///
+/// An entity with an `Interactor` component can be passed to an `InteractorFiredEvent` in order to
+/// start an interaction with any nearby `Interactable` entities.
+#[derive(Component, Default)]
+pub struct Interactor {
+    /// All `Interactable` targets in-range of this interactor.
+    pub targets: HashSet<Entity>,
+    /// The closest `Interactable` target to this interactor, if any.
+    pub closest: Option<Entity>,
+}
+
+/// Component which enables an entity to recieve interactions.
+///
+/// An entity with an `Interactable` component might get passed to an `InteractionEvent` when an
+/// `Interactor` requests an interaction, if the interactable is in range.
+#[derive(Component)]
+pub struct Interactable {
+    pub(crate) exclusive: bool,
+    pub(crate) max_distance_squared: f32,
+}
+
+impl Interactable {
+    /// Construct a new instance of this component.
+    ///
+    /// If exclusive, this interactable will only be interacted with if it's the closest one to the
+    /// interactor, and the interaction will *not* be processed for any other in-range
+    /// interactables.
+    pub fn new(max_distance: f32, exclusive: bool) -> Self {
+        Self {
+            exclusive,
+            max_distance_squared: max_distance * max_distance,
+        }
+    }
+}
+
+impl Default for Interactable {
+    fn default() -> Self {
+        Self::new(1.0, false)
+    }
+}
+
diff --git a/src/events.rs b/src/events.rs
new file mode 100644
index 0000000..43ca1ba
--- /dev/null
+++ b/src/events.rs
@@ -0,0 +1,19 @@
+//! Events which enable interactions between `Interactor` and `Interactable` entities.
+
+use bevy::prelude::*;
+
+/// Event sent by user to request an interaction from the given `Interactor` entity.
+#[derive(Event)]
+pub struct InteractorFiredEvent(pub Entity);
+
+/// Event sent by the plugin once an `InteractorFiredEvent` has been processed. It should be caught
+/// by the user to perform some action on the affected interactable entity.
+///
+/// It is not intended to be invoked directly.
+#[derive(Event)]
+pub struct InteractionEvent {
+    /// `Interactor` entity which triggered this interaction.
+    pub interactor: Entity,
+    /// `Interactable` entity whicg is receiving this interaction.
+    pub interactable: Entity,
+}
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..2e3fc60
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,110 @@
+#![warn(missing_docs)]
+
+//! This library provides basic "interaction" functionality
+//! Entities which can trigger interactions get the `Interactor` component, and entities which can
+//! Be interacted with get the `Interactable` component. An `InteractorFiredEvent` can be invoked for
+//! a given `Interactor`, which does the following:
+//!   1. Checks to make sure there is at least 1 `Interactable` in range
+//!   2. If the nearest `Interactable` is "exclusive", an `InteractionEvent` is invoked for only that
+//!      entity
+//!   3. If the nearest `Interactable` is *not* "exclusive", an individual `InteractionEvent` is invoked for
+//!      that entity and each "non-exclusive" `Interactable` entity within range
+
+use std::f32::consts::PI;
+
+use bevy::prelude::*;
+use components::{Interactable, Interactor};
+use events::{InteractionEvent, InteractorFiredEvent};
+
+pub mod components;
+pub mod events;
+
+/// Plugin which enables interaction functionality.
+/// Sets up event handling for `InteractorFiredEvent` to automatically trigger the correct
+/// `InteractionEvent`s
+pub struct InteractionPlugin;
+
+impl Plugin for InteractionPlugin {
+    fn build(&self, app: &mut App) {
+        app.add_systems(Update, (handle_interactor_events, update_interactor_targets))
+            .add_event::<InteractorFiredEvent>()
+            .add_event::<InteractionEvent>();
+    }
+}
+
+fn handle_interactor_events(
+    mut interactor_events: EventReader<InteractorFiredEvent>,
+    interactable_query: Query<&Interactable>,
+    interactor_query: Query<&Interactor>,
+    mut event_writer: EventWriter<InteractionEvent>,
+) {
+    for InteractorFiredEvent(interactor_entity) in interactor_events.read() {
+        let interactor = interactor_query.get(*interactor_entity).unwrap();
+
+        if let Some(interactable_entity) = interactor.closest {
+            let interactable = interactable_query.get(interactable_entity).unwrap();
+            if interactable.exclusive {
+                event_writer.send(InteractionEvent {
+                    interactor: *interactor_entity,
+                    interactable: interactable_entity,
+                });
+                continue;
+            } else {
+                for interactable_entity in &interactor.targets {
+                    let interactable = interactable_query.get(*interactable_entity).unwrap();
+                    if !interactable.exclusive {
+                        event_writer.send(InteractionEvent {
+                            interactor: *interactor_entity,
+                            interactable: *interactable_entity,
+                        });
+                    }
+                }
+            }
+        }
+    }
+}
+
+fn update_interactor_targets(
+    mut interactable_query: Query<(Entity, &Interactable)>,
+    mut interactor_query: Query<(Entity, &mut Interactor)>,
+    transform_query: Query<&GlobalTransform>,
+) {
+    for (interactor_entity, mut interactor) in interactor_query.iter_mut() {
+        let interactor_transform = transform_query.get(interactor_entity).unwrap();
+
+        let mut closest_active_interactable: Option<(f32, Entity)> = None;
+        for (interactable_entity, interactable) in interactable_query.iter_mut() {
+            let interactable_transform = transform_query.get(interactable_entity).unwrap();
+            let interactable_distance_squared = interactable_transform
+                .translation()
+                .distance_squared(interactor_transform.translation());
+            let interactable_arccosine = f32::acos(
+                interactor_transform.forward().dot(
+                    (interactable_transform.translation() - interactor_transform.translation())
+                        .normalize(),
+                ),
+            );
+            if interactable_distance_squared < interactable.max_distance_squared
+                && interactable_arccosine < PI / 8.0
+            {
+                interactor.targets.insert(interactable_entity);
+                if let Some((arccosine, _)) = closest_active_interactable {
+                    if interactable_arccosine < arccosine {
+                        closest_active_interactable =
+                            Some((interactable_arccosine, interactable_entity));
+                    }
+                } else {
+                    closest_active_interactable =
+                        Some((interactable_arccosine, interactable_entity));
+                }
+            } else {
+                interactor.targets.remove(&interactable_entity);
+            }
+        }
+        interactor.closest = if let Some((_, interactable_entity)) = closest_active_interactable {
+            Some(interactable_entity)
+        } else {
+            None
+        }
+    }
+}